3 This file describes commands available through the requests/ file:
5 Lines starting with < describe what the page sends back
6 Lines starting with > describe what you can send to the page
8 All parameters need to be URL encoded.
19 The entire interface is moving to using <MRL> for input and output parameters and attributes
20 pl_play and in_enqueue previously accepted paths. This is still supported, but from 1.3 <MRL> will be required
21 where path attributes are provided in output, these should be ignored in favour of uri attributes
22 path support is scheduled to be removed entirely from 1.3
29 > Get album art for current input:
30 /art (NB: not /requests/art)
32 > Get album art for any playlist input (available from API version 3):
33 /art?item=123 (NB: not /requests/art)
36 status.xml or status.json
40 < Get VLC status information, current item info and meta.
41 < Get VLC version, and http api version
43 > add <uri> to playlist and start playback:
44 ?command=in_play&input=<uri>&option=<option>
45 the option field is optional, and can have the values:
49 > add <uri> to playlist:
50 ?command=in_enqueue&input=<uri>
52 > add subtitle to currently playing file
53 ?command=addsubtitle&val=<uri>
55 > play playlist item <id>. If <id> is omitted, play last active item:
56 ?command=pl_play&id=<id>
58 > toggle pause. If current state was 'stop', play item <id>, if no <id> specified, play current item. If no current item, play 1st item in the playlist:
59 ?command=pl_pause&id=<id>
61 > resume playback if paused, else do nothing
62 ?command=pl_forceresume
64 > pause playback, do nothing if already paused
65 ?command=pl_forcepause
73 > jump to previous item:
76 > delete item <id> from playlist:
77 ?command=pl_delete&id=<id>
78 NOTA BENE: pl_delete is completly UNSUPPORTED
84 ?command=audiodelay&val=<delayinseconds>
87 ?command=subdelay&val=<delayinseconds>
89 > set playback rate. must be > 0
90 ?command=rate&val=<newplaybackrate>
92 > set aspect ratio. Must be one of the following values. Any other value will reset aspect ratio to default
93 ?command=aspectratio&val=<newratio>
94 Valid aspect ratio values: 1:1 , 4:3 , 5:4 , 16:9 , 16:10 , 221:100 , 235:100 , 239:100
96 > sort playlist using sort mode <val> and order <id>:
97 ?command=pl_sort&id=<id>&val=<val>
98 If id=0 then items will be sorted in normal order, if id=1 they will be
99 sorted in reverse order
100 A non exhaustive list of sort modes:
107 > toggle random playback:
119 > set volume level to <val> (can be absolute integer, percent or +/- relative value):
120 ?command=volume&val=<val>
121 Allowed values are of the form:
122 +<int>, -<int>, <int> or <int>%
125 ?command=seek&val=<val>
126 Allowed values are of the form:
127 [+ or -][<int><H or h>:][<int><M or m or '>:][<int><nothing or S or s or ">]
129 (value between [ ] are optional, value between < > are mandatory)
131 1000 -> seek to the 1000th second
132 +1H:2M -> seek 1 hour and 2 minutes forward
133 -10% -> seek 10% back
135 >command=preamp&val=<val in dB>
136 sets the preamp value, must be >=-20 and <=20
138 >command=equalizer&band=<band>&val=<gain in dB, must be >=-20 and <=20)
139 set the gain for a specific band
141 >command=enableeq&val=<0 or 1>
142 0 -- disables the equalizer
143 1 -- enables the equalizer
145 >command=setpreset&val=<presetid>
146 set the equalizer preset as per the id specified
148 <Displays the equalizer band gains.
149 Band 0: 60 Hz, 1: 170 Hz, 2: 310 Hz, 3: 600 Hz, 4: 1 kHz,
150 5: 3 kHz, 6: 6 kHz, 7: 12 kHz , 8: 14 kHz , 9: 16 kHz
152 <Display the list of presets available for the equalizer
155 Commands available from API version 2
159 ?command=title&val=<val>
162 ?command=title&val=<val>
164 > select the audio track (use the number from the stream)
165 ?command=audio_track&val=<val>
167 > select the video track (use the number from the stream)
168 ?command=video_track&val=<val>
170 > select the sibtitle track (use the number from the stream)
171 ?command=subtitle_track&val=<val>
173 playlist.xml or playlist.json:
175 < get the full playlist tree
177 NB: playlist_jstree.xml is used for the internal web client. It should not be relied upon by external remotes.
178 It may be removed without notice.
180 browse.xml or browse.json:
184 > get file list from uri. At the moment, only local file uris are supported
186 NB: uri is the preferred parameter. Dir is deprecated and may be removed in a future release.
188 > get <dir>'s filelist
192 < get the full list of VLM elements
196 < execute VLM command <cmd>
198 > get the error message from <cmd>