Spec-Zone.ru › Hammerspoon

hs.audiodevice

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

Этот модуль в основном основан на коде предыдущей версии Mjolnir от Steven Degutis.

Подмодули

  • hs.audiodevice.datasource
  • hs.audiodevice.watcher

Обзор 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[]
Тип Функция
Описание

Возвращает список всех подключенных устройств

Параметры
  • None
Возвращает
  • Таблица нуля или более аудиоустройств, подключенных к системе
Источник extensions/audiodevice/libaudiodevice.m строка 173
allInputDevices
Подпись hs.audiodevice.allInputDevices() -> audio[]
Тип Функция
Описание

Возвращает список всех подключенных устройств ввода.

Параметры
  • None
Возвращает
  • Таблица нуля или более аудиоустройств ввода, подключенных к системе
Источник extensions/audiodevice/audiodevice.lua строка 141
allOutputDevices
Подпись hs.audiodevice.allOutputDevices() -> hs.audiodevice[]
Тип Функция
Описание

Возвращает список всех подключенных устройств вывода звука.

Параметры
  • Нет
Возвращаемое значение
  • Таблица нуля или более устройств аудиовывода, подключенных к системе.
Источник extensions/audiodevice/audiodevice.lua строка 128
current
Подпись hs.audiodevice.current([input]) -> table
Тип Функция
Описание

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

Параметры
  • output - Необязательный булевый параметр, true для получения информации о устройстве ввода по умолчанию, false для устройства вывода. По умолчанию false.
