chrome.audio

الوصف

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

الأذونات

audio

مدى توفّر الخدمة

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

الأنواع

AudioDeviceInfo

أماكن إقامة

  • deviceName

    سلسلة

    اسم الجهاز

  • deviceType

    DeviceType

    نوع الجهاز

  • displayName

    سلسلة

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

  • id

    سلسلة

    المعرّف الفريد للجهاز السماعي.

  • isActive

    boolean

    صحيح إذا كان هذا هو الجهاز النشط حاليًا.

  • المستوى

    الرقم

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

  • stableDeviceId

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

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

  • streamType

    StreamType

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

DeviceFilter

أماكن إقامة

  • isActive

    منطقية اختيارية

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

  • streamTypes

    StreamType[] اختيارية

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

DeviceIdLists

أماكن إقامة

  • مصدر الإدخال

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

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

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

  • الإنتاج

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

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

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

DeviceProperties

أماكن إقامة

  • المستوى

    الرقم اختياري

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

    وفي حال استخدامه مع جهاز إدخال صوت، يتم تمثيل هذا المكسب الذي تم تحقيقه في الجهاز السماعي.

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

DeviceType

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

التعداد

"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

    boolean

    ما إذا كان البث مكتومًا الآن أم لا

  • streamType

    StreamType

    نوع البث الذي تغيّرت فيه قيمة كتم الصوت. تنطبق قيمة كتم الصوت المعدَّلة على جميع الأجهزة التي تستخدم هذا النوع من البث.

StreamType

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

التعداد

"INPUT":

"OUTPUT"

الطُرق

getDevices()

وعد 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

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

المَعلمات

  • filter

    DeviceFilter اختياري

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

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (devices: AudioDeviceInfo[])=>void

المرتجعات

  • Promise<AudioDeviceInfo[]>

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

    تتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.

getMute()

وعد 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

يؤدي هذا الخيار إلى كتم الصوت على مستوى النظام لنوع البث المحدّد.

المَعلمات

  • streamType

    StreamType

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

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (value: boolean)=>void

    • القيمة

      boolean

المرتجعات

  • Promise<boolean>

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

    تتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.

setActiveDevices()

وعد 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

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

المَعلمات

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

    من الخطأ تمرير رقم تعريف جهاز غير موجود.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

    تتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.

setMute()

وعد 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

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

المَعلمات

  • streamType

    StreamType

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

  • isMuted

    boolean

    قيمة تجاهل جديدة.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

    تتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.

setProperties()

وعد 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

يضبط خصائص جهاز الإدخال أو الإخراج.

المَعلمات

  • id

    سلسلة

  • المواقع

    DeviceProperties

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

    تتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.

فعاليات

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,
)

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

المَعلمات

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

    (event: MuteChangedEvent)=>void