org.videolan.libvlc

Class MediaPlayer

java.lang.Object

org.videolan.libvlc.MediaPlayer

public class MediaPlayer
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPlayer.Chapter
static class	MediaPlayer.Equalizer
static class	MediaPlayer.Event
static interface	MediaPlayer.EventListener
static class	MediaPlayer.Navigate
static class	MediaPlayer.Position
static class	MediaPlayer.Title
static class	MediaPlayer.TrackDescription

Constructor Summary

Constructors

Constructor and Description
MediaPlayer(LibVLC libVLC) Create an empty MediaPlayer
MediaPlayer(Media media) Create a MediaPlayer from a Media

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addSlave(int type, java.lang.String path, boolean select) Add a slave (or subtitle) to the current media player.
boolean	addSlave(int type, android.net.Uri uri, boolean select) Add a slave (or subtitle) to the current media player.
long	getAudioDelay() Get the current audio delay.
int	getAudioTrack() Get the current audio track.
MediaPlayer.TrackDescription[]	getAudioTracks() Get the list of available audio tracks.
int	getAudioTracksCount() Get the number of available audio tracks.
int	getChapter()
MediaPlayer.Chapter[]	getChapters(int title) Get the full description of available chapters.
long	getLength() Gets current movie's length in ms.
Media	getMedia() Get the Media used by this MediaPlayer.
int	getPlayerState() Get player state.
float	getPosition() Gets the movie position.
float	getRate() Get the current playback speed
long	getSpuDelay() Get the current spu (subtitle) delay.
int	getSpuTrack() Get the current spu (subtitle) track.
MediaPlayer.TrackDescription[]	getSpuTracks() Get the list of available spu (subtitle) tracks.
int	getSpuTracksCount() Get the number of available spu (subtitle) tracks.
long	getTime() Gets the current movie time (in ms).
int	getTitle()
MediaPlayer.Title[]	getTitles() Get the full description of available titles.
int	getVideoTrack() Get the current video track.
MediaPlayer.TrackDescription[]	getVideoTracks() Get the list of available video tracks.
int	getVideoTracksCount() Get the number of available video tracks.
IVLCVout	getVLCVout() Get the IVLCVout helper.
int	getVolume() Gets volume as integer
boolean	isPlaying() Returns true if any media is playing
boolean	isReleased() Returns true if native object is released
boolean	isSeekable() Returns true if any media is seekable
void	navigate(int navigate)
int	nextChapter()
protected MediaPlayer.Event	onEventNative(int eventType, long arg1, float arg2) Called when libvlc send events.
protected void	onReleaseNative() Called when native object is released (refcount is 0).
void	pause() Pauses any playing media
void	play() Play the media
int	previousChapter()
void	release() Release the native object if ref count is 1.
boolean	retain() Increment internal ref count of the native object.
boolean	setAudioDelay(long delay) Set current audio delay.
boolean	setAudioOutput(java.lang.String aout) Selects an audio output module.
boolean	setAudioOutputDevice(java.lang.String id) Configures an explicit audio output device.
boolean	setAudioTrack(int index) Set the audio track.
void	setChapter(int chapter)
boolean	setEqualizer(MediaPlayer.Equalizer equalizer) Apply new equalizer settings to a media player.
void	setEventListener(MediaPlayer.EventListener listener)
protected void	setEventListener(org.videolan.libvlc.VLCEvent.Listener<T> listener) Set an event listener.
void	setMedia(Media media) Set a Media
void	setPosition(float pos) Sets the movie position.
void	setRate(float rate) Sets the speed of playback (1 being normal speed, 2 being twice as fast)
boolean	setSpuDelay(long delay) Set current spu (subtitle) delay.
boolean	setSpuTrack(int index) Set the spu (subtitle) track.
long	setTime(long time) Sets the movie time (in ms), if any media is being played.
void	setTitle(int title)
void	setVideoTitleDisplay(int position, int timeout) Set if, and how, the video title will be shown when media is played
boolean	setVideoTrack(int index) Set the video track.
void	setVideoTrackEnabled(boolean enabled) Set the enabled state of the video track
int	setVolume(int volume) Sets volume as integer
void	stop() Stops the playing media

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaPlayer

