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 * Create new media_list_player.
51 * \param p_instance libvlc instance
52 * \param p_e initialized exception instance
53 * \return media list player instance
55 VLC_PUBLIC_API libvlc_media_list_player_t *
56 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
57 libvlc_exception_t * p_e );
60 * Release media_list_player.
62 * \param p_mlp media list player instance
65 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
68 * Replace media player in media_list_player with this instance.
70 * \param p_mlp media list player instance
71 * \param p_mi media player instance
72 * \param p_e initialized exception instance
75 libvlc_media_list_player_set_media_player(
76 libvlc_media_list_player_t * p_mlp,
77 libvlc_media_player_t * p_mi,
78 libvlc_exception_t * p_e );
81 libvlc_media_list_player_set_media_list(
82 libvlc_media_list_player_t * p_mlp,
83 libvlc_media_list_t * p_mlist,
84 libvlc_exception_t * p_e );
89 * \param p_mlp media list player instance
90 * \param p_e initialized exception instance
93 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
94 libvlc_exception_t * p_e );
99 * \param p_mlp media list player instance
100 * \param p_e initialized exception instance
103 libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
104 libvlc_exception_t * p_e );
107 * Is media list playing?
109 * \param p_mlp media list player instance
110 * \param p_e initialized exception instance
111 * \return true for playing and false for not playing
114 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
115 libvlc_exception_t * p_e );
118 * Get current libvlc_state of media list player
120 * \param p_mlp media list player instance
121 * \param p_e initialized exception instance
122 * \return libvlc_state_t for media list player
124 VLC_PUBLIC_API libvlc_state_t
125 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
126 libvlc_exception_t * p_e );
129 * Play media list item at position index
131 * \param p_mlp media list player instance
132 * \param i_index index in media list to play
133 * \param p_e initialized exception instance
136 libvlc_media_list_player_play_item_at_index(
137 libvlc_media_list_player_t * p_mlp,
139 libvlc_exception_t * p_e );
142 libvlc_media_list_player_play_item(
143 libvlc_media_list_player_t * p_mlp,
144 libvlc_media_t * p_md,
145 libvlc_exception_t * p_e );
148 * Stop playing media list
150 * \param p_mlp media list player instance
151 * \param p_e initialized exception instance
154 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
155 libvlc_exception_t * p_e );
158 * Play next item from media list
160 * \param p_mlp media list player instance
161 * \param p_e initialized exception instance
164 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
165 libvlc_exception_t * p_e );
167 /* NOTE: shouldn't there also be a libvlc_media_list_player_prev() */
169 /** @} media_list_player */
175 #endif /* LIBVLC_MEDIA_LIST_PLAYER_H */