Package uk.co.caprica.vlcj.medialist

Class MediaList

java.lang.Object

uk.co.caprica.vlcj.medialist.MediaList

public class MediaList
extends Object

A media list (i.e. a play-list).

To do anything more advanced than the functionality provided by this class, the underlying native media list instance is accessible via mediaListInstance.

Constructor Summary

Constructors

Constructor	Description
MediaList(LibVlc libvlc, libvlc_instance_t instance)	Create a new media list.
MediaList(LibVlc libvlc, libvlc_instance_t instance, libvlc_media_list_t mediaListInstance)	Create a media list for a given native media list instance.

Method Summary

Modifier and Type	Method	Description
void	addMedia(String mrl, String... mediaOptions)	Add a media item, with options, to the play-list.
void	addMediaListEventListener(MediaListEventListener listener)	Add a component to be notified of media list events.
void	clear()	Clear the list.
void	insertMedia(int index, String mrl, String... mediaOptions)	Insert a media item, with options, to the play-list.
boolean	isReadOnly()	Test if the play-list is read-only.
List<MediaListItem>	items()	Get the list of items.
libvlc_media_list_t	mediaListInstance()	Get the native media list instance handle.
void	release()	Clean up media list resources.
void	removeListEventListener(MediaListEventListener listener)	Remove a component previously added so that it no longer receives media list events.
void	removeMedia(int index)	Remove a media item from the play-list.
void	setStandardMediaOptions(String... standardMediaOptions)	Set standard media options for all media items subsequently played.
int	size()	Get the number of items currently in the list.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MediaList

public MediaList(LibVlc libvlc,
                 libvlc_instance_t instance)

Create a new media list.

Parameters:

libvlc - native interface

instance - native library instance

MediaList

public MediaList(LibVlc libvlc,
                 libvlc_instance_t instance,
                 libvlc_media_list_t mediaListInstance)

Create a media list for a given native media list instance.

Parameters:

libvlc - native interface

instance - native library instance

mediaListInstance - media list instance

Method Detail

addMediaListEventListener

public final void addMediaListEventListener(MediaListEventListener listener)

Add a component to be notified of media list events.

Parameters:

listener - component to add

removeListEventListener

public final void removeListEventListener(MediaListEventListener listener)

Remove a component previously added so that it no longer receives media list events.

Parameters:

listener - component to remove

setStandardMediaOptions

public final void setStandardMediaOptions(String... standardMediaOptions)

Set standard media options for all media items subsequently played.

This will not affect any currently playing media item.

Parameters:

standardMediaOptions - options to apply to all subsequently played media items

addMedia

public final void addMedia(String mrl,
                           String... mediaOptions)

Add a media item, with options, to the play-list.

Parameters:

mrl - media resource locator

mediaOptions - zero or more media item options

insertMedia

public final void insertMedia(int index,
                              String mrl,
                              String... mediaOptions)

Insert a media item, with options, to the play-list.

Parameters:

index - position at which to insert the media item (counting from zero)

mrl - media resource locator

mediaOptions - zero or more media item options

removeMedia

public final void removeMedia(int index)

Remove a media item from the play-list.

Parameters:

index - item to remove (counting from zero)

clear

public final void clear()

Clear the list.

size

public final int size()

Get the number of items currently in the list.

Returns:

item count

isReadOnly

public final boolean isReadOnly()

Test if the play-list is read-only.

Returns:

true if the play-list is currently read-only, otherwise false

items

public final List<MediaListItem> items()

Get the list of items.

Returns:

list of items

release

public final void release()

Clean up media list resources.

mediaListInstance

public final libvlc_media_list_t mediaListInstance()

Get the native media list instance handle.

Returns:

native media list handle