Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

Playlist
[Basic Components]


Detailed Description

loading and saving playlist file.

Supported format
Playlist formats supported for loading:

Playlist formats supported for saving:

Adding new playlist format:
The playlist module allows to add new playlist supported format :

function mypl_generic_loader(file) local name=read(file) return name and ( file=name } end filetype_add("playlist", "mypl", ".mypl.\0.mpl\0") playlist_add_loader("mypl", mypl_generic_loader)

Limitations
Playlist module could only save m3u playlist, since there is no generic save function nor saver table. It should be very easy to add it but it is not very useful !

Author:
benjamin gerard


Files

file  playlist.lua
 loading and saving playlist file.


Functions

 playlist_save (var fname, var dir)
 Save a playlist in basic m3u format.

 playlist_make_entry (var path, var entry)
 Make a playlist entry.

 playlist_load_generic (var path, var file, var read_entry)
 Load playlist generic function.

 playlist_load_m3u_entry (var file)
 Load a mu3 playlist entry.

 playlist_load_pls_entry (var file)
 Load a pls playlist entry.

 playlist_load (var fname)
 Load a playlist.

 playlist_add_loader (var minor, var loader)
 Reference a new playlist loader.


Variables

function playlist_loaders [minor]
 Referenced playlist loader table.


Function Documentation

playlist_save var  fname,
var  dir
 

Save a playlist in basic m3u format.

Parameters:
fname Playlist filename.
dir Table of entry { [file,] name [,path] }.
Returns:
error-code
Return values:
nil on error
1 on success

playlist_load var  fname  ) 
 

Load a playlist.

Parameters:
fname Playlist filename.
Returns:
error-code
Return values:
nil on error
1 on success

playlist_add_loader var  minor,
var  loader
 

Reference a new playlist loader.

The playlist_add_loader() functions add an entry to the playlist_loaders table indexed by minor with the loader function. playlist_loaders will be create if it does not exist.

Parameters:
minor Minor type name for this playlist type.
loader Playlist load entry function.
Returns:
error-code
Return values:
nil,on error.
1,on success.


Variable Documentation

function playlist_loaders[minor]
 

Referenced playlist loader table.

The playlist_loader table references all playlist type that could be load. The table is indexed by minor filetype and contains the loader function for that type.

The loader function get a file as parameter and returns the next entry read in file.


dcplaya documentation version 2.0 Generated on November 2004 by doxygen 1.3.6