libvlc_media_list_player
[libvlc]

Collaboration diagram for libvlc_media_list_player:
LibVLC Media List Player, play a media_list. More...

Typedefs

typedef struct
libvlc_media_list_player_t 
libvlc_media_list_player_t

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

VLC_PUBLIC_API
libvlc_media_list_player_t
libvlc_media_list_player_new (libvlc_instance_t *p_instance, libvlc_exception_t *p_e)
 Create new media_list_player.
VLC_PUBLIC_API void libvlc_media_list_player_release (libvlc_media_list_player_t *p_mlp)
 Release media_list_player.
VLC_PUBLIC_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.
VLC_PUBLIC_API void libvlc_media_list_player_set_media_player (libvlc_media_list_player_t *p_mlp, libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
 Replace media player in media_list_player with this instance.
VLC_PUBLIC_API void libvlc_media_list_player_set_media_list (libvlc_media_list_player_t *p_mlp, libvlc_media_list_t *p_mlist, libvlc_exception_t *p_e)
VLC_PUBLIC_API void libvlc_media_list_player_play (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Play media list.
VLC_PUBLIC_API void libvlc_media_list_player_pause (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Pause media list.
VLC_PUBLIC_API int libvlc_media_list_player_is_playing (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Is media list playing?
VLC_PUBLIC_API libvlc_state_t libvlc_media_list_player_get_state (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Get current libvlc_state of media list player.
VLC_PUBLIC_API void libvlc_media_list_player_play_item_at_index (libvlc_media_list_player_t *p_mlp, int i_index, libvlc_exception_t *p_e)
 Play media list item at position index.
VLC_PUBLIC_API void libvlc_media_list_player_play_item (libvlc_media_list_player_t *p_mlp, libvlc_media_t *p_md, libvlc_exception_t *p_e)
VLC_PUBLIC_API void libvlc_media_list_player_stop (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Stop playing media list.
VLC_PUBLIC_API void libvlc_media_list_player_next (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Play next item from media list.
VLC_PUBLIC_API void libvlc_media_list_player_previous (libvlc_media_list_player_t *p_mlp, libvlc_exception_t *p_e)
 Play previous item from media list.
VLC_PUBLIC_API void libvlc_media_list_player_set_playback_mode (libvlc_media_list_player_t *p_mlp, libvlc_playback_mode_t e_mode, libvlc_exception_t *p_e)
 Sets the playback mode for the playlist.

Detailed Description

LibVLC Media List Player, play a media_list.

You can see that as a media instance subclass


Typedef Documentation


Enumeration Type Documentation

Defines playback modes for playlist.

Enumerator:
libvlc_playback_mode_default 
libvlc_playback_mode_loop 
libvlc_playback_mode_repeat 


Function Documentation

VLC_PUBLIC_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

References libvlc_media_list_player_t::p_event_manager.

VLC_PUBLIC_API libvlc_state_t libvlc_media_list_player_get_state ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Get current libvlc_state of media list player.

Parameters:
p_mlp media list player instance
p_e initialized exception instance
Returns:
libvlc_state_t for media list player

References libvlc_Ended, libvlc_media_player_get_state(), and libvlc_media_list_player_t::p_mi.

VLC_PUBLIC_API int libvlc_media_list_player_is_playing ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Is media list playing?

Parameters:
p_mlp media list player instance
p_e initialized exception instance
Returns:
true for playing and false for not playing

References libvlc_Buffering, libvlc_media_player_get_state(), libvlc_Opening, libvlc_Playing, and libvlc_media_list_player_t::p_mi.

VLC_PUBLIC_API libvlc_media_list_player_t* libvlc_media_list_player_new ( libvlc_instance_t p_instance,
libvlc_exception_t p_e 
)

VLC_PUBLIC_API void libvlc_media_list_player_next ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Play next item from media list.

Parameters:
p_mlp media list player instance
p_e initialized exception instance

References lock, set_relative_playlist_position_and_play(), and unlock().

VLC_PUBLIC_API void libvlc_media_list_player_pause ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Pause media list.

Parameters:
p_mlp media list player instance
p_e initialized exception instance

References libvlc_media_player_pause(), lock, libvlc_media_list_player_t::p_mi, and unlock().

VLC_PUBLIC_API void libvlc_media_list_player_play ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Play media list.

Parameters:
p_mlp media list player instance
p_e initialized exception instance

References libvlc_media_list_player_t::current_playing_item_path, libvlc_media_player_play(), lock, libvlc_media_list_player_t::p_mi, set_relative_playlist_position_and_play(), and unlock().

VLC_PUBLIC_API void libvlc_media_list_player_play_item ( libvlc_media_list_player_t p_mlp,
libvlc_media_t p_md,
libvlc_exception_t p_e 
)

VLC_PUBLIC_API void libvlc_media_list_player_play_item_at_index ( libvlc_media_list_player_t p_mlp,
int  i_index,
libvlc_exception_t p_e 
)

Play media list item at position index.

Parameters:
p_mlp media list player instance
i_index index in media list to play
p_e initialized exception instance

References libvlc_event_send(), libvlc_media_list_path_with_root_index(), libvlc_media_player_play(), libvlc_MediaListPlayerNextItemSet, lock, libvlc_media_list_player_t::p_event_manager, libvlc_media_list_player_t::p_mi, set_current_playing_item(), unlock(), and VLC_UNUSED.

VLC_PUBLIC_API void libvlc_media_list_player_previous ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Play previous item from media list.

Parameters:
p_mlp media list player instance
p_e initialized exception instance

References lock, set_relative_playlist_position_and_play(), and unlock().

VLC_PUBLIC_API void libvlc_media_list_player_release ( libvlc_media_list_player_t p_mlp  ) 

VLC_PUBLIC_API void libvlc_media_list_player_set_media_list ( libvlc_media_list_player_t p_mlp,
libvlc_media_list_t p_mlist,
libvlc_exception_t p_e 
)

VLC_PUBLIC_API void libvlc_media_list_player_set_media_player ( libvlc_media_list_player_t p_mlp,
libvlc_media_player_t p_mi,
libvlc_exception_t p_e 
)

Replace media player in media_list_player with this instance.

Parameters:
p_mlp media list player instance
p_mi media player instance
p_e initialized exception instance

References install_media_player_observer(), libvlc_media_player_release(), libvlc_media_player_retain(), lock, libvlc_media_list_player_t::p_mi, uninstall_media_player_observer(), unlock(), and VLC_UNUSED.

VLC_PUBLIC_API void libvlc_media_list_player_set_playback_mode ( libvlc_media_list_player_t p_mlp,
libvlc_playback_mode_t  e_mode,
libvlc_exception_t p_e 
)

Sets the playback mode for the playlist.

Parameters:
p_mlp media list player instance
e_mode playback mode specification
p_e initialized exception instance

References libvlc_media_list_player_t::e_playback_mode, lock, unlock(), and VLC_UNUSED.

VLC_PUBLIC_API void libvlc_media_list_player_stop ( libvlc_media_list_player_t p_mlp,
libvlc_exception_t p_e 
)

Stop playing media list.

Parameters:
p_mlp media list player instance
p_e initialized exception instance

References lock, stop(), and unlock().


Generated on Sat Nov 21 08:06:02 2009 for VLC by  doxygen 1.5.6