Spec-Zone.ru › Hammerspoon

hs.sound

Загрузка/воспроизведение/манипулирование звуковыми файлами

Обзор API

  • Функции - API-вызовы, предлагаемые непосредственно расширением
    • getAudioEffectNames
    • soundFileTypes
    • soundTypes
    • systemSounds
  • Конструкторы - API-вызовы, возвращающие объект, обычно с методами API
    • getByFile
    • getByName
  • Методы - API-вызовы, которые могут быть выполнены только над объектом, возвращённым конструктором
    • currentTime
    • device
    • duration
    • isPlaying
    • loopSound
    • name
    • pause
    • play
    • resume
    • setCallback
    • stop
    • stopOnReload
    • volume

Документация API

Функции

getAudioEffectNames
Подпись hs.sound.getAudioEffectNames() -> table
Тип Функция
Описание

Получает таблицу имён установленных эффектов Audio Units.

Параметры
  • Нет
Возвращает
  • Таблица, содержащая имена всех установленных эффектов Audio Units.
Примечания
  • Пример использования: hs.inspect(hs.audiounit.getAudioEffectNames())
Источник extensions/sound/libsound.m строка 62
soundFileTypes
Подпись hs.sound.soundFileTypes() -> table
Тип Функция
Описание

Получает поддерживаемые типы звуковых файлов

Параметры
  • Нет
Возвращает
  • Таблица, содержащая расширения имён файлов звуковых файлов, поддерживаемые системой
Примечания
  • Эта функция вряд ли будет чрезвычайно полезной, поскольку расширения имён файлов фактически бессмысленны. Данные, возвращаемые hs.sound.soundTypes(), гораздо более ценны
Источник extensions/sound/libsound.m строка 200
soundTypes
Подпись hs.sound.soundTypes() -> table
Тип Функция
Описание

Получает поддерживаемые форматы звуковых файлов UTI

Параметры
  • Нет
Возвращает
  • Таблица, содержащая форматы звуков UTI, поддерживаемые системой
Источник extensions/sound/libsound.m строка 184
systemSounds
Подпись hs.sound.systemSounds() -> table
Тип Функция
Описание

Получает таблицу доступных системных звуков

Параметры
  • Нет
Возвращает
  • Таблица, содержащая все доступные звуковые файлы (т.е. те, которые находятся в ~/Library/Sounds, /Library/Sounds, /Network/Library/Sounds и /System/Library/Sounds)
Примечания
  • Звуки, перечисленные этой функцией, можно загрузить с помощью hs.sound.getByName()
Источник extensions/sound/libsound.m строка 150

Конструкторы

getByFile
Подпись hs.sound.getByFile(path) -> sound or nil
Тип Конструктор
Описание

Создаёт объект hs.sound из файла

Параметры
  • path - Строка, содержащая путь к звуковому файлу
Возвращает
  • Объект hs.sound или nil, если файл не удалось загрузить
Источник extensions/sound/libsound.m строка 128
getByName
Подпись hs.sound.getByName(name) -> sound or nil
Тип Конструктор
Описание

Создаёт объект hs.sound из именованного звука

Параметры
  • name - Строка, содержащая имя звука
Возвращает
  • Объект hs.sound или nil, если соответствующий звук не найден
Примечания
  • Звуки могут быть загружены только по имени, если они являются системными звуками (т.е. находятся в ~/Library/Sounds, /Library/Sounds, /Network/Library/Sounds и /System/Library/Sounds) или являются звуковыми файлами, которые были ранее загружены и именованы
Источник extensions/sound/libsound.m строка 103

Методы

currentTime
Подпись hs.sound:currentTime([seekTime]) -> soundObject | seconds
Тип Метод
Описание

Получение или установка текущего смещения поиска внутри объекта hs.sound.

Параметры
  • seekTime - Необязательное число секунд для поиска в пределах объекта звука
Возвращает
  • Если параметр предоставлен, возвращает объект звука; в противном случае возвращает текущую позицию.
Источник extensions/sound/libsound.m строка 435
device
Подпись hs.sound:device([deviceUID]) -> soundObject | UID string
Тип Метод
Описание

Получение или установка устройства воспроизведения для объекта hs.sound

Параметры
  • deviceUID - Необязательная строка, содержащая UID объекта hs.audiodevice для использования при воспроизведении звука. Использование явного nil для использования системного устройства по умолчанию
Возвращает
  • Если параметр предоставлен, возвращает объект звука; в противном случае возвращает текущую настройку.
Примечания
  • Для получения UID устройства звука см. hs.audiodevice:uid()
Источник extensions/sound/libsound.m строка 400
duration
Подпись hs.sound:duration() -> seconds
Тип Метод
Описание

Получает длительность объекта hs.sound

Параметры
  • Нет
Возвращает
  • Число, содержащее длительность звука в секундах
