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