1 /*****************************************************************************
2 * libvlc_media_list.h: libvlc_media_list API
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Pierre d'Herbemont
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef LIBVLC_MEDIA_LIST_PLAYER_H
25 #define LIBVLC_MEDIA_LIST_PLAYER_H 1
29 * This file defines libvlc_media_list_player API
36 /*****************************************************************************
38 *****************************************************************************/
39 /** \defgroup libvlc_media_list_player libvlc_media_list_player
41 * LibVLC Media List Player, play a media_list. You can see that as a media
46 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
49 * Defines playback modes for playlist.
51 typedef enum libvlc_playback_mode_t
53 libvlc_playback_mode_default,
54 libvlc_playback_mode_loop,
55 libvlc_playback_mode_repeat
56 } libvlc_playback_mode_t;
59 * Create new media_list_player.
61 * \param p_instance libvlc instance
62 * \param p_e initialized exception instance
63 * \return media list player instance or NULL on error
65 VLC_PUBLIC_API libvlc_media_list_player_t *
66 libvlc_media_list_player_new( libvlc_instance_t * p_instance );
69 * Release media_list_player.
71 * \param p_mlp media list player instance
74 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
77 * Return the event manager of this media_list_player.
79 * \param p_mlp media list player instance
81 VLC_PUBLIC_API libvlc_event_manager_t *
82 libvlc_media_list_player_event_manager(libvlc_media_list_player_t * p_mlp);
85 * Replace media player in media_list_player with this instance.
87 * \param p_mlp media list player instance
88 * \param p_mi media player instance
89 * \param p_e initialized exception instance
92 libvlc_media_list_player_set_media_player(
93 libvlc_media_list_player_t * p_mlp,
94 libvlc_media_player_t * p_mi );
97 libvlc_media_list_player_set_media_list(
98 libvlc_media_list_player_t * p_mlp,
99 libvlc_media_list_t * p_mlist );
104 * \param p_mlp media list player instance
105 * \param p_e initialized exception instance
108 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
109 libvlc_exception_t * p_e );
114 * \param p_mlp media list player instance
115 * \param p_e initialized exception instance
118 libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
119 libvlc_exception_t * p_e );
122 * Is media list playing?
124 * \param p_mlp media list player instance
125 * \param p_e initialized exception instance
126 * \return true for playing and false for not playing
129 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp );
132 * Get current libvlc_state of media list player
134 * \param p_mlp media list player instance
135 * \return libvlc_state_t for media list player
137 VLC_PUBLIC_API libvlc_state_t
138 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp );
141 * Play media list item at position index
143 * \param p_mlp media list player instance
144 * \param i_index index in media list to play
145 * \param p_e initialized exception instance
148 libvlc_media_list_player_play_item_at_index(
149 libvlc_media_list_player_t * p_mlp,
151 libvlc_exception_t * p_e );
154 libvlc_media_list_player_play_item(
155 libvlc_media_list_player_t * p_mlp,
156 libvlc_media_t * p_md,
157 libvlc_exception_t * p_e );
160 * Stop playing media list
162 * \param p_mlp media list player instance
165 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp );
168 * Play next item from media list
170 * \param p_mlp media list player instance
171 * \param p_e initialized exception instance
174 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
175 libvlc_exception_t * p_e );
178 * Play previous item from media list
180 * \param p_mlp media list player instance
181 * \param p_e initialized exception instance
184 libvlc_media_list_player_previous( libvlc_media_list_player_t * p_mlp,
185 libvlc_exception_t * p_e );
190 * Sets the playback mode for the playlist
192 * \param p_mlp media list player instance
193 * \param e_mode playback mode specification
196 libvlc_media_list_player_set_playback_mode(
197 libvlc_media_list_player_t * p_mlp,
198 libvlc_playback_mode_t e_mode );
200 /** @} media_list_player */
206 #endif /* LIBVLC_MEDIA_LIST_PLAYER_H */