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 /*****************************************************************************
34 * Playlist (Deprecated)
35 *****************************************************************************/
36 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
38 * LibVLC Playlist handling (Deprecated)
39 * @deprecated Use media_list
44 * Set the playlist's loop attribute. If set, the playlist runs continuously
45 * and wraps around when it reaches the end.
47 * \param p_instance the playlist instance
48 * \param loop the loop attribute. 1 sets looping, 0 disables it
49 * \param p_e an initialized exception pointer
51 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
52 libvlc_exception_t * );
57 * Additionnal playlist item options can be specified for addition to the
58 * item before it is played.
60 * \param p_instance the playlist instance
61 * \param i_id the item to play. If this is a negative number, the next
62 * item will be selected. Otherwise, the item with the given ID will be
64 * \param i_options the number of options to add to the item
65 * \param ppsz_options the options to add to the item
66 * \param p_e an initialized exception pointer
68 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
69 char **, libvlc_exception_t * );
72 * Toggle the playlist's pause status.
74 * If the playlist was running, it is paused. If it was paused, it is resumed.
76 * \param p_instance the playlist instance to pause
77 * \param p_e an initialized exception pointer
79 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
80 libvlc_exception_t * );
83 * Checks whether the playlist is running
85 * \param p_instance the playlist instance
86 * \param p_e an initialized exception pointer
87 * \return 0 if the playlist is stopped or paused, 1 if it is running
89 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
90 libvlc_exception_t * );
93 * Get the number of items in the playlist
95 * \param p_instance the playlist instance
96 * \param p_e an initialized exception pointer
97 * \return the number of items
99 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
100 libvlc_exception_t * );
105 * \param p_instance the playlist instance
107 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
110 * Unlock the playlist.
112 * \param p_instance the playlist instance
114 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
119 * \param p_instance the playlist instance to stop
120 * \param p_e an initialized exception pointer
122 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
123 libvlc_exception_t * );
126 * Go to the next playlist item. If the playlist was stopped, playback
129 * \param p_instance the playlist instance
130 * \param p_e an initialized exception pointer
132 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
133 libvlc_exception_t * );
136 * Go to the previous playlist item. If the playlist was stopped, playback
139 * \param p_instance the playlist instance
140 * \param p_e an initialized exception pointer
142 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
143 libvlc_exception_t * );
146 * Empty a playlist. All items in the playlist are removed.
148 * \param p_instance the playlist instance
149 * \param p_e an initialized exception pointer
151 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
152 libvlc_exception_t * );
155 * Append an item to the playlist. The item is added at the end. If more
156 * advanced options are required, \see libvlc_playlist_add_extended instead.
158 * \param p_instance the playlist instance
159 * \param psz_uri the URI to open, using VLC format
160 * \param psz_name a name that you might want to give or NULL
161 * \param p_e an initialized exception pointer
162 * \return the identifier of the new item
164 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
165 const char *, libvlc_exception_t * );
168 * Append an item to the playlist. The item is added at the end, with
169 * additional input options.
171 * \param p_instance the playlist instance
172 * \param psz_uri the URI to open, using VLC format
173 * \param psz_name a name that you might want to give or NULL
174 * \param i_options the number of options to add
175 * \param ppsz_options strings representing the options to add
176 * \param p_e an initialized exception pointer
177 * \return the identifier of the new item
179 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
180 const char *, int, const char **,
181 libvlc_exception_t * );
184 * Delete the playlist item with the given ID.
186 * \param p_instance the playlist instance
187 * \param i_id the id to remove
188 * \param p_e an initialized exception pointer
189 * \return 0 in case of success, a non-zero value otherwise
191 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
192 libvlc_exception_t * );
194 /** Get the input that is currently being played by the playlist.
196 * \param p_instance the playlist instance to use
197 * \param p_e an initialized exception pointern
198 * \return a media instance object
200 VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
201 libvlc_instance_t *, libvlc_exception_t * );
206 * \defgroup libvlc_old Libvlc Old (Deprecated)
207 * This is libvlc, the base library of the VLC program. (Deprecated)
208 * This is the legacy API. Please consider using the new libvlc API
215 /*****************************************************************************
216 * Exported vlc API (Deprecated)
217 *****************************************************************************/
219 /*****************************************************************************
221 *****************************************************************************/
223 /* Used by VLC_AddTarget() */
224 #define PLAYLIST_INSERT 0x0001
225 #define PLAYLIST_APPEND 0x0002
226 #define PLAYLIST_GO 0x0004
227 #define PLAYLIST_PREPARSE 0x0008
228 #define PLAYLIST_SPREPARSE 0x0010
229 #define PLAYLIST_NO_REBUILD 0x0020
231 #define PLAYLIST_END -666
233 /*****************************************************************************
235 *****************************************************************************/
236 #define VLC_SUCCESS -0 /* No error */
237 #define VLC_ENOMEM -1 /* Not enough memory */
238 #define VLC_ETHREAD -2 /* Thread error */
239 #define VLC_ETIMEOUT -3 /* Timeout */
241 #define VLC_ENOMOD -10 /* Module not found */
243 #define VLC_ENOOBJ -20 /* Object not found */
244 #define VLC_EBADOBJ -21 /* Bad object type */
246 #define VLC_ENOVAR -30 /* Variable not found */
247 #define VLC_EBADVAR -31 /* Bad variable value */
249 #define VLC_ENOITEM -40 /**< Item not found */
251 #define VLC_EEXIT -255 /* Program exited */
252 #define VLC_EEXITSUCCESS -999 /* Program exited successfully */
253 #define VLC_EGENERIC -666 /* Generic error */
257 #if !defined( __LIBVLC__ )
258 /* Otherwise they are declared and exported in vlc_common.h */
260 * Retrieve libvlc version
262 * \return a string containing the libvlc version
264 VLC_DEPRECATED_API char const * VLC_Version ( void );
267 * Retrieve the username of the libvlc builder
269 * \return a string containing the username of the libvlc builder
271 VLC_DEPRECATED_API char const * VLC_CompileBy ( void );
274 * Retrieve the host of the libvlc builder
276 * \return a string containing the host of the libvlc builder
278 VLC_DEPRECATED_API char const * VLC_CompileHost ( void );
281 * Retrieve the domain name of the host of the libvlc builder
283 * \return a string containing the domain name of the host of the libvlc builder
285 VLC_DEPRECATED_API char const * VLC_CompileDomain ( void );
288 * Retrieve libvlc compiler version
290 * \return a string containing the libvlc compiler version
292 VLC_DEPRECATED_API char const * VLC_Compiler ( void );
295 * Retrieve libvlc changeset
297 * \return a string containing the libvlc subversion changeset
299 VLC_DEPRECATED_API char const * VLC_Changeset ( void );
301 #endif /* __LIBVLC__ */
306 * This function sets a variable of VLC
308 * \note Was previously called VLC_Set
310 * \param i_object a vlc object id
311 * \param psz_var a vlc variable name
312 * \param value a vlc_value_t structure
313 * \return VLC_SUCCESS on success
315 VLC_DEPRECATED_API int VLC_VariableSet( int, char const *, vlc_value_t );
320 * This function gets the value of a variable of VLC
321 * It stores it in the p_value argument
323 * \note Was previously called VLC_Get
325 * \param i_object a vlc object id
326 * \param psz_var a vlc variable name
327 * \param p_value a pointer to a vlc_value_t structure
328 * \return VLC_SUCCESS on success
330 VLC_DEPRECATED_API int VLC_VariableGet( int, char const *, vlc_value_t * );
333 * Get a VLC variable type
335 * This function gets the type of a variable of VLC
336 * It stores it in the p_type argument
338 * \param i_object a vlc object id
339 * \param psz_var a vlc variable name
340 * \param pi_type a pointer to an integer
341 * \return VLC_SUCCESS on success
343 VLC_DEPRECATED_API int VLC_VariableType( int, char const *, int * );
346 * Add a target to the current playlist
348 * This funtion will add a target to the current playlist. If a playlist does
349 * not exist, it will be created.
351 * \param i_object a vlc object id
352 * \param psz_target the URI of the target to play
353 * \param ppsz_options an array of strings with input options (ie. :input-repeat)
354 * \param i_options the amount of options in the ppsz_options array
355 * \param i_mode the insert mode to insert the target into the playlist (PLAYLIST_* defines)
356 * \param i_pos the position at which to add the new target (PLAYLIST_END for end)
357 * \return the item id on success and -1 on error
359 VLC_DEPRECATED_API int VLC_AddTarget( int, char const *, const char **, int, int, int );
362 * Start the playlist and play the currently selected playlist item
364 * If there is something in the playlist, and the playlist is not running,
365 * then start the playlist and play the currently selected playlist item.
366 * If an item is currently paused, then resume it.
368 * \param i_object a vlc object id
369 * \return VLC_SUCCESS on success
371 VLC_DEPRECATED_API int VLC_Play( int );
374 * Pause the currently playing item. Resume it if already paused
376 * If an item is currently playing then pause it.
377 * If the item is already paused, then resume playback.
379 * \param i_object a vlc object id
380 * \return VLC_SUCCESS on success
382 VLC_DEPRECATED_API int VLC_Pause( int );
387 * If an item is currently playing then stop it.
388 * Set the playlist to a stopped state.
390 * \note This function is new. The old VLC_Stop is now called VLC_CleanUp
392 * \param i_object a vlc object id
393 * \return VLC_SUCCESS on success
395 VLC_DEPRECATED_API int VLC_Stop( int );
398 * Tell if VLC is playing
400 * If an item is currently playing, it returns
403 * \param i_object a vlc object id
404 * \return true or false
406 VLC_DEPRECATED_API bool VLC_IsPlaying( int );
409 * Get the current position in a input
411 * Return the current position as a float
412 * This method should be used for time sliders etc
413 * \note For some inputs, this will be unknown.
415 * \param i_object a vlc object id
416 * \return a float in the range of 0.0 - 1.0
418 VLC_DEPRECATED_API float VLC_PositionGet( int );
421 * Set the current position in a input
423 * Set the current position as a float
424 * This method should be used for time sliders etc
425 * \note For some inputs, this will be unknown.
427 * \param i_object a vlc object id
428 * \param i_position a float in the range of 0.0 - 1.0
429 * \return a float in the range of 0.0 - 1.0
431 VLC_DEPRECATED_API float VLC_PositionSet( int, float );
434 * Get the current position in a input
436 * Return the current position in seconds from the start.
437 * \note For some inputs, this will be unknown.
439 * \param i_object a vlc object id
440 * \return the offset from 0:00 in seconds
442 VLC_DEPRECATED_API int VLC_TimeGet( int );
445 * Seek to a position in the current input
447 * Seek i_seconds in the current input. If b_relative is set,
448 * then the seek will be relative to the current position, otherwise
449 * it will seek to i_seconds from the beginning of the input.
450 * \note For some inputs, this will be unknown.
452 * \param i_object a vlc object id
453 * \param i_seconds seconds from current position or from beginning of input
454 * \param b_relative seek relative from current position
455 * \return VLC_SUCCESS on success
457 VLC_DEPRECATED_API int VLC_TimeSet( int, int, bool );
460 * Get the total length of a input
462 * Return the total length in seconds from the current input.
463 * \note For some inputs, this will be unknown.
465 * \param i_object a vlc object id
466 * \return the length in seconds
468 VLC_DEPRECATED_API int VLC_LengthGet( int );
471 * Play the input faster than realtime
473 * 2x, 4x, 8x faster than realtime
474 * \note For some inputs, this will be impossible.
476 * \param i_object a vlc object id
477 * \return the current speedrate
479 VLC_DEPRECATED_API float VLC_SpeedFaster( int );
482 * Play the input slower than realtime
484 * 1/2x, 1/4x, 1/8x slower than realtime
485 * \note For some inputs, this will be impossible.
487 * \param i_object a vlc object id
488 * \return the current speedrate
490 VLC_DEPRECATED_API float VLC_SpeedSlower( int );
493 * Return the current playlist item
495 * \param i_object a vlc object id
496 * \return the index of the playlistitem that is currently selected for play
498 VLC_DEPRECATED_API int VLC_PlaylistIndex( int );
501 * Total amount of items in the playlist
503 * \param i_object a vlc object id
504 * \return amount of playlist items
506 VLC_DEPRECATED_API int VLC_PlaylistNumberOfItems( int );
511 * Skip to the next playlistitem and play it.
513 * \param i_object a vlc object id
514 * \return VLC_SUCCESS on success
516 VLC_DEPRECATED_API int VLC_PlaylistNext( int );
519 * Previous playlist item
521 * Skip to the previous playlistitem and play it.
523 * \param i_object a vlc object id
524 * \return VLC_SUCCESS on success
526 VLC_DEPRECATED_API int VLC_PlaylistPrev( int );
529 * Clear the contents of the playlist
531 * Completly empty the entire playlist.
533 * \note Was previously called VLC_ClearPlaylist
535 * \param i_object a vlc object id
536 * \return VLC_SUCCESS on success
538 VLC_DEPRECATED_API int VLC_PlaylistClear( int );
543 * \param i_object a vlc object id
544 * \param i_volume something in a range from 0-200
545 * \return the new volume (range 0-200 %)
547 VLC_DEPRECATED_API int VLC_VolumeSet( int, int );
550 * Get the current volume
552 * Retrieve the current volume.
554 * \param i_object a vlc object id
555 * \return the current volume (range 0-200 %)
557 VLC_DEPRECATED_API int VLC_VolumeGet( int );
560 * Mute/Unmute the volume
562 * \param i_object a vlc object id
563 * \return VLC_SUCCESS on success
565 VLC_DEPRECATED_API int VLC_VolumeMute( int );
568 * Toggle Fullscreen mode
570 * Switch between normal and fullscreen video
572 * \param i_object a vlc object id
573 * \return VLC_SUCCESS on success
575 VLC_DEPRECATED_API int VLC_FullScreen( int );
583 #endif /* _LIBVLC_DEPRECATED_H */