lua_osd: add some parameters to the osd.message function to allow the user to set...

[vlc] / share / lua / README.txt

diff --git a/share/lua/README.txt b/share/lua/README.txt
index 73dc2d54d858e369a87c3f1cd8c81033bceddcc6..c290621ad7e7c43c52131fc58d819661405089d0 100644 (file)
--- a/share/lua/README.txt
+++ b/share/lua/README.txt
@@ -231,7 +231,10 @@ OSD
 osd.icon( type, [id] ): Display an icon on the given OSD channel. Uses the
   default channel is none is given. Icon types are: "pause", "play",
   "speaker" and "mute".
-osd.message( string, [id] ): Display text message on the given OSD channel.
+osd.message( string, [id], [position], [duration]: Display the text message on
+  the given OSD channel. Position types are: "center", "left", "right", "top",
+  "bottom", "top-left", "top-right", "bottom-left" or "bottom-right". The
+  duration is set in microseconds.
 osd.slider( position, type, [id] ): Display slider. Position is an integer
   from 0 to 100. Type can be "horizontal" or "vertical".
 osd.channel_register(): Register a new OSD channel. Returns the channel id.