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>:
  30   ?command=pl_pause&id=<id>
  31
  32 > stop playback:
  33   ?command=pl_stop
  34
  35 > jump to next item:
  36   ?command=pl_next
  37
  38 > jump to previous item:
  39   ?command=pl_previous
  40
  41 > delete item <id> from playlist:
  42   ?command=pl_delete&id=<id>
  43
  44 > empty playlist:
  45   ?command=pl_empty
  46
  47 > sort playlist using sort mode <val> and order <id>:
  48   ?command=pl_sort&id=<id>&val=<val>
  49   If id=0 then items will be sorted in normal order, if id=1 they will be
  50   sorted in reverse order
  51   A non exhaustive list of sort modes:
  52     0 Id
  53     1 Name
  54     3 Author
  55     5 Random
  56     7 Track number
  57
  58 > toggle random playback:
  59   ?command=pl_random
  60
  61 > toggle loop:
  62   ?command=pl_loop
  63
  64 > toggle repeat:
  65   ?command=pl_repeat
  66
  67 > toggle enable service discovery module <val>:
  68   ?command=pl_sd&val=<val>
  69   Typical values are:
  70     sap
  71     shoutcast
  72     podcast
  73     hal
  74
  75 > toggle fullscreen:
  76   ?command=fullscreen
  77
  78 > set volume level to <val> (can be absolute integer, percent or +/- relative value):
  79   ?command=volume&val=<val>
  80   Allowed values are of the form:
  81     +<int>, -<int>, <int> or <int>%
  82
  83 > seek to <val>:
  84   ?command=seek&val=<val>
  85   Allowed values are of the form:
  86     [+ or -][<int><H or h>:][<int><M or m or '>:][<int><nothing or S or s or ">]
  87     or [+ or -]<int>%
  88     (value between [ ] are optional, value between < > are mandatory)
  89   examples:
  90     1000 -> seek to the 1000th second
  91     +1H:2M -> seek 1 hour and 2 minutes forward
  92     -10% -> seek 10% back
  93
  94 playlist.xml:
  95 =============
  96 < get the full playlist tree
  97
  98 browse.xml:
  99 ===========
 100 < ?dir=<dir>
 101 > get <dir>'s filelist
 102
 103 vlm.xml:
 104 ========
 105 < get the full list of VLM elements
 106
 107 vlm_cmd.xml:
 108 ============
 109 < execute VLM command <cmd>
 110   ?command=<cmd>
 111 > get the error message from <cmd>