chrome.audio

refresh date: 2026-09-25 robots: noindex

مهم: این API فقط در ChromeOS کار می‌کند.

شرح

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

اجازه‌ها

audio

دردسترس بودن

Chrome نسخه ۵۹ و بالاتر فقط ChromeOS

انواع

AudioDeviceInfo

مشخصات

• deviceName

  رشته

  نام دستگاه.

• deviceType

  DeviceType

  نوع دستگاه.

• displayName

  رشته

  نام کاربرپسند (مثلاً «میکروفون USB»).

• id

  رشته

  شناسه یکتای دستگاه صوتی.

• isActive

  بولی

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

• سطح

  شماره

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

• stableDeviceId

  رشته اختیاری

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

• streamType

  StreamType

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

DeviceFilter

مشخصات

• isActive

  بولی اختیاری

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

• streamTypes

  StreamType[] اختیاری

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

DeviceIdLists

مشخصات

• ورودی

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

  فهرست دستگاه‌های ورودی که با شناسه آن‌ها مشخص شده است.

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

• خروجی

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

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

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

DeviceProperties

مشخصات

• سطح

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

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

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

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

DeviceType

انواع دستگاه‌های صوتی دردسترس.

شمارشی

"HEADPHONE"

«MIC»

"USB"

«بلوتوث»

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

«HOTWORD»

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

مشخصات

• deviceId

  رشته

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

• سطح

  شماره

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

MuteChangedEvent

مشخصات

• isMuted

  بولی

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

• streamType

  StreamType

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

StreamType

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

شمارشی

«ورودی»

«OUTPUT»

روش‌ها

getDevices()

قول

chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
): Promise<AudioDeviceInfo[]>

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

پارامترها

• فیلتر کردن

  DeviceFilter اختیاری

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

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (devices: AudioDeviceInfo[]) => void

  • دستگاه

    AudioDeviceInfo[]

بازگشتی‌ها

• Promise<AudioDeviceInfo[]>

  Chrome نسخه ۱۱۶ و بالاتر

  فهرست درخواستی دستگاه‌های صوتی را گزارش می‌کند.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getMute()

قول

chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
): Promise<boolean>

وضعیت بی‌صدا در سراسر سیستم را برای نوع جاری‌سازی مشخص‌شده دریافت می‌کند.

پارامترها

• streamType

  StreamType

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

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (value: boolean) => void

  • مقدار

    بولی

بازگشتی‌ها

• Promise<boolean>

  Chrome نسخه ۱۱۶ و بالاتر

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

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setActiveDevices()

قول

chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
): Promise<void>

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

پارامترها

• شناسه‌ها

  DeviceIdLists

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

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

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۱۶ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setMute()

قول

chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
): Promise<void>

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

پارامترها

• streamType

  StreamType

  نوع جاری‌سازی که باید وضعیت صامت برای آن تنظیم شود.

• isMuted

  بولی

  مقدار صامت کردن جدید.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۱۶ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setProperties()

قول

chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
): Promise<void>

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

پارامترها

• id

  رشته

• اقامتگاه‌ها

  DeviceProperties

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۱۶ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onDeviceListChanged

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (devices: AudioDeviceInfo[]) => void

  • دستگاه

    AudioDeviceInfo[]

onLevelChanged

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (event: LevelChangedEvent) => void

  • رویداد

    LevelChangedEvent

onMuteChanged

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (event: MuteChangedEvent) => void

  • رویداد

    MuteChangedEvent