org.videolan.jvlc
Interface PlaylistIntf

All Known Implementing Classes:

Playlist

public interface PlaylistIntf

Method Summary

int	add(java.lang.String uri, java.lang.String name) TODO: document the kind of items that can be added.
void	addExtended() Currently not implemented
void	clear() Clear the playlist which becomes empty after this call.
boolean	isRunning() This function returns true if the current item has not been stopped.
int	itemsCount() TODO: this should return the number of items added with add, with no respect to videolan internal playlist.
void	next() Move to next item in the playlist and play it.
void	play() Plays the current item in the playlist.
void	play(int id, java.lang.String[] options) Plays the item specified in id, with options.
void	prev() Move to previous item in the playlist and play it.
void	setPause(boolean pause) Pauses the currently playing item if pause value is true.
void	stop() Stops the currently playing item.
void	togglePause() Toggles pause for the current item.

Method Detail

play

void play(int id,
          java.lang.String[] options)
          throws VLCException

Plays the item specified in id, with options. At the moment options has no effect and can be safely set to null.

Parameters:

id - The ID to play

options - Options to play the item with

Throws:

VLCException

play

void play()
          throws VLCException

Plays the current item in the playlist.

Throws:

VLCException

togglePause

void togglePause()
                 throws VLCException

Toggles pause for the current item.

Throws:

VLCException

setPause

void setPause(boolean pause)
              throws VLCException

Pauses the currently playing item if pause value is true. Plays it otherwise. If you set pause to true and the current item is already playing, this has no effect.

Parameters:

pause -

Throws:

VLCException

stop

void stop()
          throws VLCException

Stops the currently playing item. Differently from pause, stopping an item destroys any information related to the item.

Throws:

VLCException

isRunning

boolean isRunning()
                  throws VLCException

This function returns true if the current item has not been stopped.

Returns:

True if the current item has not been stopped

Throws:

VLCException

itemsCount

int itemsCount()
               throws VLCException

TODO: this should return the number of items added with add, with no respect to videolan internal playlist. Returns the number of items in the playlist. Beware that this number could be bigger than the number of times add() has been called.

Returns:

Current number of items in the playlist

Throws:

VLCException

next

void next()
          throws VLCException

Move to next item in the playlist and play it.

Throws:

VLCException

prev

void prev()
          throws VLCException

Move to previous item in the playlist and play it.

Throws:

VLCException

clear

void clear()
           throws VLCException

Clear the playlist which becomes empty after this call.

Throws:

VLCException

add

int add(java.lang.String uri,
        java.lang.String name)
        throws VLCException

TODO: document the kind of items that can be added. Add a new item in the playlist.

Parameters:

uri - Location of the item

name - Name of the item

Returns:

The item ID

Throws:

VLCException

addExtended

void addExtended()

Currently not implemented