Module uk.co.caprica.vlcj

Package uk.co.caprica.vlcj.player.base

Class OneShotMediaPlayerEventListener

java.lang.Object

uk.co.caprica.vlcj.player.base.MediaPlayerEventAdapter

uk.co.caprica.vlcj.player.base.OneShotMediaPlayerEventListener

All Implemented Interfaces:

MediaPlayerEventListener

Direct Known Subclasses:

SynchronisedOneShotMediaPlayerEventListener

public abstract class OneShotMediaPlayerEventListener
extends MediaPlayerEventAdapter

Base implementation for a component that supports "one-shot" event listeners, i.e. event listeners attached to a media player instance that will remove themselves when an event of interest is fired.

A sub-class should override methods to implement the desired event behaviour, and from one or other of those methods it should invoke done(MediaPlayer) to cause the listener to be removed.

If is the event method implementations that decide if/when the event listener should be removed, so it may not strictly be one received event only - for example if a listener were added to trigger when the playback time reached five seconds, there would be multiple intermediate time changed events fired before the target time were reached.

Note that by default, the following methods will be implemented to invoke done(MediaPlayer), this behaviour can be overriden by sub-classes:

• stopped(MediaPlayer)
• finished(MediaPlayer)
• error(MediaPlayer)

Constructor Summary

Constructors

Constructor	Description
OneShotMediaPlayerEventListener()

Method Summary

Modifier and Type	Method	Description
void	error(MediaPlayer mediaPlayer)	An error occurred.
void	finished(MediaPlayer mediaPlayer)	Media finished playing (i.e.
void	stopped(MediaPlayer mediaPlayer)	Media stopped.

Methods inherited from class uk.co.caprica.vlcj.player.base.MediaPlayerEventAdapter

audioDeviceChanged, backward, buffering, chapterChanged, corked, elementaryStreamAdded, elementaryStreamDeleted, elementaryStreamSelected, forward, lengthChanged, mediaChanged, mediaPlayerReady, muted, opening, pausableChanged, paused, playing, positionChanged, scrambledChanged, seekableChanged, snapshotTaken, timeChanged, titleChanged, videoOutput, volumeChanged

Methods inherited from class java.lang.Object

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

Constructor Details

OneShotMediaPlayerEventListener

public OneShotMediaPlayerEventListener()

Method Details

stopped

public void stopped(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Media stopped.

A stopped event may be raised under certain circumstances even if the media player is not playing (e.g. as part of the associated media list player sub-item handling). Client applications must therefore be prepared to handle such a situation.

Specified by:

stopped in interface MediaPlayerEventListener

Overrides:

stopped in class MediaPlayerEventAdapter

Parameters:

mediaPlayer - media player that raised the event

finished

public void finished(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Media finished playing (i.e. the end was reached without being stopped).

Specified by:

finished in interface MediaPlayerEventListener

Overrides:

finished in class MediaPlayerEventAdapter

Parameters:

mediaPlayer - media player that raised the event

error

public void error(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

An error occurred.

Specified by:

error in interface MediaPlayerEventListener

Overrides:

error in class MediaPlayerEventAdapter

Parameters:

mediaPlayer - media player that raised the event