хром.аудио

Описание

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

Разрешения

audio

Доступность

Только Chrome OS 59+

Типы

AudioDeviceInfo

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

  • Имя_устройства

    нить

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

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

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

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

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

    нить

    Удобное для пользователя название (например, «USB-микрофон»).

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

    нить

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

  • isActive

    булев

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

  • уровень

    число

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

  • stableDeviceId

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

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

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

DeviceFilter

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

  • isActive

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

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

  • streamTypes

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

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

DeviceIdLists

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

  • вход

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

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

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

  • выход

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

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

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

DeviceProperties

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

  • уровень

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

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

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

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

DeviceType

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

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

"НАУШНИКИ"

"МИК"

"USB"

"BLUETOOTH"

"HDMI"

"ВНУТРЕННИЙ_ДИНАМИК"

"INTERNAL_MIC"

"FRONT_MIC"

"ЗАДНИЙ_МИКРОФОН"

"KEYBOARD_MIC"

"HOTWORD"

"ЛИНЕЙНЫЙ АВАН"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"ДРУГОЙ"

LevelChangedEvent

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

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

    нить

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

  • уровень

    число

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

MuteChangedEvent

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

  • isMuted

    булев

    Отключен ли сейчас звук трансляции.

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

StreamType

Тип потока, предоставляемый аудиоустройством.

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

"ВХОД"

"ВЫХОД"

Методы

getDevices()

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

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

Параметры

  • фильтр

    DeviceFilter (необязательно)

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

Возврат

getMute()

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

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

Параметры

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

Возврат

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

    Хром 116+

setActiveDevices()

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

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

Параметры

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

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

Возврат

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

    Хром 116+

setMute()

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

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

Параметры

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

  • isMuted

    булев

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

Возврат

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

    Хром 116+

setProperties()

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

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

Параметры

Возврат

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

    Хром 116+

События

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

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

Параметры