#hs.vox
Controls for VOX music player
#API Overview
Functions - API calls offered directly by the extension
- addurl
- backward
- decreaseVolume
- fastBackward
- fastForward
- forward
- getAlbumArtist
- getCurrentAlbum
- getCurrentArtist
- getPlayerState
- getUniqueID
- increaseVolume
- isRunning
- next
- pause
- play
- playpause
- playurl
- previous
- shuffle
- togglePlaylist
- trackInfo
#API Documentation
#Functions
Signature | hs.vox.addurl(url) |
Type | Function |
Description | Add media URL to current list |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 115 |
Signature | hs.vox.backward() |
Type | Function |
Description | Skips the playback position backwards by about 7 seconds |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 141 |
Signature | hs.vox.decreaseVolume() |
Type | Function |
Description | Decreases the player volume |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 193 |
Signature | hs.vox.fastBackward() |
Type | Function |
Description | Skips the playback position backwards by about 14 seconds |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 167 |
Signature | hs.vox.fastForward() |
Type | Function |
Description | Skips the playback position forwards by about 17 seconds |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 154 |
Signature | hs.vox.forward() |
Type | Function |
Description | Skips the playback position forwards by about 7 seconds |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 128 |
Signature | hs.vox.getAlbumArtist() |
Type | Function |
Description | Gets the artist of current Album |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 261 |
Signature | hs.vox.getCurrentAlbum() |
Type | Function |
Description | Gets the name of the album of the current track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 248 |
Signature | hs.vox.getCurrentArtist() |
Type | Function |
Description | Gets the name of the artist of the current track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 235 |
Signature | hs.vox.getPlayerState() |
Type | Function |
Description | Gets the current playback state of vox |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 287 |
Signature | hs.vox.getUniqueID() |
Type | Function |
Description | Gets the uniqueID of the current track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 274 |
Signature | hs.vox.increaseVolume() |
Type | Function |
Description | Increases the player volume |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 180 |
Signature | hs.vox.isRunning() |
Type | Function |
Description | Returns whether VOX is currently open |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 301 |
Signature | hs.vox.next() |
Type | Function |
Description | Skips to the next track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 63 |
Signature | hs.vox.pause() |
Type | Function |
Description | Pauses the current vox track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 24 |
Signature | hs.vox.play() |
Type | Function |
Description | Plays the current vox track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 37 |
Signature | hs.vox.playpause() |
Type | Function |
Description | Toggles play/pause of current vox track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 50 |
Signature | hs.vox.playurl(url) |
Type | Function |
Description | Play media from the given URL |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 102 |
Signature | hs.vox.previous() |
Type | Function |
Description | Skips to previous track |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 76 |
Signature | hs.vox.shuffle() |
Type | Function |
Description | Toggle shuffle state of current list |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 89 |
Signature | hs.vox.togglePlaylist() |
Type | Function |
Description | Toggle playlist |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 206 |
Signature | hs.vox.trackInfo() |
Type | Function |
Description | Displays information for current track on screen |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | extensions/vox/vox.lua line 219 |