Возвращаемое значение
  • Таблица со следующим содержимым:
{
        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
Тип Функция
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.audiodevice или nil, если подходящее устройство не найдено
Источник extensions/audiodevice/libaudiodevice.m строка 315
defaultInputDevice
Подпись hs.audiodevice.defaultInputDevice() -> audio or nil
Тип Функция
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.audiodevice или nil, если подходящее устройство не найдено
Источник extensions/audiodevice/libaudiodevice.m строка 284
defaultOutputDevice
Подпись hs.audiodevice.defaultOutputDevice() -> audio or nil
Тип Функция
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.audiodevice или nil, если подходящее устройство не найдено
Источник extensions/audiodevice/libaudiodevice.m строка 253
findDeviceByName
Подпись hs.audiodevice.findDeviceByName(name) -> device or nil
Тип Функция
Описание

Поиск устройства аудио по имени.

Параметры
  • name - Строка, содержащая имя устройства аудио для поиска
Возвращаемое значение
  • Объект hs.audiodevice или nil, если устройство не найдено
Источник extensions/audiodevice/audiodevice.lua строка 50
findDeviceByUID
Подпись hs.audiodevice.findDeviceByUID(uid) -> device or nil
Тип Функция
Описание

Поиск устройства аудио по UID.

Параметры
  • uid - Строка, содержащая UID устройства аудио для поиска
Возвращаемое значение
  • Объект hs.audiodevice или nil, если устройство не найдено
Источник extensions/audiodevice/audiodevice.lua строка 63
findInputByName
Подпись hs.audiodevice.findInputByName(name) -> device or nil
Тип Функция
Описание

Поиск устройства аудиоввода по имени.

Параметры
  • name - Строка, содержащая имя устройства аудиоввода для поиска
Возвращаемое значение
  • Объект hs.audiodevice или nil, если устройство не найдено
Источник extensions/audiodevice/audiodevice.lua строка 89
findInputByUID
Подпись hs.audiodevice.findInputByUID(uid) -> device or nil
Тип Функция
Описание

Поиск устройства аудиоввода по UID.

Параметры
  • name - Строка, содержащая UID устройства аудиоввода для поиска
Возвращаемое значение
  • Объект hs.audiodevice или nil, если устройство не найдено
Источник extensions/audiodevice/audiodevice.lua строка 115
END_OF_DOCUMENT_MARKER
findOutputByName
Signature hs.audiodevice.findOutputByName(name) -> device or nil
Type Function
Description

Найти устройство аудиовывода по имени

Parameters
  • name - Строка, содержащая имя устройства аудиовывода для поиска
Returns
  • Объект hs.audiodevice или nil, если устройство не найдено
Source extensions/audiodevice/audiodevice.lua строка 76
findOutputByUID
Signature hs.audiodevice.findOutputByUID(uid) -> device or nil
Type Function
Description

Найти устройство аудиовывода по UID

Parameters
  • name - Строка, содержащая UID устройства аудиовывода для поиска
Returns
  • Объект hs.audiodevice или nil, если устройство не найдено
Source extensions/audiodevice/audiodevice.lua строка 102

Methods

allInputDataSources
Signature hs.audiodevice:allInputDataSources() -> hs.audiodevice.dataSource[] or nil
Type Method
Description

Получить все источники входных данных устройства аудио

Parameters
  • None
Returns
  • Список объектов hs.audiodevice.dataSource или nil, если произошла ошибка
Source extensions/audiodevice/libaudiodevice.m строка 1499
allOutputDataSources
Signature hs.audiodevice:allOutputDataSources() -> hs.audiodevice.dataSource[] or nil
Type Method
Description

Получить все источники выходных данных устройства аудио

Parameters
  • None
Returns
  • Список объектов hs.audiodevice.dataSource или nil, если произошла ошибка
Source extensions/audiodevice/libaudiodevice.m строка 1446
balance
Signature hs.audiodevice:balance() -> number or nil
Type Method
Description

Получить текущий баланс левого/правого канала этого устройства аудио

Parameters
  • None
Returns
  • Число от 0.0 до 1.0, представляющее баланс (0.0 — полностью слева, 1.0 — полностью справа, 0.5 — по центру), или nil, если устройство аудио не поддерживает баланс
Notes
  • Значение возврата будет числом с плавающей точкой
  • Этот метод проверит устройство, чтобы определить, является ли оно устройством ввода или вывода, и вернёт соответствующий объём. Для устройств, которые являются устройствами как ввода, так и вывода, см. :inputVolume() и :outputVolume().
Source extensions/audiodevice/libaudiodevice.m строка 1067
currentInputDataSource
Signature hs.audiodevice:currentInputDataSource() -> hs.audiodevice.dataSource object or nil
Type Method
Description

Получить текущий источник входных данных устройства аудио

Parameters
  • None
Returns
  • Объект hs.audiodevice.dataSource или nil, если произошла ошибка
Notes
  • Перед вызовом этого метода необходимо проверить результат hs.audiodevice:supportsInputDataSources()
Source extensions/audiodevice/libaudiodevice.m строка 1372
currentOutputDataSource
Signature hs.audiodevice:currentOutputDataSource() -> hs.audiodevice.dataSource object or nil
Type Method
Description

Получить текущий источник выходных данных устройства аудио

Parameters
  • None
Returns
  • Объект hs.audiodevice.dataSource или nil, если произошла ошибка
Notes
  • Перед вызовом этого метода необходимо проверить результат hs.audiodevice:supportsOutputDataSources()
Source extensions/audiodevice/libaudiodevice.m строка 1409
inputMuted
Signature hs.audiodevice:inputMuted() -> bool or nil
Type Method
Description

Получить состояние приглушения входного канала устройства аудио

Parameters
  • None
Returns
  • True, если входной канал устройства аудио приглушен. False, если не приглушен. nil, если приглушение не поддерживается
Source extensions/audiodevice/libaudiodevice.m строка 563
inputVolume
Signature hs.audiodevice:inputVolume() -> number or nil
Type Method
Description

Получить текущий объём ввода этого устройства аудио

Parameters
  • None
Returns
  • Число от 0 до 100, представляющее процент объёма ввода, или nil, если устройство аудио не поддерживает уровни объёма ввода
Notes
  • Значение возврата будет числом с плавающей точкой
Source extensions/audiodevice/libaudiodevice.m строка 794
inUse
Signature hs.audiodevice:inUse() -> bool or nil
Type Method
Description

Проверить, используется ли устройство аудио

Parameters
  • None
Returns
  • True, если устройство аудио используется, False, если нет. nil, если произошла ошибка.
Source extensions/audiodevice/libaudiodevice.m строка 521
isInputDevice
Signature hs.audiodevice:isInputDevice() -> boolean
Type Method
Description

Определить, является ли устройство аудио устройством ввода

Parameters
  • None
Returns
  • Булево значение, true, если устройство является устройством ввода, false, если нет
Source extensions/audiodevice/libaudiodevice.m строка 1185
isOutputDevice
Signature hs.audiodevice:isOutputDevice() -> boolean
Type Method
Description

Определить, является ли устройство аудио устройством вывода

Parameters
  • None
Returns
  • Булево значение, true, если устройство является устройством вывода, false, если нет
Source extensions/audiodevice/libaudiodevice.m строка 1165
jackConnected
Signature hs.audiodevice:jackConnected() -> boolean or nil
Type Method
Description

Определить, подключён ли аудиоразъём (например, наушники) к устройству аудио

Parameters
  • None
Returns
  • Булево значение, true, если разъём подключён, false, если нет, или nil, если устройство не поддерживает определение состояния разъёма
Source extensions/audiodevice/libaudiodevice.m строка 1284
muted
Signature hs.audiodevice:muted() -> bool or nil
Type Method
Description

Получить состояние приглушения устройства аудио

Parameters
  • None
Returns
  • True, если устройство аудио приглушено, False, если нет, nil, если приглушение не поддерживается
Notes
  • Если устройство способно к вводу и выводу, этот метод отдаёт предпочтение выводу. См. :inputMuted() и :outputMuted() для специфических вариантов.
Source extensions/audiodevice/libaudiodevice.m строка 635
END_OF_DOCUMENT_MARKER
имя
Подпись hs.audiodevice:name() -> string or nil
Тип Метод
Описание

Получить имя аудиоустройства

Параметры
  • Ничего
Возвращает
  • Строка, содержащая имя аудиоустройства, или nil, если у него нет имени
Источник extensions/audiodevice/libaudiodevice.m строка 448
выходной звук выключен
Подпись hs.audiodevice:outputMuted() -> bool or nil
Тип Метод
Описание

Получить состояние отключения звука выхода аудиоустройства

Параметры
  • Ничего
Возвращает
  • True, если выходной звук аудиоустройства выключен. False, если звук включен, nil, если функция отключения звука не поддерживается.
Источник extensions/audiodevice/libaudiodevice.m строка 599
выходной громкость
Подпись hs.audiodevice:outputVolume() -> number or nil
Тип Метод
Описание

Получить текущую громкость вывода этого аудиоустройства

Параметры
  • Ничего
Возвращает
  • Число от 0 до 100, представляющее процент громкости вывода, или nil, если аудиоустройство не поддерживает уровни громкости вывода
Примечания
  • Значение возврата будет числом с плавающей точкой
Источник extensions/audiodevice/libaudiodevice.m строка 835
установить баланс
Подпись hs.audiodevice:setBalance(level) -> bool
Тип Метод
Описание

Установить баланс этого аудиоустройства

Параметры
  • level - Число от 0.0 до 1.0, представляющее баланс (0.0 для полного левого канала, 1.0 для полного правого, 0.5 для центра)
Возвращает
  • True, если баланс был установлен, False, если аудиоустройство не поддерживает установку баланса.
Примечания
  • Этот метод проверит устройство, чтобы определить, является ли оно устройством ввода или вывода, и установит соответствующую громкость. Для устройств, которые являются одновременно устройствами ввода и вывода, см. :setInputVolume() и :setOutputVolume()
Источник extensions/audiodevice/libaudiodevice.m строка 1112
установить устройство по умолчанию для эффектов
Подпись hs.audiodevice:setDefaultEffectDevice() -> bool
Тип Метод
Описание

Выбирает это устройство в качестве аудиоустройства вывода для системных звуковых эффектов

Параметры
  • Ничего
Возвращает
  • True, если аудиоустройство было успешно выбрано, в противном случае False.
Источник extensions/audiodevice/libaudiodevice.m строка 382
установить устройство ввода по умолчанию
Подпись hs.audiodevice:setDefaultInputDevice() -> bool
Тип Метод
Описание

Выбирает это устройство в качестве устройства аудиоввода системы

Параметры
  • Ничего
Возвращает
  • True, если аудиоустройство было успешно выбрано, в противном случае False.
Источник extensions/audiodevice/libaudiodevice.m строка 415
установить устройство вывода по умолчанию
Подпись hs.audiodevice:setDefaultOutputDevice() -> bool
Тип Метод
Описание

Выбирает это устройство в качестве устройства аудиовывода системы

Параметры
  • Ничего
Возвращает
  • True, если аудиоустройство было успешно выбрано, в противном случае False.
Источник extensions/audiodevice/libaudiodevice.m строка 349
выключить звук ввода
Подпись hs.audiodevice:setInputMuted(state) -> bool
Тип Метод
Описание

Установить состояние отключения звука входа аудиоустройства

Параметры
  • state - Булево значение. True для отключения звука, False для включения
Возвращает
  • True, если состояние отключения звука входа устройства было установлено, или False, если функция отключения звука не поддерживается.
Источник extensions/audiodevice/libaudiodevice.m строка 678
установить громкость ввода
Подпись hs.audiodevice:setInputVolume(level) -> bool
Тип Метод
Описание

Установить громкость ввода этого аудиоустройства

Параметры
  • level - Число от 0 до 100, представляющее громкость ввода в процентах
Возвращает
  • True, если громкость была установлена, False, если аудиоустройство не поддерживает установку уровня громкости ввода
Примечания
  • Уровень громкости — число с плавающей точкой. В зависимости от вашего аудиооборудования, может быть невозможно увеличить громкость с однозначными приращениями.
Источник extensions/audiodevice/libaudiodevice.m строка 921
отключить звук
Подпись hs.audiodevice:setMuted(state) -> bool
Тип Метод
Описание

Установить состояние отключения звука аудиоустройства

Параметры
  • state - Булево значение. True для отключения звука, False для включения
Возвращает
  • True, если состояние отключения звука устройства было установлено, или False, если функция отключения звука не поддерживается.
Примечания
  • Если устройство способно к вводу и выводу, этот метод отдаст предпочтение выводу. См. :setInputMuted() и :setOutputMuted() для конкретных вариантов.
Источник extensions/audiodevice/libaudiodevice.m строка 751
выключить выходной звук
Подпись hs.audiodevice:setOutputMuted(state) -> bool
Тип Метод
Описание

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

Параметры
  • state - Булево значение. True для отключения звука, False для включения
Возвращает
  • True, если состояние отключения звука вывода устройства было установлено, или False, если функция отключения звука не поддерживается.
Источник extensions/audiodevice/libaudiodevice.m строка 714
установить громкость вывода
Подпись hs.audiodevice:setOutputVolume(level) -> bool
Тип Метод
Описание

Установить громкость вывода этого аудиоустройства

Параметры
  • level - Число от 0 до 100, представляющее громкость вывода в процентах
Возвращает
  • True, если громкость была установлена, False, если аудиоустройство не поддерживает установку уровня громкости вывода
Примечания
  • Уровень громкости — число с плавающей точкой. В зависимости от вашего аудиооборудования, может быть невозможно увеличить громкость с однозначными приращениями.
Источник extensions/audiodevice/libaudiodevice.m строка 967
установить громкость
Подпись hs.audiodevice:setVolume(level) -> bool
Тип Метод
Описание

Установить громкость этого аудиоустройства

Параметры
  • level - Число от 0 до 100, представляющее громкость в процентах
Возвращает
  • True, если громкость была установлена, False, если аудиоустройство не поддерживает установку уровня громкости.
Примечания
  • Уровень громкости — число с плавающей точкой. В зависимости от вашего аудиооборудования, может быть невозможно увеличить громкость с однозначными приращениями.
  • Этот метод проверит устройство, чтобы определить, является ли оно устройством ввода или вывода, и установит соответствующую громкость. Для устройств, которые являются одновременно устройствами ввода и вывода, см. :setInputVolume() и :setOutputVolume()
Источник extensions/audiodevice/libaudiodevice.m строка 1013
END_OF_DOCUMENT_MARKER
supportsInputDataSources
Подпись hs.audiodevice:supportsInputDataSources() -> boolean
Тип Метод
Описание

Определяет, поддерживает ли аудиоустройство источники входных данных

Параметры
  • Ничего
Возвращает
  • Булево значение, true, если устройство поддерживает источники входных данных, false — если нет
Источник extensions/audiodevice/libaudiodevice.m строка 1318
supportsOutputDataSources
Подпись hs.audiodevice:supportsOutputDataSources() -> boolean
Тип Метод
Описание

Определяет, поддерживает ли аудиоустройство источники выходных данных

Параметры
  • Ничего
Возвращает
  • Булево значение, true, если устройство поддерживает источники выходных данных, false — если нет
Источник extensions/audiodevice/libaudiodevice.m строка 1345
transportType
Подпись hs.audiodevice:transportType() -> string
Тип Метод
Описание

Получает тип транспортного средства аудиоустройства по аппаратной части

Параметры
  • Ничего
Возвращает
  • Строка, содержащая тип транспорта, или nil в случае ошибки
Источник extensions/audiodevice/libaudiodevice.m строка 1205
uid
Подпись hs.audiodevice:uid() -> string or nil
Тип Метод
Описание

Получение уникального идентификатора аудиоустройства

Параметры
  • Ничего
Возвращает
  • Строка, содержащая UID аудиоустройства, или nil, если UID отсутствует.
Источник extensions/audiodevice/libaudiodevice.m строка 482
volume
Подпись hs.audiodevice:volume() -> number or nil
Тип Метод
Описание

Получение текущего уровня громкости этого аудиоустройства

Параметры
  • Ничего
Возвращает
  • Число от 0 до 100, представляющее процент громкости, или nil, если аудиоустройство не поддерживает уровни громкости
Примечания
  • Значение возврата будет числом с плавающей запятой
  • Этот метод проверит устройство, чтобы определить, является ли оно устройством ввода или вывода, и вернёт соответствующий уровень громкости. Для устройств, являющихся как устройствами ввода, так и вывода, см. :inputVolume() и :outputVolume()
Источник extensions/audiodevice/libaudiodevice.m строка 876
watcherCallback
Подпись hs.audiodevice:watcherCallback(fn) -> hs.audiodevice
Тип Метод
Описание

Установка или удаление функции обратного вызова для наблюдателя аудиоустройства

Параметры
  • fn — функция обратного вызова, которая будет вызываться при изменении свойств этого аудиоустройства, или nil для удаления существующего обратного вызова. Функция должна принимать четыре аргумента:
    • Строка, содержащая UID аудиоустройства (см. hs.audiodevice.findDeviceByUID())
    • Строка, содержащая имя события. Возможные значения:
    • vmvc — громкость изменилась
    • mute — изменилось состояние отключения
    • jack — изменилось состояние подключения джека (как правило, это означает, что наушники подключены/отключены)
    • span — изменилась стереопанорама
    • diff — изменилась конфигурация устройства (если вы кэшируете свойства аудиоустройства, это событие означает, что вы должны очистить кэш)
    • gone — изменилось состояние «используется» устройства (например, другое приложение начало использовать устройство или перестало использовать его)
    • Строка, содержащая область действия события. Возможные значения:
    • glob — это глобальное событие, относящееся ко всему устройству
    • inpt — это событие, относящееся только к функциям ввода устройства
    • outp — это событие, относящееся только к функциям вывода устройства
    • Число, содержащее элемент события. Типичные значения:
    • 0 — обычно означает главный канал
    • 1 — обычно означает левый канал
    • 2 — обычно означает правый канал
Возвращает
  • Объект hs.audiodevice
Примечания
  • Вы получите много событий в своём обратном вызове, поэтому фильтрация по аргументам name/scope/element имеет решающее значение. Например, на стереоустройстве нередко возникает событие volm для каждого аудиоканала при изменении громкости или несколько событий mute для каналов. Перетаскивание ползунка громкости в системных настройках звука приведет к большому количеству событий volm. Подключение/отключение наушников может привести к событиям volm в дополнение к событиям jack и т.д.
  • Если вам нужно использовать объект hs.audiodevice в вашем обратном вызове, используйте hs.audiodevice.findDeviceByUID() для получения его из первого аргумента обратного вызова.
Источник extensions/audiodevice/libaudiodevice.m строка 1552
watcherIsRunning
Подпись hs.audiodevice:watcherIsRunning() -> boolean
Тип Метод
Описание

Получение статуса наблюдателя объекта hs.audiodevice

Параметры
  • Ничего
Возвращает
  • Булево значение, true, если наблюдатель работает, false — если нет
Источник extensions/audiodevice/libaudiodevice.m строка 1698
watcherStart
Подпись hs.audiodevice:watcherStart() -> hs.audiodevice or nil
Тип Метод
Описание

Запуск наблюдателя для объекта hs.audiodevice

Параметры
  • Ничего
Возвращает
  • Объект hs.audiodevice, или nil в случае ошибки
Источник extensions/audiodevice/libaudiodevice.m строка 1608
watcherStop
Подпись hs.audiodevice:watcherStop() -> hs.audiodevice
Тип Метод
Описание

Остановка наблюдателя для объекта hs.audiodevice

Параметры
  • Ничего
Возвращает
  • Объект hs.audiodevice
Источник extensions/audiodevice/libaudiodevice.m строка 1676

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.audiodevice.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API