Documentation:Modules/mqtt: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 32: | Line 32: | ||
=== → | === → vlc/command <cmd> <arguments> === | ||
:add | :{| | ||
|- | |||
| '''add''' || <uri> || add <uri> to playlist | |||
|- | |||
| '''delete''' || <pos> || delete item <pos> in playlist | |||
|- | |||
| '''clear''' || || clear the playlist | |||
|- | |||
| '''play''' || <pos> || Start playing item <num> | |||
|- | |||
| '''pause''' || || Pause playback | |||
|- | |||
| '''stop''' || || Stop stream | |||
|- | |||
| '''goto''' || <pos> || Goto item at index | |||
|- | |||
| '''next''' || || Start playing next item in playlist | |||
|- | |||
| '''prev''' || || Start playing previous item in playlist | |||
|- | |||
| '''seek''' || <time> || Seek to <time> in the current item (in seconds) | |||
|- | |||
| '''volume''' || <volume> || Set volume to <volume> (0 to 255) | |||
|- | |||
| '''volup''' || <volume> || Increase volume by <volume> | |||
|- | |||
| '''voldown''' || <volume> || Descrease volume by <volume> | |||
|- | |||
| '''repeat''' || <mode> || Turn on or off playlist repeat mode (0 or 1) | |||
|- | |||
| '''random''' || <mode> || Turn on or off playlist random/shuffle mode (0 or 1) | |||
|- | |||
| '''loop''' || <mode> || Turn on or off playlist loop mode (0 or 1) | |||
|- | |||
|} | |||
=== ← vlc/status/playlist === | === ← vlc/status/playlist === | ||
A JSON representation of the playlist is sent whenever the playlist changes. | |||
=== ← vlc/status/state === | === ← vlc/status/state === | ||
This retained message is sent by VLC | This retained message is sent by VLC whenever the player changes state. | ||
:opening | :{| | ||
|- | |||
| '''opening''' || | |||
|- | |||
| '''buffering''' || | |||
|- | |||
| '''playing''' || | |||
|- | |||
| '''paused''' || | |||
|- | |||
| '''stopped''' || | |||
|- | |||
| '''ended''' || | |||
|- | |||
| '''error''' || | |||
|- | |||
| '''notconnected''' || sent when VLC disconnects from the broker | |||
|- | |||
|} | |||
=== ← vlc/status/playing === | === ← vlc/status/playing === | ||
Information about the currently playing item as JSON | Information about the currently playing item as JSON is sent whenever a new item starts playing. | ||
=== ← vlc/status/time === | === ← vlc/status/time === | ||
Progress through the current stream as decimal seconds | |||
=== ← vlc/status/length === | === ← vlc/status/length === | ||
Duration of current stream as decimal seconds | |||
=== ← vlc/status/volume === | === ← vlc/status/volume === | ||
The current volume between 0 and 255 (inclusive) | The current volume between 0 and 255 (inclusive) | ||
[[Category:Interfaces]] | [[Category:Interfaces]] | ||
Revision as of 20:43, 4 May 2014
NOTE: this module is in active development and has not made it into the main tree yet.
| Module: mqtt | |
|---|---|
| Type | Interface |
| First VLC version | - |
| Last VLC version | - |
| Operating system(s) | Any that support the mosquitto library |
| Description | control VLC using the MQTT protocol |
| Shortcut(s) | - |
This module will let you send control messages to VLC using the MQTT protocol.
Options
- mqtt-host <string> : Hostname of MQTT broker to connect to default value: localhost
- mqtt-port <integer> : Port number of MQTT broker to connect to default value: 1883
- mqtt-prefix <string> : The topic name prefix to use default value: vlc/
Protocol
→ : From client to VLC
← : From VLC to client
→ vlc/command <cmd> <arguments>
add <uri> add <uri> to playlist delete <pos> delete item <pos> in playlist clear clear the playlist play <pos> Start playing item <num> pause Pause playback stop Stop stream goto <pos> Goto item at index next Start playing next item in playlist prev Start playing previous item in playlist seek Seek to volume <volume> Set volume to <volume> (0 to 255) volup <volume> Increase volume by <volume> voldown <volume> Descrease volume by <volume> repeat <mode> Turn on or off playlist repeat mode (0 or 1) random <mode> Turn on or off playlist random/shuffle mode (0 or 1) loop <mode> Turn on or off playlist loop mode (0 or 1)
← vlc/status/playlist
A JSON representation of the playlist is sent whenever the playlist changes.
← vlc/status/state
This retained message is sent by VLC whenever the player changes state.
opening buffering playing paused stopped ended error notconnected sent when VLC disconnects from the broker
← vlc/status/playing
Information about the currently playing item as JSON is sent whenever a new item starts playing.
← vlc/status/time
Progress through the current stream as decimal seconds
← vlc/status/length
Duration of current stream as decimal seconds
← vlc/status/volume
The current volume between 0 and 255 (inclusive)