home *** CD-ROM | disk | FTP | other *** search
/ mail.altrad.com / 2015.02.mail.altrad.com.tar / mail.altrad.com / TEST / vlc-2-0-5-win32.exe / lua / http / requests / README.txt < prev    next >
Text File  |  2012-12-12  |  5KB  |  208 lines
  1. $Id$
  2.  
  3. This file describes commands available through the requests/ file:
  4.  
  5. Lines starting with < describe what the page sends back
  6. Lines starting with > describe what you can send to the page
  7.  
  8. All parameters need to be URL encoded.
  9. Examples:
  10.  # -> %23
  11.  % -> %25
  12.  + -> %2B
  13.  space -> +
  14.  ...
  15.  
  16.  
  17. Deprecation Notice:
  18. ---
  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
  23. ---
  24.  
  25. <root> (/)
  26. ===========
  27.  
  28.  
  29. > Get album art for current input:
  30.   /art  (NB: not /requests/art)
  31.  
  32. > Get album art for any playlist input (available from API version 3):
  33.   /art?item=123  (NB: not /requests/art)
  34.  
  35.  
  36. status.xml or status.json
  37. ===========
  38.  
  39.  
  40. < Get VLC status information, current item info and meta.
  41. < Get VLC version, and http api version
  42.  
  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:
  46.     noaudio
  47.     novideo
  48.  
  49. > add <uri> to playlist:
  50.   ?command=in_enqueue&input=<uri>
  51.  
  52. > add subtitle to currently playing file
  53.   ?command=addsubtitle&val=<uri>
  54.  
  55. > play playlist item <id>. If <id> is omitted, play last active item:
  56.   ?command=pl_play&id=<id>
  57.  
  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>
  60.  
  61. > resume playback if paused, else do nothing
  62.   ?command=pl_forceresume
  63.  
  64. > pause playback, do nothing if already paused
  65.   ?command=pl_forcepause
  66.  
  67. > stop playback:
  68.   ?command=pl_stop
  69.  
  70. > jump to next item:
  71.   ?command=pl_next
  72.  
  73. > jump to previous item:
  74.   ?command=pl_previous
  75.  
  76. > delete item <id> from playlist:
  77.   ?command=pl_delete&id=<id>
  78.   NOTA BENE: pl_delete is completly UNSUPPORTED
  79.  
  80. > empty playlist:
  81.   ?command=pl_empty
  82.  
  83. > set audio delay
  84.   ?command=audiodelay&val=<delayinseconds>
  85.  
  86. > set subtitle delay
  87.   ?command=subdelay&val=<delayinseconds>
  88.  
  89. > set playback rate. must be > 0
  90.   ?command=rate&val=<newplaybackrate>
  91.  
  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
  95.  
  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:
  101.     0 Id
  102.     1 Name
  103.     3 Author
  104.     5 Random
  105.     7 Track number
  106.  
  107. > toggle random playback:
  108.   ?command=pl_random
  109.  
  110. > toggle loop:
  111.   ?command=pl_loop
  112.  
  113. > toggle repeat:
  114.   ?command=pl_repeat
  115.  
  116. > toggle enable service discovery module <val>:
  117.   ?command=pl_sd&val=<val>
  118.   Typical values are:
  119.     sap
  120.     shoutcast
  121.     podcast
  122.     hal
  123.  
  124. > toggle fullscreen:
  125.   ?command=fullscreen
  126.  
  127. > set volume level to <val> (can be absolute integer, percent or +/- relative value):
  128.   ?command=volume&val=<val>
  129.   Allowed values are of the form:
  130.     +<int>, -<int>, <int> or <int>%
  131.  
  132. > seek to <val>:
  133.   ?command=seek&val=<val>
  134.   Allowed values are of the form:
  135.     [+ or -][<int><H or h>:][<int><M or m or '>:][<int><nothing or S or s or ">]
  136.     or [+ or -]<int>%
  137.     (value between [ ] are optional, value between < > are mandatory)
  138.   examples:
  139.     1000 -> seek to the 1000th second
  140.     +1H:2M -> seek 1 hour and 2 minutes forward
  141.     -10% -> seek 10% back
  142.  
  143. >command=preamp&val=<val in dB>
  144.  sets the preamp value, must be >=-20 and <=20
  145.  
  146. >command=equalizer&band=<band>&val=<gain in dB, must be >=-20 and <=20)
  147.  set the gain for a specific band
  148.  
  149. >command=enableeq&val=<0 or 1>
  150.  0 --  disables the equalizer
  151.  1 --  enables the equalizer
  152.  
  153. >command=setpreset&val=<presetid>
  154.  set the equalizer preset as per the id specified
  155.  
  156. <Displays the equalizer band gains.
  157. Band 0: 60 Hz, 1: 170 Hz, 2: 310 Hz, 3: 600 Hz, 4: 1 kHz,
  158. 5: 3 kHz, 6: 6 kHz, 7: 12 kHz , 8: 14 kHz , 9: 16 kHz
  159.  
  160. <Display the list of presets available for the equalizer
  161.  
  162. ---
  163. Commands available from API version 2
  164. ---
  165.  
  166. > select the title
  167.   ?command=title&val=<val>
  168.  
  169. > select the chapter
  170.   ?command=title&val=<val>
  171.  
  172. > select the audio track (use the number from the stream)
  173.   ?command=audio_track&val=<val>
  174.  
  175. > select the video track (use the number from the stream)
  176.   ?command=video_track&val=<val>
  177.  
  178. > select the sibtitle track (use the number from the stream)
  179.   ?command=subtitle_track&val=<val>
  180.  
  181. playlist.xml or playlist.json:
  182. =============
  183. < get the full playlist tree
  184.  
  185. NB: playlist_jstree.xml is used for the internal web client. It should not be relied upon by external remotes.
  186. It may be removed without notice.
  187.  
  188. browse.xml or browse.json:
  189. ===========
  190.  
  191. < ?dir=<uri>
  192. > get file list from uri. At the moment, only local file uris are supported
  193.  
  194. NB: uri is the preferred parameter. Dir is deprecated and may be removed in a future release.
  195. < ?dir=<dir>
  196. > get <dir>'s filelist
  197.  
  198. vlm.xml:
  199. ========
  200. < get the full list of VLM elements
  201.  
  202. vlm_cmd.xml:
  203. ============
  204. < execute VLM command <cmd>
  205.   ?command=<cmd>
  206. > get the error message from <cmd>
  207.  
  208.