Class Xmms::Playlist
In: rb_xmmsclient_main.c
Parent: Object

call-seq:

 pl.add_collection(coll [, order]) -> result

Adds the collection coll to the playlist.

Methods

add_collection   add_entry   clear   current_pos   entries   insert_entry   load   move_entry   name   new   radd   remove   remove_entry   rinsert   shuffle   sort  

Classes and Modules

Class Xmms::Playlist::ClientError
Class Xmms::Playlist::DisconnectedError
Class Xmms::Playlist::PlaylistError

Constants

ACTIVE_NAME = INT2FIX (XMMS_ACTIVE_PLAYLIST)

Public Class methods

call-seq:

 pl = Xmms::Playlist.new(xc, [name])

Initializes a new Xmms::Playlist using the playlist named name and the Xmms::Client instance xc. Xmms::Client#playlist(name) is a useful shortcut. name is is the name of the playlist and the active playlist will be used if it is not specified. Raises PlaylistError if the playlist name is invalid.

Public Instance methods

Adds the collection coll to the playlist.

Adds an entry to the playlist. arg can be either a URL or an id.

Clears the playlist.

Retrieves the current position of the playlist. May raise an Xmms::Result::ValueError exception if the current position is undefined.

Retrieves an array containing ids for each position of the playlist.

Inserts an entry to the current playlist at position pos in the playlist. arg can be either a URL or an id.

Loads the playlist as the current active playlist.

Moves the entry at current_pos to new_pos in the playlist.

call-seq:

 pl.name -> string

Returns the name of the playlist in the medialib as a String.

Recursively imports all media files under path to the playlist.

Removes the playlist from the medialib.

Removes the entry at pos from the playlist.

Recursively imports all media files under path at position pos in the playlist.

Shuffles the playlist.

Sorts the playlist on properties, which is an array of medialib properties such as [“title”, “artist”].

[Validate]