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
  50 > empty playlist:
  51   ?command=pl_empty
  52
  53 > set audio delay
  54   ?command=audiodelay&val=<delayinseconds>
  55
  56 > set subtitle delay
  57   ?command=subdelay&val=<delayinseconds>
  58
  59 > set playback rate. must be > 0
  60   ?command=rate&val=<newplaybackrate>
  61
  62 > sort playlist using sort mode <val> and order <id>:
  63   ?command=pl_sort&id=<id>&val=<val>
  64   If id=0 then items will be sorted in normal order, if id=1 they will be
  65   sorted in reverse order
  66   A non exhaustive list of sort modes:
  67     0 Id
  68     1 Name
  69     3 Author
  70     5 Random
  71     7 Track number
  72
  73 > toggle random playback:
  74   ?command=pl_random
  75
  76 > toggle loop:
  77   ?command=pl_loop
  78
  79 > toggle repeat:
  80   ?command=pl_repeat
  81
  82 > toggle enable service discovery module <val>:
  83   ?command=pl_sd&val=<val>
  84   Typical values are:
  85     sap
  86     shoutcast
  87     podcast
  88     hal
  89
  90 > toggle fullscreen:
  91   ?command=fullscreen
  92
  93 > set volume level to <val> (can be absolute integer, percent or +/- relative value):
  94   ?command=volume&val=<val>
  95   Allowed values are of the form:
  96     +<int>, -<int>, <int> or <int>%
  97
  98 > seek to <val>:
  99   ?command=seek&val=<val>
 100   Allowed values are of the form:
 101     [+ or -][<int><H or h>:][<int><M or m or '>:][<int><nothing or S or s or ">]
 102     or [+ or -]<int>%
 103     (value between [ ] are optional, value between < > are mandatory)
 104   examples:
 105     1000 -> seek to the 1000th second
 106     +1H:2M -> seek 1 hour and 2 minutes forward
 107     -10% -> seek 10% back
 108
 109 playlist.xml:
 110 =============
 111 < get the full playlist tree
 112
 113 browse.xml:
 114 ===========
 115 < ?dir=<dir>
 116 > get <dir>'s filelist
 117
 118 vlm.xml:
 119 ========
 120 < get the full list of VLM elements
 121
 122 vlm_cmd.xml:
 123 ============
 124 < execute VLM command <cmd>
 125   ?command=<cmd>
 126 > get the error message from <cmd>