Module uk.co.caprica.vlcj

Package uk.co.caprica.vlcj.player.component

Class AudioPlayerComponent

java.lang.Object

uk.co.caprica.vlcj.player.component.AudioPlayerComponent

All Implemented Interfaces:

MediaEventListener, MediaPlayerEventListener, MediaPlayerComponent

Direct Known Subclasses:

AudioListPlayerComponent

public class AudioPlayerComponent
extends Object
implements MediaPlayerComponent

Implementation of an audio player.

When the component is no longer needed, it should be released by invoking the release() method.

Constructor Summary

Constructors

Constructor	Description
AudioPlayerComponent()	Construct a media player component with reasonable defaults.
AudioPlayerComponent(MediaPlayerFactory mediaPlayerFactory)	Construct a media player component.
AudioPlayerComponent(MediaPlayerSpecs.AudioPlayerSpec spec)	Construct a media player component from a builder.

Method Summary

Modifier and Type	Method	Description
void	audioDeviceChanged(MediaPlayer mediaPlayer, String audioDevice)	The audio device changed.
void	backward(MediaPlayer mediaPlayer)	Media skipped backward.
void	buffering(MediaPlayer mediaPlayer, float newCache)	Buffering media.
void	chapterChanged(MediaPlayer mediaPlayer, int newChapter)	The chapter changed.
void	corked(MediaPlayer mediaPlayer, boolean corked)	The media player was corked/un-corked.
void	elementaryStreamAdded(MediaPlayer mediaPlayer, TrackType type, int id)	An elementary stream was added.
void	elementaryStreamDeleted(MediaPlayer mediaPlayer, TrackType type, int id)	An elementary stream was deleted.
void	elementaryStreamSelected(MediaPlayer mediaPlayer, TrackType type, int id)	An elementary stream was selected.
void	error(MediaPlayer mediaPlayer)	An error occurred.
void	finished(MediaPlayer mediaPlayer)	Media finished playing (i.e.
void	forward(MediaPlayer mediaPlayer)	Media skipped forward.
void	lengthChanged(MediaPlayer mediaPlayer, long newLength)	Media length changed.
void	mediaChanged(MediaPlayer mediaPlayer, MediaRef media)	The media changed.
void	mediaDurationChanged(Media media, long newDuration)	The current media duration changed.
void	mediaFreed(Media media, MediaRef mediaFreed)	The current media was freed.
void	mediaMetaChanged(Media media, Meta metaType)	Current media meta data changed.
void	mediaParsedChanged(Media media, MediaParsedStatus newStatus)	The current media parsed status changed.
final MediaPlayer	mediaPlayer()	Get the media player reference.
final MediaPlayerFactory	mediaPlayerFactory()	Get the media player factory that was used to create the media player component.
void	mediaPlayerReady(MediaPlayer mediaPlayer)	Media player is ready (to enable features like logo and marquee) after the media has started playing.
void	mediaStateChanged(Media media, State newState)	The current media state changed.
void	mediaSubItemAdded(Media media, MediaRef newChild)	A new sub-item was added to the current media.
void	mediaSubItemTreeAdded(Media media, MediaRef item)	A sub-item tree was added to the media.
void	mediaThumbnailGenerated(Media media, Picture picture)
void	muted(MediaPlayer mediaPlayer, boolean muted)	The audio was muted/un-muted.
void	opening(MediaPlayer mediaPlayer)	Opening the media.
void	pausableChanged(MediaPlayer mediaPlayer, int newSeekable)	Media pausable status changed.
void	paused(MediaPlayer mediaPlayer)	Media paused.
void	playing(MediaPlayer mediaPlayer)	The media started playing.
void	positionChanged(MediaPlayer mediaPlayer, float newPosition)	Media play-back position changed.
final void	release()	Release the media player component and the associated native media player resources.
void	scrambledChanged(MediaPlayer mediaPlayer, int newScrambled)	Program scrambled changed.
void	seekableChanged(MediaPlayer mediaPlayer, int newSeekable)	Media seekable status changed.
void	snapshotTaken(MediaPlayer mediaPlayer, String filename)	A snapshot was taken.
void	stopped(MediaPlayer mediaPlayer)	Media stopped.
void	timeChanged(MediaPlayer mediaPlayer, long newTime)	Media play-back time changed.
void	titleChanged(MediaPlayer mediaPlayer, int newTitle)	Media title changed.
void	videoOutput(MediaPlayer mediaPlayer, int newCount)	The number of video outputs changed.
void	volumeChanged(MediaPlayer mediaPlayer, float volume)	The volume changed.

Methods inherited from class java.lang.Object

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

Constructor Details

AudioPlayerComponent

public AudioPlayerComponent(MediaPlayerFactory mediaPlayerFactory)

Construct a media player component.

Any constructor parameter may be null, in which case a reasonable default will be used.

Parameters:

mediaPlayerFactory - media player factory

AudioPlayerComponent

public AudioPlayerComponent(MediaPlayerSpecs.AudioPlayerSpec spec)

Construct a media player component from a builder.

Parameters:

spec - builder

AudioPlayerComponent

public AudioPlayerComponent()

Construct a media player component with reasonable defaults.

Method Details

mediaPlayer

public final MediaPlayer mediaPlayer()

Get the media player reference.

An application uses this handle to control the media player, add listeners and so on.

Returns:

media player

release

public final void release()

Release the media player component and the associated native media player resources.

mediaPlayerFactory

public final MediaPlayerFactory mediaPlayerFactory()

Description copied from interface: MediaPlayerComponent

Get the media player factory that was used to create the media player component.

If the client application did not suppl a media player factory when creating the component, then the component is the "owner" of the returned factory instance. A client application must not releasse the factory in this case.

If a client application did supply the factory, then the client application is wholly responsible for the correct life-cycle of that factory and should release it at the appropriate time.

Specified by:

mediaPlayerFactory in interface MediaPlayerComponent

Returns:

factory

mediaChanged

public void mediaChanged(MediaPlayer mediaPlayer,
 MediaRef media)

Description copied from interface: MediaPlayerEventListener

The media changed.

Specified by:

mediaChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

media - new media instance

opening

public void opening(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Opening the media.

Specified by:

opening in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

buffering

public void buffering(MediaPlayer mediaPlayer,
 float newCache)

Description copied from interface: MediaPlayerEventListener

Buffering media.

Specified by:

buffering in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newCache - percentage complete, ranging from 0.0 to 100.0

playing

public void playing(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

The media started playing.

There is no guarantee that a video output has been created at this point.

Specified by:

playing in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

paused

public void paused(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Media paused.

Specified by:

paused in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

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

Parameters:

mediaPlayer - media player that raised the event

forward

public void forward(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Media skipped forward.

Specified by:

forward in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

backward

public void backward(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Media skipped backward.

Specified by:

backward in interface MediaPlayerEventListener

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

Parameters:

mediaPlayer - media player that raised the event

timeChanged

public void timeChanged(MediaPlayer mediaPlayer,
 long newTime)

Description copied from interface: MediaPlayerEventListener

Media play-back time changed.

Specified by:

timeChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newTime - new time

positionChanged

public void positionChanged(MediaPlayer mediaPlayer,
 float newPosition)

Description copied from interface: MediaPlayerEventListener

Media play-back position changed.

Specified by:

positionChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newPosition - percentage between 0.0 and 1.0

seekableChanged

public void seekableChanged(MediaPlayer mediaPlayer,
 int newSeekable)

Description copied from interface: MediaPlayerEventListener

Media seekable status changed.

Specified by:

seekableChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newSeekable - new seekable status

pausableChanged

public void pausableChanged(MediaPlayer mediaPlayer,
 int newSeekable)

Description copied from interface: MediaPlayerEventListener

Media pausable status changed.

Specified by:

pausableChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newSeekable - new pausable status

titleChanged

public void titleChanged(MediaPlayer mediaPlayer,
 int newTitle)

Description copied from interface: MediaPlayerEventListener

Media title changed.

Specified by:

titleChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newTitle - new title

snapshotTaken

public void snapshotTaken(MediaPlayer mediaPlayer,
 String filename)

Description copied from interface: MediaPlayerEventListener

A snapshot was taken.

Specified by:

snapshotTaken in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

filename - name of the file containing the snapshot

lengthChanged

public void lengthChanged(MediaPlayer mediaPlayer,
 long newLength)

Description copied from interface: MediaPlayerEventListener

Media length changed.

Specified by:

lengthChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newLength - new length (number of milliseconds)

videoOutput

public void videoOutput(MediaPlayer mediaPlayer,
 int newCount)

Description copied from interface: MediaPlayerEventListener

The number of video outputs changed.

Specified by:

videoOutput in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newCount - new number of video outputs

scrambledChanged

public void scrambledChanged(MediaPlayer mediaPlayer,
 int newScrambled)

Description copied from interface: MediaPlayerEventListener

Program scrambled changed.

Specified by:

scrambledChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newScrambled - new scrambled value

elementaryStreamAdded

public void elementaryStreamAdded(MediaPlayer mediaPlayer,
 TrackType type,
 int id)

Description copied from interface: MediaPlayerEventListener

An elementary stream was added.

Specified by:

elementaryStreamAdded in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

type - type of stream

id - identifier of stream

elementaryStreamDeleted

public void elementaryStreamDeleted(MediaPlayer mediaPlayer,
 TrackType type,
 int id)

Description copied from interface: MediaPlayerEventListener

An elementary stream was deleted.

Specified by:

elementaryStreamDeleted in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

type - type of stream

id - identifier of stream

elementaryStreamSelected

public void elementaryStreamSelected(MediaPlayer mediaPlayer,
 TrackType type,
 int id)

Description copied from interface: MediaPlayerEventListener

An elementary stream was selected.

Specified by:

elementaryStreamSelected in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

type - type of stream

id - identifier of stream

corked

public void corked(MediaPlayer mediaPlayer,
 boolean corked)

Description copied from interface: MediaPlayerEventListener

The media player was corked/un-corked.

Corking/un-corking can occur e.g. when another media player (or some other application) starts/stops playing media.

Specified by:

corked in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

corked - true if corked; otherwise false

muted

public void muted(MediaPlayer mediaPlayer,
 boolean muted)

Description copied from interface: MediaPlayerEventListener

The audio was muted/un-muted.

Specified by:

muted in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

muted - true if muted; otherwise false

volumeChanged

public void volumeChanged(MediaPlayer mediaPlayer,
 float volume)

Description copied from interface: MediaPlayerEventListener

The volume changed.

Specified by:

volumeChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

volume - new volume

audioDeviceChanged

public void audioDeviceChanged(MediaPlayer mediaPlayer,
 String audioDevice)

Description copied from interface: MediaPlayerEventListener

The audio device changed.

Specified by:

audioDeviceChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

audioDevice - new audio device

chapterChanged

public void chapterChanged(MediaPlayer mediaPlayer,
 int newChapter)

Description copied from interface: MediaPlayerEventListener

The chapter changed.

Specified by:

chapterChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newChapter - new chapter

error

public void error(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

An error occurred.

Specified by:

error in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

mediaPlayerReady

public void mediaPlayerReady(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

Media player is ready (to enable features like logo and marquee) after the media has started playing.

The implementation will fire this event once on receipt of the first native position-changed event with a position value greater than zero.

The event will be fired again if the media is played again after a native stopped or finished event is received.

Waiting for this event may be more reliable than using MediaPlayerEventListener.playing(MediaPlayer) or MediaPlayerEventListener.videoOutput(MediaPlayer, int) in some cases (logo and marquee already mentioned, also setting audio tracks, sub-title tracks and so on).

Specified by:

mediaPlayerReady in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

mediaMetaChanged

public void mediaMetaChanged(Media media,
 Meta metaType)

Description copied from interface: MediaEventListener

Current media meta data changed.

Specified by:

mediaMetaChanged in interface MediaEventListener

Parameters:

media - media that raised the event

metaType - type of meta data that changed

mediaSubItemAdded

public void mediaSubItemAdded(Media media,
 MediaRef newChild)

Description copied from interface: MediaEventListener

A new sub-item was added to the current media.

Specified by:

mediaSubItemAdded in interface MediaEventListener

Parameters:

media - media that raised the event

newChild - native sub-item handle

mediaDurationChanged

public void mediaDurationChanged(Media media,
 long newDuration)

Description copied from interface: MediaEventListener

The current media duration changed.

Specified by:

mediaDurationChanged in interface MediaEventListener

Parameters:

media - media that raised the event

newDuration - new duration (number of milliseconds)

mediaParsedChanged

public void mediaParsedChanged(Media media,
 MediaParsedStatus newStatus)

Description copied from interface: MediaEventListener

The current media parsed status changed.

Specified by:

mediaParsedChanged in interface MediaEventListener

Parameters:

media - media that raised the event

newStatus - new parsed status

mediaFreed

public void mediaFreed(Media media,
 MediaRef mediaFreed)

Description copied from interface: MediaEventListener

The current media was freed.

Specified by:

mediaFreed in interface MediaEventListener

Parameters:

media - media that raised the event

mediaStateChanged

public void mediaStateChanged(Media media,
 State newState)

Description copied from interface: MediaEventListener

The current media state changed.

Specified by:

mediaStateChanged in interface MediaEventListener

Parameters:

media - media that raised the event

newState - new state

mediaSubItemTreeAdded

public void mediaSubItemTreeAdded(Media media,
 MediaRef item)

Description copied from interface: MediaEventListener

A sub-item tree was added to the media.

Specified by:

mediaSubItemTreeAdded in interface MediaEventListener

Parameters:

media - media that raised the event

item - media item

mediaThumbnailGenerated

public void mediaThumbnailGenerated(Media media,
 Picture picture)

Specified by:

mediaThumbnailGenerated in interface MediaEventListener