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 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_instance_t * libvlc_playlist_get_media_instance(
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
214 /*****************************************************************************
216 *****************************************************************************/
217 typedef bool vlc_bool_t;
218 typedef struct vlc_list_t vlc_list_t;
219 typedef struct vlc_object_t vlc_object_t;
222 * \defgroup var_type Variable types
223 * These are the different types a vlc variable can have.
226 #define VLC_VAR_VOID 0x0010
227 #define VLC_VAR_BOOL 0x0020
228 #define VLC_VAR_INTEGER 0x0030
229 #define VLC_VAR_HOTKEY 0x0031
230 #define VLC_VAR_STRING 0x0040
231 #define VLC_VAR_MODULE 0x0041
232 #define VLC_VAR_FILE 0x0042
233 #define VLC_VAR_DIRECTORY 0x0043
234 #define VLC_VAR_VARIABLE 0x0044
235 #define VLC_VAR_FLOAT 0x0050
236 #define VLC_VAR_TIME 0x0060
237 #define VLC_VAR_ADDRESS 0x0070
238 #define VLC_VAR_MUTEX 0x0080
239 #define VLC_VAR_LIST 0x0090
243 * VLC value structure
252 vlc_object_t * p_object;
256 struct { char *psz_name; int i_object_id; } var;
258 /* Make sure the structure is at least 64bits */
259 struct { char a, b, c, d, e, f, g, h; } padding;
269 vlc_value_t * p_values;
274 /*****************************************************************************
276 *****************************************************************************/
277 #define VLC_SUCCESS -0 /* No error */
278 #define VLC_ENOMEM -1 /* Not enough memory */
279 #define VLC_ETHREAD -2 /* Thread error */
280 #define VLC_ETIMEOUT -3 /* Timeout */
282 #define VLC_ENOMOD -10 /* Module not found */
284 #define VLC_ENOOBJ -20 /* Object not found */
285 #define VLC_EBADOBJ -21 /* Bad object type */
287 #define VLC_ENOVAR -30 /* Variable not found */
288 #define VLC_EBADVAR -31 /* Bad variable value */
290 #define VLC_ENOITEM -40 /**< Item not found */
292 #define VLC_EEXIT -255 /* Program exited */
293 #define VLC_EEXITSUCCESS -999 /* Program exited successfully */
294 #define VLC_EGENERIC -666 /* Generic error */
296 /*****************************************************************************
298 *****************************************************************************/
299 #define VLC_FALSE false
300 #define VLC_TRUE true
302 /*****************************************************************************
304 *****************************************************************************/
306 /* Used by VLC_AddTarget() */
307 #define PLAYLIST_INSERT 0x0001
308 #define PLAYLIST_APPEND 0x0002
309 #define PLAYLIST_GO 0x0004
310 #define PLAYLIST_PREPARSE 0x0008
311 #define PLAYLIST_SPREPARSE 0x0010
312 #define PLAYLIST_NO_REBUILD 0x0020
314 #define PLAYLIST_END -666
316 /*****************************************************************************
317 * Required internal headers
318 *****************************************************************************/
319 #if defined( __LIBVLC__ )
320 # include "vlc_common.h"
324 /*****************************************************************************
325 * Exported vlc API (Deprecated)
326 *****************************************************************************/
328 #if !defined( __LIBVLC__ )
329 /* Otherwise they are declared and exported in vlc_common.h */
331 * Retrieve libvlc version
333 * \return a string containing the libvlc version
335 VLC_DEPRECATED_API char const * VLC_Version ( void );
338 * Retrieve libvlc compile time
340 * \return a string containing the libvlc compile time
342 VLC_DEPRECATED_API char const * VLC_CompileTime ( void );
345 * Retrieve the username of the libvlc builder
347 * \return a string containing the username of the libvlc builder
349 VLC_DEPRECATED_API char const * VLC_CompileBy ( void );
352 * Retrieve the host of the libvlc builder
354 * \return a string containing the host of the libvlc builder
356 VLC_DEPRECATED_API char const * VLC_CompileHost ( void );
359 * Retrieve the domain name of the host of the libvlc builder
361 * \return a string containing the domain name of the host of the libvlc builder
363 VLC_DEPRECATED_API char const * VLC_CompileDomain ( void );
366 * Retrieve libvlc compiler version
368 * \return a string containing the libvlc compiler version
370 VLC_DEPRECATED_API char const * VLC_Compiler ( void );
373 * Retrieve libvlc changeset
375 * \return a string containing the libvlc subversion changeset
377 VLC_DEPRECATED_API char const * VLC_Changeset ( void );
380 * Return an error string
382 * \param i_err an error code
383 * \return an error string
385 VLC_DEPRECATED_API char const * VLC_Error ( int i_err );
387 #endif /* __LIBVLC__ */
392 * This function allocates a vlc_t structure and returns a negative value
393 * in case of failure. Also, the thread system is initialized
395 * \return vlc object id or an error code
397 VLC_DEPRECATED_API int VLC_Create( void );
400 * Initialize a vlc_t structure
402 * This function initializes a previously allocated vlc_t structure:
404 * - gettext initialization
405 * - message queue, module bank and playlist initialization
406 * - configuration and commandline parsing
408 * \param i_object a vlc object id
409 * \param i_argc the number of arguments
410 * \param ppsz_argv an array of arguments
411 * \return VLC_SUCCESS on success
413 VLC_DEPRECATED_API int VLC_Init( int, int, const char *[] );
418 * This function opens an interface plugin and runs it. If b_block is set
419 * to 0, VLC_AddIntf will return immediately and let the interface run in a
420 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
421 * user requests to quit.
423 * \param i_object a vlc object id
424 * \param psz_module a vlc module name of an interface
425 * \param b_block make this interface blocking
426 * \param b_play start playing when the interface is done loading
427 * \return VLC_SUCCESS on success
429 VLC_DEPRECATED_API int VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );
434 * This function sets p_libvlc->b_die to VLC_TRUE, but does not do any other
435 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
437 * \param i_object a vlc object id
438 * \return VLC_SUCCESS on success
440 VLC_DEPRECATED_API int VLC_Die( int );
443 * Clean up all the intf, playlist, vout and aout
445 * This function requests all intf, playlist, vout and aout objects to finish
446 * and CleanUp. Only a blank VLC object should remain after this.
448 * \note This function was previously called VLC_Stop
450 * \param i_object a vlc object id
451 * \return VLC_SUCCESS on success
453 VLC_DEPRECATED_API int VLC_CleanUp( int );
456 * Destroy all threads and the VLC object
458 * This function requests the running threads to finish, waits for their
459 * termination, and destroys their structure.
460 * Then it will de-init all VLC object initializations.
462 * \param i_object a vlc object id
463 * \return VLC_SUCCESS on success
465 VLC_DEPRECATED_API int VLC_Destroy( int );
470 * This function sets a variable of VLC
472 * \note Was previously called VLC_Set
474 * \param i_object a vlc object id
475 * \param psz_var a vlc variable name
476 * \param value a vlc_value_t structure
477 * \return VLC_SUCCESS on success
479 VLC_DEPRECATED_API int VLC_VariableSet( int, char const *, vlc_value_t );
484 * This function gets the value of a variable of VLC
485 * It stores it in the p_value argument
487 * \note Was previously called VLC_Get
489 * \param i_object a vlc object id
490 * \param psz_var a vlc variable name
491 * \param p_value a pointer to a vlc_value_t structure
492 * \return VLC_SUCCESS on success
494 VLC_DEPRECATED_API int VLC_VariableGet( int, char const *, vlc_value_t * );
497 * Get a VLC variable type
499 * This function gets the type of a variable of VLC
500 * It stores it in the p_type argument
502 * \param i_object a vlc object id
503 * \param psz_var a vlc variable name
504 * \param pi_type a pointer to an integer
505 * \return VLC_SUCCESS on success
507 VLC_DEPRECATED_API int VLC_VariableType( int, char const *, int * );
510 * Add a target to the current playlist
512 * This funtion will add a target to the current playlist. If a playlist does
513 * not exist, it will be created.
515 * \param i_object a vlc object id
516 * \param psz_target the URI of the target to play
517 * \param ppsz_options an array of strings with input options (ie. :input-repeat)
518 * \param i_options the amount of options in the ppsz_options array
519 * \param i_mode the insert mode to insert the target into the playlist (PLAYLIST_* defines)
520 * \param i_pos the position at which to add the new target (PLAYLIST_END for end)
521 * \return the item id on success and -1 on error
523 VLC_DEPRECATED_API int VLC_AddTarget( int, char const *, const char **, int, int, int );
526 * Start the playlist and play the currently selected playlist item
528 * If there is something in the playlist, and the playlist is not running,
529 * then start the playlist and play the currently selected playlist item.
530 * If an item is currently paused, then resume it.
532 * \param i_object a vlc object id
533 * \return VLC_SUCCESS on success
535 VLC_DEPRECATED_API int VLC_Play( int );
538 * Pause the currently playing item. Resume it if already paused
540 * If an item is currently playing then pause it.
541 * If the item is already paused, then resume playback.
543 * \param i_object a vlc object id
544 * \return VLC_SUCCESS on success
546 VLC_DEPRECATED_API int VLC_Pause( int );
551 * If an item is currently playing then stop it.
552 * Set the playlist to a stopped state.
554 * \note This function is new. The old VLC_Stop is now called VLC_CleanUp
556 * \param i_object a vlc object id
557 * \return VLC_SUCCESS on success
559 VLC_DEPRECATED_API int VLC_Stop( int );
562 * Tell if VLC is playing
564 * If an item is currently playing, it returns
565 * VLC_TRUE, else VLC_FALSE
567 * \param i_object a vlc object id
568 * \return VLC_TRUE or VLC_FALSE
570 VLC_DEPRECATED_API vlc_bool_t VLC_IsPlaying( int );
573 * Get the current position in a input
575 * Return the current position as a float
576 * This method should be used for time sliders etc
577 * \note For some inputs, this will be unknown.
579 * \param i_object a vlc object id
580 * \return a float in the range of 0.0 - 1.0
582 VLC_DEPRECATED_API float VLC_PositionGet( int );
585 * Set the current position in a input
587 * Set the current position as a float
588 * This method should be used for time sliders etc
589 * \note For some inputs, this will be unknown.
591 * \param i_object a vlc object id
592 * \param i_position a float in the range of 0.0 - 1.0
593 * \return a float in the range of 0.0 - 1.0
595 VLC_DEPRECATED_API float VLC_PositionSet( int, float );
598 * Get the current position in a input
600 * Return the current position in seconds from the start.
601 * \note For some inputs, this will be unknown.
603 * \param i_object a vlc object id
604 * \return the offset from 0:00 in seconds
606 VLC_DEPRECATED_API int VLC_TimeGet( int );
609 * Seek to a position in the current input
611 * Seek i_seconds in the current input. If b_relative is set,
612 * then the seek will be relative to the current position, otherwise
613 * it will seek to i_seconds from the beginning of the input.
614 * \note For some inputs, this will be unknown.
616 * \param i_object a vlc object id
617 * \param i_seconds seconds from current position or from beginning of input
618 * \param b_relative seek relative from current position
619 * \return VLC_SUCCESS on success
621 VLC_DEPRECATED_API int VLC_TimeSet( int, int, vlc_bool_t );
624 * Get the total length of a input
626 * Return the total length in seconds from the current input.
627 * \note For some inputs, this will be unknown.
629 * \param i_object a vlc object id
630 * \return the length in seconds
632 VLC_DEPRECATED_API int VLC_LengthGet( int );
635 * Play the input faster than realtime
637 * 2x, 4x, 8x faster than realtime
638 * \note For some inputs, this will be impossible.
640 * \param i_object a vlc object id
641 * \return the current speedrate
643 VLC_DEPRECATED_API float VLC_SpeedFaster( int );
646 * Play the input slower than realtime
648 * 1/2x, 1/4x, 1/8x slower than realtime
649 * \note For some inputs, this will be impossible.
651 * \param i_object a vlc object id
652 * \return the current speedrate
654 VLC_DEPRECATED_API float VLC_SpeedSlower( int );
657 * Return the current playlist item
659 * \param i_object a vlc object id
660 * \return the index of the playlistitem that is currently selected for play
662 VLC_DEPRECATED_API int VLC_PlaylistIndex( int );
665 * Total amount of items in the playlist
667 * \param i_object a vlc object id
668 * \return amount of playlist items
670 VLC_DEPRECATED_API int VLC_PlaylistNumberOfItems( int );
675 * Skip to the next playlistitem and play it.
677 * \param i_object a vlc object id
678 * \return VLC_SUCCESS on success
680 VLC_DEPRECATED_API int VLC_PlaylistNext( int );
683 * Previous playlist item
685 * Skip to the previous playlistitem and play it.
687 * \param i_object a vlc object id
688 * \return VLC_SUCCESS on success
690 VLC_DEPRECATED_API int VLC_PlaylistPrev( int );
693 * Clear the contents of the playlist
695 * Completly empty the entire playlist.
697 * \note Was previously called VLC_ClearPlaylist
699 * \param i_object a vlc object id
700 * \return VLC_SUCCESS on success
702 VLC_DEPRECATED_API int VLC_PlaylistClear( int );
707 * \param i_object a vlc object id
708 * \param i_volume something in a range from 0-200
709 * \return the new volume (range 0-200 %)
711 VLC_DEPRECATED_API int VLC_VolumeSet( int, int );
714 * Get the current volume
716 * Retrieve the current volume.
718 * \param i_object a vlc object id
719 * \return the current volume (range 0-200 %)
721 VLC_DEPRECATED_API int VLC_VolumeGet( int );
724 * Mute/Unmute the volume
726 * \param i_object a vlc object id
727 * \return VLC_SUCCESS on success
729 VLC_DEPRECATED_API int VLC_VolumeMute( int );
732 * Toggle Fullscreen mode
734 * Switch between normal and fullscreen video
736 * \param i_object a vlc object id
737 * \return VLC_SUCCESS on success
739 VLC_DEPRECATED_API int VLC_FullScreen( int );
747 #endif /* _LIBVLC_DEPRECATED_H */