LUA: Enable/Disable EQ, fix EQ input validation, and presets getter

[vlc] / share / lua / http / requests / README.txt

diff --git a/share/lua/http/requests/README.txt b/share/lua/http/requests/README.txt
index a327ff281be75f4695b6afbb48ec6585df4da898..8d21fe9366804b9cc46201d4cb62a0429cd542b4 100644 (file)
--- a/share/lua/http/requests/README.txt
+++ b/share/lua/http/requests/README.txt
@@ -13,9 +13,10 @@ Examples:
  space -> +
  ...
 
-status.xml:
+status.xml or status.json
 ===========
 < Get VLC status information, current item info and meta.
+< Get VLC version, and http api version
 
 > add <mrl> to playlist and start playback:
   ?command=in_play&input=<mrl>
@@ -46,6 +47,7 @@ status.xml:
 
 > delete item <id> from playlist:
   ?command=pl_delete&id=<id>
+  NOTA BENE: pl_delete is completly UNSUPPORTED
 
 > empty playlist:
   ?command=pl_empty
@@ -59,6 +61,10 @@ status.xml:
 > set playback rate. must be > 0
   ?command=rate&val=<newplaybackrate>
 
+> set aspect ratio. Must be one of the following values. Any other value will reset aspect ratio to default
+  ?command=aspectratio&val=<newratio>
+  Valid aspect ratio values: 1:1 , 4:3 , 5:4 , 16:9 , 16:10 , 221:100 , 235:100 , 239:100
+
 > sort playlist using sort mode <val> and order <id>:
   ?command=pl_sort&id=<id>&val=<val>
   If id=0 then items will be sorted in normal order, if id=1 they will be
@@ -106,6 +112,23 @@ status.xml:
     +1H:2M -> seek 1 hour and 2 minutes forward
     -10% -> seek 10% back
 
+>command=preamp&val=<val in dB>
+ sets the preamp value, must be >=-20 and <=20
+
+>command=equalizer&band=<band>&val=<gain in dB, must be >=-20 and <=20)
+ set the gain for a specific band
+
+>command=enableeq&val=<0 or 1>
+ 0 --  disables the equalizer
+ 1 --  enables the equalizer
+
+<Displays the equalizer band gains.
+Band 0: 60 Hz, 1: 170 Hz, 2: 310 Hz, 3: 600 Hz, 4: 1 kHz,
+5: 3 kHz, 6: 6 kHz, 7: 12 kHz , 8: 14 kHz , 9: 16 kHz
+
+<Display the list of presets available for the equalizer
+
+=======
 playlist.xml:
 =============
 < get the full playlist tree
@@ -125,7 +148,3 @@ vlm_cmd.xml:
   ?command=<cmd>
 > get the error message from <cmd>
 
-equalizer.xml:
-=============
->command=preamp&val=<val in dB> 
- sets the preamp value, must be >=-20 and <=20