LibVLC media list player [LibVLC]

The LibVLC media list player plays a libvlc_media_list_t list of media, in a certain order. More...

Collaboration diagram for LibVLC media list player:

Typedefs
typedef struct libvlc_media_list_player_t	libvlc_media_list_player_t
typedef enum libvlc_playback_mode_t	libvlc_playback_mode_t
	Defines playback modes for playlist.
Enumerations
enum	libvlc_playback_mode_t { libvlc_playback_mode_default, libvlc_playback_mode_loop, libvlc_playback_mode_repeat }
	Defines playback modes for playlist. More...
Functions
LIBVLC_API libvlc_media_list_player_t *	libvlc_media_list_player_new (libvlc_instance_t *p_instance)
	Create new media_list_player.
LIBVLC_API void	libvlc_media_list_player_release (libvlc_media_list_player_t *p_mlp)
	Release a media_list_player after use Decrement the reference count of a media player object.
LIBVLC_API void	libvlc_media_list_player_retain (libvlc_media_list_player_t *p_mlp)
	Retain a reference to a media player list object.
LIBVLC_API libvlc_event_manager_t *	libvlc_media_list_player_event_manager (libvlc_media_list_player_t *p_mlp)
	Return the event manager of this media_list_player.
LIBVLC_API void	libvlc_media_list_player_set_media_player (libvlc_media_list_player_t *p_mlp, libvlc_media_player_t *p_mi)
	Replace media player in media_list_player with this instance.
LIBVLC_API void	libvlc_media_list_player_set_media_list (libvlc_media_list_player_t *p_mlp, libvlc_media_list_t *p_mlist)
	Set the media list associated with the player.
LIBVLC_API void	libvlc_media_list_player_play (libvlc_media_list_player_t *p_mlp)
	Play media list.
LIBVLC_API void	libvlc_media_list_player_pause (libvlc_media_list_player_t *p_mlp)
	Toggle pause (or resume) media list.
LIBVLC_API int	libvlc_media_list_player_is_playing (libvlc_media_list_player_t *p_mlp)
	Is media list playing?
LIBVLC_API libvlc_state_t	libvlc_media_list_player_get_state (libvlc_media_list_player_t *p_mlp)
	Get current libvlc_state of media list player.
LIBVLC_API int	libvlc_media_list_player_play_item_at_index (libvlc_media_list_player_t *p_mlp, int i_index)
	Play media list item at position index.
LIBVLC_API int	libvlc_media_list_player_play_item (libvlc_media_list_player_t *p_mlp, libvlc_media_t *p_md)
	Play the given media item.
LIBVLC_API void	libvlc_media_list_player_stop (libvlc_media_list_player_t *p_mlp)
	Stop playing media list.
LIBVLC_API int	libvlc_media_list_player_next (libvlc_media_list_player_t *p_mlp)
	Play next item from media list.
LIBVLC_API int	libvlc_media_list_player_previous (libvlc_media_list_player_t *p_mlp)
	Play previous item from media list.
LIBVLC_API void	libvlc_media_list_player_set_playback_mode (libvlc_media_list_player_t *p_mlp, libvlc_playback_mode_t e_mode)
	Sets the playback mode for the playlist.

---

Detailed Description

The LibVLC media list player plays a libvlc_media_list_t list of media, in a certain order.

This is required to especially support playlist files. The normal libvlc_media_player_t LibVLC media player can only play a single media, and does not handle playlist files properly.

---

Typedef Documentation

typedef struct libvlc_media_list_player_t libvlc_media_list_player_t

typedef enum libvlc_playback_mode_t libvlc_playback_mode_t

Defines playback modes for playlist.

---

Enumeration Type Documentation

enum libvlc_playback_mode_t

Defines playback modes for playlist.

Enumerator:

libvlc_playback_mode_default
libvlc_playback_mode_loop
libvlc_playback_mode_repeat

---

Function Documentation

LIBVLC_API libvlc_event_manager_t* libvlc_media_list_player_event_manager

