cf1bd8f35fefb4dfba15e884a87b61d4e06b49ad
[vlc.git] / include / vlc / libvlc.h
1 /*****************************************************************************
2  * libvlc.h:  libvlc_* new external API
3  *****************************************************************************
4  * Copyright (C) 1998-2005 the VideoLAN team
5  * $Id: vlc.h 13701 2005-12-12 17:58:56Z zorglub $
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 /**
26  * \defgroup libvlc Libvlc
27  * This is libvlc, the base library of the VLC program.
28  *
29  * @{
30  */
31
32
33 #ifndef _LIBVLC_H
34 #define _LIBVLC_H 1
35
36 #include <vlc/vlc.h>
37 #include <vlc/libvlc_structures.h>
38
39 # ifdef __cplusplus
40 extern "C" {
41 # endif
42
43 /*****************************************************************************
44  * Exception handling
45  *****************************************************************************/
46 /** defgroup libvlc_exception Exceptions
47  * \ingroup libvlc
48  * LibVLC Exceptions handling
49  * @{
50  */
51
52 /**
53  * Initialize an exception structure. This can be called several times to reuse
54  * an exception structure.
55  * \param p_exception the exception to initialize
56  */
57 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
58
59 /**
60  * Has an exception been raised ?
61  * \param p_exception the exception to query
62  * \return 0 if no exception raised, 1 else
63  */
64 VLC_PUBLIC_API int libvlc_exception_raised( libvlc_exception_t *p_exception );
65
66 /**
67  * Raise an exception
68  * \param p_exception the exception to raise
69  * \param psz_message the exception message
70  */
71 VLC_PUBLIC_API void libvlc_exception_raise( libvlc_exception_t *p_exception, const char *psz_format, ... );
72
73 /**
74  * Clear an exception object so it can be reused.
75  * The exception object must be initialized
76  * \param p_exception the exception to clear
77  */
78 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
79
80 /**
81  * Get exception message
82  * \param p_exception the exception to query
83  * \return the exception message or NULL if not applicable (exception not raised
84  * for example)
85  */
86 VLC_PUBLIC_API char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
87
88 /**@} */
89
90 /*****************************************************************************
91  * Core handling
92  *****************************************************************************/
93
94 /** defgroup libvlc_core Core
95  * \ingroup libvlc
96  * LibVLC Core
97  * @{
98  */
99
100 /**
101  * Create an initialized libvlc instance
102  * \param argc the number of arguments
103  * \param argv command-line-type arguments
104  * \param exception an initialized exception pointer
105  */
106 VLC_PUBLIC_API libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
107
108 /**
109  * Returns a libvlc instance identifier for legacy APIs. Use of this
110  * function is discouraged, you should convert your program to use the
111  * new API.
112  * \param p_instance the instance
113  */
114 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
115
116 /**
117  * Destroy a libvlc instance.
118  * \param p_instance the instance to destroy
119  */
120 VLC_PUBLIC_API void libvlc_destroy( libvlc_instance_t *, libvlc_exception_t * );
121
122 /** @}*/
123
124 /*****************************************************************************
125  * Tree
126  *****************************************************************************/
127 /** defgroup libvlc_tree Tree
128  * \ingroup libvlc
129  * LibVLC Tree. A tree holds an item plus several subtrees.
130  * @{
131  */
132 VLC_PUBLIC_API libvlc_tree_t *
133     libvlc_tree_new_with_media_list_as_item( libvlc_media_list_t * p_mlist,
134                                              libvlc_exception_t * p_e );
135
136 VLC_PUBLIC_API libvlc_tree_t *
137     libvlc_tree_new_with_string_as_item( const char * psz,
138                                          libvlc_exception_t * p_e );
139 VLC_PUBLIC_API void
140     libvlc_tree_release( libvlc_tree_t * p_tree );
141
142 VLC_PUBLIC_API void
143     libvlc_tree_retain( libvlc_tree_t * p_tree );
144
145 VLC_PUBLIC_API char *
146     libvlc_tree_item_as_string( libvlc_tree_t * p_tree,
147                                 libvlc_exception_t * p_e );
148
149 VLC_PUBLIC_API libvlc_media_list_t *
150     libvlc_tree_item_as_media_list( libvlc_tree_t * p_tree,
151                                     libvlc_exception_t * p_e );
152
153 VLC_PUBLIC_API int
154     libvlc_tree_subtree_count( libvlc_tree_t * p_tree, libvlc_exception_t * p_e );
155
156 VLC_PUBLIC_API libvlc_tree_t *
157     libvlc_tree_subtree_at_index( libvlc_tree_t * p_tree,
158                               int index,
159                               libvlc_exception_t * p_e );
160
161 VLC_PUBLIC_API void
162     libvlc_tree_insert_subtree_at_index( libvlc_tree_t * p_tree,
163                                          libvlc_tree_t * p_subtree,
164                                          int index,
165                                          libvlc_exception_t * p_e );
166
167 VLC_PUBLIC_API void
168     libvlc_tree_remove_subtree_at_index( libvlc_tree_t * p_tree,
169                                          int index,
170                                          libvlc_exception_t * p_e );
171
172 /**@} */
173
174
175
176 /*****************************************************************************
177  * Media descriptor
178  *****************************************************************************/
179 /** defgroup libvlc_media_descriptor Media Descriptor
180  * \ingroup libvlc
181  * LibVLC Media Descriptor
182  * @{
183  */
184  
185 /**
186  * Create a media descriptor with the given mrl.
187  * \param p_instance the instance
188  * \param psz_mrl the mrl to read
189  */
190 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
191                                    libvlc_instance_t *p_instance,
192                                    const char * psz_mrl,
193                                    libvlc_exception_t *p_e );
194
195 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
196                                    libvlc_media_descriptor_t *p_meta_desc );
197
198 VLC_PUBLIC_API void libvlc_media_descriptor_release(
199                                    libvlc_media_descriptor_t *p_meta_desc );
200
201 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
202                                                        libvlc_exception_t * p_e );
203
204 /**
205  * Read the meta of the media descriptor.
206  * \param p_meta_desc the media descriptor to read
207  * \param p_meta_desc the meta to read
208  */
209 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
210                                    libvlc_media_descriptor_t *p_meta_desc,
211                                    libvlc_meta_t e_meta,
212                                    libvlc_exception_t *p_e );
213
214 /* Tags */
215 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
216                                                      const char * key,
217                                                      const libvlc_tag_t tag,
218                                                      libvlc_exception_t *p_e );
219
220 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
221                                                          const char * key,
222                                                          const libvlc_tag_t tag,
223                                                          libvlc_exception_t *p_e );
224
225 VLC_PUBLIC_API int
226     libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
227                                                 const char * key,
228                                                 libvlc_exception_t *p_e );
229
230 VLC_PUBLIC_API libvlc_tag_t
231     libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
232                                                   int i,
233                                                   const char * key,
234                                                   libvlc_exception_t *p_e );
235
236 /** @}*/
237
238 /*****************************************************************************
239  * Playlist
240  *****************************************************************************/
241 /** defgroup libvlc_playlist Playlist
242  * \ingroup libvlc
243  * LibVLC Playlist handling
244  * @{
245  */
246
247 /**
248  * Set loop variable
249  */
250 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
251                                           libvlc_exception_t * );
252
253 /**
254  * Start playing. You can give some additionnal playlist item options
255  * that will be added to the item before playing it.
256  * \param p_instance the instance
257  * \param i_id the item to play. If this is a negative number, the next
258  * item will be selected. Else, the item with the given ID will be played
259  * \param i_options the number of options to add to the item
260  * \param ppsz_options the options to add to the item
261  * \param p_exception an initialized exception
262  */
263 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
264                                           libvlc_exception_t * );
265
266 /**
267  * Pause a running playlist, resume if it was stopped
268  * \param p_instance the instance to pause
269  * \param p_exception an initialized exception
270  */
271 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
272
273 /**
274  * Checks if the playlist is running
275  * \param p_instance the instance
276  * \param p_exception an initialized exception
277  * \return 0 if the playlist is stopped or paused, 1 if it is running
278  */
279 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
280
281 /**
282  * Get the number of items in the playlist
283  * \param p_instance the instance
284  * \param p_exception an initialized exception
285  * \return the number of items
286  */
287 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
288
289 /**
290  * Lock the playlist instance
291  * \param p_instance the instance
292  */
293 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
294
295 /**
296  * Unlock the playlist instance
297  * \param p_instance the instance
298  */
299 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
300
301 /**
302  * Stop playing
303  * \param p_instance the instance to stop
304  * \param p_exception an initialized exception
305  */
306 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
307
308 /**
309  * Go to next playlist item (starts playback if it was stopped)
310  * \param p_instance the instance to use
311  * \param p_exception an initialized exception
312  */
313 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
314
315 /**
316  * Go to previous playlist item (starts playback if it was stopped)
317  * \param p_instance the instance to use
318  * \param p_exception an initialized exception
319  */
320 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
321
322 /**
323  * Remove all playlist items
324  * \param p_instance the instance
325  * \param p_exception an initialized exception
326  */
327 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
328
329 /**
330  * Add an item at the end of the playlist
331  * If you need more advanced options, \see libvlc_playlist_add_extended
332  * \param p_instance the instance
333  * \param psz_uri the URI to open, using VLC format
334  * \param psz_name a name that you might want to give or NULL
335  * \return the identifier of the new item
336  */
337 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
338                                         libvlc_exception_t * );
339
340 /**
341  * Add an item at the end of the playlist, with additional input options
342  * \param p_instance the instance
343  * \param psz_uri the URI to open, using VLC format
344  * \param psz_name a name that you might want to give or NULL
345  * \param i_options the number of options to add
346  * \param ppsz_options strings representing the options to add
347  * \param p_exception an initialized exception
348  * \return the identifier of the new item
349  */
350 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
351                                                  const char *, int, const char **,
352                                                  libvlc_exception_t * );
353
354 /**
355  * Delete the playlist item with the given ID.
356  * \param p_instance the instance
357  * \param i_id the id to remove
358  * \param p_exception an initialized exception
359  * \return
360  */
361 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
362                                                 libvlc_exception_t * );
363
364 /* Get the input that is currently being played by the playlist
365  * \param p_instance the instance to use
366  * \param p_exception an initialized excecption
367  * \return an input object
368  */
369 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
370                                 libvlc_instance_t *, libvlc_exception_t * );
371
372 /** @}*/
373
374 /*****************************************************************************
375  * Media Instance
376  *****************************************************************************/
377 /** defgroup libvlc_media_instance Media Instance
378  * \ingroup libvlc
379  * LibVLC Media Instance
380  * @{
381  */
382
383 /** Create an empty Media Instance object
384  * \param p_libvlc_instance the libvlc instance in which the Media Instance
385  * should be (not used for now).
386  */
387 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
388
389 /** Create a Media Instance object from a Media Descriptor
390  * \param p_md the media descriptor. Afterwards the p_md can safely be
391  * destroyed.
392  */
393 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
394
395 /** Release a media_instance after use
396  * \param p_mi the Media Instance to free
397  */
398 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
399 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
400
401 /** Set the media descriptor that will be used by the media_instance. If any,
402  * previous md will be released.
403  * \param p_mi the Media Instance 
404  * \param p_md the Media Descriptor. Afterwards the p_md can safely be
405  * destroyed.
406  */
407 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
408
409 /** Get the media descriptor used by the media_instance (if any). A copy of
410  * the md is returned. NULL is returned if no media instance is associated.
411  * \param p_mi the Media Instance 
412  */
413 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
414
415 /** Get the Event Manager from which the media instance send event.
416  * \param p_mi the Media Instance 
417  */
418 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
419
420 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
421 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
422 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
423
424 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
425
426 /// \bug This might go away ... to be replaced by a broader system
427 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
428 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
429 VLC_PUBLIC_API void        libvlc_media_instance_set_time       ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
430 VLC_PUBLIC_API float       libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
431 VLC_PUBLIC_API void        libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
432 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
433 VLC_PUBLIC_API float       libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
434 VLC_PUBLIC_API void        libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
435 VLC_PUBLIC_API int         libvlc_media_instance_get_state      ( libvlc_media_instance_t *, libvlc_exception_t *);
436
437 /**
438  * Does this input have a video output ?
439  * \param p_input the input
440  * \param p_exception an initialized exception
441  */
442 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
443 VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
444
445
446 /** @} */
447
448 /*****************************************************************************
449  * Tag Query
450  *****************************************************************************/
451 /** defgroup libvlc_tag_query Tag Query
452  * \ingroup libvlc
453  * LibVLC Tag query
454  * @{
455  */
456 VLC_PUBLIC_API libvlc_tag_query_t * 
457     libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
458
459 VLC_PUBLIC_API void 
460     libvlc_tag_query_release( libvlc_tag_query_t * );
461
462 VLC_PUBLIC_API void 
463     libvlc_tag_query_retain( libvlc_tag_query_t * );
464
465 VLC_PUBLIC_API vlc_bool_t 
466     libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
467                             libvlc_exception_t * );
468
469 /** @} */
470
471 /*****************************************************************************
472  * Media List
473  *****************************************************************************/
474 /** defgroup libvlc_media_list MediaList
475  * \ingroup libvlc
476  * LibVLC Media List
477  * @{
478  */
479 VLC_PUBLIC_API libvlc_media_list_t *
480     libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
481
482 VLC_PUBLIC_API void
483     libvlc_media_list_release( libvlc_media_list_t * );
484
485 VLC_PUBLIC_API void
486     libvlc_media_list_retain( libvlc_media_list_t * );
487
488 VLC_PUBLIC_API void
489     libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
490                                         const char * psz_uri,
491                                         libvlc_exception_t * p_e );
492
493 VLC_PUBLIC_API void
494     libvlc_media_list_set_name( libvlc_media_list_t *,
495                                 const char * psz_name,
496                                 libvlc_exception_t *);
497
498 VLC_PUBLIC_API char *
499     libvlc_media_list_name( libvlc_media_list_t *,
500                             libvlc_exception_t *);
501
502 VLC_PUBLIC_API void
503     libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
504                                             libvlc_media_descriptor_t *,
505                                             libvlc_exception_t * );
506 VLC_PUBLIC_API void
507     libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
508                                                libvlc_media_descriptor_t *,
509                                                int,
510                                                libvlc_exception_t * );
511 VLC_PUBLIC_API void
512     libvlc_media_list_remove_index( libvlc_media_list_t *, int,
513                                     libvlc_exception_t * );
514
515 VLC_PUBLIC_API int
516     libvlc_media_list_count( libvlc_media_list_t * p_mlist,
517                              libvlc_exception_t * p_e );
518
519 VLC_PUBLIC_API libvlc_media_descriptor_t *
520     libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
521                                      libvlc_exception_t * );
522 VLC_PUBLIC_API int
523     libvlc_media_list_index_of_item( libvlc_media_list_t *,
524                                      libvlc_media_descriptor_t *,
525                                      libvlc_exception_t * );
526
527 VLC_PUBLIC_API void
528     libvlc_media_list_lock( libvlc_media_list_t * );
529 VLC_PUBLIC_API void
530     libvlc_media_list_unlock( libvlc_media_list_t * );
531
532 VLC_PUBLIC_API libvlc_event_manager_t *
533     libvlc_media_list_event_manager( libvlc_media_list_t *,
534                                     libvlc_exception_t * );
535
536 VLC_PUBLIC_API libvlc_media_list_t *
537     libvlc_media_list_dynamic_sublist( libvlc_media_list_t *,
538                                        libvlc_tag_query_t *,
539                                        libvlc_exception_t * );
540
541 /** @} */
542
543 /*****************************************************************************
544  * Media List
545  *****************************************************************************/
546 /** defgroup libvlc_media_library Media Library
547  * \ingroup libvlc
548  * LibVLC Media Library
549  * @{
550  */
551 VLC_PUBLIC_API libvlc_media_library_t *
552     libvlc_media_library_new( libvlc_instance_t * p_inst,
553                               libvlc_exception_t * p_e );
554 VLC_PUBLIC_API void
555     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
556 VLC_PUBLIC_API void
557     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
558
559
560 VLC_PUBLIC_API void
561     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
562                                libvlc_exception_t * p_e );
563
564 VLC_PUBLIC_API void
565     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
566                                libvlc_exception_t * p_e );
567
568 VLC_PUBLIC_API libvlc_media_list_t *
569     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
570                                      libvlc_exception_t * p_e );
571
572
573 /** @} */
574
575 /*****************************************************************************
576  * Media List Player
577  *****************************************************************************/
578 /** defgroup libvlc_media_list_player MediaListPlayer
579  * \ingroup libvlc
580  * LibVLC Media List Player
581  * @{
582  */
583 VLC_PUBLIC_API libvlc_media_list_player_t *
584     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
585                                   libvlc_exception_t * p_e );
586 VLC_PUBLIC_API void
587     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
588
589 VLC_PUBLIC_API void
590     libvlc_media_list_player_set_media_instance(
591                                      libvlc_media_list_player_t * p_mlp,
592                                      libvlc_media_instance_t * p_mi,
593                                      libvlc_exception_t * p_e );
594
595 VLC_PUBLIC_API void
596     libvlc_media_list_player_set_media_list(
597                                      libvlc_media_list_player_t * p_mlp,
598                                      libvlc_media_list_t * p_mlist,
599                                      libvlc_exception_t * p_e );
600
601 VLC_PUBLIC_API void
602     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
603                                    libvlc_exception_t * p_e );
604
605 VLC_PUBLIC_API void
606     libvlc_media_list_player_play_item_at_index(
607                                    libvlc_media_list_player_t * p_mlp,
608                                    int i_index,
609                                    libvlc_exception_t * p_e );
610
611 VLC_PUBLIC_API void
612     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
613                                    libvlc_exception_t * p_e );
614 VLC_PUBLIC_API void
615     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
616                                    libvlc_exception_t * p_e );
617
618 /** @} */
619
620 /** defgroup libvlc_video Video
621  * \ingroup libvlc
622  * LibVLC Video handling
623  * @{
624  */
625
626 /**
627  * Does this input have a video output ?
628  * \param p_input the input
629  * \param p_exception an initialized exception
630  */
631 VLC_PUBLIC_API vlc_bool_t  libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
632 VLC_PUBLIC_API float       libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
633
634 /**
635  * Toggle fullscreen status on video output
636  * \param p_input the input
637  * \param p_exception an initialized exception
638  */
639 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
640
641 /**
642  * Enable or disable fullscreen on a video output
643  * \param p_input the input
644  * \param b_fullscreen boolean for fullscreen status
645  * \param p_exception an initialized exception
646  */
647 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
648
649 /**
650  * Get current fullscreen status
651  * \param p_input the input
652  * \param p_exception an initialized exception
653  * \return the fullscreen status (boolean)
654  */
655 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
656
657 /**
658  * Get current video height
659  * \param p_input the input
660  * \param p_exception an initialized exception
661  * \return the video height
662  */
663 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
664
665 /**
666  * Get current video width
667  * \param p_input the input
668  * \param p_exception an initialized exception
669  * \return the video width
670  */
671 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
672
673 /**
674  * Get current video aspect ratio
675  * \param p_input the input
676  * \param p_exception an initialized exception
677  * \return the video aspect ratio
678  */
679 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
680
681 /**
682  * Set new video aspect ratio
683  * \param p_input the input
684  * \param psz_aspect new video aspect-ratio
685  * \param p_exception an initialized exception
686  */
687 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
688
689 /**
690  * Get current video subtitle
691  * \param p_input the input
692  * \param p_exception an initialized exception
693  * \return the video subtitle selected
694  */
695 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
696
697 /**
698  * Set new video subtitle
699  * \param p_input the input
700  * \param i_spu new video subtitle to select
701  * \param p_exception an initialized exception
702  */
703 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
704
705 /**
706  * Get current crop filter geometry
707  * \param p_input the input
708  * \param p_exception an initialized exception
709  * \return the crop filter geometry
710  */
711 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
712
713 /**
714  * Set new crop filter geometry
715  * \param p_input the input
716  * \param psz_geometry new crop filter geometry
717  * \param p_exception an initialized exception
718  */
719 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
720
721 /**
722  * Get current teletext page requested.
723  * \param p_input the input
724  * \param p_exception an initialized exception
725  * \return the current teletext page requested.
726  */
727 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
728
729 /**
730  * Set new teletext page to retrieve
731  * \param p_input the input
732  * \param i_page teletex page number requested
733  * \param p_exception an initialized exception
734  */
735 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
736
737 /**
738  * Take a snapshot of the current video window
739  * \param p_input the input
740  * \param psz_filepath the path where to save the screenshot to
741  * \param p_exception an initialized exception
742  */
743 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
744
745 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
746
747 /**
748  * Resize the current video output window
749  * \param p_instance libvlc instance
750  * \param width new width for video output window
751  * \param height new height for video output window
752  * \param p_exception an initialized exception
753  * \return the success status (boolean)
754  */
755 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
756
757 /**
758  * change the parent for the current the video output
759  * \param p_instance libvlc instance
760  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
761  * \param p_exception an initialized exception
762  * \return the success status (boolean)
763  */
764 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
765
766 /**
767  * Tell windowless video output to redraw rectangular area (MacOS X only)
768  * \param p_instance libvlc instance
769  * \param area coordinates within video drawable
770  * \param p_exception an initialized exception
771  */
772 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
773
774 /**
775  * Set the default video output parent
776  *  this settings will be used as default for all video outputs
777  * \param p_instance libvlc instance
778  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
779  * \param p_exception an initialized exception
780  */
781 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
782
783 /**
784  * Set the default video output parent
785  *  this settings will be used as default for all video outputs
786  * \param p_instance libvlc instance
787  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
788  * \param p_exception an initialized exception
789  */
790 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
791
792 /**
793  * Set the default video output size
794  *  this settings will be used as default for all video outputs
795  * \param p_instance libvlc instance
796  * \param width new width for video drawable
797  * \param height new height for video drawable
798  * \param p_exception an initialized exception
799  */
800 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
801
802 /**
803  * Set the default video output viewport for a windowless video output (MacOS X only)
804  *  this settings will be used as default for all video outputs
805  * \param p_instance libvlc instance
806  * \param view coordinates within video drawable
807  * \param clip coordinates within video drawable
808  * \param p_exception an initialized exception
809  */
810 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
811
812 /** @} */
813
814 /** defgroup libvlc_audio Audio
815  * \ingroup libvlc
816  * LibVLC Audio handling
817  * @{
818  */
819
820 /**
821  * Toggle mute status
822  * \param p_instance libvlc instance
823  * \param p_exception an initialized exception
824  * \return void
825  */
826 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
827
828 /**
829  * Get current mute status
830  * \param p_instance libvlc instance
831  * \param p_exception an initialized exception
832  * \return the mute status (boolean)
833  */
834 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
835
836 /**
837  * Set mute status
838  * \param p_instance libvlc instance
839  * \param status If status is VLC_TRUE then mute, otherwise unmute
840  * \param p_exception an initialized exception
841  * \return void
842  */
843 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
844
845 /**
846  * Get current audio level
847  * \param p_instance libvlc instance
848  * \param p_exception an initialized exception
849  * \return the audio level (int)
850  */
851 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
852
853 /**
854  * Set current audio level
855  * \param p_instance libvlc instance
856  * \param i_volume the volume (int)
857  * \param p_exception an initialized exception
858  */
859 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
860
861 /**
862 +  * Get current audio track
863 +  * \param p_input input instance
864 +  * \param p_exception an initialized exception
865 +  * \return the audio track (int)
866 +  */
867 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
868
869 /**
870  * Set current audio track
871  * \param p_input input instance
872  * \param i_track the track (int)
873  * \param p_exception an initialized exception
874  */
875 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
876
877 /**
878  * Get current audio channel
879  * \param p_instance input instance
880  * \param p_exception an initialized exception
881  * \return the audio channel (int)
882  */
883 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
884
885 /**
886  * Set current audio channel
887  * \param p_instance input instance
888  * \param i_channel the audio channel (int)
889  * \param p_exception an initialized exception
890  */
891 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
892
893 /** @} */
894
895 /*****************************************************************************
896  * Services/Media Discovery
897  *****************************************************************************/
898 /** defgroup libvlc_media_discoverer Media Discoverer
899  * \ingroup libvlc
900  * LibVLC Media Discoverer
901  * @{
902  */
903
904 VLC_PUBLIC_API libvlc_media_discoverer_t *
905 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
906                                        const char * psz_name,
907                                        libvlc_exception_t * p_e );
908 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
909 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
910
911 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( );
912
913 /**@} */
914
915 /*****************************************************************************
916  * VLM
917  *****************************************************************************/
918 /** defgroup libvlc_vlm VLM
919  * \ingroup libvlc
920  * LibVLC VLM
921  * @{
922  */
923
924 /**
925  * Add a broadcast, with one input
926  * \param p_instance the instance
927  * \param psz_name the name of the new broadcast
928  * \param psz_input the input MRL
929  * \param psz_output the output MRL (the parameter to the "sout" variable)
930  * \param i_options number of additional options
931  * \param ppsz_options additional options
932  * \param b_enabled boolean for enabling the new broadcast
933  * \param b_loop Should this broadcast be played in loop ?
934  * \param p_exception an initialized exception
935  */
936 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
937                                               int, char **, int, int, libvlc_exception_t * );
938
939 /**
940  * Delete a media (vod or broadcast)
941  * \param p_instance the instance
942  * \param psz_name the media to delete
943  * \param p_exception an initialized exception
944  */
945 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
946
947 /**
948  * Enable or disable a media (vod or broadcast)
949  * \param p_instance the instance
950  * \param psz_name the media to work on
951  * \param b_enabled the new status
952  * \param p_exception an initialized exception
953  */
954 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
955                                             libvlc_exception_t *);
956
957 /**
958  * Set the output for a media
959  * \param p_instance the instance
960  * \param psz_name the media to work on
961  * \param psz_output the output MRL (the parameter to the "sout" variable)
962  * \param p_exception an initialized exception
963  */
964 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
965                                            libvlc_exception_t *);
966
967 /**
968  * Set a media's input MRL. This will delete all existing inputs and
969  * add the specified one.
970  * \param p_instance the instance
971  * \param psz_name the media to work on
972  * \param psz_input the input MRL
973  * \param p_exception an initialized exception
974  */
975 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
976                                           libvlc_exception_t *);
977
978 /**
979  * Add a media's input MRL. This will add the specified one.
980  * \param p_instance the instance
981  * \param psz_name the media to work on
982  * \param psz_input the input MRL
983  * \param p_exception an initialized exception
984  */
985 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
986                                           libvlc_exception_t *p_exception );
987 /**
988  * Set output for a media
989  * \param p_instance the instance
990  * \param psz_name the media to work on
991  * \param b_loop the new status
992  * \param p_exception an initialized exception
993  */
994 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
995                                          libvlc_exception_t *);
996
997 /**
998  * Edit the parameters of a media. This will delete all existing inputs and
999  * add the specified one.
1000  * \param p_instance the instance
1001  * \param psz_name the name of the new broadcast
1002  * \param psz_input the input MRL
1003  * \param psz_output the output MRL (the parameter to the "sout" variable)
1004  * \param i_options number of additional options
1005  * \param ppsz_options additional options
1006  * \param b_enabled boolean for enabling the new broadcast
1007  * \param b_loop Should this broadcast be played in loop ?
1008  * \param p_exception an initialized exception
1009  */
1010 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1011                                              int, char **, int, int, libvlc_exception_t * );
1012
1013 /**
1014  * Plays the named broadcast.
1015  * \param p_instance the instance
1016  * \param psz_name the name of the broadcast
1017  * \param p_exception an initialized exception
1018  */
1019 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1020
1021 /**
1022  * Stops the named broadcast.
1023  * \param p_instance the instance
1024  * \param psz_name the name of the broadcast
1025  * \param p_exception an initialized exception
1026  */ 
1027 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1028
1029 /**
1030  * Pauses the named broadcast.
1031  * \param p_instance the instance
1032  * \param psz_name the name of the broadcast
1033  * \param p_exception an initialized exception
1034  */ 
1035 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1036     
1037 /**
1038  * Seeks in the named broadcast.
1039  * \param p_instance the instance
1040  * \param psz_name the name of the broadcast
1041  * \param f_percentage the percentage to seek to
1042  * \param p_exception an initialized exception
1043  */ 
1044 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1045                                            float, libvlc_exception_t * );
1046    
1047 /**
1048  * Return information of the named broadcast.
1049  * \param p_instance the instance
1050  * \param psz_name the name of the broadcast
1051  * \param p_exception an initialized exception
1052  */ 
1053 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1054
1055 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1056 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1057                         char *, int , libvlc_exception_t * );
1058
1059 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1060 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1061 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1062 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1063 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1064 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1065 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1066
1067 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1068
1069 /** @} */
1070
1071 /*****************************************************************************
1072  * Message log handling
1073  *****************************************************************************/
1074
1075 /** defgroup libvlc_log Log
1076  * \ingroup libvlc
1077  * LibVLC Message Logging
1078  * @{
1079  */
1080
1081 /**
1082  * Returns the VLC messaging verbosity level
1083  * \param p_instance libvlc instance
1084  * \param exception an initialized exception pointer
1085  */
1086 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1087                                                   libvlc_exception_t *p_e );
1088
1089 /**
1090  * Set the VLC messaging verbosity level
1091  * \param p_log libvlc log instance
1092  * \param exception an initialized exception pointer
1093  */
1094 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1095                                               libvlc_exception_t *p_e );
1096
1097 /**
1098  * Open an instance to VLC message log 
1099  * \param p_instance libvlc instance
1100  * \param exception an initialized exception pointer
1101  */
1102 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
1103
1104 /**
1105  * Close an instance of VLC message log 
1106  * \param p_log libvlc log instance
1107  * \param exception an initialized exception pointer
1108  */
1109 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1110
1111 /**
1112  * Returns the number of messages in log
1113  * \param p_log libvlc log instance
1114  * \param exception an initialized exception pointer
1115  */
1116 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1117
1118 /**
1119  * Clear all messages in log
1120  *  the log should be cleared on a regular basis to avoid clogging
1121  * \param p_log libvlc log instance
1122  * \param exception an initialized exception pointer
1123  */
1124 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1125
1126 /**
1127  * Allocate and returns a new iterator to messages in log
1128  * \param p_log libvlc log instance
1129  * \param exception an initialized exception pointer
1130  */
1131 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1132
1133 /**
1134  * Releases a previoulsy allocated iterator
1135  * \param p_log libvlc log iterator 
1136  * \param exception an initialized exception pointer
1137  */
1138 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1139
1140 /**
1141  * Returns whether log iterator has more messages 
1142  * \param p_log libvlc log iterator
1143  * \param exception an initialized exception pointer
1144  */
1145 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1146
1147 /**
1148  * Returns next log message
1149  *   the content of message must not be freed
1150  * \param p_log libvlc log iterator
1151  * \param exception an initialized exception pointer
1152  */
1153 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1154                                                                struct libvlc_log_message_t *buffer,
1155                                                                libvlc_exception_t *p_e );
1156
1157 /** @} */
1158
1159 /*****************************************************************************
1160  * Event handling
1161  *****************************************************************************/
1162
1163 /** defgroup libvlc_callbacks Callbacks
1164  * \ingroup libvlc
1165  * LibVLC Events
1166  * @{
1167  */
1168
1169 /**
1170  * Register for an event notification
1171  * \param p_event_manager the event manager to which you want to attach to
1172  * Generally it is obtained by vlc_my_object_event_manager() where my_object
1173  * Is the object you want to listen to.
1174  * \param i_event_type the desired event to which we want to listen
1175  * \param f_callback the function to call when i_event_type occurs
1176  * \param user_data user provided data to carry with the event
1177  * \param p_e an initialized exception pointer
1178  */
1179 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1180                                          libvlc_event_type_t i_event_type,
1181                                          libvlc_callback_t f_callback,
1182                                          void *user_data,
1183                                          libvlc_exception_t *p_e );
1184
1185 /**
1186  * Unregister an event notification
1187  * \param p_event_manager the event manager
1188  * \param i_event_type the desired event to which we want to unregister
1189  * \param f_callback the function to call when i_event_type occurs
1190  * \param p_e an initialized exception pointer
1191  */
1192 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1193                                          libvlc_event_type_t i_event_type,
1194                                          libvlc_callback_t f_callback,
1195                                          void *p_user_data,
1196                                          libvlc_exception_t *p_e );
1197
1198
1199 /**
1200  * Get an event type name 
1201  * \param i_event_type the desired event
1202  */
1203 #define libvlc_event_type_name(a) #a
1204
1205 /** @} */
1206
1207
1208 # ifdef __cplusplus
1209 }
1210 # endif
1211
1212 #endif /* <vlc/libvlc.h> */