Difference between revisions of "Documentation:Modules/mqtt"
Jump to navigation
Jump to search
| Line 24: | Line 24: | ||
|description=The topic name prefix to use | |description=The topic name prefix to use | ||
}} | }} | ||
| + | |||
| + | |||
| + | == Protocol == | ||
| + | |||
| + | <big>→</big> : From client to VLC <br /> | ||
| + | <big>←</big> : From VLC to client <br /> | ||
| + | |||
| + | |||
| + | === → '''vlc/command''' <cmd> <arguments> === | ||
| + | :add: <uri> <br /> | ||
| + | :delete: <pos> <br /> | ||
| + | :clear: <br /> | ||
| + | :play: <br /> | ||
| + | :pause: <br /> | ||
| + | :stop: <br /> | ||
| + | :goto: <pos> <br /> | ||
| + | :next: <br /> | ||
| + | :prev: <br /> | ||
| + | :seek: <time> <br /> | ||
| + | :volume: <volume> <br /> | ||
| + | :volup: <X> <br /> | ||
| + | :voldown: <X> <br /> | ||
| + | :repeat: <0|1> <br /> | ||
| + | :random: <0|1> <br /> | ||
| + | :loop: <0|1> <br /> | ||
| + | |||
| + | |||
| + | === ← vlc/status/playlist === | ||
| + | Return a JSON representation of the playlist | ||
| + | |||
| + | === ← vlc/status/state === | ||
| + | This retained message is sent by VLC when | ||
| + | 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 | ||
| + | |||
| + | === ← vlc/status/time === | ||
| + | Returns current time in stream as decimal seconds | ||
| + | |||
| + | === ← vlc/status/length === | ||
| + | Returns duration of current stream as decimal seconds | ||
| + | |||
| + | === ← vlc/status/volume === | ||
| + | The current volume between 0 and 255 (inclusive) | ||
[[Category:Interfaces]] | [[Category:Interfaces]] | ||
Revision as of 18:59, 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.
Contents
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>
- delete: <pos>
- clear:
- play:
- pause:
- stop:
- goto: <pos>
- next:
- prev:
- seek:
- volume: <volume>
- volup: <X>
- voldown: <X>
- repeat: <0|1>
- random: <0|1>
- loop: <0|1>
← vlc/status/playlist
Return a JSON representation of the playlist
← vlc/status/state
This retained message is sent by VLC when 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
← vlc/status/time
Returns current time in stream as decimal seconds
← vlc/status/length
Returns duration of current stream as decimal seconds
← vlc/status/volume
The current volume between 0 and 255 (inclusive)
