libvlc_playlist (Deprecated)
[libvlc]

Collaboration diagram for libvlc_playlist (Deprecated):

LibVLC Playlist handling (Deprecated). More...

Data Structures
struct	libvlc_playlist_item_t
Functions
VLC_DEPRECATED_API void	libvlc_playlist_loop (libvlc_instance_t *, int, libvlc_exception_t *)
	Set the playlist's loop attribute.
VLC_DEPRECATED_API void	libvlc_playlist_play (libvlc_instance_t *, int, int, char **, libvlc_exception_t *)
	Start playing.
VLC_DEPRECATED_API void	libvlc_playlist_pause (libvlc_instance_t *, libvlc_exception_t *)
	Toggle the playlist's pause status.
VLC_DEPRECATED_API int	libvlc_playlist_isplaying (libvlc_instance_t *, libvlc_exception_t *)
	Checks whether the playlist is running.
VLC_DEPRECATED_API int	libvlc_playlist_items_count (libvlc_instance_t *, libvlc_exception_t *)
	Get the number of items in the playlist.
VLC_DEPRECATED_API int	libvlc_playlist_get_current_index (libvlc_instance_t *, libvlc_exception_t *)
VLC_DEPRECATED_API void	libvlc_playlist_lock (libvlc_instance_t *)
	Lock the playlist.
VLC_DEPRECATED_API void	libvlc_playlist_unlock (libvlc_instance_t *)
	Unlock the playlist.
VLC_DEPRECATED_API void	libvlc_playlist_stop (libvlc_instance_t *, libvlc_exception_t *)
	Stop playing.
VLC_DEPRECATED_API void	libvlc_playlist_next (libvlc_instance_t *, libvlc_exception_t *)
	Go to the next playlist item.
VLC_DEPRECATED_API void	libvlc_playlist_prev (libvlc_instance_t *, libvlc_exception_t *)
	Go to the previous playlist item.
VLC_DEPRECATED_API void	libvlc_playlist_clear (libvlc_instance_t *, libvlc_exception_t *)
	Empty a playlist.
VLC_DEPRECATED_API int	libvlc_playlist_add (libvlc_instance_t *, const char *, const char *, libvlc_exception_t *)
	Append an item to the playlist.
VLC_DEPRECATED_API int	libvlc_playlist_add_extended (libvlc_instance_t *, const char *, const char *, int, const char **, libvlc_exception_t *)
	Append an item to the playlist.
VLC_DEPRECATED_API int	libvlc_playlist_delete_item (libvlc_instance_t *, int, libvlc_exception_t *)
	Delete the playlist item with the given ID.
VLC_DEPRECATED_API libvlc_media_player_t *	libvlc_playlist_get_media_player (libvlc_instance_t *, libvlc_exception_t *)
	Get the input that is currently being played by the playlist.

---

Detailed Description

LibVLC Playlist handling (Deprecated).

Deprecated:

Use media_list

---

Function Documentation

VLC_DEPRECATED_API int libvlc_playlist_add	(	libvlc_instance_t *	,
		const char *	,
		const char *	,
		libvlc_exception_t *
	)

Append an item to the playlist.

The item is added at the end. If more advanced options are required,

See also:

libvlc_playlist_add_extended instead.

Parameters:

	p_instance	the playlist instance
	psz_uri	the URI to open, using VLC format
	psz_name	a name that you might want to give or NULL
	p_e	an initialized exception pointer

Returns:

the identifier of the new item

VLC_DEPRECATED_API int libvlc_playlist_add_extended	(	libvlc_instance_t *	,
		const char *	,
		const char *	,
		int	,
		const char **	,
		libvlc_exception_t *
	)

Append an item to the playlist.

The item is added at the end, with additional input options.

Parameters:

	p_instance	the playlist instance
	psz_uri	the URI to open, using VLC format
	psz_name	a name that you might want to give or NULL
	i_options	the number of options to add
	ppsz_options	strings representing the options to add
	p_e	an initialized exception pointer

Returns:

the identifier of the new item

VLC_DEPRECATED_API void libvlc_playlist_clear	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Empty a playlist.

All items in the playlist are removed.

Parameters:

	p_instance	the playlist instance
	p_e	an initialized exception pointer

VLC_DEPRECATED_API int libvlc_playlist_delete_item	(	libvlc_instance_t *	,
		int	,
		libvlc_exception_t *
	)

Delete the playlist item with the given ID.

Parameters:

	p_instance	the playlist instance
	i_id	the id to remove
	p_e	an initialized exception pointer

Returns:

0 in case of success, a non-zero value otherwise

< Item not found

VLC_DEPRECATED_API int libvlc_playlist_get_current_index	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

VLC_DEPRECATED_API libvlc_media_player_t* libvlc_playlist_get_media_player	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Get the input that is currently being played by the playlist.

Parameters:

	p_instance	the playlist instance to use
	p_e	an initialized exception pointern

Returns:

a media instance object

VLC_DEPRECATED_API int libvlc_playlist_isplaying	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Checks whether the playlist is running.

Parameters:

	p_instance	the playlist instance
	p_e	an initialized exception pointer

Returns:

0 if the playlist is stopped or paused, 1 if it is running

VLC_DEPRECATED_API int libvlc_playlist_items_count	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Get the number of items in the playlist.

Parameters:

	p_instance	the playlist instance
	p_e	an initialized exception pointer

Returns:

the number of items

VLC_DEPRECATED_API void libvlc_playlist_lock

(

libvlc_instance_t *

)

Lock the playlist.

Parameters:

p_instance

the playlist instance

VLC_DEPRECATED_API void libvlc_playlist_loop	(	libvlc_instance_t *	,
		int	,
		libvlc_exception_t *
	)

Set the playlist's loop attribute.

If set, the playlist runs continuously and wraps around when it reaches the end.

Parameters:

	p_instance	the playlist instance
	loop	the loop attribute. 1 sets looping, 0 disables it
	p_e	an initialized exception pointer

VLC_DEPRECATED_API void libvlc_playlist_next	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Go to the next playlist item.

If the playlist was stopped, playback is started.

Parameters:

	p_instance	the playlist instance
	p_e	an initialized exception pointer

VLC_DEPRECATED_API void libvlc_playlist_pause	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Toggle the playlist's pause status.

If the playlist was running, it is paused. If it was paused, it is resumed.

Parameters:

	p_instance	the playlist instance to pause
	p_e	an initialized exception pointer

VLC_DEPRECATED_API void libvlc_playlist_play	(	libvlc_instance_t *	,
		int	,
		int	,
		char **	,
		libvlc_exception_t *
	)

Start playing.

Additionnal playlist item options can be specified for addition to the item before it is played.

Parameters:

	p_instance	the playlist instance
	i_id	the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played
	i_options	the number of options to add to the item
	ppsz_options	the options to add to the item
	p_e	an initialized exception pointer

Todo:

Handle additionnal options

VLC_DEPRECATED_API void libvlc_playlist_prev	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Go to the previous playlist item.

If the playlist was stopped, playback is started.

Parameters:

	p_instance	the playlist instance
	p_e	an initialized exception pointer

VLC_DEPRECATED_API void libvlc_playlist_stop	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Stop playing.

Parameters:

	p_instance	the playlist instance to stop
	p_e	an initialized exception pointer

VLC_DEPRECATED_API void libvlc_playlist_unlock

(

libvlc_instance_t *

)

Unlock the playlist.

Parameters:

p_instance

the playlist instance

---