chrome.audio

الوصف

يتم توفير واجهة برمجة التطبيقات chrome.audio للسماح للمستخدمين بالحصول على معلومات حول أجهزة الصوت المرفقة بالنظام والتحكّم فيها. لا تتوفّر واجهة برمجة التطبيقات هذه حاليًا إلا في وضع Kiosk على ChromeOS.

الأذونات

audio

مدى التوفّر

الإصدار 59 من Chrome أو إصدار أحدث نظام التشغيل ChromeOS فقط

الأنواع

AudioDeviceInfo

الخصائص

  • deviceName

    سلسلة

    اسم الجهاز

  • deviceType

    DeviceType

    نوع الجهاز

  • displayName

    سلسلة

    الاسم السهل الاستخدام (مثل "ميكروفون USB").

  • id

    سلسلة

    المعرّف الفريد لجهاز الصوت.

  • isActive

    قيمة منطقية

    تكون القيمة صحيحة إذا كان هذا هو الجهاز النشط الحالي.

  • المستوى

    الرقم

    مستوى صوت الجهاز، ومستوى صوت الإخراج، ومستوى صوت الإدخال

  • stableDeviceId

    سلسلة اختيارية

    سلسلة رقم تعريف الجهاز الثابت/الدائم عند توفّره

  • streamType

    StreamType

    نوع البث المرتبط بهذا الجهاز

DeviceFilter

الخصائص

  • isActive

    boolean اختياري

    في حال ضبط هذه السمة، لن تستوفي الفلتر سوى أجهزة الصوت التي تتطابق حالتها النشطة مع هذه القيمة.

  • streamTypes

    StreamType[] اختياري

    في حال ضبط هذا الإعداد، لن تستوفي الفلتر سوى أجهزة الصوت التي يتضمّن هذا الإعداد نوع بثها.

DeviceIdLists

الخصائص

  • إدخال

    string[] اختياري

    قائمة بأجهزة الإدخال المحدّدة حسب رقم تعريفها

    للتوضيح أنّه يجب عدم تأثّر أجهزة الإدخال، اترك هذه السمة بدون ضبط.

  • output

    string[] اختياري

    قائمة بأجهزة الإخراج المحدّدة حسب رقم تعريفها

    للتأكيد على أنّه يجب ألا تتأثر أجهزة الإخراج، اترك هذه السمة بدون ضبط.

DeviceProperties

الخصائص

  • المستوى

    number اختياري

    مستوى الصوت المطلوب لجهاز الصوت يكون هذا الحقل تلقائيًا على مستوى الصوت الحالي للجهاز.

    في حال استخدامها مع جهاز إدخال الصوت، تمثّل مستوى الصوت الملتقط.

    في حال استخدامها مع جهاز إخراج الصوت، تمثّل مستوى صوت جهاز الصوت.

DeviceType

أنواع أجهزة الصوت المتاحة

Enum

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"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

تمثّل هذه السمة نوع البث الذي يوفّره الجهاز الصوتي.

Enum

"INPUT"

"OUTPUT"

الطُرق

getDevices()

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

تعرض هذه الطريقة قائمة بأجهزة الصوت التي تمّت فلترتها استنادًا إلى filter.

المعلمات

  • تصفية

    ‫DeviceFilter اختياري

    خصائص الجهاز التي سيتم فلترة قائمة أجهزة الصوت المعروضة حسبها إذا لم يتم ضبط الفلتر أو تم ضبطه على {}، ستتضمّن قائمة الأجهزة التي يتم عرضها جميع أجهزة الصوت المتاحة.

المرتجعات

  • Promise<AudioDeviceInfo[]>

    الإصدار 116 من Chrome والإصدارات الأحدث

    تعرض هذه السمة قائمة بأجهزة الصوت المطلوبة.

getMute()

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

تعرض هذه السمة حالة كتم الصوت على مستوى النظام لنوع البث المحدّد.

المعلمات

  • streamType

    StreamType

    نوع البث المباشر الذي يجب استرداد حالة كتم الصوت له

المرتجعات

  • Promise<boolean>

    الإصدار 116 من Chrome والإصدارات الأحدث

    وعد يتم تنفيذه بقيمة منطقية تشير إلى ما إذا كان قد تم ضبط كتم الصوت لنوع البث المحدّد أم لا.

setActiveDevices()

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

تضبط هذه السمة قوائم بأجهزة الإدخال و/أو الإخراج النشطة.

المعلمات

  • المعرّفات

    DeviceIdLists

    تحدِّد هذه السمة أرقام تعريف الأجهزة التي يجب أن تكون نشطة. إذا لم يتم ضبط قائمة الإدخال أو الإخراج، لن تتأثر الأجهزة في تلك الفئة.

    يُعدّ إدخال رقم تعريف جهاز غير متوفّر خطأً.

المرتجعات

  • Promise<void>

    الإصدار 116 من Chrome والإصدارات الأحدث

setMute()

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

تضبط هذه السمة حالة كتم الصوت لنوع بث معيّن. سيتم تطبيق حالة كتم الصوت على جميع أجهزة الصوت التي تتضمّن نوع بث الصوت المحدّد.

المعلمات

  • streamType

    StreamType

    نوع البث الذي يجب ضبط حالة كتم الصوت له

  • isMuted

    قيمة منطقية

    قيمة الكتم الجديدة

المرتجعات

  • Promise<void>

    الإصدار 116 من Chrome والإصدارات الأحدث

setProperties()

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

تضبط هذه السمة خصائص جهاز الإدخال أو الإخراج.

المعلمات

المرتجعات

  • Promise<void>

    الإصدار 116 من Chrome والإصدارات الأحدث

الفعاليات

onDeviceListChanged

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

يتم تنشيط هذا الحدث عند تغيير الأجهزة الصوتية، سواء تمت إضافة أجهزة جديدة أو إزالة أجهزة حالية.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (devices: AudioDeviceInfo[]) => void

onLevelChanged

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

يتم تشغيل هذا الحدث عندما يتغير مستوى الصوت لجهاز صوت نشط.

المعلمات

onMuteChanged

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

يتم تنشيط هذا الحدث عند تغيُّر حالة كتم صوت الإدخال أو الإخراج. يُرجى العِلم أنّ حالة كتم الصوت تكون على مستوى النظام، وأنّ القيمة الجديدة تنطبق على كل جهاز صوتي بنوع بث محدّد.

المعلمات