git.sesse.net Git - vlc/blob - share/http/requests/readme

   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  + -> %2B
  11  # -> %23
  12  space -> +
  13  ...
  14
  15 status.xml:
  16 ===========
  17 < Get VLC status information, current item info and meta.
  18
  19 > add <mrl> to playlist and start playback:
  20   ?command=in_play&input=<mrl>
  21
  22 > add <mrl> to playlist:
  23   ?command=in_enqueue&input=<mrl>
  24
  25 > play playlist item <id>:
  26   ?command=pl_play&id=<id>
  27
  28 > toggle pause. If current state was 'stop', play item <id>:
  29   ?command=pl_pause&id=<id>
  30
  31 > stop playback:
  32   ?command=pl_stop
  33
  34 > jump to next item:
  35   ?command=pl_next
  36
  37 > jump to previous item:
  38   ?command=pl_previous
  39
  40 > delete item <id> from playlist:
  41   ?command=pl_delete&id=<id>
  42
  43 > empty playlist:
  44   ?command=pl_empty
  45
  46 > sort playlist node <id> using sort mode <val>:
  47   ?command=pl_sort&id=<id>&val=<val>
  48
  49 > toggle random playback:
  50   ?command=pl_random
  51
  52 > toggle loop:
  53   ?command=pl_loop
  54
  55 > toggle repeat:
  56   ?command=pl_repeat
  57
  58 > toggle enable service discovery module <val>:
  59   ?command=pl_sd&val=<val>
  60
  61 > toggle fullscreen:
  62   ?command=fullscreen
  63
  64 > set volume level to <val> (can be absolute integer, percent or +/- relative value):
  65   ?command=volume&val=<val>
  66
  67 > seek to <val>:
  68   ?command=seek&val=<val>
  69
  70 playlist.xml:
  71 =============
  72 < get the full playlist tree
  73
  74 browse.xml:
  75 ===========
  76 < ?dir=<dir>
  77 > get <dir>'s filelist
  78
  79 vlm.xml:
  80 ========
  81 < get the full list of VLM elements
  82
  83 vlm_cmd.xml:
  84 ============
  85 < execute VLM command <cmd>
  86   ?command=<cmd>
  87 > get the error message from <cmd>