1 /*****************************************************************************
2 * deprecated.h: libvlc deprecated API
3 *****************************************************************************
4 * Copyright (C) 1998-2005 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #ifndef _LIBVLC_DEPRECATED_H
26 #define _LIBVLC_DEPRECATED_H 1
33 * This function shall not be used at all. It may lead to crash and race condition.
35 VLC_DEPRECATED_API int libvlc_video_destroy( libvlc_media_player_t *, libvlc_exception_t *);
37 /*****************************************************************************
38 * Playlist (Deprecated)
39 *****************************************************************************/
40 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
42 * LibVLC Playlist handling (Deprecated)
43 * @deprecated Use media_list
48 * Set the playlist's loop attribute. If set, the playlist runs continuously
49 * and wraps around when it reaches the end.
51 * \param p_instance the playlist instance
52 * \param loop the loop attribute. 1 sets looping, 0 disables it
53 * \param p_e an initialized exception pointer
55 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
56 libvlc_exception_t * );
61 * Additionnal playlist item options can be specified for addition to the
62 * item before it is played.
64 * \param p_instance the playlist instance
65 * \param i_id the item to play. If this is a negative number, the next
66 * item will be selected. Otherwise, the item with the given ID will be
68 * \param i_options the number of options to add to the item
69 * \param ppsz_options the options to add to the item
70 * \param p_e an initialized exception pointer
72 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
73 char **, libvlc_exception_t * );
76 * Toggle the playlist's pause status.
78 * If the playlist was running, it is paused. If it was paused, it is resumed.
80 * \param p_instance the playlist instance to pause
81 * \param p_e an initialized exception pointer
83 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
84 libvlc_exception_t * );
87 * Checks whether the playlist is running
89 * \param p_instance the playlist instance
90 * \param p_e an initialized exception pointer
91 * \return 0 if the playlist is stopped or paused, 1 if it is running
93 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
94 libvlc_exception_t * );
97 * Get the number of items in the playlist
99 * \param p_instance the playlist instance
100 * \param p_e an initialized exception pointer
101 * \return the number of items
103 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
104 libvlc_exception_t * );
109 * \param p_instance the playlist instance
111 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
114 * Unlock the playlist.
116 * \param p_instance the playlist instance
118 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
123 * \param p_instance the playlist instance to stop
124 * \param p_e an initialized exception pointer
126 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
127 libvlc_exception_t * );
130 * Go to the next playlist item. If the playlist was stopped, playback
133 * \param p_instance the playlist instance
134 * \param p_e an initialized exception pointer
136 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
137 libvlc_exception_t * );
140 * Go to the previous playlist item. If the playlist was stopped, playback
143 * \param p_instance the playlist instance
144 * \param p_e an initialized exception pointer
146 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
147 libvlc_exception_t * );
150 * Empty a playlist. All items in the playlist are removed.
152 * \param p_instance the playlist instance
153 * \param p_e an initialized exception pointer
155 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
156 libvlc_exception_t * );
159 * Append an item to the playlist. The item is added at the end. If more
160 * advanced options are required, \see libvlc_playlist_add_extended instead.
162 * \param p_instance the playlist instance
163 * \param psz_uri the URI to open, using VLC format
164 * \param psz_name a name that you might want to give or NULL
165 * \param p_e an initialized exception pointer
166 * \return the identifier of the new item
168 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
169 const char *, libvlc_exception_t * );
172 * Append an item to the playlist. The item is added at the end, with
173 * additional input options.
175 * \param p_instance the playlist instance
176 * \param psz_uri the URI to open, using VLC format
177 * \param psz_name a name that you might want to give or NULL
178 * \param i_options the number of options to add
179 * \param ppsz_options strings representing the options to add
180 * \param p_e an initialized exception pointer
181 * \return the identifier of the new item
183 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
184 const char *, int, const char **,
185 libvlc_exception_t * );
188 * Delete the playlist item with the given ID.
190 * \param p_instance the playlist instance
191 * \param i_id the id to remove
192 * \param p_e an initialized exception pointer
193 * \return 0 in case of success, a non-zero value otherwise
195 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
196 libvlc_exception_t * );
198 /** Get the input that is currently being played by the playlist.
200 * \param p_instance the playlist instance to use
201 * \param p_e an initialized exception pointern
202 * \return a media instance object
204 VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
205 libvlc_instance_t *, libvlc_exception_t * );
213 #endif /* _LIBVLC_DEPRECATED_H */