Home       Trees       Indices       Help   
Module vlc :: Class MediaListPlayer
[hide private]
[frames] | no frames]

Class MediaListPlayer

source code

object --+    
         |    
    _Ctype --+
             |
            MediaListPlayer

Create a new MediaListPlayer instance.

It may take as parameter either:

Instance Methods [hide private]
 
get_instance(self)
Return the associated Instance.		 source code
 
release(self)
Release a media_list_player after use Decrement the reference count of a media player object.		 source code
 
retain(self)
Retain a reference to a media player list object.		 source code
 
event_manager(self)
Decorator.		 source code
 
set_media_player(self, p_mi)
Replace media player in media_list_player with this instance.		 source code
 
get_media_player(self)
Get media player of the media_list_player instance.		 source code
 
set_media_list(self, p_mlist)
Set the media list associated with the player.		 source code
 
play(self)
Play media list.		 source code
 
pause(self)
Toggle pause (or resume) media list.		 source code
 
set_pause(self, do_pause)
Pause or resume media list.		 source code
 
is_playing(self)
Is media list playing?		 source code
 
get_state(self)
Get current libvlc_state of media list player.		 source code
 
play_item_at_index(self, i_index)
Play media list item at position index.		 source code
 
__getitem__(self, i) source code
 
__iter__(self) source code
 
play_item(self, p_md)
Play the given media item.		 source code
 
stop(self)
Stop playing media list.		 source code
 
next(self)
Play next item from media list.		 source code
 
previous(self)
Play previous item from media list.		 source code
 
set_playback_mode(self, e_mode)
Sets the playback mode for the playlist.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
a new object with type S, a subtype of T
__new__(cls, arg=None) source code

Inherited from _Ctype: from_param

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(cls, arg=None)
Static Method

source code 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__
(inherited documentation)

release(self)

source code 

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(self)

source code 

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

event_manager(self)

source code 

Decorator. Caches a parameterless method's return value each time it is called.

If called later with the same arguments, the cached value is returned (not reevaluated). Adapted from https://wiki.python.org/moin/PythonDecoratorLibrary

Decorators:
  • @memoize_parameterless

set_media_player(self, p_mi)

source code 

Replace media player in media_list_player with this instance.

Parameters:
  • p_mi - media player instance.

get_media_player(self)

source code 

Get media player of the media_list_player instance.

Returns:
media player instance @note the caller is responsible for releasing the returned instance.

set_media_list(self, p_mlist)

source code 

Set the media list associated with the player.

Parameters:
  • p_mlist - list of media.

set_pause(self, do_pause)

source code 

Pause or resume media list.

Parameters:
  • do_pause - play/resume if zero, pause if non-zero.

Version: LibVLC 3.0.0 or later.

is_playing(self)

source code 

Is media list playing?

Returns:
true for playing and false for not playing \libvlc_return_bool.

get_state(self)

source code 

Get current libvlc_state of media list player.

Returns:
State for media list player.

play_item_at_index(self, i_index)

source code 

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.

play_item(self, p_md)

source code 

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.

next(self)

source code 

Play next item from media list.

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

previous(self)

source code 

Play previous item from media list.

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

set_playback_mode(self, e_mode)

source code 

Sets the playback mode for the playlist.

Parameters:
  • e_mode - playback mode specification.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat Jul 25 13:13:08 2020 http://epydoc.sourceforge.net