vlc.MediaListPlayer

class vlc.MediaListPlayer

Bases: _Ctype

It may take as parameter either:

• an Instance

• nothing

event_manager()

Return the event manager of this media_list_player.

Returns:

the event manager.

get_instance()

Return the associated Instance.

get_media_player()

Get media player of the media_list_player instance.

Note

the caller is responsible for releasing the returned instance.

Returns:

media player instance.

get_state()

Get current libvlc_state of media list player

Returns:

State for media list player.

is_playing()

Is media list playing?

Returns:

true for playing and false for not playing.

next()

Play next item from media list

Returns:

0 upon success -1 if there is no next item.

pause()

Toggle pause (or resume) media list

play()

Play media list

play_item(p_md)

Play the given media item

Parameters:

p_md – the media instance.

Returns:

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

play_item_at_index(i_index)

Play media list item at position index

Parameters:

i_index – index in media list to play.

Returns:

0 upon success -1 if the item wasn’t found.

previous()

Play previous item from media list

Returns:

0 upon success -1 if there is no previous item.

release()

Release a media_list_player after use Decrement the reference count of a media player object. If the reference count is 0, then release() will release the media player object. If the media player object has been released, then it should not be used again.

retain()

Retain a reference to a media player list object. Use release() to decrement reference count.

set_media_list(p_mlist)

Set the media list associated with the player

Parameters:

p_mlist – list of media.

set_media_player(p_mi)

Replace media player in media_list_player with this instance.

Parameters:

p_mi – media player instance.

set_pause(do_pause)

Pause or resume media list

Parameters:

do_pause – play/resume if zero, pause if non-zero.

Version:

LibVLC 3.0.0 or later.

set_playback_mode(e_mode)

Sets the playback mode for the playlist

Parameters:

e_mode – playback mode specification.

stop()

Stop playing media list