uk.co.caprica.vlcj.component

Class DirectAudioPlayerComponent

java.lang.Object

uk.co.caprica.vlcj.component.DirectAudioPlayerComponent

All Implemented Interfaces:

AudioCallback, MediaPlayerEventListener

public class DirectAudioPlayerComponent
extends Object
implements MediaPlayerEventListener, AudioCallback

Encapsulation of a direct audio player.

Constructor Summary

Constructors

Constructor and Description
DirectAudioPlayerComponent(String format, int rate, int channels) Create a direct audio player component.

Method Summary

Methods

Modifier and Type	Method and Description
void	backward(MediaPlayer mediaPlayer) Media skipped backward.
void	buffering(MediaPlayer mediaPlayer, float newCache) Buffering media.
void	drain(DirectAudioPlayer mediaPlayer) Audio buffer was drained.
void	endOfSubItems(MediaPlayer mediaPlayer) The end of the media sub-items was reached.
void	error(MediaPlayer mediaPlayer) An error occurred.
void	finished(MediaPlayer mediaPlayer) Media finished playing (i.e.
void	flush(DirectAudioPlayer mediaPlayer, long pts) Audio buffer was flushed.
void	forward(MediaPlayer mediaPlayer) Media skipped forward.
DirectAudioPlayer	getMediaPlayer() Get the direct audio player reference.
MediaPlayerFactory	getMediaPlayerFactory() Get the media player factory reference.
void	lengthChanged(MediaPlayer mediaPlayer, long newLength) Media length changed.
void	mediaChanged(MediaPlayer mediaPlayer, libvlc_media_t media, String mrl) The media changed.
void	mediaDurationChanged(MediaPlayer mediaPlayer, long newDuration) The current media duration changed.
void	mediaFreed(MediaPlayer mediaPlayer) The current media was freed.
void	mediaMetaChanged(MediaPlayer mediaPlayer, int metaType) Current media meta data changed.
void	mediaParsedChanged(MediaPlayer mediaPlayer, int newStatus) The current media parsed status changed.
void	mediaStateChanged(MediaPlayer mediaPlayer, int newState) The current media state changed.
void	mediaSubItemAdded(MediaPlayer mediaPlayer, libvlc_media_t subItem) A new sub-item was added to the current media.
void	newMedia(MediaPlayer mediaPlayer) New media was opened.
void	opening(MediaPlayer mediaPlayer) Opening the media.
void	pausableChanged(MediaPlayer mediaPlayer, int newPausable) Media pausable status changed.
void	pause(DirectAudioPlayer mediaPlayer, long pts) Audio was paused.
void	paused(MediaPlayer mediaPlayer) Media paused.
void	play(DirectAudioPlayer mediaPlayer, com.sun.jna.Pointer samples, int sampleCount, long pts) Play samples.
void	playing(MediaPlayer mediaPlayer) The media started playing.
void	positionChanged(MediaPlayer mediaPlayer, float newPosition) Media play-back position changed.
void	release() Release the media player component and the associated native media player resources.
void	release(boolean releaseFactory) Release the media player component and the associated media player factory.
void	resume(DirectAudioPlayer mediaPlayer, long pts) Audio was resumed.
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	subItemFinished(MediaPlayer mediaPlayer, int subItemIndex) A sub-item finished playing.
void	subItemPlayed(MediaPlayer mediaPlayer, int subItemIndex) A sub-item was played.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectAudioPlayerComponent

public DirectAudioPlayerComponent(String format,
                          int rate,
                          int channels)

Create a direct audio player component.

Parameters:

format - decoded audio buffer format

rate - decoded audio rate

channels - decoded audio channels

Method Detail

getMediaPlayerFactory

public final MediaPlayerFactory getMediaPlayerFactory()

Get the media player factory reference.

Returns:

media player factory

getMediaPlayer

public final DirectAudioPlayer getMediaPlayer()

Get the direct audio 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.

The associated media player factory will not be released, the client application is responsible for releasing the factory at the appropriate time.

release

public final void release(boolean releaseFactory)

Release the media player component and the associated media player factory.

Optionally release the media player factory.

This method invokes release(), then depending on the value of the releaseFactory parameter the associated factory will also be released.

Parameters:

releaseFactory - true if the factory should also be released; false if it should not

mediaChanged

public void mediaChanged(MediaPlayer mediaPlayer,
                libvlc_media_t media,
                String mrl)

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

mrl - media resource locator

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.

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 newPausable)

