Documentation:Modules/mqtt - Revision history

Nhumfrey: Restructured as a table of commands and responses

2014-05-05T10:31:09Z

Restructured as a table of commands and responses

Nhumfrey: /* Options */

2014-05-04T21:08:19Z

Options

@@ Line 17: / Line 17: @@
 |default=1883
 |description=Port number of MQTT broker to connect to
 }}
 {{Option
@@ Line 24: / Line 36: @@
 |description=The topic name prefix to use
 }}
+{{Option
 == Protocol ==

Nhumfrey: /* → vlc/command */

2014-05-04T20:51:43Z

→ vlc/command

← Older revision		Revision as of 20:51, 4 May 2014
Line 33:		Line 33:

	=== → vlc/command <cmd> <arguments> ===		=== → vlc/command <cmd> <arguments> ===
			The following commands are accepted:
	:{\|		:{\|
	\|-		\|-
Line 68:		Line 69:
	\|-		\|-
	\|}		\|}


	=== ← vlc/status/playlist ===		=== ← vlc/status/playlist ===

Nhumfrey at 20:43, 4 May 2014

2014-05-04T20:43:48Z

← Older revision		Revision as of 20:43, 4 May 2014
Line 32:		Line 32:


	=== → ~~'''~~vlc/command~~'''~~ <cmd> <arguments> ===		=== → vlc/command <cmd> <arguments> ===
	:add: <uri> <~~br /~~>		:{\|
	:delete: <pos> <~~br /~~>		\|-
	:clear: <~~br /~~>		\| '''add''' \|\| <uri> \|\| add <uri> to playlist
	~~:play:~~ <~~br /~~>		\|-
	:pause~~: <br />~~		\| '''delete''' \|\| <pos> \|\| delete item <pos> in playlist
	:stop~~: <br />~~		\|-
	:goto: <pos> ~~<br />~~		\| '''clear''' \|\| \|\| clear the playlist
	:next~~: <br />~~		\|-
	:prev~~: <br />~~		\| '''play''' \|\| <pos> \|\| Start playing item <num>
	:seek: <time> <~~br /~~>		\|-
	:volume: <volume> <~~br /~~>		\| '''pause''' \|\| \|\| Pause playback
	:volup: <X> <~~br /~~>		\|-
	:voldown: <X> <~~br /~~>		\| '''stop''' \|\| \|\| Stop stream
	:repeat: <0\|1> <~~br /~~>		\|-
	:random~~: <~~0\|1> <~~br /~~>		\| '''goto''' \|\| <pos> \|\| Goto item at index
	:loop~~: <~~0\|~~1> <br />~~		\|-
			\| '''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 ===
	~~Return a~~ JSON representation of the 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 ~~when~~		This retained message is sent by VLC whenever the player changes state.
	:opening :		:{\|
	:buffering :		\|-
	:playing :		\| '''opening''' \|\|
	:paused :		\|-
	:stopped :		\| '''buffering''' \|\|
	:ended :		\|-
	:error :		\| '''playing''' \|\|
	:notconnected : sent when VLC disconnects from the broker		\|-
			\| '''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 ===
	~~Returns~~ current ~~time in~~ stream as decimal seconds		Progress through the current stream as decimal seconds


	=== ← vlc/status/length ===		=== ← vlc/status/length ===
	~~Returns duration~~ of current stream as decimal seconds		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]]

Nhumfrey: /* ← vlc/status/state */

2014-05-04T20:18:27Z

← vlc/status/state

← Older revision		Revision as of 20:18, 4 May 2014
Line 56:		Line 56:
	=== ← vlc/status/state ===		=== ← vlc/status/state ===
	This retained message is sent by VLC when		This retained message is sent by VLC when
	opening :		:opening :
	buffering :		:buffering :
	playing :		:playing :
	paused :		:paused :
	stopped :		:stopped :
	ended :		:ended :
	error :		:error :
	notconnected : sent when VLC disconnects from the broker		:notconnected : sent when VLC disconnects from the broker

	=== ← vlc/status/playing ===		=== ← vlc/status/playing ===

Nhumfrey at 18:59, 4 May 2014

2014-05-04T18:59:08Z

@@ Line 24: / Line 24: @@
 |description=The topic name prefix to use
 }}
 [[Category:Interfaces]]

Nhumfrey at 09:33, 12 April 2014

2014-04-12T09:33:02Z

← Older revision		Revision as of 09:33, 12 April 2014
Line 18:		Line 18:
	\|description=Port number of MQTT broker to connect to		\|description=Port number of MQTT broker to connect to
	}}		}}
			{{Option
			\|name=mqtt-prefix
			\|value=string
			\|default=vlc/
			\|description=The topic name prefix to use
			}}

	[[Category:Interfaces]]		[[Category:Interfaces]]

Nhumfrey: /* Options */

2014-04-10T23:58:25Z

Options

← Older revision		Revision as of 23:58, 10 April 2014
Line 6:		Line 6:

	== Options ==		== Options ==
			{{Option
			\|name=mqtt-host
			\|value=string
			\|default=localhost
			\|description=Hostname of MQTT broker to connect to
			}}
	{{Option		{{Option
	\|name=mqtt-port		\|name=mqtt-port
	\|value=integer		\|value=integer
	\|default=1883		\|default=1883
	\|description=Port number of MQTT broker to connect o		\|description=Port number of MQTT broker to connect to
	}}		}}


	[[Category:Interfaces]]		[[Category:Interfaces]]

Nhumfrey: Created page with "'''NOTE: this module is in active development and has not made it into the main tree yet.''' {{Module|name=mqtt|type=Interface|os=Any that support the [http://mosquitto.org/ ..."

2014-04-10T23:57:36Z

Created page with "'''NOTE: this module is in active development and has not made it into the main tree yet.''' {{Module|name=mqtt|type=Interface|os=Any that support the [http://mosquitto.org/ ..."

New page

'''NOTE: this module is in active development and has not made it into the main tree yet.'''

{{Module|name=mqtt|type=Interface|os=Any that support the [http://mosquitto.org/ mosquitto] library|description=control VLC using the MQTT protocol}}

This module will let you send control messages to VLC using the [http://www.mqtt.org/ MQTT] protocol.

== Options ==
{{Option
|name=mqtt-port
|value=integer
|default=1883
|description=Port number of MQTT broker to connect o
}}

[[Category:Interfaces]]