توضیحات
رابط برنامهنویسی کاربردی chrome.audio به کاربران اجازه میدهد تا اطلاعاتی در مورد دستگاههای صوتی متصل به سیستم دریافت کرده و آنها را کنترل کنند. این رابط برنامهنویسی کاربردی در حال حاضر فقط در حالت کیوسک برای ChromeOS در دسترس است.
مجوزها
audioدر دسترس بودن
انواع
AudioDeviceInfo
خواص
- نام دستگاه
رشته
نام دستگاه.
- نوع دستگاه
نوع دستگاه.
- نام نمایش
رشته
نام کاربرپسند (مثلاً "میکروفون USB").
- شناسه
رشته
شناسه منحصر به فرد دستگاه صوتی.
- فعال است
بولی
اگر این دستگاه فعال فعلی باشد، درست است.
- سطح
شماره
سطح صدای دستگاه، ولوم برای خروجی، گین برای ورودی.
- شناسه دستگاه پایدار
رشته اختیاری
رشته شناسه دستگاه پایدار/دائمی در صورت موجود بودن.
- نوع جریان
نوع جریان مرتبط با این دستگاه.
DeviceFilter
خواص
- فعال است
بولی اختیاری
در صورت تنظیم، فقط دستگاههای صوتی که وضعیت فعال آنها با این مقدار مطابقت دارد، فیلتر را برآورده میکنند.
- انواع جریان
نوع جریان [] اختیاری
در صورت تنظیم، فقط دستگاههای صوتی که نوع جریان آنها در این لیست گنجانده شده باشد، فیلتر را برآورده میکنند.
DeviceIdLists
خواص
- ورودی
رشته[] اختیاری
فهرست دستگاههای ورودی مشخصشده با شناسهشان.
برای اینکه مشخص شود دستگاههای ورودی نباید تحت تأثیر قرار بگیرند، این ویژگی را بدون تنظیم رها کنید.
- خروجی
رشته[] اختیاری
فهرست دستگاههای خروجی مشخص شده با شناسه آنها.
برای اینکه مشخص شود دستگاههای خروجی نباید تحت تأثیر قرار گیرند، این ویژگی را بدون تنظیم رها کنید.
DeviceProperties
خواص
- سطح
شماره اختیاری
سطح صدای مطلوب دستگاه صوتی. به طور پیشفرض روی سطح صدای فعلی دستگاه تنظیم شده است.
اگر با دستگاه ورودی صدا استفاده شود، نشاندهندهی بهرهی دستگاه صوتی است.
اگر با دستگاه خروجی صدا استفاده شود، نشاندهندهی میزان صدای دستگاه صوتی است.
DeviceType
انواع دستگاههای صوتی موجود.
شمارشی
«هدفون» "میک" "یو اس بی" "بلوتوث" «اچدیامآی» «بلندگوی داخلی» "میکروفون داخلی" "میکروفن جلویی" "میکروفن عقب" "کیبورد_میکروفن" «کلمه داغ» "خطچینی" "پست_ترکیب_حلقه_بازگشت" "پست_DSP_LOOPBACK" "ALSA_LOOPBACK" «دیگر»
LevelChangedEvent
خواص
- شناسه دستگاه
رشته
شناسه دستگاهی که سطح صدای آن تغییر کرده است.
- سطح
شماره
سطح صدای جدید دستگاه.
MuteChangedEvent
خواص
- خاموش شده
بولی
اینکه آیا جریان اکنون بیصدا شده است یا خیر.
- نوع جریان
نوع جریانی که مقدار بیصدا کردن برای آن تغییر کرده است. مقدار بیصدا کردن بهروزرسانیشده برای همه دستگاههای دارای این نوع جریان اعمال میشود.
StreamType
نوع جریانی که یک دستگاه صوتی ارائه میدهد.
شمارشی
"ورودی" "خروجی"
روشها
getDevices()
chrome.audio.getDevices(
filter?: DeviceFilter,
): Promise<AudioDeviceInfo[]>
لیستی از دستگاههای صوتی فیلتر شده بر اساس filter را دریافت میکند.
پارامترها
- فیلتر
فیلتر دستگاه اختیاری
ویژگیهای دستگاه که با استفاده از آنها میتوان لیست دستگاههای صوتی برگشتی را فیلتر کرد. اگر فیلتر تنظیم نشده باشد یا روی
{}تنظیم شده باشد، لیست دستگاههای برگشتی شامل تمام دستگاههای صوتی موجود خواهد بود.
بازگشتها
قول< اطلاعات دستگاه صوتی []>
کروم ۱۱۶+لیست درخواستی دستگاههای صوتی را گزارش میدهد.
getMute()
chrome.audio.getMute(
streamType: StreamType,
): Promise<boolean>
حالت بیصدا در سطح سیستم را برای نوع جریان مشخص شده دریافت میکند.
پارامترها
- نوع جریان
نوع جریانی که حالت بیصدا باید برای آن واکشی شود.
بازگشتها
قول <boolean>
کروم ۱۱۶+وعدهای که با یک مقدار بولی که نشان میدهد آیا برای نوع جریان مشخص شده، بیصدا تنظیم شده است یا خیر، حل میشود.
setActiveDevices()
chrome.audio.setActiveDevices(
ids: DeviceIdLists,
): Promise<void>
فهرست دستگاههای ورودی و/یا خروجی فعال را تنظیم میکند.
پارامترها
- شناسهها
شناسههای دستگاههایی را که باید فعال باشند مشخص میکند. اگر لیست ورودی یا خروجی تنظیم نشده باشد، دستگاههای موجود در آن دسته تحت تأثیر قرار نمیگیرند.
ارسال شناسه دستگاهی که وجود ندارد، خطا محسوب میشود.
بازگشتها
قول<void>
کروم ۱۱۶+
setMute()
chrome.audio.setMute(
streamType: StreamType,
isMuted: boolean,
): Promise<void>
حالت بیصدا را برای یک نوع جریان تنظیم میکند. حالت بیصدا برای همه دستگاههای صوتی با نوع جریان صوتی مشخص شده اعمال میشود.
پارامترها
- نوع جریان
نوع جریانی که باید حالت بیصدا برای آن تنظیم شود.
- خاموش شده
بولی
مقدار بیصدای جدید.
بازگشتها
قول<void>
کروم ۱۱۶+
setProperties()
chrome.audio.setProperties(
id: string,
properties: DeviceProperties,
): Promise<void>
ویژگیهای دستگاه ورودی یا خروجی را تنظیم میکند.
پارامترها
- شناسه
رشته
- خواص
بازگشتها
قول<void>
کروم ۱۱۶+
رویدادها
onDeviceListChanged
chrome.audio.onDeviceListChanged.addListener(
callback: function,
)
وقتی دستگاههای صوتی تغییر میکنند، چه دستگاههای جدید اضافه شوند و چه دستگاههای موجود حذف شوند، اجرا میشود.
پارامترها
- تماس برگشتی
تابع
پارامتر
callbackبه شکل زیر است:(devices: AudioDeviceInfo[]) => void
- دستگاهها
onLevelChanged
chrome.audio.onLevelChanged.addListener(
callback: function,
)
هنگامی که سطح صدا برای یک دستگاه صوتی فعال تغییر میکند، فعال میشود.
پارامترها
- تماس برگشتی
تابع
پارامتر
callbackبه شکل زیر است:(event: LevelChangedEvent) => void
- رویداد
onMuteChanged
chrome.audio.onMuteChanged.addListener(
callback: function,
)
زمانی اجرا میشود که وضعیت بیصدا کردن ورودی یا خروجی صدا تغییر کند. توجه داشته باشید که وضعیت بیصدا کردن در کل سیستم است و مقدار جدید برای هر دستگاه صوتی با نوع جریان مشخص شده اعمال میشود.
پارامترها
- تماس برگشتی
تابع
پارامتر
callbackبه شکل زیر است:(event: MuteChangedEvent) => void
- رویداد