hs.sound
Загрузка/воспроизведение/манипулирование звуковыми файлами
Обзор API
- Функции - API-вызовы, предлагаемые непосредственно расширением
- Конструкторы - API-вызовы, возвращающие объект, обычно с методами API
- Методы - API-вызовы, которые могут быть выполнены только над объектом, возвращённым конструктором
Документация API
Функции
getAudioEffectNames
| Подпись | hs.sound.getAudioEffectNames() -> table |
|---|---|
| Тип | Функция |
| Описание |
Получает таблицу имён установленных эффектов Audio Units. |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 62 |
soundFileTypes
| Подпись | hs.sound.soundFileTypes() -> table |
|---|---|
| Тип | Функция |
| Описание |
Получает поддерживаемые типы звуковых файлов |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 200 |
soundTypes
| Подпись | hs.sound.soundTypes() -> table |
|---|---|
| Тип | Функция |
| Описание |
Получает поддерживаемые форматы звуковых файлов UTI |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/sound/libsound.m строка 184 |
systemSounds
| Подпись | hs.sound.systemSounds() -> table |
|---|---|
| Тип | Функция |
| Описание |
Получает таблицу доступных системных звуков |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 150 |
Конструкторы
getByFile
| Подпись | hs.sound.getByFile(path) -> sound or nil |
|---|---|
| Тип | Конструктор |
| Описание |
Создаёт объект |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/sound/libsound.m строка 128 |
getByName
| Подпись | hs.sound.getByName(name) -> sound or nil |
|---|---|
| Тип | Конструктор |
| Описание |
Создаёт объект |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 103 |
Методы
currentTime
| Подпись | hs.sound:currentTime([seekTime]) -> soundObject | seconds |
|---|---|
| Тип | Метод |
| Описание |
Получение или установка текущего смещения поиска внутри объекта |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/sound/libsound.m строка 435 |
device
| Подпись | hs.sound:device([deviceUID]) -> soundObject | UID string |
|---|---|
| Тип | Метод |
| Описание |
Получение или установка устройства воспроизведения для объекта |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 400 |
duration
| Подпись | hs.sound:duration() -> seconds |
|---|---|
| Тип | Метод |
| Описание |
Получает длительность объекта |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/sound/libsound.m строка 457 |
isPlaying
| Подпись | hs.sound:isPlaying() -> bool |
|---|---|
| Тип | Метод |
| Описание |
Получает текущее состояние воспроизведения объекта |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/sound/libsound.m строка 496 |
loopSound
| Подпись | hs.sound:loopSound([loop]) -> soundObject | bool |
|---|---|
| Тип | Метод |
| Описание |
Получение или установка циклического поведения объекта |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 316 |
name
| Подпись | hs.sound:name([soundName]) -> soundObject | name string |
|---|---|
| Тип | Метод |
| Описание |
Получение или установка имени объекта |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/sound/libsound.m строка 370 |
пауза
| Подпись | hs.sound:pause() -> soundObject | bool |
|---|---|
| Тип | Метод |
| Описание |
Приостанавливает объект |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/sound/libsound.m строка 253 |
воспроизведение
| Подпись | hs.sound:play() -> soundObject | bool |
|---|---|
| Тип | Метод |
| Описание |
Воспроизводит объект |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/sound/libsound.m строка 228 |
восстановить
| Подпись | hs.sound:resume() -> soundObject | bool |
|---|---|
| Тип | Метод |
| Описание |
Возобновляет воспроизведение приостановленного объекта |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/sound/libsound.m строка 274 |
установитьОбработчик
| Подпись | hs.sound:setCallback(function) -> soundObject |
|---|---|
| Тип | Метод |
| Описание |
Устанавливает или удаляет обработчик для получения уведомления о завершении воспроизведения объекта звука. |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Исходный код | extensions/sound/libsound.m строка 513 |
остановить
| Подпись | hs.sound:stop() -> soundObject | bool |
|---|---|
| Тип | Метод |
| Описание |
Останавливает воспроизведение объекта |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/sound/libsound.m строка 295 |
остановкаПриПерезагрузке
| Подпись | hs.sound:stopOnReload([stopOnReload]) -> soundObject | bool |
|---|---|
| Тип | Метод |
| Описание |
Установить или получить значение, определяющее, следует ли останавливать звук при перезагрузке конфигурации Hammerspoon |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Исходный код | extensions/sound/libsound.m строка 341 |
громкость
| Подпись | hs.sound:volume([level]) -> soundObject | number |
|---|---|
| Тип | Метод |
| Описание |
Получение или установка громкости воспроизведения объекта |
| Параметры |
|
| Возвращает |
|
| Исходный код | extensions/sound/libsound.m строка 474 |
© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.sound.html