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
34 * This is the legacy representation of a platform-specific drawable. Because
35 * it cannot accomodate a pointer on most 64-bits platforms, it should not be
38 typedef int libvlc_drawable_t;
45 * Set the drawable where the media player should render its video output.
47 * On Windows 32-bits, a window handle (HWND) is expected.
48 * On Windows 64-bits, this function will always fail.
50 * On OSX 32-bits, a CGrafPort is expected.
51 * On OSX 64-bits, this function will always fail.
53 * On other platforms, an existing X11 window ID is expected. See
54 * libvlc_media_player_set_xid() for details.
56 * \param p_mi the Media Player
57 * \param drawable the libvlc_drawable_t where the media player
58 * should render its video
59 * \param p_e an initialized exception pointer
61 VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
64 * Get the drawable where the media player should render its video output
66 * \param p_mi the Media Player
67 * \param p_e an initialized exception pointer
68 * \return the libvlc_drawable_t where the media player
69 * should render its video
71 VLC_PUBLIC_API libvlc_drawable_t
72 libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
75 * Set the default video output's parent.
77 * This setting will be used as default for any video output.
79 * \param p_instance libvlc instance
80 * \param drawable the new parent window
81 * (see libvlc_media_player_set_drawable() for details)
82 * \param p_e an initialized exception pointer
83 * @deprecated Use libvlc_media_player_set_drawable
85 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
88 * Set the default video output parent.
90 * This setting will be used as default for all video outputs.
92 * \param p_instance libvlc instance
93 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
94 * \param p_e an initialized exception pointer
95 * @deprecated Use libvlc_media_player_get_drawable
97 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
100 * Change the parent for the current the video output.
102 * \param p_instance libvlc instance
103 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
104 * \param p_e an initialized exception pointer
105 * \return the success status (boolean)
107 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
110 * This function shall not be used at all. It may lead to crash and race condition.
112 VLC_DEPRECATED_API int libvlc_video_destroy( libvlc_media_player_t *, libvlc_exception_t *);
114 /*****************************************************************************
115 * Playlist (Deprecated)
116 *****************************************************************************/
117 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
119 * LibVLC Playlist handling (Deprecated)
120 * @deprecated Use media_list
125 * Set the playlist's loop attribute. If set, the playlist runs continuously
126 * and wraps around when it reaches the end.
128 * \param p_instance the playlist instance
129 * \param loop the loop attribute. 1 sets looping, 0 disables it
130 * \param p_e an initialized exception pointer
132 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
133 libvlc_exception_t * );
138 * Additionnal playlist item options can be specified for addition to the
139 * item before it is played.
141 * \param p_instance the playlist instance
142 * \param i_id the item to play. If this is a negative number, the next
143 * item will be selected. Otherwise, the item with the given ID will be
145 * \param i_options the number of options to add to the item
146 * \param ppsz_options the options to add to the item
147 * \param p_e an initialized exception pointer
149 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
150 char **, libvlc_exception_t * );
153 * Toggle the playlist's pause status.
155 * If the playlist was running, it is paused. If it was paused, it is resumed.
157 * \param p_instance the playlist instance to pause
158 * \param p_e an initialized exception pointer
160 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
161 libvlc_exception_t * );
164 * Checks whether the playlist is running
166 * \param p_instance the playlist instance
167 * \param p_e an initialized exception pointer
168 * \return 0 if the playlist is stopped or paused, 1 if it is running
170 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
171 libvlc_exception_t * );
174 * Get the number of items in the playlist
176 * \param p_instance the playlist instance
177 * \param p_e an initialized exception pointer
178 * \return the number of items
180 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
181 libvlc_exception_t * );
183 VLC_DEPRECATED_API int libvlc_playlist_get_current_index( libvlc_instance_t *,
184 libvlc_exception_t *);
188 * \param p_instance the playlist instance
190 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
193 * Unlock the playlist.
195 * \param p_instance the playlist instance
197 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
202 * \param p_instance the playlist instance to stop
203 * \param p_e an initialized exception pointer
205 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
206 libvlc_exception_t * );
209 * Go to the next playlist item. If the playlist was stopped, playback
212 * \param p_instance the playlist instance
213 * \param p_e an initialized exception pointer
215 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
216 libvlc_exception_t * );
219 * Go to the previous playlist item. If the playlist was stopped, playback
222 * \param p_instance the playlist instance
223 * \param p_e an initialized exception pointer
225 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
226 libvlc_exception_t * );
229 * Empty a playlist. All items in the playlist are removed.
231 * \param p_instance the playlist instance
232 * \param p_e an initialized exception pointer
234 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
235 libvlc_exception_t * );
238 * Append an item to the playlist. The item is added at the end. If more
239 * advanced options are required, \see libvlc_playlist_add_extended instead.
241 * \param p_instance the playlist instance
242 * \param psz_uri the URI to open, using VLC format
243 * \param psz_name a name that you might want to give or NULL
244 * \param p_e an initialized exception pointer
245 * \return the identifier of the new item
247 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
248 const char *, libvlc_exception_t * );
251 * Append an item to the playlist. The item is added at the end, with
252 * additional input options.
254 * \param p_instance the playlist instance
255 * \param psz_uri the URI to open, using VLC format
256 * \param psz_name a name that you might want to give or NULL
257 * \param i_options the number of options to add
258 * \param ppsz_options strings representing the options to add
259 * \param p_e an initialized exception pointer
260 * \return the identifier of the new item
262 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
263 const char *, int, const char **,
264 libvlc_exception_t * );
267 * Append an item to the playlist. The item is added at the end, with
268 * additional input options from an untrusted source.
270 * \param p_instance the playlist instance
271 * \param psz_uri the URI to open, using VLC format
272 * \param psz_name a name that you might want to give or NULL
273 * \param i_options the number of options to add
274 * \param ppsz_options strings representing the options to add
275 * \param p_e an initialized exception pointer
276 * \return the identifier of the new item
278 VLC_DEPRECATED_API int libvlc_playlist_add_extended_untrusted( libvlc_instance_t *, const char *,
279 const char *, int, const char **,
280 libvlc_exception_t * );
283 * Delete the playlist item with the given ID.
285 * \param p_instance the playlist instance
286 * \param i_id the id to remove
287 * \param p_e an initialized exception pointer
288 * \return 0 in case of success, a non-zero value otherwise
290 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
291 libvlc_exception_t * );
293 /** Get the input that is currently being played by the playlist.
295 * \param p_instance the playlist instance to use
296 * \param p_e an initialized exception pointern
297 * \return a media instance object
299 VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
300 libvlc_instance_t *, libvlc_exception_t * );
308 #endif /* _LIBVLC_DEPRECATED_H */