public MediaPlayer(LibVLC libVLC)

Create an empty MediaPlayer

Parameters:

libVLC - a valid libVLC

MediaPlayer

public MediaPlayer(Media media)

Create a MediaPlayer from a Media

Parameters:

media - a valid Media object

Method Detail

getVLCVout

public IVLCVout getVLCVout()

Get the IVLCVout helper.

setMedia

public void setMedia(Media media)

Set a Media

Parameters:

media - a valid Media object

getMedia

public Media getMedia()

Get the Media used by this MediaPlayer. This Media should be released with release().

play

public void play()

Play the media

stop

public void stop()

Stops the playing media

setVideoTitleDisplay

public void setVideoTitleDisplay(int position,
                        int timeout)

Set if, and how, the video title will be shown when media is played

Parameters:

position - see MediaPlayer.Position

timeout -

setAudioOutput

public boolean setAudioOutput(java.lang.String aout)

Selects an audio output module. Any change will take effect only after playback is stopped and restarted. Audio output cannot be changed while playing.

Returns:

true on success.

setAudioOutputDevice

public boolean setAudioOutputDevice(java.lang.String id)

Configures an explicit audio output device. Audio output will be moved to the device specified by the device identifier string.

Returns:

true on success.

getTitles

public MediaPlayer.Title[] getTitles()

Get the full description of available titles.

Returns:

the list of titles

getChapters

public MediaPlayer.Chapter[] getChapters(int title)

Get the full description of available chapters.

Parameters:

title - index of the title (if -1, use the current title)

Returns:

the list of Chapters for the title

getVideoTracksCount

public int getVideoTracksCount()

Get the number of available video tracks.

getVideoTracks

public MediaPlayer.TrackDescription[] getVideoTracks()

Get the list of available video tracks.

getVideoTrack

public int getVideoTrack()

Get the current video track.

Returns:

the video track ID or -1 if no active input

setVideoTrack

public boolean setVideoTrack(int index)

Set the video track.

Returns:

true on success.

setVideoTrackEnabled

public void setVideoTrackEnabled(boolean enabled)

Set the enabled state of the video track

Parameters:

enabled -

getAudioTracksCount

public int getAudioTracksCount()

Get the number of available audio tracks.

getAudioTracks

public MediaPlayer.TrackDescription[] getAudioTracks()

Get the list of available audio tracks.

getAudioTrack

public int getAudioTrack()

Get the current audio track.

Returns:

the audio track ID or -1 if no active input

setAudioTrack

public boolean setAudioTrack(int index)

Set the audio track.

Returns:

true on success.

getAudioDelay

public long getAudioDelay()

Get the current audio delay.

Returns:

delay in microseconds.

setAudioDelay

public boolean setAudioDelay(long delay)

Set current audio delay. The audio delay will be reset to zero each time the media changes.

Parameters:

delay - in microseconds.

Returns:

true on success.

getSpuTracksCount

public int getSpuTracksCount()

Get the number of available spu (subtitle) tracks.

getSpuTracks

public MediaPlayer.TrackDescription[] getSpuTracks()

Get the list of available spu (subtitle) tracks.

getSpuTrack

public int getSpuTrack()

Get the current spu (subtitle) track.

Returns:

the spu (subtitle) track ID or -1 if no active input

setSpuTrack

public boolean setSpuTrack(int index)

Set the spu (subtitle) track.

Returns:

true on success.

getSpuDelay

public long getSpuDelay()

Get the current spu (subtitle) delay.

Returns:

delay in microseconds.

setSpuDelay

public boolean setSpuDelay(long delay)