Источник extensions/sound/libsound.m строка 457
isPlaying
Подпись hs.sound:isPlaying() -> bool
Тип Метод
Описание

Получает текущее состояние воспроизведения объекта hs.sound

Параметры
  • Нет
Возвращает
  • Булево значение, true, если звук воспроизводится в данный момент, иначе false
Источник extensions/sound/libsound.m строка 496
loopSound
Подпись hs.sound:loopSound([loop]) -> soundObject | bool
Тип Метод
Описание

Получение или установка циклического поведения объекта hs.sound

Параметры
  • loop - Необязательный булево значение, true для циклического воспроизведения, false - для нециклического
Возвращает
  • Если параметр предоставлен, возвращает объект звука; в противном случае возвращает текущую настройку.
Примечания
  • Если вы зарегистрировали функцию обратного вызова для завершения воспроизведения звука, она не будет вызвана при циклическом воспроизведении звука
Источник extensions/sound/libsound.m строка 316
name
Подпись hs.sound:name([soundName]) -> soundObject | name string
Тип Метод
Описание

Получение или установка имени объекта hs.sound

Параметры
  • soundName - Необязательная строка для использования в качестве имени объекта; использование явного nil для удаления имени
Возвращает
  • Если параметр предоставлен, возвращает объект звука; в противном случае возвращает текущую настройку.
Примечания
  • Если вы удалите имя звука, указав nil, звук автоматически будет остановлен при перезагрузке Hammerspoon.
Источник extensions/sound/libsound.m строка 370
пауза
Подпись hs.sound:pause() -> soundObject | bool
Тип Метод
Описание

Приостанавливает объект hs.sound

Параметры
  • Нет
Возвращает
  • Объект hs.sound , если команда выполнена успешно, в противном случае false.
Исходный код extensions/sound/libsound.m строка 253
воспроизведение
Подпись hs.sound:play() -> soundObject | bool
Тип Метод
Описание

Воспроизводит объект hs.sound

Параметры
  • Нет
Возвращает
  • Объект hs.sound , если команда выполнена успешно, в противном случае false.
Исходный код extensions/sound/libsound.m строка 228
восстановить
Подпись hs.sound:resume() -> soundObject | bool
Тип Метод
Описание

Возобновляет воспроизведение приостановленного объекта hs.sound

Параметры
  • Нет
Возвращает
  • Объект hs.sound , если команда выполнена успешно, в противном случае false.
Исходный код extensions/sound/libsound.m строка 274
установитьОбработчик
Подпись hs.sound:setCallback(function) -> soundObject
Тип Метод
Описание

Устанавливает или удаляет обработчик для получения уведомления о завершении воспроизведения объекта звука.

Параметры
  • function - Функция, которая должна вызываться при завершении воспроизведения звука. Для удаления функции обратного вызова укажите явное значение nil.
Возвращает
  • объект звука
Примечания
  • Функция обратного вызова должна принимать два параметра и не возвращать значение. Параметры, передаваемые функции обратного вызова, следующие:
    • state - логическое значение, указывающее, завершилось ли воспроизведение звука. Возвращает true, если воспроизведение завершилось успешно, или false, если произошла ошибка декодирования или звук был остановлен преждевременно с помощью hs.sound:stop.
    • sound - пользовательские данные soundObject
Исходный код extensions/sound/libsound.m строка 513
остановить
Подпись hs.sound:stop() -> soundObject | bool
Тип Метод
Описание

Останавливает воспроизведение объекта hs.sound

Параметры
  • Нет
Возвращает
  • Объект hs.sound , если команда выполнена успешно, в противном случае false.
Исходный код extensions/sound/libsound.m строка 295
остановкаПриПерезагрузке
Подпись hs.sound:stopOnReload([stopOnReload]) -> soundObject | bool
Тип Метод
Описание

Установить или получить значение, определяющее, следует ли останавливать звук при перезагрузке конфигурации Hammerspoon

Параметры
  • stopOnReload - Необязательный boolean, true для остановки воспроизведения при перезагрузке конфигурации Hammerspoon, false для продолжения воспроизведения независимо. По умолчанию true.
Возвращает
  • Если параметр предоставлен, возвращает объект звука; в противном случае возвращает текущее значение.
Примечания
  • Этот метод может быть использован только с именованным объектом hs.sound, см. hs.sound:name()
Исходный код extensions/sound/libsound.m строка 341
громкость
Подпись hs.sound:volume([level]) -> soundObject | number
Тип Метод
Описание

Получение или установка громкости воспроизведения объекта hs.sound

Параметры
  • level - Число от 0,0 до 1,0, представляющее громкость объекта звука относительно текущей громкости системы
Возвращает
  • Если параметр предоставлен, возвращает объект звука; в противном случае возвращает текущее значение.
Исходный код extensions/sound/libsound.m строка 474

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

Spec-Zone.ru

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