libvlc_media_player
[libvlc]

Collaboration diagram for libvlc_media_player:

LibVLC Media Player, object that let you play a media in a libvlc_drawable_t. More...

Modules
	libvlc_video
	LibVLC Video handling.
	libvlc_audio
	LibVLC Audio handling.
Typedefs
typedef libvlc_media_player_t	libvlc_media_player_t
Enumerations
enum	libvlc_state_t {   libvlc_NothingSpecial = 0, libvlc_Opening, libvlc_Buffering, libvlc_Playing,   libvlc_Paused, libvlc_Stopped, libvlc_Forward, libvlc_Backward,   libvlc_Ended, libvlc_Error }
	Note the order of libvlc_state_t enum must match exactly the order of. More...
Functions
libvlc_media_player_t *	libvlc_media_player_new (libvlc_instance_t *, libvlc_exception_t *)
	Create an empty Media Player object.
libvlc_media_player_t *	libvlc_media_player_new_from_media (libvlc_media_t *, libvlc_exception_t *)
	Create a Media Player object from a Media.
void	libvlc_media_player_release (libvlc_media_player_t *)
	Release a media_player after use Decrement the reference count of a media player object.
void	libvlc_media_player_retain (libvlc_media_player_t *)
	Retain a reference to a media player object.
void	libvlc_media_player_set_media (libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t *)
	Set the media that will be used by the media_player.
libvlc_media_t *	libvlc_media_player_get_media (libvlc_media_player_t *, libvlc_exception_t *)
	Get the media used by the media_player.
libvlc_event_manager_t *	libvlc_media_player_event_manager (libvlc_media_player_t *, libvlc_exception_t *)
	Get the Event Manager from which the media player send event.
void	libvlc_media_player_play (libvlc_media_player_t *, libvlc_exception_t *)
	Play.
void	libvlc_media_player_pause (libvlc_media_player_t *, libvlc_exception_t *)
	Pause.
void	libvlc_media_player_stop (libvlc_media_player_t *, libvlc_exception_t *)
	Stop.
void	libvlc_media_player_set_drawable (libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t *)
	Set the drawable where the media player should render its video output.
libvlc_drawable_t	libvlc_media_player_get_drawable (libvlc_media_player_t *, libvlc_exception_t *)
	Get the drawable where the media player should render its video output.
libvlc_time_t	libvlc_media_player_get_length (libvlc_media_player_t *, libvlc_exception_t *)
	Get the current movie length (in ms).
libvlc_time_t	libvlc_media_player_get_time (libvlc_media_player_t *, libvlc_exception_t *)
	Get the current movie time (in ms).
void	libvlc_media_player_set_time (libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *)
	Set the movie time (in ms).
float	libvlc_media_player_get_position (libvlc_media_player_t *, libvlc_exception_t *)
void	libvlc_media_player_set_position (libvlc_media_player_t *, float, libvlc_exception_t *)
void	libvlc_media_player_set_chapter (libvlc_media_player_t *, int, libvlc_exception_t *)
int	libvlc_media_player_get_chapter (libvlc_media_player_t *, libvlc_exception_t *)
int	libvlc_media_player_get_chapter_count (libvlc_media_player_t *, libvlc_exception_t *)
int	libvlc_media_player_will_play (libvlc_media_player_t *, libvlc_exception_t *)
float	libvlc_media_player_get_rate (libvlc_media_player_t *, libvlc_exception_t *)
void	libvlc_media_player_set_rate (libvlc_media_player_t *, float, libvlc_exception_t *)
libvlc_state_t	libvlc_media_player_get_state (libvlc_media_player_t *, libvlc_exception_t *)
float	libvlc_media_player_get_fps (libvlc_media_player_t *, libvlc_exception_t *)
int	libvlc_media_player_has_vout (libvlc_media_player_t *, libvlc_exception_t *)
	Does this media player have a video output?
