hs.audiodevice
Управление аудиоустройствами системы
Этот модуль в основном основан на коде предыдущей версии Mjolnir от Steven Degutis.
Подмодули
Обзор API
- Функции - API-вызовы, предлагаемые непосредственно расширением
- allDevices
- allInputDevices
- allOutputDevices
- current
- defaultEffectDevice
- defaultInputDevice
- defaultOutputDevice
- findDeviceByName
- findDeviceByUID
- findInputByName
- findInputByUID
- findOutputByName
- findOutputByUID
- Методы - API-вызовы, которые можно выполнить только на объекте, возвращаемом конструктором
- allInputDataSources
- allOutputDataSources
- balance
- currentInputDataSource
- currentOutputDataSource
- inputMuted
- inputVolume
- inUse
- isInputDevice
- isOutputDevice
- jackConnected
- muted
- name
- outputMuted
- outputVolume
- setBalance
- setDefaultEffectDevice
- setDefaultInputDevice
- setDefaultOutputDevice
- setInputMuted
- setInputVolume
- setMuted
- setOutputMuted
- setOutputVolume
- setVolume
- supportsInputDataSources
- supportsOutputDataSources
- transportType
- uid
- volume
- watcherCallback
- watcherIsRunning
- watcherStart
- watcherStop
Документация API
Функции
allDevices
| Подпись | hs.audiodevice.allDevices() -> hs.audiodevice[] |
|---|---|
| Тип | Функция |
| Описание |
Возвращает список всех подключенных устройств |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 173 |
allInputDevices
| Подпись | hs.audiodevice.allInputDevices() -> audio[] |
|---|---|
| Тип | Функция |
| Описание |
Возвращает список всех подключенных устройств ввода. |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/audiodevice.lua строка 141 |
allOutputDevices
| Подпись | hs.audiodevice.allOutputDevices() -> hs.audiodevice[] |
|---|---|
| Тип | Функция |
| Описание |
Возвращает список всех подключенных устройств вывода звука. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/audiodevice.lua строка 128 |
current
| Подпись | hs.audiodevice.current([input]) -> table |
|---|---|
| Тип | Функция |
| Описание |
Получение различных метаданных о текущих устройствах аудио по умолчанию. |
| Параметры |
|
| Возвращаемое значение |
{
name = defaultOutputDevice():name(),
uid = module.defaultOutputDevice():uid(),
muted = defaultOutputDevice():muted(),
volume = defaultOutputDevice():volume(),
device = defaultOutputDevice(),
}
|
| Источник | extensions/audiodevice/audiodevice.lua строка 15 |
defaultEffectDevice
| Подпись | hs.audiodevice.defaultEffectDevice() -> audio or nil |
|---|---|
| Тип | Функция |
| Описание |
Получение текущего выбранного устройства обработки звука. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 315 |
defaultInputDevice
| Подпись | hs.audiodevice.defaultInputDevice() -> audio or nil |
|---|---|
| Тип | Функция |
| Описание |
Получение текущего выбранного устройства аудиоввода. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 284 |
defaultOutputDevice
| Подпись | hs.audiodevice.defaultOutputDevice() -> audio or nil |
|---|---|
| Тип | Функция |
| Описание |
Получение текущего выбранного устройства аудиовывода. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 253 |
findDeviceByName
| Подпись | hs.audiodevice.findDeviceByName(name) -> device or nil |
|---|---|
| Тип | Функция |
| Описание |
Поиск устройства аудио по имени. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/audiodevice.lua строка 50 |
findDeviceByUID
| Подпись | hs.audiodevice.findDeviceByUID(uid) -> device or nil |
|---|---|
| Тип | Функция |
| Описание |
Поиск устройства аудио по UID. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/audiodevice.lua строка 63 |
findInputByName
| Подпись | hs.audiodevice.findInputByName(name) -> device or nil |
|---|---|
| Тип | Функция |
| Описание |
Поиск устройства аудиоввода по имени. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/audiodevice.lua строка 89 |
findInputByUID
| Подпись | hs.audiodevice.findInputByUID(uid) -> device or nil |
|---|---|
| Тип | Функция |
| Описание |
Поиск устройства аудиоввода по UID. |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/audiodevice/audiodevice.lua строка 115 |
findOutputByName
| Signature | hs.audiodevice.findOutputByName(name) -> device or nil |
|---|---|
| Type | Function |
| Description |
Найти устройство аудиовывода по имени |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/audiodevice.lua строка 76 |
findOutputByUID
| Signature | hs.audiodevice.findOutputByUID(uid) -> device or nil |
|---|---|
| Type | Function |
| Description |
Найти устройство аудиовывода по UID |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/audiodevice.lua строка 102 |
Methods
allInputDataSources
| Signature | hs.audiodevice:allInputDataSources() -> hs.audiodevice.dataSource[] or nil |
|---|---|
| Type | Method |
| Description |
Получить все источники входных данных устройства аудио |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1499 |
allOutputDataSources
| Signature | hs.audiodevice:allOutputDataSources() -> hs.audiodevice.dataSource[] or nil |
|---|---|
| Type | Method |
| Description |
Получить все источники выходных данных устройства аудио |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1446 |
balance
| Signature | hs.audiodevice:balance() -> number or nil |
|---|---|
| Type | Method |
| Description |
Получить текущий баланс левого/правого канала этого устройства аудио |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1067 |
currentInputDataSource
| Signature | hs.audiodevice:currentInputDataSource() -> hs.audiodevice.dataSource object or nil |
|---|---|
| Type | Method |
| Description |
Получить текущий источник входных данных устройства аудио |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1372 |
currentOutputDataSource
| Signature | hs.audiodevice:currentOutputDataSource() -> hs.audiodevice.dataSource object or nil |
|---|---|
| Type | Method |
| Description |
Получить текущий источник выходных данных устройства аудио |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1409 |
inputMuted
| Signature | hs.audiodevice:inputMuted() -> bool or nil |
|---|---|
| Type | Method |
| Description |
Получить состояние приглушения входного канала устройства аудио |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 563 |
inputVolume
| Signature | hs.audiodevice:inputVolume() -> number or nil |
|---|---|
| Type | Method |
| Description |
Получить текущий объём ввода этого устройства аудио |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 794 |
inUse
| Signature | hs.audiodevice:inUse() -> bool or nil |
|---|---|
| Type | Method |
| Description |
Проверить, используется ли устройство аудио |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 521 |
isInputDevice
| Signature | hs.audiodevice:isInputDevice() -> boolean |
|---|---|
| Type | Method |
| Description |
Определить, является ли устройство аудио устройством ввода |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1185 |
isOutputDevice
| Signature | hs.audiodevice:isOutputDevice() -> boolean |
|---|---|
| Type | Method |
| Description |
Определить, является ли устройство аудио устройством вывода |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1165 |
jackConnected
| Signature | hs.audiodevice:jackConnected() -> boolean or nil |
|---|---|
| Type | Method |
| Description |
Определить, подключён ли аудиоразъём (например, наушники) к устройству аудио |
| Parameters |
|
| Returns |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 1284 |
muted
| Signature | hs.audiodevice:muted() -> bool or nil |
|---|---|
| Type | Method |
| Description |
Получить состояние приглушения устройства аудио |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/audiodevice/libaudiodevice.m строка 635 |
имя
| Подпись | hs.audiodevice:name() -> string or nil |
|---|---|
| Тип | Метод |
| Описание |
Получить имя аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 448 |
выходной звук выключен
| Подпись | hs.audiodevice:outputMuted() -> bool or nil |
|---|---|
| Тип | Метод |
| Описание |
Получить состояние отключения звука выхода аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 599 |
выходной громкость
| Подпись | hs.audiodevice:outputVolume() -> number or nil |
|---|---|
| Тип | Метод |
| Описание |
Получить текущую громкость вывода этого аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 835 |
установить баланс
| Подпись | hs.audiodevice:setBalance(level) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить баланс этого аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1112 |
установить устройство по умолчанию для эффектов
| Подпись | hs.audiodevice:setDefaultEffectDevice() -> bool |
|---|---|
| Тип | Метод |
| Описание |
Выбирает это устройство в качестве аудиоустройства вывода для системных звуковых эффектов |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 382 |
установить устройство ввода по умолчанию
| Подпись | hs.audiodevice:setDefaultInputDevice() -> bool |
|---|---|
| Тип | Метод |
| Описание |
Выбирает это устройство в качестве устройства аудиоввода системы |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 415 |
установить устройство вывода по умолчанию
| Подпись | hs.audiodevice:setDefaultOutputDevice() -> bool |
|---|---|
| Тип | Метод |
| Описание |
Выбирает это устройство в качестве устройства аудиовывода системы |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 349 |
выключить звук ввода
| Подпись | hs.audiodevice:setInputMuted(state) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить состояние отключения звука входа аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 678 |
установить громкость ввода
| Подпись | hs.audiodevice:setInputVolume(level) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить громкость ввода этого аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 921 |
отключить звук
| Подпись | hs.audiodevice:setMuted(state) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить состояние отключения звука аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 751 |
выключить выходной звук
| Подпись | hs.audiodevice:setOutputMuted(state) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить состояние отключения звука вывода аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 714 |
установить громкость вывода
| Подпись | hs.audiodevice:setOutputVolume(level) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить громкость вывода этого аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 967 |
установить громкость
| Подпись | hs.audiodevice:setVolume(level) -> bool |
|---|---|
| Тип | Метод |
| Описание |
Установить громкость этого аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1013 |
supportsInputDataSources
| Подпись | hs.audiodevice:supportsInputDataSources() -> boolean |
|---|---|
| Тип | Метод |
| Описание |
Определяет, поддерживает ли аудиоустройство источники входных данных |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1318 |
supportsOutputDataSources
| Подпись | hs.audiodevice:supportsOutputDataSources() -> boolean |
|---|---|
| Тип | Метод |
| Описание |
Определяет, поддерживает ли аудиоустройство источники выходных данных |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1345 |
transportType
| Подпись | hs.audiodevice:transportType() -> string |
|---|---|
| Тип | Метод |
| Описание |
Получает тип транспортного средства аудиоустройства по аппаратной части |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1205 |
uid
| Подпись | hs.audiodevice:uid() -> string or nil |
|---|---|
| Тип | Метод |
| Описание |
Получение уникального идентификатора аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 482 |
volume
| Подпись | hs.audiodevice:volume() -> number or nil |
|---|---|
| Тип | Метод |
| Описание |
Получение текущего уровня громкости этого аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 876 |
watcherCallback
| Подпись | hs.audiodevice:watcherCallback(fn) -> hs.audiodevice |
|---|---|
| Тип | Метод |
| Описание |
Установка или удаление функции обратного вызова для наблюдателя аудиоустройства |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1552 |
watcherIsRunning
| Подпись | hs.audiodevice:watcherIsRunning() -> boolean |
|---|---|
| Тип | Метод |
| Описание |
Получение статуса наблюдателя объекта |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1698 |
watcherStart
| Подпись | hs.audiodevice:watcherStart() -> hs.audiodevice or nil |
|---|---|
| Тип | Метод |
| Описание |
Запуск наблюдателя для объекта |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1608 |
watcherStop
| Подпись | hs.audiodevice:watcherStop() -> hs.audiodevice |
|---|---|
| Тип | Метод |
| Описание |
Остановка наблюдателя для объекта |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/audiodevice/libaudiodevice.m строка 1676 |
© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.audiodevice.html