Documentation:Modules/mqtt

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/

→ : From client to VLC
← : From VLC to client

The following commands are accepted:

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 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)

A JSON representation of the playlist is sent whenever the playlist changes.

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

Information about the currently playing item as JSON is sent whenever a new item starts playing.

Progress through the current stream as decimal seconds

Duration of current stream as decimal seconds

The current volume between 0 and 255 (inclusive)