#hs.vox

Controls for VOX music player


#API Overview

Functions - API calls offered directly by the extension


#API Documentation

#Functions

Signaturehs.vox.addurl(url)
TypeFunction
DescriptionAdd media URL to current list
Parameters
  • url
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 115

Signaturehs.vox.backward()
TypeFunction
DescriptionSkips the playback position backwards by about 7 seconds
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 141

Signaturehs.vox.decreaseVolume()
TypeFunction
DescriptionDecreases the player volume
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 193

Signaturehs.vox.fastBackward()
TypeFunction
DescriptionSkips the playback position backwards by about 14 seconds
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 167

Signaturehs.vox.fastForward()
TypeFunction
DescriptionSkips the playback position forwards by about 17 seconds
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 154

Signaturehs.vox.forward()
TypeFunction
DescriptionSkips the playback position forwards by about 7 seconds
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 128

Signaturehs.vox.getAlbumArtist()
TypeFunction
DescriptionGets the artist of current Album
Parameters
  • None
Returns
  • A string containing the artist of current Album, or nil if an error occurred
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 261

Signaturehs.vox.getCurrentAlbum()
TypeFunction
DescriptionGets the name of the album of the current track
Parameters
  • None
Returns
  • A string containing the Album of the current track, or nil if an error occurred
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 248

Signaturehs.vox.getCurrentArtist()
TypeFunction
DescriptionGets the name of the artist of the current track
Parameters
  • None
Returns
  • A string containing the Artist of the current track, or nil if an error occurred
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 235

Signaturehs.vox.getPlayerState()
TypeFunction
DescriptionGets the current playback state of vox
Parameters
  • None
Returns
  • 0 for paused
  • 1 for playing
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 287

Signaturehs.vox.getUniqueID()
TypeFunction
DescriptionGets the uniqueID of the current track
Parameters
  • None
Returns
  • A string containing the name of the current track, or nil if an error occurred
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 274

Signaturehs.vox.increaseVolume()
TypeFunction
DescriptionIncreases the player volume
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 180

Signaturehs.vox.isRunning()
TypeFunction
DescriptionReturns whether VOX is currently open
Parameters
  • None
Returns
  • A boolean value indicating whether the vox application is running
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 301

Signaturehs.vox.next()
TypeFunction
DescriptionSkips to the next track
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 63

Signaturehs.vox.pause()
TypeFunction
DescriptionPauses the current vox track
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 24

Signaturehs.vox.play()
TypeFunction
DescriptionPlays the current vox track
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 37

Signaturehs.vox.playpause()
TypeFunction
DescriptionToggles play/pause of current vox track
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 50

Signaturehs.vox.playurl(url)
TypeFunction
DescriptionPlay media from the given URL
Parameters
  • url
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 102

Signaturehs.vox.previous()
TypeFunction
DescriptionSkips to previous track
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 76

Signaturehs.vox.shuffle()
TypeFunction
DescriptionToggle shuffle state of current list
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 89

Signaturehs.vox.togglePlaylist()
TypeFunction
DescriptionToggle playlist
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 206

Signaturehs.vox.trackInfo()
TypeFunction
DescriptionDisplays information for current track on screen
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourceextensions/vox/vox.lua line 219