git.sesse.net Git - vlc/blob - share/lua/http/requests/README.txt

   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 status.xml:
  17 ===========
  18 < Get VLC status information, current item info and meta.
  19
  20 > add <mrl> to playlist and start playback:
  21   ?command=in_play&input=<mrl>
  22
  23 > add <mrl> to playlist:
  24   ?command=in_enqueue&input=<mrl>
  25
  26 > play playlist item <id>. If <id> is omitted, play last active item:
  27   ?command=pl_play&id=<id>
  28
  29 > 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:
  30   ?command=pl_pause&id=<id>
  31
  32 > resume playback if paused, else do nothing
  33   ?command=pl_forceresume
  34
  35 > pause playback, do nothing if already paused
  36   ?command=pl_forcepause
  37
  38 > stop playback:
  39   ?command=pl_stop
  40
  41 > jump to next item:
  42   ?command=pl_next
  43
  44 > jump to previous item:
  45   ?command=pl_previous
  46
  47 > delete item <id> from playlist:
  48   ?command=pl_delete&id=<id>
  49   NOTA BENE: pl_delete is completly UNSUPPORTED
  50
  51 > empty playlist:
  52   ?command=pl_empty
  53
  54 > set audio delay
  55   ?command=audiodelay&val=<delayinseconds>
  56
  57 > set subtitle delay
  58   ?command=subdelay&val=<delayinseconds>
  59
  60 > set playback rate. must be > 0
  61   ?command=rate&val=<newplaybackrate>
  62
  63 > sort playlist using sort mode <val> and order <id>:
  64   ?command=pl_sort&id=<id>&val=<val>
  65   If id=0 then items will be sorted in normal order, if id=1 they will be
  66   sorted in reverse order
  67   A non exhaustive list of sort modes:
  68     0 Id
  69     1 Name
  70     3 Author
  71     5 Random
  72     7 Track number
  73
  74 > toggle random playback:
  75   ?command=pl_random
  76
  77 > toggle loop:
  78   ?command=pl_loop
  79
  80 > toggle repeat:
  81   ?command=pl_repeat
  82
  83 > toggle enable service discovery module <val>:
  84   ?command=pl_sd&val=<val>
  85   Typical values are:
  86     sap
  87     shoutcast
  88     podcast
  89     hal
  90
  91 > toggle fullscreen:
  92   ?command=fullscreen
  93
  94 > set volume level to <val> (can be absolute integer, percent or +/- relative value):
  95   ?command=volume&val=<val>
  96   Allowed values are of the form:
  97     +<int>, -<int>, <int> or <int>%
  98
  99 > seek to <val>:
 100   ?command=seek&val=<val>
 101   Allowed values are of the form:
 102     [+ or -][<int><H or h>:][<int><M or m or '>:][<int><nothing or S or s or ">]
 103     or [+ or -]<int>%
 104     (value between [ ] are optional, value between < > are mandatory)
 105   examples:
 106     1000 -> seek to the 1000th second
 107     +1H:2M -> seek 1 hour and 2 minutes forward
 108     -10% -> seek 10% back
 109
 110 playlist.xml:
 111 =============
 112 < get the full playlist tree
 113
 114 browse.xml:
 115 ===========
 116 < ?dir=<dir>
 117 > get <dir>'s filelist
 118
 119 vlm.xml:
 120 ========
 121 < get the full list of VLM elements
 122
 123 vlm_cmd.xml:
 124 ============
 125 < execute VLM command <cmd>
 126   ?command=<cmd>
 127 > get the error message from <cmd>
 128
 129 equalizer.xml:
 130 =============
 131 >command=preamp&val=<val in dB>
 132  sets the preamp value, must be >=-20 and <=20
 133
 134 >command=equalizer&band=<band>&val=<gain in dB, must be >=-20 and <=20)
 135
 136 <Displays the equalizer band gains.
 137 Band 0: 60 Hz, 1: 170 Hz, 2: 310 Hz, 3: 600 Hz, 4: 1 kHz,
 138 5: 3 kHz, 6: 6 kHz, 7: 12 kHz , 8: 14 kHz , 9: 16 kHz