Change vlc.stream() and vlc.memory_stream() error reporting to behave like lua's...

[vlc] / share / lua / README.txt

diff --git a/share/lua/README.txt b/share/lua/README.txt
index f7e6283edb527b78efc7d5758fbcf23e986f57aa..dec466fe63ae902441be743559a44b97c4b956da 100644 (file)
--- a/share/lua/README.txt
+++ b/share/lua/README.txt
@@ -337,6 +337,9 @@ n:add_node( ... ): Same as sd.add_node(), but as a subnode of n.
 Stream
 ------
 stream( url ): Instantiate a stream object for specific url.
+memory_stream( string ): Instantiate a stream object containing a specific string.
+  Those two functions return the stream object upon success and nil if an
+  error occured, in that case, the second return value will be an error message.
 
 s = vlc.stream( "http://www.videolan.org/" )
 s:read( 128 ) -- read up to 128 characters. Return 0 if no more data is available (FIXME?).