1 /*****************************************************************************
2 * deprecated.h: libvlc deprecated API
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman@videolan.org>
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
30 * This file defines libvlc depreceated API
38 * Set the default video output's parent.
40 * This setting will be used as default for all video outputs.
42 * \param p_instance libvlc instance
43 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
44 * \param p_e an initialized exception pointer
45 * @deprecated Use libvlc_media_player_set_drawable
47 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
50 * Set the default video output parent.
52 * This setting will be used as default for all video outputs.
54 * \param p_instance libvlc instance
55 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
56 * \param p_e an initialized exception pointer
57 * @deprecated Use libvlc_media_player_get_drawable
59 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
62 * This function shall not be used at all. It may lead to crash and race condition.
64 VLC_DEPRECATED_API int libvlc_video_destroy( libvlc_media_player_t *, libvlc_exception_t *);
66 /*****************************************************************************
67 * Playlist (Deprecated)
68 *****************************************************************************/
69 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
71 * LibVLC Playlist handling (Deprecated)
72 * @deprecated Use media_list
77 * Set the playlist's loop attribute. If set, the playlist runs continuously
78 * and wraps around when it reaches the end.
80 * \param p_instance the playlist instance
81 * \param loop the loop attribute. 1 sets looping, 0 disables it
82 * \param p_e an initialized exception pointer
84 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
85 libvlc_exception_t * );
90 * Additionnal playlist item options can be specified for addition to the
91 * item before it is played.
93 * \param p_instance the playlist instance
94 * \param i_id the item to play. If this is a negative number, the next
95 * item will be selected. Otherwise, the item with the given ID will be
97 * \param i_options the number of options to add to the item
98 * \param ppsz_options the options to add to the item
99 * \param p_e an initialized exception pointer
101 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
102 char **, libvlc_exception_t * );
105 * Toggle the playlist's pause status.
107 * If the playlist was running, it is paused. If it was paused, it is resumed.
109 * \param p_instance the playlist instance to pause
110 * \param p_e an initialized exception pointer
112 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
113 libvlc_exception_t * );
116 * Checks whether the playlist is running
118 * \param p_instance the playlist instance
119 * \param p_e an initialized exception pointer
120 * \return 0 if the playlist is stopped or paused, 1 if it is running
122 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
123 libvlc_exception_t * );
126 * Get the number of items in the playlist
128 * \param p_instance the playlist instance
129 * \param p_e an initialized exception pointer
130 * \return the number of items
132 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
133 libvlc_exception_t * );
135 VLC_DEPRECATED_API int libvlc_playlist_get_current_index( libvlc_instance_t *,
136 libvlc_exception_t *);
140 * \param p_instance the playlist instance
142 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
145 * Unlock the playlist.
147 * \param p_instance the playlist instance
149 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
154 * \param p_instance the playlist instance to stop
155 * \param p_e an initialized exception pointer
157 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
158 libvlc_exception_t * );
161 * Go to the next playlist item. If the playlist was stopped, playback
164 * \param p_instance the playlist instance
165 * \param p_e an initialized exception pointer
167 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
168 libvlc_exception_t * );
171 * Go to the previous playlist item. If the playlist was stopped, playback
174 * \param p_instance the playlist instance
175 * \param p_e an initialized exception pointer
177 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
178 libvlc_exception_t * );
181 * Empty a playlist. All items in the playlist are removed.
183 * \param p_instance the playlist instance
184 * \param p_e an initialized exception pointer
186 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
187 libvlc_exception_t * );
190 * Append an item to the playlist. The item is added at the end. If more
191 * advanced options are required, \see libvlc_playlist_add_extended instead.
193 * \param p_instance the playlist instance
194 * \param psz_uri the URI to open, using VLC format
195 * \param psz_name a name that you might want to give or NULL
196 * \param p_e an initialized exception pointer
197 * \return the identifier of the new item
199 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
200 const char *, libvlc_exception_t * );
203 * Append an item to the playlist. The item is added at the end, with
204 * additional input options.
206 * \param p_instance the playlist instance
207 * \param psz_uri the URI to open, using VLC format
208 * \param psz_name a name that you might want to give or NULL
209 * \param i_options the number of options to add
210 * \param ppsz_options strings representing the options to add
211 * \param p_e an initialized exception pointer
212 * \return the identifier of the new item
214 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
215 const char *, int, const char **,
216 libvlc_exception_t * );
219 * Delete the playlist item with the given ID.
221 * \param p_instance the playlist instance
222 * \param i_id the id to remove
223 * \param p_e an initialized exception pointer
224 * \return 0 in case of success, a non-zero value otherwise
226 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
227 libvlc_exception_t * );
229 /** Get the input that is currently being played by the playlist.
231 * \param p_instance the playlist instance to use
232 * \param p_e an initialized exception pointern
233 * \return a media instance object
235 VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
236 libvlc_instance_t *, libvlc_exception_t * );
244 #endif /* _LIBVLC_DEPRECATED_H */