Описание
API chrome.audio предназначен для получения пользователями информации об аудиоустройствах, подключенных к системе, и управления ими. В настоящее время этот API доступен только в режиме киоска для ChromeOS.
Разрешения
audioДоступность
Типы
AudioDeviceInfo
Характеристики
- deviceName
нить
Название устройства.
- тип устройства
Тип устройства.
- отображаемое имя
нить
Удобное для пользователя название (например, "USB-микрофон").
- идентификатор
нить
Уникальный идентификатор аудиоустройства.
- isActive
логический
Истина, если это текущее активное устройство.
- уровень
число
Уровень звука устройства, громкость выходного сигнала, усиление входного сигнала.
- stableDeviceId
строка необязательный
Если доступна строка идентификатора стабильного/постоянного устройства, она будет отображаться.
- streamType
Тип потока, связанный с этим устройством.
DeviceFilter
Характеристики
- isActive
логический необязательный
Если этот параметр задан, фильтр будет применяться только к аудиоустройствам, чье активное состояние соответствует этому значению.
- streamTypes
StreamType [] необязательный
Если этот параметр задан, фильтр будет применяться только к аудиоустройствам, тип потока которых включен в этот список.
DeviceIdLists
Характеристики
- вход
строка[] необязательный
Список устройств ввода, определяемых по их идентификатору.
Чтобы указать, что входные устройства не должны подвергаться воздействию, оставьте это свойство незаданным.
- выход
строка[] необязательный
Список выходных устройств, определяемых их идентификатором.
Чтобы указать, что выходные устройства не должны быть затронуты, оставьте это свойство незаданным.
DeviceProperties
Характеристики
- уровень
число необязательно
Желаемый уровень громкости аудиоустройства. По умолчанию используется текущий уровень громкости устройства.
При использовании с аудиовходным устройством обозначает коэффициент усиления аудиоустройства.
При использовании с устройством вывода звука отображает громкость аудиоустройства.
DeviceType
Доступные типы аудиоустройств.
Перечисление
"НАУШНИКИ" "МИК" "USB" "BLUETOOTH" «HDMI» "ВНУТРЕННИЙ_ДИНАМИК" "ВНУТРЕННИЙ_МИКРОФОН" "FRONT_MIC" "ЗАДНИЙ МИКРОФОН" "KEYBOARD_MIC" "ГОРЯЧЕЕ СЛОВО" "Лайнаут" "POST_MIX_LOOPBACK" "POST_DSP_LOOPBACK" "ALSA_LOOPBACK" "ДРУГОЙ"
LevelChangedEvent
Характеристики
- идентификатор устройства
нить
Идентификатор устройства, у которого изменился уровень звука.
- уровень
число
Новый уровень звука устройства.
MuteChangedEvent
Характеристики
- isMuted
логический
Независимо от того, отключен ли звук в трансляции.
- streamType
Тип потока, для которого изменилось значение отключения звука. Обновленное значение отключения звука применяется ко всем устройствам с этим типом потока.
StreamType
Тип потока, предоставляемого аудиоустройством.
Перечисление
"ВХОД" "ВЫХОД"
Методы
getDevices()
chrome.audio.getDevices(
filter?: DeviceFilter,
): Promise<AudioDeviceInfo[]>
Получает список аудиоустройств, отфильтрованных по заданному filter .
Параметры
- фильтр
DeviceFilter (необязательно)
Свойства устройства, по которым следует фильтровать список возвращаемых аудиоустройств. Если фильтр не задан или задан в виде
{}, возвращаемый список устройств будет содержать все доступные аудиоустройства.
Возвраты
Promise< AudioDeviceInfo []>
Chrome 116+Выводит запрошенный список аудиоустройств.
getMute()
chrome.audio.getMute(
streamType: StreamType,
): Promise<boolean>
Получает общесистемное состояние отключения звука для указанного типа потока.
Параметры
- streamType
Тип потока, для которого следует получить состояние отключения звука.
Возвраты
Promise<boolean>
Chrome 116+Обещание, которое завершается логическим значением, указывающим, установлен ли параметр отключения звука для указанного типа потока или нет.
setActiveDevices()
chrome.audio.setActiveDevices(
ids: DeviceIdLists,
): Promise<void>
Задает списки активных устройств ввода и/или вывода.
Параметры
- идентификаторы
Указывает идентификаторы устройств, которые должны быть активны. Если список входных или выходных устройств не задан, устройства в этой категории остаются без изменений.
Передача несуществующего идентификатора устройства является ошибкой.
Возвраты
Обещание<пустота>
Chrome 116+
setMute()
chrome.audio.setMute(
streamType: StreamType,
isMuted: boolean,
): Promise<void>
Задает состояние отключения звука для определенного типа аудиопотока. Это состояние будет применяться ко всем аудиоустройствам с указанным типом аудиопотока.
Параметры
- streamType
Тип потока, для которого следует установить состояние отключения звука.
- isMuted
логический
Новое значение отключения звука.
Возвраты
Обещание<пустота>
Chrome 116+
setProperties()
chrome.audio.setProperties(
id: string,
properties: DeviceProperties,
): Promise<void>
Задает свойства для входного или выходного устройства.
Параметры
- идентификатор
нить
- характеристики
Возвраты
Обещание<пустота>
Chrome 116+
События
onDeviceListChanged
chrome.audio.onDeviceListChanged.addListener(
callback: function,
)
Срабатывает при изменении типа аудиоустройств, будь то добавление новых устройств или удаление существующих.
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(devices: AudioDeviceInfo[]) => void
- устройства
onLevelChanged
chrome.audio.onLevelChanged.addListener(
callback: function,
)
Срабатывает при изменении уровня звука на активном аудиоустройстве.
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(event: LevelChangedEvent) => void
- событие
onMuteChanged
chrome.audio.onMuteChanged.addListener(
callback: function,
)
Событие срабатывает при изменении состояния отключения звука на аудиовходе или выходе. Обратите внимание, что состояние отключения звука является общесистемным, и новое значение применяется ко всем аудиоустройствам с указанным типом потока.
Параметры
- перезвонить
функция
Параметр
callbackвыглядит следующим образом:(event: MuteChangedEvent) => void
- событие