chrome.audio

الوصف

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

الأذونات

audio

مدى التوفّر

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

الأنواع

AudioDeviceInfo

أماكن إقامة

  • deviceName

    سلسلة

    اسم الجهاز

  • deviceType

    DeviceType

    نوع الجهاز

  • displayName

    سلسلة

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

  • id

    سلسلة

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

  • isActive

    منطقي

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

  • المستوى

    الرقم

    مستوى الصوت في الجهاز، مستوى صوت الناتج، مستوى الصوت عند الإدخال

  • stableDeviceId

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

    تشير هذه السمة إلى سلسلة رقم تعريف الجهاز الثابت أو الثابت عند توفُّرها.

  • streamType

    StreamType

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

DeviceFilter

أماكن إقامة

  • isActive

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

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

  • streamTypes

    StreamType[] اختيارية

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

DeviceIdLists

أماكن إقامة

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

    string[] اختيارية

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

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

  • output

    string[] اختيارية

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

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

DeviceProperties

أماكن إقامة

  • المستوى

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

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

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

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

DeviceType

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

Enum

"سماعة الرأس"

"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"

"المخرج"

الطُرق

getDevices()

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

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

المعلمات

  • تصفية

    DeviceFilter اختيارية

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

  • رد الاتصال

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

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

    (devices: AudioDeviceInfo[]) => void

المرتجعات

  • Promise<AudioDeviceInfo[]>

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

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

getMute()

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

الحصول على حالة كتم الصوت على مستوى النظام لنوع البث المحدّد

المعلمات

  • streamType

    StreamType

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

  • رد الاتصال

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

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

    (value: boolean) => void

    • القيمة

      منطقي

المرتجعات

  • Promise<boolean>

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

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

setActiveDevices()

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

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

المعلمات

  • أرقام التعريف

    DeviceIdLists

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

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

  • رد الاتصال

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

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

    () => void

المرتجعات

  • وعود <باطلة>

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

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

setMute()

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

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

المعلمات

  • streamType

    StreamType

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

  • isMuted

    منطقي

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

  • رد الاتصال

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

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

    () => void

المرتجعات

  • وعود <باطلة>

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

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

setProperties()

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

تحدِّد هذه السياسة خصائص جهاز الإدخال والإخراج.

المعلمات

  • id

    سلسلة

  • المواقع

    خصائص الجهاز

  • رد الاتصال

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

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

    () => void

المرتجعات

  • وعود <باطلة>

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

    تتوفّر الوعود في الإصدار 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,
)

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

المعلمات