хром.аудио

Описание

API chrome.audio позволяет пользователям получать информацию об аудиоустройствах, подключенных к системе, и управлять ими. В настоящее время этот API доступен только в режиме киоска для ChromeOS.

Разрешения

audio

Доступность

Chrome 59+ только для ChromeOS

Типы

AudioDeviceInfo

Характеристики

  • имя устройства

    нить

    Имя устройства.

  • тип устройства

    Тип устройства

    Тип устройства.

  • отображаемое имя

    нить

    Понятное имя (например, «USB-микрофон»).

  • идентификатор

    нить

    Уникальный идентификатор аудиоустройства.

  • isActive

    логическое значение

    True, если это текущее активное устройство.

  • уровень

    число

    Уровень звука устройства, громкость на выходе, усиление на входе.

  • стабильныйDeviceId

    строка необязательна

    Строка стабильного/сохраняемого идентификатора устройства, если она доступна.

  • тип потока

    Тип Стрима

    Тип потока, связанный с этим устройством.

DeviceFilter

Характеристики

  • isActive

    логическое значение необязательно

    Если этот параметр установлен, фильтру будут удовлетворять только аудиоустройства, активное состояние которых соответствует этому значению.

  • типы потоков

    StreamType [] необязательно

    Если этот параметр установлен, фильтру будут удовлетворять только аудиоустройства, тип потока которых включен в этот список.

DeviceIdLists

Характеристики

  • вход

    строка[] необязательно

    Список устройств ввода, указанных по их идентификатору.

    Чтобы указать, что устройства ввода не должны быть затронуты, оставьте это свойство незаданным.

  • выход

    строка[] необязательно

    Список устройств вывода, указанных по их идентификатору.

    Чтобы указать, что устройства вывода не должны быть затронуты, оставьте это свойство незаданным.

DeviceProperties

Характеристики

  • уровень

    номер необязательно

    Желаемый уровень звука аудиоустройства. По умолчанию используется текущий уровень звука устройства.

    При использовании с устройством аудиовхода представляет усиление аудиоустройства.

    При использовании с устройством вывода звука обозначает громкость аудиоустройства.

DeviceType

Доступные типы аудиоустройств.

Перечисление

"НАУШНИКИ"

"МИК"

"USB"

"BLUETOOTH"

"HDMI"

"ВНУТРЕННИЙ_СПИКЕР"

"ВНУТРЕННИЙ_МИКРОФОН"

"FRONT_MIC"

"REAR_MIC"

"КЛАВИАТУРА_МИКРОФОН"

"ХОТВОРД"

"ЛИНЕаут"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"ДРУГОЙ"

LevelChangedEvent

Характеристики

  • идентификатор устройства

    нить

    Идентификатор устройства, у которого изменился уровень звука.

  • уровень

    число

    Новый уровень звука устройства.

MuteChangedEvent

Характеристики

  • isMuted

    логическое значение

    Независимо от того, отключен ли поток сейчас.

  • тип потока

    Тип Стрима

    Тип потока, для которого изменилось значение отключения звука. Обновленное значение отключения звука применяется ко всем устройствам с этим типом потока.

StreamType

Тип потока, который обеспечивает аудиоустройство.

Перечисление

"ВХОД"

"ВЫХОД"

Методы

getDevices()

Обещать
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

Получает список аудиоустройств, отфильтрованных на основе filter .

Параметры

  • фильтр

    Фильтр устройств необязательно

    Свойства устройства, по которым можно фильтровать список возвращаемых аудиоустройств. Если фильтр не установлен или установлен на {} , возвращаемый список устройств будет содержать все доступные аудиоустройства.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (devices: AudioDeviceInfo[]) => void

Возврат

  • Обещание < AudioDeviceInfo []>

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

getMute()

Обещать
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

Получает общесистемное состояние отключения звука для указанного типа потока.

Параметры

  • тип потока

    Тип Стрима

    Тип потока, для которого необходимо получить состояние отключения звука.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (value: boolean) => void

    • ценить

      логическое значение

Возврат

  • Обещание <логическое значение>

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

setActiveDevices()

Обещать
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

Устанавливает списки активных устройств ввода и/или вывода.

Параметры

  • Указывает идентификаторы устройств, которые должны быть активными. Если список входов или выходов не установлен, устройства в этой категории не затрагиваются.

    Передача несуществующего идентификатора устройства является ошибкой.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    () => void

Возврат

  • Обещание<void>

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

setMute()

Обещать
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

Устанавливает состояние отключения звука для типа потока. Состояние отключения звука будет применяться ко всем аудиоустройствам с указанным типом аудиопотока.

Параметры

  • тип потока

    Тип Стрима

    Тип потока, для которого должно быть установлено состояние отключения звука.

  • isMuted

    логическое значение

    Новое значение отключения звука.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    () => void

Возврат

  • Обещание<void>

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

setProperties()

Обещать
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

Устанавливает свойства устройства ввода или вывода.

Параметры

  • идентификатор

    нить

  • характеристики

    Свойства устройства

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    () => void

Возврат

  • Обещание<void>

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

События

onDeviceListChanged

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

Запускается при изменении аудиоустройств: добавлении новых устройств или удалении существующих устройств.

Параметры

onLevelChanged

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

Срабатывает при изменении уровня звука для активного аудиоустройства.

Параметры

onMuteChanged

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

Срабатывает, когда изменяется состояние отключения звука аудиовхода или выхода. Обратите внимание, что состояние отключения звука является общесистемным, и новое значение применяется к каждому аудиоустройству с указанным типом потока.

Параметры