uk.co.caprica.vlcj.player.list

Interface MediaListPlayer

All Known Implementing Classes:

DefaultMediaListPlayer

public interface MediaListPlayer

Specification for a media list player component.

A media list player can be used with an embedded media player (without this a native video window will be opened when video is played). For example:

 MediaPlayerFactory mediaPlayerFactory = new MediaPlayerFactory();

 Canvas canvas = new Canvas();
 canvas.setBackground(Color.black);
 CanvasVideoSurface videoSurface = mediaPlayerFactory.newVideoSurface(canvas);

 EmbeddedMediaPlayer mediaPlayer = mediaPlayerFactory.newEmbeddedMediaPlayer();
 mediaPlayer.setVideoSurface(videoSurface);

 MediaListPlayer mediaListPlayer = mediaPlayerFactory.newMediaListPlayer();

 // Important: associate the media player with the media list player
 mediaListPlayer.setMediaPlayer(mediaPlayer);

 MediaList mediaList = mediaPlayerFactory.newMediaList();
 mediaList.addMedia("/movies/1.mp4");
 mediaList.addMedia("/movies/2.mp4");
 mediaList.addMedia("/movies/3.mp4");

 mediaListPlayer.setMediaList(mediaList);
 mediaListPlayer.setMode(MediaListPlayerMode.LOOP);

 mediaListPlayer.play();
 

Method Summary

Methods

Modifier and Type	Method and Description
void	addMediaListPlayerEventListener(MediaListPlayerEventListener listener) Add a component to be notified of media list player events.
void	enableEvents(int eventMask) Restrict the set of media list player events that generate event notifications to listeners.
MediaList	getMediaList() Get the media list.
boolean	isPlaying() Determine whether or not the media list is playing.
String	mrl(libvlc_media_t mediaInstance) Get the media resource locator for a media instance.
void	pause() Pause the media list.
void	play() Play the media list.
boolean	playItem(int itemIndex) Play a particular item on the media list.
void	playNext() Play the next item in the media list.
void	playPrevious() Play the previous item in the media list.
void	release() Release the media list player resources.
void	removeMediaListPlayerEventListener(MediaListPlayerEventListener listener) Remove a component that was previously interested in notifications of media list player events.
void	setMediaList(MediaList mediaList) Set the media list (i.e.
void	setMediaPlayer(MediaPlayer mediaPlayer) Associate an actual media player with the media list player.
void	setMode(MediaListPlayerMode mode) Set the media list play mode.
void	stop() Stop the media list.
Object	userData() Get the user data associated with the media player.
void	userData(Object userData) Set user data to associate with the media player.

Method Detail

addMediaListPlayerEventListener

void addMediaListPlayerEventListener(MediaListPlayerEventListener listener)

Add a component to be notified of media list player events.

Parameters:

listener - component to notify

removeMediaListPlayerEventListener

void removeMediaListPlayerEventListener(MediaListPlayerEventListener listener)

Remove a component that was previously interested in notifications of media list player events.

Parameters:

listener - component to stop notifying

enableEvents

void enableEvents(int eventMask)

Restrict the set of media list player events that generate event notifications to listeners.

If a set of events is not explicitly enabled, then it is expected that all events be enabled.

See MediaListPlayerEventType.

Parameters:

eventMask - bit mask of events to enable

setMediaPlayer

void setMediaPlayer(MediaPlayer mediaPlayer)

Associate an actual media player with the media list player.

Parameters:

mediaPlayer - media player

setMediaList

void setMediaList(MediaList mediaList)

Set the media list (i.e. the "play" list).

Parameters:

mediaList - media list

getMediaList

MediaList getMediaList()

Get the media list.

Returns:

media list

play

void play()

Play the media list.

pause

void pause()

Pause the media list.

stop

void stop()

Stop the media list.

playItem

boolean playItem(int itemIndex)

Play a particular item on the media list.

There is a bug in vlc that prevents proper operation of this method, and may cause a fatal JVM failure. This is resolved in vlc 2.0.2 and later.

Parameters:

itemIndex - index of the item to play

Returns:

true if the item could be played, otherwise false

playNext

void playNext()

Play the next item in the media list.

playPrevious

void playPrevious()

Play the previous item in the media list.

isPlaying

boolean isPlaying()

Determine whether or not the media list is playing.

Returns:

true if playing, otherwise false

setMode

void setMode(MediaListPlayerMode mode)

Set the media list play mode.

Note that if you set the play mode to REPEAT before you have played any media then play-back will never start.

Parameters:

mode - mode

mrl

String mrl(libvlc_media_t mediaInstance)

Get the media resource locator for a media instance.

The native media instance may be an automatically/scripted added sub-item.

Parameters:

mediaInstance - native media instance

Returns:

URL-encoded media resource locator

userData

Object userData()

Get the user data associated with the media player.

Returns:

user data

userData

void userData(Object userData)

Set user data to associate with the media player.

Parameters:

userData - user data

release

void release()

Release the media list player resources.