Spec-Zone.ru › Hammerspoon

hs.spotify

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

Обзор API

  • Константы — Полезные значения, которые нельзя изменить
    • state_paused
    • state_playing
    • state_stopped
  • Функции — API-вызовы, предоставляемые напрямую расширением
    • displayCurrentTrack
    • ff
    • getCurrentAlbum
    • getCurrentArtist
    • getCurrentTrack
    • getCurrentTrackId
    • getDuration
    • getPlaybackState
    • getPosition
    • getVolume
    • isPlaying
    • isRunning
    • next
    • pause
    • play
    • playpause
    • playTrack
    • previous
    • rw
    • setPosition
    • setVolume
    • volumeDown
    • volumeUp

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

Константы

state_paused
Подпись hs.spotify.state_paused
Тип Константа
Описание

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

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

Возвращается hs.spotify.getPlaybackState() для указания, что Spotify остановлен
Источник extensions/spotify/spotify.lua строка 21

Функции

displayCurrentTrack
Подпись hs.spotify.displayCurrentTrack()
Тип Функция
Описание

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

Переводит позицию воспроизведения вперед на 5 секунд
Параметры
  • Нет
Возвращаемые значения
  • Нет
Источник extensions/spotify/spotify.lua строка 323
END_OF_DOCUMENT_MARKER
getCurrentAlbum
Signature hs.spotify.getCurrentAlbum()
Type Function
Description

Получает название альбома текущей композиции
Parameters
  • None
Returns
  • Строка, содержащая название альбома текущей композиции, или nil, если произошла ошибка
Source extensions/spotify/spotify.lua строка 144
getCurrentArtist
Signature hs.spotify.getCurrentArtist()
Type Function
Description

Получает имя исполнителя текущей композиции
Parameters
  • None
Returns
  • Строка, содержащая имя исполнителя текущей композиции, или nil, если произошла ошибка
Source extensions/spotify/spotify.lua строка 131
getCurrentTrack
Signature hs.spotify.getCurrentTrack()
Type Function
Description

Получает название текущей композиции
Parameters
  • None
Returns
  • Строка, содержащая название текущей композиции, или nil, если произошла ошибка
Source extensions/spotify/spotify.lua строка 157
getCurrentTrackId
Signature hs.spotify.getCurrentTrackId()
Type Function
Description

Получает идентификатор текущей композиции
Parameters
  • None
Returns
  • Строка, содержащая идентификатор текущей композиции, или nil, если произошла ошибка
Source extensions/spotify/spotify.lua строка 169
getDuration
Signature hs.spotify.getDuration()
Type Function
Description

Получает продолжительность текущей композиции (в секундах)
Parameters
  • None
Returns
  • Количество секунд, которое длится текущая композиция, 0, если нет воспроизведения
Source extensions/spotify/spotify.lua строка 309
getPlaybackState
Signature hs.spotify.getPlaybackState()
Type Function
Description

Получает текущее состояние воспроизведения Spotify
Parameters
  • None
Returns
  • Строка, содержащая одну из следующих констант:
    • hs.spotify.state_stopped
    • hs.spotify.state_paused
    • hs.spotify.state_playing
Source extensions/spotify/spotify.lua строка 182
getPosition
Signature hs.spotify.getPosition()
Type Function
Description

Получает текущую позицию воспроизведения (в секундах) в текущей композиции
Parameters
  • None
Returns
  • Число, указывающее текущую позицию в композиции
Source extensions/spotify/spotify.lua строка 283
getVolume
Signature hs.spotify.getVolume()
Type Function
Description

Получает настройку громкости Spotify
Parameters
  • None
Returns
  • Число, содержащее уровень громкости Spotify, от 1 до 100
Source extensions/spotify/spotify.lua строка 235
isPlaying
Signature hs.spotify.isPlaying()
Type Function
Description

Возвращает, воспроизводится ли в данный момент Spotify
Parameters
  • None
Returns
  • Булево значение, указывающее, воспроизводится ли в данный момент композиция в Spotify, или nil, если произошла ошибка (неизвестное состояние плеера). Также возвращает false, если приложение не запущено
Source extensions/spotify/spotify.lua строка 211
isRunning
Signature hs.spotify.isRunning()
Type Function
Description

Возвращает, открыт ли Spotify в данный момент. Большинство других функций в hs.spotify автоматически запускают приложение, поэтому эту функцию можно использовать для защиты от этого.
Parameters
  • None
Returns
  • Булево значение, указывающее, запущено ли приложение Spotify.
Source extensions/spotify/spotify.lua строка 198
следующая
Подпись hs.spotify.next()
Тип Функция
Описание

Переходит к следующей песне в Spotify
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 76
пауза
Подпись hs.spotify.pause()
Тип Функция
Описание

Приостанавливает текущую песню в Spotify
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 63
воспроизведение
Подпись hs.spotify.play()
Тип Функция
Описание

Воспроизводит текущую песню в Spotify
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 50
воспроизведение/пауза
Подпись hs.spotify.playpause()
Тип Функция
Описание

Переключает воспроизведение/паузу текущей песни в Spotify
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 37
воспроизвестиТрек
Подпись hs.spotify.playTrack(id)
Тип Функция
Описание

Воспроизводит песню Spotify с заданным id
Параметры
  • id - Id песни Spotify для воспроизведения
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 102
предыдущая
Подпись hs.spotify.previous()
Тип Функция
Описание

Переходит к предыдущей песне в Spotify
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 89
rw
Подпись hs.spotify.rw()
Тип Функция
Описание

Перематывает воспроизведение назад на 5 секунд
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 334
установитьПозицию
Подпись hs.spotify.setPosition(pos)
Тип Функция
Описание

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

Устанавливает громкость Spotify
Параметры
  • vol - Число от 1 до 100
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 246
уменьшитьГромкость
Подпись hs.spotify.volumeDown()
Тип Функция
Описание

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

Увеличивает громкость на 5
Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/spotify/spotify.lua строка 261

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

Spec-Zone.ru

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