(

libvlc_media_list_player_t *

p_mlp

)

Return the event manager of this media_list_player.

Parameters:

p_mlp

media list player instance

Returns:

the event manager

LIBVLC_API libvlc_state_t libvlc_media_list_player_get_state

(

libvlc_media_list_player_t *

p_mlp

)

Get current libvlc_state of media list player.

Parameters:

p_mlp

media list player instance

Returns:

libvlc_state_t for media list player

LIBVLC_API int libvlc_media_list_player_is_playing

(

libvlc_media_list_player_t *

p_mlp

)

Is media list playing?

Parameters:

p_mlp

media list player instance

Returns:

true for playing and false for not playing

LIBVLC_API libvlc_media_list_player_t* libvlc_media_list_player_new

(

libvlc_instance_t *

p_instance

)

Create new media_list_player.

Parameters:

p_instance

libvlc instance

Returns:

media list player instance or NULL on error

LIBVLC_API int libvlc_media_list_player_next

(

libvlc_media_list_player_t *

p_mlp

)

Play next item from media list.

Parameters:

p_mlp

media list player instance

Returns:

0 upon success -1 if there is no next item

LIBVLC_API void libvlc_media_list_player_pause

(

libvlc_media_list_player_t *

p_mlp

)

Toggle pause (or resume) media list.

Parameters:

p_mlp

media list player instance

LIBVLC_API void libvlc_media_list_player_play

(

libvlc_media_list_player_t *

p_mlp

)

Play media list.

Parameters:

p_mlp

media list player instance

LIBVLC_API int libvlc_media_list_player_play_item	(	libvlc_media_list_player_t *	p_mlp,
		libvlc_media_t *	p_md
	)

Play the given media item.

Parameters:

	p_mlp	media list player instance
	p_md	the media instance

Returns:

0 upon success, -1 if the media is not part of the media list

LIBVLC_API int libvlc_media_list_player_play_item_at_index	(	libvlc_media_list_player_t *	p_mlp,
		int	i_index
	)

Play media list item at position index.

Parameters:

	p_mlp	media list player instance
	i_index	index in media list to play

Returns:

0 upon success -1 if the item wasn't found

LIBVLC_API int libvlc_media_list_player_previous

(

libvlc_media_list_player_t *

p_mlp

)

Play previous item from media list.

Parameters:

p_mlp

media list player instance

Returns:

0 upon success -1 if there is no previous item

LIBVLC_API void libvlc_media_list_player_release

(

libvlc_media_list_player_t *

p_mlp

)

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

If the reference count is 0, then libvlc_media_list_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_mlp

media list player instance

LIBVLC_API void libvlc_media_list_player_retain

(

libvlc_media_list_player_t *

p_mlp

)

Retain a reference to a media player list object.

Use libvlc_media_list_player_release() to decrement reference count.

Parameters:

p_mlp

media player list object

LIBVLC_API void libvlc_media_list_player_set_media_list	(	libvlc_media_list_player_t *	p_mlp,
		libvlc_media_list_t *	p_mlist
	)

Set the media list associated with the player.

Parameters:

	p_mlp	media list player instance
	p_mlist	list of media

LIBVLC_API void libvlc_media_list_player_set_media_player	(	libvlc_media_list_player_t *	p_mlp,
		libvlc_media_player_t *	p_mi
	)

Replace media player in media_list_player with this instance.

Parameters:

	p_mlp	media list player instance
	p_mi	media player instance

LIBVLC_API void libvlc_media_list_player_set_playback_mode	(	libvlc_media_list_player_t *	p_mlp,
		libvlc_playback_mode_t	e_mode
	)

Sets the playback mode for the playlist.

Parameters:

	p_mlp	media list player instance
	e_mode	playback mode specification

LIBVLC_API void libvlc_media_list_player_stop

(

libvlc_media_list_player_t *

p_mlp

)

Stop playing media list.

Parameters:

p_mlp

media list player instance