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 * The LibVLC media list player plays a @ref libvlc_media_list_t list of media,
43 * This is required to especially support playlist files.
44 * The normal @ref libvlc_media_player_t LibVLC media player can only play a
45 * single media, and does not handle playlist files properly.
49 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
52 * Defines playback modes for playlist.
54 typedef enum libvlc_playback_mode_t
56 libvlc_playback_mode_default,
57 libvlc_playback_mode_loop,
58 libvlc_playback_mode_repeat
59 } libvlc_playback_mode_t;
62 * Create new media_list_player.
64 * \param p_instance libvlc instance
65 * \return media list player instance or NULL on error
67 LIBVLC_API libvlc_media_list_player_t *
68 libvlc_media_list_player_new( libvlc_instance_t * p_instance );
71 * Release a media_list_player after use
72 * Decrement the reference count of a media player object. If the
73 * reference count is 0, then libvlc_media_list_player_release() will
74 * release the media player object. If the media player object
75 * has been released, then it should not be used again.
77 * \param p_mlp media list player instance
80 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
83 * Retain a reference to a media player list object. Use
84 * libvlc_media_list_player_release() to decrement reference count.
86 * \param p_mlp media player list object
89 libvlc_media_list_player_retain( libvlc_media_list_player_t *p_mlp );
92 * Return the event manager of this media_list_player.
94 * \param p_mlp media list player instance
95 * \return the event manager
97 LIBVLC_API libvlc_event_manager_t *
98 libvlc_media_list_player_event_manager(libvlc_media_list_player_t * p_mlp);
101 * Replace media player in media_list_player with this instance.
103 * \param p_mlp media list player instance
104 * \param p_mi media player instance
107 libvlc_media_list_player_set_media_player(
108 libvlc_media_list_player_t * p_mlp,
109 libvlc_media_player_t * p_mi );
112 * Set the media list associated with the player
114 * \param p_mlp media list player instance
115 * \param p_mlist list of media
118 libvlc_media_list_player_set_media_list(
119 libvlc_media_list_player_t * p_mlp,
120 libvlc_media_list_t * p_mlist );
125 * \param p_mlp media list player instance
128 void libvlc_media_list_player_play(libvlc_media_list_player_t * p_mlp);
133 * \param p_mlp media list player instance
136 void libvlc_media_list_player_pause(libvlc_media_list_player_t * p_mlp);
139 * Is media list playing?
141 * \param p_mlp media list player instance
142 * \return true for playing and false for not playing
144 * \libvlc_return_bool
147 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp );
150 * Get current libvlc_state of media list player
152 * \param p_mlp media list player instance
153 * \return libvlc_state_t for media list player
155 LIBVLC_API libvlc_state_t
156 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp );
159 * Play media list item at position index
161 * \param p_mlp media list player instance
162 * \param i_index index in media list to play
163 * \return 0 upon success -1 if the item wasn't found
166 int libvlc_media_list_player_play_item_at_index(libvlc_media_list_player_t * p_mlp,
170 * Play the given media item
172 * \param p_mlp media list player instance
173 * \param p_md the media instance
174 * \return 0 upon success, -1 if the media is not part of the media list
177 int libvlc_media_list_player_play_item(libvlc_media_list_player_t * p_mlp,
178 libvlc_media_t * p_md);
181 * Stop playing media list
183 * \param p_mlp media list player instance
186 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp);
189 * Play next item from media list
191 * \param p_mlp media list player instance
192 * \return 0 upon success -1 if there is no next item
195 int libvlc_media_list_player_next(libvlc_media_list_player_t * p_mlp);
198 * Play previous item from media list
200 * \param p_mlp media list player instance
201 * \return 0 upon success -1 if there is no previous item
204 int libvlc_media_list_player_previous(libvlc_media_list_player_t * p_mlp);
209 * Sets the playback mode for the playlist
211 * \param p_mlp media list player instance
212 * \param e_mode playback mode specification
215 void libvlc_media_list_player_set_playback_mode(libvlc_media_list_player_t * p_mlp,
216 libvlc_playback_mode_t e_mode );
218 /** @} media_list_player */
224 #endif /* LIBVLC_MEDIA_LIST_PLAYER_H */