int	libvlc_media_player_is_seekable (libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
	Is this media player seekable?
int	libvlc_media_player_can_pause (libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
	Can this media player be paused?

---

Detailed Description

LibVLC Media Player, object that let you play a media in a libvlc_drawable_t.

---

Typedef Documentation

typedef struct libvlc_media_player_t libvlc_media_player_t

---

Enumeration Type Documentation

enum libvlc_state_t

Note the order of libvlc_state_t enum must match exactly the order of.

See also:

mediacontrol_PlayerStatus and

input_state_e enums.

Expected states by web plugins are: IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, FORWARD=6, BACKWARD=7, ENDED=8, ERROR=9

Enumerator:

libvlc_NothingSpecial
libvlc_Opening
libvlc_Buffering
libvlc_Playing
libvlc_Paused
libvlc_Stopped
libvlc_Forward
libvlc_Backward
libvlc_Ended
libvlc_Error

---

Function Documentation

int libvlc_media_player_can_pause	(	libvlc_media_player_t *	p_mi,
		libvlc_exception_t *	p_e
	)

Can this media player be paused?

Parameters:

	p_input	the input
	p_e	an initialized exception pointer

libvlc_event_manager_t* libvlc_media_player_event_manager	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the Event Manager from which the media player send event.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the event manager associated with p_mi

int libvlc_media_player_get_chapter	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

int libvlc_media_player_get_chapter_count	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

libvlc_drawable_t libvlc_media_player_get_drawable	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the drawable where the media player should render its video output.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the libvlc_drawable_t where the media player should render its video

float libvlc_media_player_get_fps	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

libvlc_time_t libvlc_media_player_get_length	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the current movie length (in ms).

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the movie length (in ms).

libvlc_media_t* libvlc_media_player_get_media	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the media used by the media_player.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the media associated with p_mi, or NULL if no media is associated

float libvlc_media_player_get_position	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

float libvlc_media_player_get_rate	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

libvlc_state_t libvlc_media_player_get_state	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

libvlc_time_t libvlc_media_player_get_time	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the current movie time (in ms).

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the movie time (in ms).

int libvlc_media_player_has_vout	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Does this media player have a video output?

Parameters:

	p_md	the media player
	p_e	an initialized exception pointer

int libvlc_media_player_is_seekable	(	libvlc_media_player_t *	p_mi,
		libvlc_exception_t *	p_e
	)

Is this media player seekable?

Parameters:

	p_input	the input
	p_e	an initialized exception pointer

libvlc_media_player_t* libvlc_media_player_new	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Create an empty Media Player object.

Parameters:

	p_libvlc_instance	the libvlc instance in which the Media Player should be created.
	p_e	an initialized exception pointer

libvlc_media_player_t* libvlc_media_player_new_from_media	(	libvlc_media_t *	,
		libvlc_exception_t *
	)

Create a Media Player object from a Media.

Parameters:

	p_md	the media. Afterwards the p_md can be safely destroyed.
	p_e	an initialized exception pointer

void libvlc_media_player_pause	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Pause.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

void libvlc_media_player_play	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Play.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

void libvlc_media_player_release

(

libvlc_media_player_t *

)

Release a media_player after use Decrement the reference count of a media player object.

If the reference count is 0, then libvlc_media_player_release() will release the media player object. If the media player object has been released, then it should not be used again.

Parameters:

p_mi

the Media Player to free

void libvlc_media_player_retain

(

libvlc_media_player_t *

)

Retain a reference to a media player object.

Use libvlc_media_player_release() to decrement reference count.

Parameters:

p_mi

media player object

void libvlc_media_player_set_chapter	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

void libvlc_media_player_set_drawable	(	libvlc_media_player_t *	,
		libvlc_drawable_t	,
		libvlc_exception_t *
	)

Set the drawable where the media player should render its video output.

Parameters:

	p_mi	the Media Player
	drawable	the libvlc_drawable_t where the media player should render its video
	p_e	an initialized exception pointer

void libvlc_media_player_set_media	(	libvlc_media_player_t *	,
		libvlc_media_t *	,
		libvlc_exception_t *
	)

Set the media that will be used by the media_player.

If any, previous md will be released.

Parameters:

	p_mi	the Media Player
	p_md	the Media. Afterwards the p_md can be safely destroyed.
	p_e	an initialized exception pointer

void libvlc_media_player_set_position	(	libvlc_media_player_t *	,
		float	,
		libvlc_exception_t *
	)

void libvlc_media_player_set_rate	(	libvlc_media_player_t *	,
		float	,
		libvlc_exception_t *
	)

void libvlc_media_player_set_time	(	libvlc_media_player_t *	,
		libvlc_time_t	,
		libvlc_exception_t *
	)

Set the movie time (in ms).

Parameters:

	p_mi	the Media Player
	the	movie time (in ms).
	p_e	an initialized exception pointer

void libvlc_media_player_stop	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Stop.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

int libvlc_media_player_will_play	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

---