chrome.audio

توضیحات

chrome.audio API ارائه شده است تا به کاربران اجازه دهد اطلاعاتی درباره دستگاه‌های صوتی متصل به سیستم دریافت کرده و آن‌ها را کنترل کنند. این API در حال حاضر فقط در حالت کیوسک برای ChromeOS در دسترس است.

مجوزها

audio

در دسترس بودن

فقط Chrome 59+ ChromeOS

انواع

AudioDeviceInfo

خواص

  • نام دستگاه

    رشته

    نام دستگاه

  • نوع دستگاه

    نوع دستگاه

    نوع دستگاه.

  • نمایش نام

    رشته

    نام کاربر پسند (به عنوان مثال "USB Microphone").

  • شناسه

    رشته

    شناسه منحصر به فرد دستگاه صوتی.

  • فعال است

    بولی

    درست است اگر این دستگاه فعال فعلی باشد.

  • سطح

    شماره

    سطح صدای دستگاه، حجم برای خروجی، بهره برای ورودی.

  • stableDeviceId

    رشته اختیاری

    رشته شناسه دستگاه پایدار/پایدار در صورت موجود بودن.

  • نوع جریان

    StreamType

    نوع جریان مرتبط با این دستگاه.

DeviceFilter

خواص

  • فعال است

    بولی اختیاری

    اگر تنظیم شود، فقط دستگاه‌های صوتی که وضعیت فعال آنها با این مقدار مطابقت دارد، فیلتر را برآورده می‌کند.

  • انواع جریان

    StreamType [] اختیاری است

    در صورت تنظیم، فقط دستگاه‌های صوتی که نوع پخش آن‌ها در این لیست گنجانده شده است، فیلتر را برآورده می‌کنند.

DeviceIdLists

خواص

  • ورودی

    رشته[] اختیاری است

    لیست دستگاه های ورودی که توسط شناسه آنها مشخص شده است.

    برای نشان دادن اینکه دستگاه های ورودی باید بدون تأثیر باشند، این ویژگی را تنظیم نشده رها کنید.

  • خروجی

    رشته[] اختیاری است

    لیست دستگاه های خروجی که توسط شناسه آنها مشخص شده است.

    برای نشان دادن اینکه دستگاه‌های خروجی باید بدون تأثیر باشند، این ویژگی را تنظیم نشده رها کنید.

DeviceProperties

خواص

  • سطح

    شماره اختیاری

    سطح صدای مورد نظر دستگاه صوتی. به طور پیش فرض سطح صدای فعلی دستگاه را تنظیم می کند.

    اگر با دستگاه ورودی صدا استفاده شود، نشان دهنده سود دستگاه صوتی است.

    اگر با دستگاه خروجی صدا استفاده شود، نشان دهنده حجم دستگاه صوتی است.

DeviceType

انواع دستگاه های صوتی موجود

Enum

"هدفون"

"MIC"

"USB"

"بلوتوث"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"خط خط"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"دیگر"

LevelChangedEvent

خواص

  • شناسه دستگاه

    رشته

    شناسه دستگاهی که سطح صدای آن تغییر کرده است.

  • سطح

    شماره

    سطح صدای جدید دستگاه

MuteChangedEvent

خواص

  • خاموش است

    بولی

    این که آیا جریان اکنون بی‌صدا است یا خیر.

  • نوع جریان

    StreamType

    نوع جریانی که مقدار بی صدا برای آن تغییر کرده است. مقدار بی‌صدا به‌روزرسانی شده برای همه دستگاه‌های دارای این نوع جریان اعمال می‌شود.

StreamType

نوع جریانی که یک دستگاه صوتی ارائه می دهد.

Enum

"ورودی"

"خروجی"

روش ها

getDevices()

قول بده
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

لیستی از دستگاه های صوتی فیلتر شده بر اساس filter را دریافت می کند.

پارامترها

  • فیلتر

    DeviceFilter اختیاری است

    ویژگی های دستگاه که با آن لیست دستگاه های صوتی برگشتی را فیلتر می کند. اگر فیلتر تنظیم نشده باشد یا روی {} تنظیم نشده باشد، لیست دستگاه های برگشتی شامل همه دستگاه های صوتی موجود خواهد بود.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (devices: AudioDeviceInfo[]) => void

برمی گرداند

  • Promise< AudioDeviceInfo []>

    Chrome 116+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

getMute()

قول بده
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

حالت بی صدا در سراسر سیستم را برای نوع جریان مشخص شده دریافت می کند.

پارامترها

  • نوع جریان

    StreamType

    نوع جریانی که برای آن حالت بی صدا باید واکشی شود.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (value: boolean) => void

    • ارزش

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 116+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setActiveDevices()

قول بده
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

لیستی از دستگاه های ورودی و/یا خروجی فعال را تنظیم می کند.

پارامترها

  • شناسه

    DeviceIdLists

    شناسه دستگاه هایی را که باید فعال باشند را مشخص می کند. اگر لیست ورودی یا خروجی تنظیم نشده باشد، دستگاه‌های آن دسته تحت تأثیر قرار نمی‌گیرند.

    این یک خطا است که در شناسه دستگاه موجود نیست.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 116+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setMute()

قول بده
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

حالت بی صدا را برای یک نوع جریان تنظیم می کند. حالت بی‌صدا برای همه دستگاه‌های صوتی با نوع پخش صوتی مشخص شده اعمال می‌شود.

پارامترها

  • نوع جریان

    StreamType

    نوع جریانی که برای آن حالت بی صدا باید تنظیم شود.

  • خاموش است

    بولی

    مقدار جدید بی صدا.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 116+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setProperties()

قول بده
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

ویژگی های دستگاه ورودی یا خروجی را تنظیم می کند.

پارامترها

  • شناسه

    رشته

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 116+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

رویدادها

onDeviceListChanged

chrome.audio.onDeviceListChanged.addListener(
  callback: function,
)

وقتی دستگاه‌های صوتی تغییر می‌کنند، یا دستگاه‌های جدید اضافه می‌شوند یا دستگاه‌های موجود حذف می‌شوند، فعال می‌شود.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (devices: AudioDeviceInfo[]) => void

onLevelChanged

chrome.audio.onLevelChanged.addListener(
  callback: function,
)

هنگامی که سطح صدا برای یک دستگاه صوتی فعال تغییر می کند، فعال می شود.

پارامترها

onMuteChanged

chrome.audio.onMuteChanged.addListener(
  callback: function,
)

هنگامی که وضعیت بی صدا ورودی یا خروجی صدا تغییر می کند فعال می شود. توجه داشته باشید که حالت بی‌صدا در کل سیستم است و مقدار جدید برای هر دستگاه صوتی با نوع پخش مشخص اعمال می‌شود.

پارامترها