Set current spu (subtitle) delay. The spu delay will be reset to zero each time the media changes.

Parameters:

delay - in microseconds.

Returns:

true on success.

setEqualizer

public boolean setEqualizer(MediaPlayer.Equalizer equalizer)

Apply new equalizer settings to a media player. The equalizer is first created by invoking MediaPlayer.Equalizer.create() or MediaPlayer.Equalizer.createFromPreset(int)}. It is possible to apply new equalizer settings to a media player whether the media player is currently playing media or not. Invoking this method will immediately apply the new equalizer settings to the audio output of the currently playing media if there is any. If there is no currently playing media, the new equalizer settings will be applied later if and when new media is played. Equalizer settings will automatically be applied to subsequently played media. To disable the equalizer for a media player invoke this method passing null.

Returns:

true on success.

addSlave

public boolean addSlave(int type,
               android.net.Uri uri,
               boolean select)

Add a slave (or subtitle) to the current media player.

Parameters:

type - see Media.Slave.Type

uri - a valid RFC 2396 Uri

Returns:

true on success.

addSlave

public boolean addSlave(int type,
               java.lang.String path,
               boolean select)

Add a slave (or subtitle) to the current media player.

Parameters:

type - see Media.Slave.Type

path - a local path

Returns:

true on success.

setRate

public void setRate(float rate)

Sets the speed of playback (1 being normal speed, 2 being twice as fast)

Parameters:

rate -

getRate

public float getRate()

Get the current playback speed

isPlaying

public boolean isPlaying()

Returns true if any media is playing

isSeekable

public boolean isSeekable()

Returns true if any media is seekable

pause

public void pause()

Pauses any playing media

getPlayerState

public int getPlayerState()

Get player state.

getVolume

public int getVolume()

Gets volume as integer

setVolume

public int setVolume(int volume)

Sets volume as integer

Parameters:

volume: - Volume level passed as integer

getTime

public long getTime()

Gets the current movie time (in ms).

Returns:

the movie time (in ms), or -1 if there is no media.

setTime

public long setTime(long time)

Sets the movie time (in ms), if any media is being played.

Parameters:

time: - Time in ms.

Returns:

the movie time (in ms), or -1 if there is no media.

getPosition

public float getPosition()

Gets the movie position.

Returns:

the movie position, or -1 for any error.

setPosition

public void setPosition(float pos)

Sets the movie position.

Parameters:

pos: - movie position.

getLength

public long getLength()

Gets current movie's length in ms.

Returns:

the movie length (in ms), or -1 if there is no media.

getTitle

public int getTitle()

setTitle

public void setTitle(int title)

getChapter

public int getChapter()

previousChapter

public int previousChapter()

nextChapter

public int nextChapter()

setChapter

public void setChapter(int chapter)

navigate

public void navigate(int navigate)

setEventListener

public void setEventListener(MediaPlayer.EventListener listener)

onEventNative

protected MediaPlayer.Event onEventNative(int eventType,
                              long arg1,
                              float arg2)

Called when libvlc send events.

Parameters:

eventType - event type

arg1 - first argument

arg2 - second argument

Returns:

Event that will be dispatched to listeners

onReleaseNative

protected void onReleaseNative()

Called when native object is released (refcount is 0). This is where you must release native resources.

isReleased

public boolean isReleased()

Returns true if native object is released

retain

public final boolean retain()

Increment internal ref count of the native object.

Returns:

true if media is retained

release

public final void release()

Release the native object if ref count is 1. After this call, native calls are not possible anymore. You can still call others methods to retrieve cached values. For example: if you parse, then release a media, you'll still be able to retrieve all Metas or Tracks infos.

setEventListener

protected void setEventListener(org.videolan.libvlc.VLCEvent.Listener<T> listener)

Set an event listener. Events are sent via the android main thread.

Parameters:

listener - see VLCEvent.Listener