~ubuntu-branches/ubuntu/maverick/vlc/maverick

« back to all changes in this revision

Viewing changes to share/lua/playlist/README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2008-09-17 21:56:14 UTC
  • mfrom: (1.1.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20080917215614-tj0vx8xzd57e52t8
Tags: 0.9.2-1ubuntu1
* New Upstream Release, exception granted by
    - dktrkranz, norsetto, Hobbsee (via irc). LP: #270404

Changes done in ubuntu:

* add libxul-dev to build-depends
* make sure that vlc is build against libxul in configure. This doesn't
  change anything in the package, but makes it more robust if building
  in an 'unclean' chroot or when modifying the package.
* debian/control: make Vcs-* fields point to the motumedia branch
* add libx264-dev and libass-dev to build-depends
  LP: #210354, #199870
* actually enable libass support by passing --enable-libass to configure
* enable libdca: add libdca-dev to build depends and --enable-libdca
* install the x264 plugin.

Changes already in the pkg-multimedia branch in debian:

* don't install usr/share/vlc/mozilla in debian/mozilla-plugin-vlc.install  
* new upstream .desktop file now registers flash video mimetype LP: #261567
* add Xb-Npp-Applications to mozilla-plugin-vlc
* remove duplicate entries in debian/vlc-nox.install

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Instructions to code your own VLC Lua playlist script.
 
2
$Id$
 
3
 
 
4
See lua/README.txt for generic documentation about Lua usage in VLC.
 
5
 
 
6
Examples: See dailymotion.lua, googlevideo.lua, metacafe.lua, youbtube.lua
 
7
          and youtube_homepage.lua .
 
8
 
 
9
VLC Lua playlist modules should define two functions:
 
10
 * probe(): returns true if we want to handle the playlist in this script
 
11
 * parse(): read the incoming data and return playlist item(s)
 
12
            Playlist items use the same format as that expected in the
 
13
            playlist.add() function (see general lua/README.txt)
 
14
 
 
15
VLC defines a global vlc object with the following members:
 
16
 * vlc.path: the URL string (without the leading http:// or file:// element)
 
17
 * vlc.access: the access used ("http" for http://, "file" for file://, etc.)
 
18
 * vlc.peek( <int> ): return the first <int> characters from the playlist file.
 
19
 * vlc.read( <int> ): read <int> characters from the playlist file.
 
20
                      THIS FUNCTION CANNOT BE USED IN peek().
 
21
 * vlc.readline(): return a new line of playlist data on each call.
 
22
                   THIS FUNCTION CANNOT BE USED IN peek().
 
23
 
 
24
Available VLC specific Lua modules: msg and strings. See lua/README.txt.