Description copied from interface: MediaPlayerEventListener

Media pausable status changed.

Specified by:

pausableChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newPausable - 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

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

mediaMetaChanged

public void mediaMetaChanged(MediaPlayer mediaPlayer,
                    int metaType)

Description copied from interface: MediaPlayerEventListener

Current media meta data changed.

Specified by:

mediaMetaChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

metaType - type of meta data that changed

mediaSubItemAdded

public void mediaSubItemAdded(MediaPlayer mediaPlayer,
                     libvlc_media_t subItem)

Description copied from interface: MediaPlayerEventListener

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

Specified by:

mediaSubItemAdded in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

subItem - native sub-item handle

mediaDurationChanged

public void mediaDurationChanged(MediaPlayer mediaPlayer,
                        long newDuration)

Description copied from interface: MediaPlayerEventListener

The current media duration changed.

Specified by:

mediaDurationChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newDuration - new duration (number of milliseconds)

mediaParsedChanged

public void mediaParsedChanged(MediaPlayer mediaPlayer,
                      int newStatus)

Description copied from interface: MediaPlayerEventListener

The current media parsed status changed.

Specified by:

mediaParsedChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newStatus - new parsed status

mediaFreed

public void mediaFreed(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

The current media was freed.

Specified by:

mediaFreed in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

mediaStateChanged

public void mediaStateChanged(MediaPlayer mediaPlayer,
                     int newState)

Description copied from interface: MediaPlayerEventListener

The current media state changed.

Specified by:

mediaStateChanged in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

newState - new state

newMedia

public void newMedia(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

New media was opened.

This is raised only for the "main" media item and not for any sub-items.

Specified by:

newMedia in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

subItemPlayed

public void subItemPlayed(MediaPlayer mediaPlayer,
                 int subItemIndex)

Description copied from interface: MediaPlayerEventListener

A sub-item was played.

There is no guarantee the sub-item actually started, but it was at least attempted to be played.

Specified by:

subItemPlayed in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

subItemIndex - index of the sub-item that was played

subItemFinished

public void subItemFinished(MediaPlayer mediaPlayer,
                   int subItemIndex)

Description copied from interface: MediaPlayerEventListener

A sub-item finished playing.

Specified by:

subItemFinished in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

subItemIndex - index of the sub-item that finished playing

endOfSubItems

public void endOfSubItems(MediaPlayer mediaPlayer)

Description copied from interface: MediaPlayerEventListener

The end of the media sub-items was reached.

This event will not be raised if the sub-items are being repeated.

Specified by:

endOfSubItems in interface MediaPlayerEventListener

Parameters:

mediaPlayer - media player that raised the event

play

public void play(DirectAudioPlayer mediaPlayer,
        com.sun.jna.Pointer samples,
        int sampleCount,
        long pts)

Description copied from interface: AudioCallback

Play samples.

Specified by:

play in interface AudioCallback

Parameters:

mediaPlayer - media player

samples - native sample data

sampleCount - number of samples

pts - presentation time stamp

pause

public void pause(DirectAudioPlayer mediaPlayer,
         long pts)

Description copied from interface: AudioCallback

Audio was paused.

Specified by:

pause in interface AudioCallback

Parameters:

mediaPlayer - media player

pts - presentation time stamp

resume

public void resume(DirectAudioPlayer mediaPlayer,
          long pts)

Description copied from interface: AudioCallback

Audio was resumed.

Specified by:

resume in interface AudioCallback

Parameters:

mediaPlayer - media player

pts - presentation time stamp

flush

public void flush(DirectAudioPlayer mediaPlayer,
         long pts)

Description copied from interface: AudioCallback

Audio buffer was flushed.

Specified by:

flush in interface AudioCallback

Parameters:

mediaPlayer - media player

pts - presentation time stamp

drain

public void drain(DirectAudioPlayer mediaPlayer)

Description copied from interface: AudioCallback

Audio buffer was drained.

Specified by:

drain in interface AudioCallback

Parameters:

mediaPlayer - media player