hs.itunes

Управление музыкальным плеером iTunes

Обзор API

Константы - Полезные значения, которые нельзя изменить

state_paused
state_playing
state_stopped

Функции - API-вызовы, предлагаемые непосредственно расширением

displayCurrentTrack
ff
getCurrentAlbum
getCurrentArtist
getCurrentTrack
getDuration
getPlaybackState
getPosition
getVolume
isPlaying
isRunning
next
pause
play
playpause
previous
rw
setPosition
setVolume
volumeDown
volumeUp

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

Константы

state_paused

Подпись	`hs.itunes.state_paused`
Тип	Константа
Описание	Возвращается `hs.itunes.getPlaybackState()` для указания, что iTunes приостановлен
Источник	extensions/itunes/itunes.lua строка 17

state_playing

Подпись	`hs.itunes.state_playing`
Тип	Константа
Описание	Возвращается `hs.itunes.getPlaybackState()` для указания, что iTunes воспроизводит
Источник	extensions/itunes/itunes.lua строка 22

state_stopped

Подпись	`hs.itunes.state_stopped`
Тип	Константа
Описание	Возвращается `hs.itunes.getPlaybackState()` для указания, что iTunes остановлен
Источник	extensions/itunes/itunes.lua строка 27

Функции

displayCurrentTrack

Подпись	`hs.itunes.displayCurrentTrack()`
Тип	Функция
Описание	Отображает информацию о текущей дорожке на экране
Параметры	Нет
Возвращает	Нет
Источник	extensions/itunes/itunes.lua строка 108

ff

Подпись	`hs.itunes.ff()`
Тип	Функция
Описание	Перематывает текущее воспроизведение вперёд на 5 секунд
Параметры	Нет
Возвращает	Нет
Источник	extensions/itunes/itunes.lua строка 304

getCurrentAlbum

Подпись	`hs.itunes.getCurrentAlbum() -> string or nil`
Тип	Функция
Описание	Получает название текущего альбома
Параметры	Нет
Возвращает	Строка, содержащая альбом текущей дорожки, или nil, если произошла ошибка
Источник	extensions/itunes/itunes.lua строка 137

getCurrentArtist

Подпись	`hs.itunes.getCurrentArtist() -> string or nil`
Тип	Функция
Описание	Получает имя текущего исполнителя
Параметры	Нет
Возвращает	Строка, содержащая исполнителя текущей дорожки, или nil, если произошла ошибка
Источник	extensions/itunes/itunes.lua строка 124

getCurrentTrack

Подпись	`hs.itunes.getCurrentTrack() -> string or nil`
Тип	Функция
Описание	Получает название текущей дорожки
Параметры	Нет
Возвращает	Строка, содержащая название текущей дорожки, или nil, если произошла ошибка
Источник	extensions/itunes/itunes.lua строка 150

getDuration

Подпись	`hs.itunes.getDuration()`
Тип	Функция
Описание	Получает длительность (в секундах) текущей песни
Параметры	Нет
Возвращает	Количество секунд длительности текущей песни, 0, если песня не воспроизводится
Источник	extensions/itunes/itunes.lua строка 290

getPlaybackState

Подпись	`hs.itunes.getPlaybackState()`
Тип	Функция
Описание	Получает текущее состояние воспроизведения iTunes
Параметры	Нет
Возвращает	Строка, содержащая одну из следующих констант: `hs.itunes.state_stopped` `hs.itunes.state_paused` `hs.itunes.state_playing`
Источник	extensions/itunes/itunes.lua строка 163

getPosition

Подпись	`hs.itunes.getPosition()`
Тип	Функция
Описание	Получает позицию воспроизведения (в секундах) текущей песни
Параметры	Нет
Возвращает	Число, обозначающее текущую позицию в песне
Источник	extensions/itunes/itunes.lua строка 264

getVolume

Подпись	`hs.itunes.getVolume()`
Тип	Функция
Описание	Получает текущую настройку громкости iTunes
Параметры	Нет
Возвращает	Число от 1 до 100, содержащее текущую громкость воспроизведения iTunes
Источник	extensions/itunes/itunes.lua строка 216

isPlaying

Подпись	`hs.itunes.isPlaying()`
Тип	Функция
Описание	Возвращает, воспроизводится ли в данный момент iTunes
Параметры	Нет
Возвращает	Булево значение, указывающее, воспроизводится ли в iTunes трек, или nil, если произошла ошибка (неизвестное состояние плеера). Также возвращает false, если приложение не запущено
Источник	extensions/itunes/itunes.lua строка 192

isRunning

Подпись	`hs.itunes.isRunning()`
Тип	Функция
Описание	Возвращает, открыт ли в данный момент iTunes. Большинство других функций в hs.itunes автоматически запускают приложение, поэтому эту функцию можно использовать для защиты от этого.
Параметры	Нет
Возвращает	Булево значение, указывающее, запущено ли приложение iTunes.
Источник	extensions/itunes/itunes.lua строка 179

Подпись	`hs.itunes.next()`
Тип	Функция
Описание	Переходит к следующему треку в iTunes
Параметры	Нет
Возвращает	Нет
Источник	extensions/itunes/itunes.lua строка 82

pause

Подпись	`hs.itunes.pause()`
Тип	Функция
Описание	Приостанавливает текущий трек в iTunes
Параметры	Нет
Возвращает	Нет
Источник	extensions/itunes/itunes.lua строка 69

END_OF_DOCUMENT_MARKER

воспроизведение

Подпись	`hs.itunes.play()`
Тип	Функция
Описание	Воспроизводит текущую дорожку iTunes
Параметры	Нет
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 56

воспроизведение/пауза

Подпись	`hs.itunes.playpause()`
Тип	Функция
Описание	Переключает воспроизведение/паузу текущей дорожки iTunes
Параметры	Нет
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 43

Подпись	`hs.itunes.previous()`
Тип	Функция
Описание	Переходит к предыдущей дорожке iTunes
Параметры	Нет
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 95

rw

Подпись	`hs.itunes.rw()`
Тип	Функция
Описание	Перематывает текущее воспроизведение назад на 5 секунд
Параметры	Нет
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 315

установкаПозиции

Подпись	`hs.itunes.setPosition(pos)`
Тип	Функция
Описание	Устанавливает позицию воспроизведения текущей песни
Параметры	pos - Число, указывающее позицию воспроизведения (в секундах), к которой нужно перейти
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 275

установкаГромкости

Подпись	`hs.itunes.setVolume(vol)`
Тип	Функция
Описание	Устанавливает громкость воспроизведения в iTunes
Параметры	vol - Число от 1 до 100
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 227

уменьшениеГромкости

Подпись	`hs.itunes.volumeDown()`
Тип	Функция
Описание	Уменьшает громкость воспроизведения в iTunes на 5
Параметры	Нет
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 253

увеличениеГромкости

Подпись	`hs.itunes.volumeUp()`
Тип	Функция
Описание	Увеличивает громкость воспроизведения в iTunes на 5
Параметры	Нет
Возвращаемое значение	Нет
Источник	extensions/itunes/itunes.lua строка 242