libvlc.h: Document.
[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$
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
54  * reuse an exception structure.
55  *
56  * \param p_exception the exception to initialize
57  */
58 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
59
60 /**
61  * Has an exception been raised?
62  *
63  * \param p_exception the exception to query
64  * \return 0 if the exception was raised, 1 otherwise
65  */
66 VLC_PUBLIC_API int
67 libvlc_exception_raised( const libvlc_exception_t *p_exception );
68
69 /**
70  * Raise an exception using a user-provided message.
71  *
72  * \param p_exception the exception to raise
73  * \param psz_message the exception message format string
74  * \param ... the format string arguments
75  */
76 VLC_PUBLIC_API void
77 libvlc_exception_raise( libvlc_exception_t *p_exception,
78                         const char *psz_format, ... );
79
80 /**
81  * Clear an exception object so it can be reused.
82  * The exception object must have be initialized.
83  *
84  * \param p_exception the exception to clear
85  */
86 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
87
88 /**
89  * Get an exception's message.
90  *
91  * \param p_exception the exception to query
92  * \return the exception message or NULL if not applicable (exception not
93  *         raised, for example)
94  */
95 VLC_PUBLIC_API const char *
96 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
97
98 /**@} */
99
100 /*****************************************************************************
101  * Core handling
102  *****************************************************************************/
103
104 /** defgroup libvlc_core Core
105  * \ingroup libvlc
106  * LibVLC Core
107  * @{
108  */
109
110 /**
111  * Create and initialize a libvlc instance.
112  *
113  * \param argc the number of arguments
114  * \param argv command-line-type arguments. argv[0] must be the path of the
115  *        calling program.
116  * \param p_e an initialized exception pointer
117  * \return the libvlc instance
118  */
119 VLC_PUBLIC_API libvlc_instance_t *
120 libvlc_new( int , const char *const *, libvlc_exception_t *);
121
122 /**
123  * Return a libvlc instance identifier for legacy APIs. Use of this
124  * function is discouraged, you should convert your program to use the
125  * new API.
126  *
127  * \param p_instance the instance
128  * \return the instance identifier
129  */
130 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
131
132 /**
133  * Decrement the reference count of a libvlc instance, and destroy it
134  * if it reaches zero.
135  *
136  * \param p_instance the instance to destroy
137  */
138 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
139
140 /**
141  * Increments the reference count of a libvlc instance.
142  * The initial reference count is 1 after libvlc_new() returns.
143  *
144  * \param p_instance the instance to reference
145  */
146 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
147
148 /** @}*/
149
150 /*****************************************************************************
151  * Media descriptor
152  *****************************************************************************/
153 /** defgroup libvlc_media_descriptor Media Descriptor
154  * \ingroup libvlc
155  * LibVLC Media Descriptor
156  * @{
157  */
158
159 /**
160  * Create a media descriptor with the given MRL.
161  *
162  * \param p_instance the instance
163  * \param psz_mrl the MRL to read
164  * \param p_e an initialized exception pointer
165  * \return the newly created media descriptor
166  */
167 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
168                                    libvlc_instance_t *p_instance,
169                                    const char * psz_mrl,
170                                    libvlc_exception_t *p_e );
171
172 /**
173  * Create a media descriptor as an empty node with the passed name.
174  *
175  * \param p_instance the instance
176  * \param psz_name the name of the node
177  * \param p_e an initialized exception pointer
178  * \return the new empty media descriptor
179  */
180 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
181                                    libvlc_instance_t *p_instance,
182                                    const char * psz_name,
183                                    libvlc_exception_t *p_e );
184
185 /**
186  * Add an option to the media descriptor.
187  *
188  * This option will be used to determine how the media_instance will
189  * read the media_descriptor. This allows to use VLC's advanced
190  * reading/streaming options on a per-media basis.
191  *
192  * The options are detailed in vlc --long-help, for instance "--sout-all"
193  *
194  * \param p_instance the instance
195  * \param psz_mrl the MRL to read
196  * \param p_e an initialized exception pointer
197  */
198 VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
199                                    libvlc_media_descriptor_t * p_md,
200                                    const char * ppsz_options,
201                                    libvlc_exception_t * p_e );
202
203 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
204                                    libvlc_media_descriptor_t *p_meta_desc );
205
206 VLC_PUBLIC_API void libvlc_media_descriptor_release(
207                                    libvlc_media_descriptor_t *p_meta_desc );
208
209 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
210                                                        libvlc_exception_t * p_e );
211
212 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t * );
213
214 /**
215  * Read the meta of the media descriptor.
216  *
217  * \param p_meta_desc the media descriptor to read
218  * \param p_meta_desc the meta to read
219  * \param p_e an initialized exception pointer
220  * \return the media descriptor's meta
221  */
222 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
223                                    libvlc_media_descriptor_t *p_meta_desc,
224                                    libvlc_meta_t e_meta,
225                                    libvlc_exception_t *p_e );
226
227 VLC_PUBLIC_API libvlc_state_t libvlc_media_descriptor_get_state(
228                                    libvlc_media_descriptor_t *p_meta_desc,
229                                    libvlc_exception_t *p_e );
230
231 /* Tags */
232 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
233                                                      const char * key,
234                                                      const libvlc_tag_t tag,
235                                                      libvlc_exception_t *p_e );
236
237 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
238                                                          const char * key,
239                                                          const libvlc_tag_t tag,
240                                                          libvlc_exception_t *p_e );
241
242 VLC_PUBLIC_API int
243     libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
244                                                 const char * key,
245                                                 libvlc_exception_t *p_e );
246
247 VLC_PUBLIC_API libvlc_tag_t
248     libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
249                                                   int i,
250                                                   const char * key,
251                                                   libvlc_exception_t *p_e );
252
253 VLC_PUBLIC_API libvlc_media_list_t *
254     libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
255                                       libvlc_exception_t *p_e );
256
257 VLC_PUBLIC_API libvlc_event_manager_t *
258     libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
259                                            libvlc_exception_t * p_e );
260
261 VLC_PUBLIC_API libvlc_time_t
262    libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
263                                          libvlc_exception_t * p_e );
264
265 VLC_PUBLIC_API int
266    libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
267                                          libvlc_exception_t * p_e );
268
269 VLC_PUBLIC_API void
270     libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
271                                            void * p_new_user_data,
272                                            libvlc_exception_t * p_e);
273 VLC_PUBLIC_API void *
274     libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
275                                            libvlc_exception_t * p_e);
276
277 /** @}*/
278
279 /*****************************************************************************
280  * Media Instance
281  *****************************************************************************/
282 /** defgroup libvlc_media_instance Media Instance
283  * \ingroup libvlc
284  * LibVLC Media Instance, object that let you play a media descriptor
285  * in a libvlc_drawable_t
286  * @{
287  */
288
289 /** 
290  * Create an empty Media Instance object
291  *
292  * \param p_libvlc_instance the libvlc instance in which the Media Instance
293  *        should be created.
294  * \param p_e an initialized exception pointer
295  */
296 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
297
298 /**
299  * Create a Media Instance object from a Media Descriptor
300  *
301  * \param p_md the media descriptor. Afterwards the p_md can be safely
302  *        destroyed.
303  * \param p_e an initialized exception pointer
304  */
305 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
306
307 /**
308  * Release a media_instance after use
309  *
310  * \param p_mi the Media Instance to free
311  */
312 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
313 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
314
315 /** Set the media descriptor that will be used by the media_instance. If any,
316  * previous md will be released.
317  *
318  * \param p_mi the Media Instance
319  * \param p_md the Media Descriptor. Afterwards the p_md can be safely
320  *        destroyed.
321  * \param p_e an initialized exception pointer
322  */
323 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
324
325 /**
326  * Get the media descriptor used by the media_instance. 
327  *
328  * \param p_mi the Media Instance
329  * \param p_e an initialized exception pointer
330  * \return the media descriptor associated with p_mi, or NULL if no
331  *         media descriptor is associated
332  */
333 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
334
335 /**
336  * Get the Event Manager from which the media instance send event.
337  *
338  * \param p_mi the Media Instance
339  * \param p_e an initialized exception pointer
340  * \return the event manager associated with p_mi
341  */
342 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
343
344 /**
345  * Play 
346  *
347  * \param p_mi the Media Instance
348  * \param p_e an initialized exception pointer
349  */
350 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
351
352 /**
353  * Pause 
354  *
355  * \param p_mi the Media Instance
356  * \param p_e an initialized exception pointer
357  */
358 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
359
360 /**
361  * Stop 
362  *
363  * \param p_mi the Media Instance
364  * \param p_e an initialized exception pointer
365  */
366 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
367
368 /**
369  * Set the drawable where the media instance should render its video output
370  *
371  * \param p_mi the Media Instance
372  * \param drawable the libvlc_drawable_t where the media instance
373  *        should render its video
374  * \param p_e an initialized exception pointer
375  */
376 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
377
378 /**
379  * Get the drawable where the media instance should render its video output
380  *
381  * \param p_mi the Media Instance
382  * \param p_e an initialized exception pointer
383  * \return the libvlc_drawable_t where the media instance
384  *         should render its video
385  */
386 VLC_PUBLIC_API libvlc_drawable_t
387                     libvlc_media_instance_get_drawable ( libvlc_media_instance_t *, libvlc_exception_t * );
388
389 /** \bug This might go away ... to be replaced by a broader system */
390 VLC_PUBLIC_API libvlc_time_t  libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
391 VLC_PUBLIC_API libvlc_time_t  libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
392 VLC_PUBLIC_API void           libvlc_media_instance_set_time       ( libvlc_media_instance_t *, libvlc_time_t, libvlc_exception_t *);
393 VLC_PUBLIC_API float          libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
394 VLC_PUBLIC_API void           libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
395 VLC_PUBLIC_API void           libvlc_media_instance_set_chapter    ( libvlc_media_instance_t *, int, libvlc_exception_t *);
396 VLC_PUBLIC_API int            libvlc_media_instance_get_chapter    (libvlc_media_instance_t *, libvlc_exception_t *);
397 VLC_PUBLIC_API int            libvlc_media_instance_get_chapter_count( libvlc_media_instance_t *, libvlc_exception_t *);
398 VLC_PUBLIC_API int            libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
399 VLC_PUBLIC_API float          libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
400 VLC_PUBLIC_API void           libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
401 VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state   ( libvlc_media_instance_t *, libvlc_exception_t *);
402 VLC_PUBLIC_API float          libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
403
404 /**
405  * Does this media instance have a video output?
406  *
407  * \param p_md the media instance
408  * \param p_e an initialized exception pointer
409  */
410 VLC_PUBLIC_API int  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
411
412 /**
413  * Is this media instance seekable?
414  *
415  * \param p_input the input
416  * \param p_e an initialized exception pointer
417  */
418 VLC_PUBLIC_API int libvlc_media_instance_is_seekable( libvlc_media_instance_t *p_mi, libvlc_exception_t *p_e );
419
420 /**
421  * Can this media instance be paused?
422  *
423  * \param p_input the input
424  * \param p_e an initialized exception pointer
425  */
426 VLC_PUBLIC_API int libvlc_media_instance_can_pause( libvlc_media_instance_t *p_mi, libvlc_exception_t *p_e );
427
428 /** defgroup libvlc_video Video
429  * \ingroup libvlc_media_instance
430  * LibVLC Video handling
431  * @{
432  */
433
434 /**
435  * Toggle fullscreen status on video output.
436  *
437  * \param p_input the input
438  * \param p_e an initialized exception pointer
439  */
440 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
441
442 /**
443  * Enable or disable fullscreen on a video output.
444  *
445  * \param p_input the input
446  * \param b_fullscreen boolean for fullscreen status
447  * \param p_e an initialized exception pointer
448  */
449 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
450
451 /**
452  * Get current fullscreen status.
453  *
454  * \param p_input the input
455  * \param p_e an initialized exception pointer
456  * \return the fullscreen status (boolean)
457  */
458 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
459
460 /**
461  * Get current video height.
462  *
463  * \param p_input the input
464  * \param p_e an initialized exception pointer
465  * \return the video height
466  */
467 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
468
469 /**
470  * Get current video width.
471  *
472  * \param p_input the input
473  * \param p_e an initialized exception pointer
474  * \return the video width
475  */
476 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
477
478 /**
479  * Get current video aspect ratio.
480  *
481  * \param p_input the input
482  * \param p_e an initialized exception pointer
483  * \return the video aspect ratio
484  */
485 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
486
487 /**
488  * Set new video aspect ratio.
489  *
490  * \param p_input the input
491  * \param psz_aspect new video aspect-ratio
492  * \param p_e an initialized exception pointer
493  */
494 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
495
496 /**
497  * Get current video subtitle.
498  *
499  * \param p_input the input
500  * \param p_e an initialized exception pointer
501  * \return the video subtitle selected
502  */
503 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
504
505 /**
506  * Set new video subtitle.
507  *
508  * \param p_input the input
509  * \param i_spu new video subtitle to select
510  * \param p_e an initialized exception pointer
511  */
512 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
513
514 /**
515  * Get current crop filter geometry.
516  *
517  * \param p_input the input
518  * \param p_e an initialized exception pointer
519  * \return the crop filter geometry
520  */
521 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
522
523 /**
524  * Set new crop filter geometry.
525  *
526  * \param p_input the input
527  * \param psz_geometry new crop filter geometry
528  * \param p_e an initialized exception pointer
529  */
530 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
531
532 /**
533  * Toggle teletext transparent status on video output.
534  *
535  * \param p_input the input
536  * \param p_e an initialized exception pointer
537  */
538 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
539
540 /**
541  * Get current teletext page requested.
542  *
543  * \param p_input the input
544  * \param p_e an initialized exception pointer
545  * \return the current teletext page requested.
546  */
547 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
548
549 /**
550  * Set new teletext page to retrieve.
551  *
552  * \param p_input the input
553  * \param i_page teletex page number requested
554  * \param p_e an initialized exception pointer
555  */
556 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
557
558 /**
559  * Take a snapshot of the current video window.
560  *
561  * If i_width AND i_height is 0, original size is used.
562  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
563  *
564  * \param p_input the input
565  * \param psz_filepath the path where to save the screenshot to
566  * \param i_width the snapshot's width
567  * \param i_height the snapshot's height
568  * \param p_e an initialized exception pointer
569  */
570 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
571
572 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
573
574 /**
575  * Resize the current video output window.
576  *
577  * \param p_instance libvlc instance
578  * \param width new width for video output window
579  * \param height new height for video output window
580  * \param p_e an initialized exception pointer
581  * \return the success status (boolean)
582  */
583 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
584
585 /**
586  * Change the parent for the current the video output.
587  *
588  * \param p_instance libvlc instance
589  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
590  * \param p_e an initialized exception pointer
591  * \return the success status (boolean)
592  */
593 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
594
595 /**
596  * Tell windowless video output to redraw rectangular area (MacOS X only).
597  *
598  * \param p_instance libvlc instance
599  * \param area coordinates within video drawable
600  * \param p_e an initialized exception pointer
601  */
602 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
603
604 /**
605  * Set the default video output's parent.
606  *
607  * This setting will be used as default for all video outputs.
608  *
609  * \param p_instance libvlc instance
610  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
611  * \param p_e an initialized exception pointer
612  */
613 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
614
615 /**
616  * Set the default video output parent.
617  *
618  * This setting will be used as default for all video outputs.
619  *
620  * \param p_instance libvlc instance
621  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
622  * \param p_e an initialized exception pointer
623  */
624 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
625
626 /**
627  * Set the default video output size.
628  *
629  * This setting will be used as default for all video outputs.
630  *
631  * \param p_instance libvlc instance
632  * \param width new width for video drawable
633  * \param height new height for video drawable
634  * \param p_e an initialized exception pointer
635  */
636 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
637
638 /**
639  * Set the default video output viewport for a windowless video output
640  * (MacOS X only).
641  *
642  * This setting will be used as default for all video outputs.
643  *
644  * \param p_instance libvlc instance
645  * \param view coordinates within video drawable
646  * \param clip coordinates within video drawable
647  * \param p_e an initialized exception pointer
648  */
649 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
650
651 /** @} video */
652
653 /** defgroup libvlc_audio Audio
654  * \ingroup libvlc_media_instance
655  * LibVLC Audio handling
656  * @{
657  */
658
659 /**
660  * Toggle mute status.
661  *
662  * \param p_instance libvlc instance
663  * \param p_e an initialized exception pointer
664  */
665 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
666
667 /**
668  * Get current mute status.
669  *
670  * \param p_instance libvlc instance
671  * \param p_e an initialized exception pointer
672  * \return the mute status (boolean)
673  */
674 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
675
676 /**
677  * Set mute status.
678  *
679  * \param p_instance libvlc instance
680  * \param status If status is VLC_TRUE then mute, otherwise unmute
681  * \param p_e an initialized exception pointer
682  */
683 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
684
685 /**
686  * Get current audio level.
687  *
688  * \param p_instance libvlc instance
689  * \param p_e an initialized exception pointer
690  * \return the audio level (int)
691  */
692 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
693
694 /**
695  * Set current audio level.
696  *
697  * \param p_instance libvlc instance
698  * \param i_volume the volume (int)
699  * \param p_e an initialized exception pointer
700  */
701 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
702
703 /**
704  * Get number of available audio tracks.
705  *
706  * \param p_mi media instance
707  * \param p_e an initialized exception
708  * \return the number of available audio tracks (int)
709  */
710 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_instance_t *,  libvlc_exception_t * );
711
712 /**
713  * Get current audio track.
714  *
715  * \param p_input input instance
716  * \param p_e an initialized exception pointer
717  * \return the audio track (int)
718  */
719 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
720
721 /**
722  * Set current audio track.
723  *
724  * \param p_input input instance
725  * \param i_track the track (int)
726  * \param p_e an initialized exception pointer
727  */
728 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
729
730 /**
731  * Get current audio channel.
732  *
733  * \param p_instance input instance
734  * \param p_e an initialized exception pointer
735  * \return the audio channel (int)
736  */
737 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
738
739 /**
740  * Set current audio channel.
741  *
742  * \param p_instance input instance
743  * \param i_channel the audio channel (int)
744  * \param p_e an initialized exception pointer
745  */
746 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
747
748 /** @} audio */
749
750 /** @} media_instance */
751
752 /*****************************************************************************
753  * Event handling
754  *****************************************************************************/
755
756 /** defgroup libvlc_callbacks Callbacks
757  * \ingroup libvlc
758  * LibVLC Events
759  * @{
760  */
761
762 /**
763  * Register for an event notification.
764  *
765  * \param p_event_manager the event manager to which you want to attach to.
766  *        Generally it is obtained by vlc_my_object_event_manager() where
767  *        my_object is the object you want to listen to.
768  * \param i_event_type the desired event to which we want to listen
769  * \param f_callback the function to call when i_event_type occurs
770  * \param user_data user provided data to carry with the event
771  * \param p_e an initialized exception pointer
772  */
773 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
774                                          libvlc_event_type_t i_event_type,
775                                          libvlc_callback_t f_callback,
776                                          void *user_data,
777                                          libvlc_exception_t *p_e );
778
779 /**
780  * Unregister an event notification.
781  *
782  * \param p_event_manager the event manager
783  * \param i_event_type the desired event to which we want to unregister
784  * \param f_callback the function to call when i_event_type occurs
785  * \param p_e an initialized exception pointer
786  */
787 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
788                                          libvlc_event_type_t i_event_type,
789                                          libvlc_callback_t f_callback,
790                                          void *p_user_data,
791                                          libvlc_exception_t *p_e );
792
793 /**
794  * Get an event's type name.
795  *
796  * \param i_event_type the desired event
797  */
798 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
799
800 /** @} */
801
802 /*****************************************************************************
803  * Media List
804  *****************************************************************************/
805 /** defgroup libvlc_media_list MediaList
806  * \ingroup libvlc
807  * LibVLC Media List, a media list holds multiple media descriptors
808  * @{
809  */
810
811 /**
812  * Create an empty media list.
813  *
814  * \param p_libvlc the event manager
815  * \param i_event_type the desired event to which we want to unregister
816  * \param f_callback the function to call when i_event_type occurs
817  * \param p_e an initialized exception pointer
818  */
819
820 VLC_PUBLIC_API libvlc_media_list_t *
821     libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
822
823 VLC_PUBLIC_API void
824     libvlc_media_list_release( libvlc_media_list_t * );
825
826 VLC_PUBLIC_API void
827     libvlc_media_list_retain( libvlc_media_list_t * );
828
829 VLC_DEPRECATED_API void
830     libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
831                                         const char * psz_uri,
832                                         libvlc_exception_t * p_e );
833
834 VLC_PUBLIC_API void
835     libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
836                                             libvlc_media_descriptor_t *,
837                                             libvlc_exception_t *);
838
839 VLC_PUBLIC_API libvlc_media_descriptor_t *
840     libvlc_media_list_media_descriptor( libvlc_media_list_t *,
841                                         libvlc_exception_t *);
842
843 VLC_PUBLIC_API void
844     libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
845                                             libvlc_media_descriptor_t *,
846                                             libvlc_exception_t * );
847 VLC_PUBLIC_API void
848     libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
849                                                libvlc_media_descriptor_t *,
850                                                int,
851                                                libvlc_exception_t * );
852 VLC_PUBLIC_API void
853     libvlc_media_list_remove_index( libvlc_media_list_t *, int,
854                                     libvlc_exception_t * );
855
856 VLC_PUBLIC_API int
857     libvlc_media_list_count( libvlc_media_list_t * p_mlist,
858                              libvlc_exception_t * p_e );
859
860 VLC_PUBLIC_API libvlc_media_descriptor_t *
861     libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
862                                      libvlc_exception_t * );
863 VLC_PUBLIC_API int
864     libvlc_media_list_index_of_item( libvlc_media_list_t *,
865                                      libvlc_media_descriptor_t *,
866                                      libvlc_exception_t * );
867
868 /* This indicates if this media list is read-only from a user point of view */
869 VLC_PUBLIC_API int
870     libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
871
872 VLC_PUBLIC_API void
873     libvlc_media_list_lock( libvlc_media_list_t * );
874 VLC_PUBLIC_API void
875     libvlc_media_list_unlock( libvlc_media_list_t * );
876
877 VLC_PUBLIC_API libvlc_media_list_view_t *
878     libvlc_media_list_flat_view( libvlc_media_list_t *,
879                                  libvlc_exception_t * );
880
881 VLC_PUBLIC_API libvlc_media_list_view_t *
882     libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
883                                          libvlc_exception_t * );
884
885 VLC_PUBLIC_API libvlc_media_list_view_t *
886     libvlc_media_list_hierarchical_node_view( libvlc_media_list_t *,
887                                               libvlc_exception_t * );
888
889 VLC_PUBLIC_API libvlc_event_manager_t *
890     libvlc_media_list_event_manager( libvlc_media_list_t *,
891                                      libvlc_exception_t * );
892
893 /*****************************************************************************
894  * Media List View
895  *****************************************************************************/
896 /** defgroup libvlc_media_list_view MediaListView
897  * \ingroup libvlc_media_list
898  * LibVLC Media List View, represent a media_list using a different layout
899  * @{ */
900
901 VLC_PUBLIC_API void
902     libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
903
904 VLC_PUBLIC_API void
905     libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
906
907 VLC_PUBLIC_API libvlc_event_manager_t *
908     libvlc_media_list_view_event_manager(  libvlc_media_list_view_t * p_mlv );
909
910 VLC_PUBLIC_API int
911     libvlc_media_list_view_count(  libvlc_media_list_view_t * p_mlv,
912                                    libvlc_exception_t * p_e );
913
914 VLC_PUBLIC_API libvlc_media_descriptor_t *
915     libvlc_media_list_view_item_at_index(  libvlc_media_list_view_t * p_mlv,
916                                            int index,
917                                            libvlc_exception_t * p_e );
918
919 VLC_PUBLIC_API libvlc_media_list_view_t *
920     libvlc_media_list_view_children_at_index(  libvlc_media_list_view_t * p_mlv,
921                                            int index,
922                                            libvlc_exception_t * p_e );
923
924 VLC_PUBLIC_API libvlc_media_list_view_t *
925     libvlc_media_list_view_children_for_item(  libvlc_media_list_view_t * p_mlv,
926                                            libvlc_media_descriptor_t * p_md,
927                                            libvlc_exception_t * p_e );
928
929
930 VLC_PUBLIC_API int
931     libvlc_media_list_view_index_of_item(  libvlc_media_list_view_t * p_mlv,
932                                            libvlc_media_descriptor_t * p_md,
933                                            libvlc_exception_t * p_e );
934
935 VLC_PUBLIC_API void
936     libvlc_media_list_view_insert_at_index(  libvlc_media_list_view_t * p_mlv,
937                                              libvlc_media_descriptor_t * p_md,
938                                              int index,
939                                              libvlc_exception_t * p_e );
940
941 VLC_PUBLIC_API void
942     libvlc_media_list_view_remove_at_index(  libvlc_media_list_view_t * p_mlv,
943                                              int index,
944                                              libvlc_exception_t * p_e );
945
946 VLC_PUBLIC_API void
947     libvlc_media_list_view_add_item(  libvlc_media_list_view_t * p_mlv,
948                                       libvlc_media_descriptor_t * p_md,
949                                       libvlc_exception_t * p_e );
950
951 VLC_PUBLIC_API libvlc_media_list_t *
952     libvlc_media_list_view_parent_media_list(  libvlc_media_list_view_t * p_mlv,
953                                                libvlc_exception_t * p_e );
954
955 /** @} media_list_view */
956
957 /*****************************************************************************
958  * Media List Player
959  *****************************************************************************/
960 /** defgroup libvlc_media_list_player MediaListPlayer
961  * \ingroup libvlc
962  * LibVLC Media List Player, play a media_list. You can see that as a media
963  * instance subclass
964  * @{
965  */
966 VLC_PUBLIC_API libvlc_media_list_player_t *
967     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
968                                   libvlc_exception_t * p_e );
969 VLC_PUBLIC_API void
970     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
971
972 VLC_PUBLIC_API void
973     libvlc_media_list_player_set_media_instance(
974                                      libvlc_media_list_player_t * p_mlp,
975                                      libvlc_media_instance_t * p_mi,
976                                      libvlc_exception_t * p_e );
977
978 VLC_PUBLIC_API void
979     libvlc_media_list_player_set_media_list(
980                                      libvlc_media_list_player_t * p_mlp,
981                                      libvlc_media_list_t * p_mlist,
982                                      libvlc_exception_t * p_e );
983
984 VLC_PUBLIC_API void
985     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
986                                    libvlc_exception_t * p_e );
987
988 VLC_PUBLIC_API void
989     libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
990                                    libvlc_exception_t * p_e );
991
992 VLC_PUBLIC_API int
993     libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
994                                          libvlc_exception_t * p_e );
995
996 VLC_PUBLIC_API libvlc_state_t
997     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
998                                         libvlc_exception_t * p_e );
999
1000 VLC_PUBLIC_API void
1001     libvlc_media_list_player_play_item_at_index(
1002                                    libvlc_media_list_player_t * p_mlp,
1003                                    int i_index,
1004                                    libvlc_exception_t * p_e );
1005
1006 VLC_PUBLIC_API void
1007     libvlc_media_list_player_play_item(
1008                                    libvlc_media_list_player_t * p_mlp,
1009                                    libvlc_media_descriptor_t * p_md,
1010                                    libvlc_exception_t * p_e );
1011
1012 VLC_PUBLIC_API void
1013     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
1014                                    libvlc_exception_t * p_e );
1015
1016 VLC_PUBLIC_API void
1017     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
1018                                    libvlc_exception_t * p_e );
1019
1020 /** @} media_list_player */
1021
1022 /** @} media_list */
1023
1024 /*****************************************************************************
1025  * Media Library
1026  *****************************************************************************/
1027 /** defgroup libvlc_media_library Media Library
1028  * \ingroup libvlc
1029  * LibVLC Media Library
1030  * @{
1031  */
1032 VLC_PUBLIC_API libvlc_media_library_t *
1033     libvlc_media_library_new( libvlc_instance_t * p_inst,
1034                               libvlc_exception_t * p_e );
1035 VLC_PUBLIC_API void
1036     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
1037 VLC_PUBLIC_API void
1038     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
1039
1040
1041 VLC_PUBLIC_API void
1042     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
1043                                libvlc_exception_t * p_e );
1044
1045 VLC_PUBLIC_API void
1046     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
1047                                libvlc_exception_t * p_e );
1048
1049 VLC_PUBLIC_API libvlc_media_list_t *
1050     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
1051                                      libvlc_exception_t * p_e );
1052
1053
1054 /** @} */
1055
1056
1057 /*****************************************************************************
1058  * Services/Media Discovery
1059  *****************************************************************************/
1060 /** defgroup libvlc_media_discoverer Media Discoverer
1061  * \ingroup libvlc
1062  * LibVLC Media Discoverer
1063  * @{
1064  */
1065
1066 VLC_PUBLIC_API libvlc_media_discoverer_t *
1067 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1068                                        const char * psz_name,
1069                                        libvlc_exception_t * p_e );
1070 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1071 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1072
1073 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1074
1075 VLC_PUBLIC_API libvlc_event_manager_t *
1076         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1077
1078 VLC_PUBLIC_API int
1079         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1080
1081 /**@} */
1082
1083
1084 /*****************************************************************************
1085  * VLM
1086  *****************************************************************************/
1087 /** defgroup libvlc_vlm VLM
1088  * \ingroup libvlc
1089  * LibVLC VLM
1090  * @{
1091  */
1092
1093 /**
1094  * Add a broadcast, with one input.
1095  *
1096  * \param p_instance the instance
1097  * \param psz_name the name of the new broadcast
1098  * \param psz_input the input MRL
1099  * \param psz_output the output MRL (the parameter to the "sout" variable)
1100  * \param i_options number of additional options
1101  * \param ppsz_options additional options
1102  * \param b_enabled boolean for enabling the new broadcast
1103  * \param b_loop Should this broadcast be played in loop ?
1104  * \param p_e an initialized exception pointer
1105  */
1106 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
1107                                               int, char **, int, int, libvlc_exception_t * );
1108
1109 /**
1110  * Delete a media (VOD or broadcast).
1111  *
1112  * \param p_instance the instance
1113  * \param psz_name the media to delete
1114  * \param p_e an initialized exception pointer
1115  */
1116 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1117
1118 /**
1119  * Enable or disable a media (VOD or broadcast).
1120  *
1121  * \param p_instance the instance
1122  * \param psz_name the media to work on
1123  * \param b_enabled the new status
1124  * \param p_e an initialized exception pointer
1125  */
1126 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
1127                                             libvlc_exception_t *);
1128
1129 /**
1130  * Set the output for a media.
1131  *
1132  * \param p_instance the instance
1133  * \param psz_name the media to work on
1134  * \param psz_output the output MRL (the parameter to the "sout" variable)
1135  * \param p_e an initialized exception pointer
1136  */
1137 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
1138                                            libvlc_exception_t *);
1139
1140 /**
1141  * Set a media's input MRL. This will delete all existing inputs and
1142  * add the specified one.
1143  *
1144  * \param p_instance the instance
1145  * \param psz_name the media to work on
1146  * \param psz_input the input MRL
1147  * \param p_e an initialized exception pointer
1148  */
1149 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
1150                                           libvlc_exception_t *);
1151
1152 /**
1153  * Add a media's input MRL. This will add the specified one.
1154  *
1155  * \param p_instance the instance
1156  * \param psz_name the media to work on
1157  * \param psz_input the input MRL
1158  * \param p_e an initialized exception pointer
1159  */
1160 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1161                                           libvlc_exception_t *p_exception );
1162 /**
1163  * Set a media's loop status.
1164  *
1165  * \param p_instance the instance
1166  * \param psz_name the media to work on
1167  * \param b_loop the new status
1168  * \param p_e an initialized exception pointer
1169  */
1170 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1171                                          libvlc_exception_t *);
1172
1173 /**
1174  * Edit the parameters of a media. This will delete all existing inputs and
1175  * add the specified one.
1176  *
1177  * \param p_instance the instance
1178  * \param psz_name the name of the new broadcast
1179  * \param psz_input the input MRL
1180  * \param psz_output the output MRL (the parameter to the "sout" variable)
1181  * \param i_options number of additional options
1182  * \param ppsz_options additional options
1183  * \param b_enabled boolean for enabling the new broadcast
1184  * \param b_loop Should this broadcast be played in loop ?
1185  * \param p_e an initialized exception pointer
1186  */
1187 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1188                                              int, char **, int, int, libvlc_exception_t * );
1189
1190 /**
1191  * Play the named broadcast.
1192  *
1193  * \param p_instance the instance
1194  * \param psz_name the name of the broadcast
1195  * \param p_e an initialized exception pointer
1196  */
1197 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1198
1199 /**
1200  * Stop the named broadcast.
1201  *
1202  * \param p_instance the instance
1203  * \param psz_name the name of the broadcast
1204  * \param p_e an initialized exception pointer
1205  */
1206 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1207
1208 /**
1209  * Pause the named broadcast.
1210  *
1211  * \param p_instance the instance
1212  * \param psz_name the name of the broadcast
1213  * \param p_e an initialized exception pointer
1214  */
1215 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1216
1217 /**
1218  * Seek in the named broadcast.
1219  *
1220  * \param p_instance the instance
1221  * \param psz_name the name of the broadcast
1222  * \param f_percentage the percentage to seek to
1223  * \param p_e an initialized exception pointer
1224  */
1225 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1226                                            float, libvlc_exception_t * );
1227
1228 /**
1229  * Return information about the named broadcast.
1230  *
1231  * \param p_instance the instance
1232  * \param psz_name the name of the broadcast
1233  * \param p_e an initialized exception pointer
1234  */
1235 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1236
1237 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1238 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1239                         char *, int , libvlc_exception_t * );
1240
1241 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1242 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1243 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1244 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1245 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1246 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1247 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1248
1249 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1250
1251 /** @} */
1252
1253 /*****************************************************************************
1254  * Message log handling
1255  *****************************************************************************/
1256
1257 /** defgroup libvlc_log Log
1258  * \ingroup libvlc
1259  * LibVLC Message Logging
1260  * @{
1261  */
1262
1263 /**
1264  * Return the VLC messaging verbosity level.
1265  *
1266  * \param p_instance libvlc instance
1267  * \param exception an initialized exception pointer
1268  */
1269 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1270                                                   libvlc_exception_t *p_e );
1271
1272 /**
1273  * Set the VLC messaging verbosity level.
1274  *
1275  * \param p_log libvlc log instance
1276  * \param exception an initialized exception pointer
1277  */
1278 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1279                                               libvlc_exception_t *p_e );
1280
1281 /**
1282  * Open a VLC message log instance.
1283  *
1284  * \param p_instance libvlc instance
1285  * \param exception an initialized exception pointer
1286  */
1287 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1288
1289 /**
1290  * Close a VLC message log instance.
1291  *
1292  * \param p_log libvlc log instance
1293  * \param exception an initialized exception pointer
1294  */
1295 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1296
1297 /**
1298  * Returns the number of messages in a log instance.
1299  *
1300  * \param p_log libvlc log instance
1301  * \param exception an initialized exception pointer
1302  */
1303 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1304
1305 /**
1306  * Clear a log instance.
1307  *
1308  * All messages in the log are removed. The log should be cleared on a
1309  * regular basis to avoid clogging.
1310  *
1311  * \param p_log libvlc log instance
1312  * \param exception an initialized exception pointer
1313  */
1314 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1315
1316 /**
1317  * Allocate and returns a new iterator to messages in log.
1318  *
1319  * \param p_log libvlc log instance
1320  * \param exception an initialized exception pointer
1321  */
1322 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1323
1324 /**
1325  * Release a previoulsy allocated iterator.
1326  *
1327  * \param p_log libvlc log iterator
1328  * \param exception an initialized exception pointer
1329  */
1330 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1331
1332 /**
1333  * Return whether log iterator has more messages.
1334  *
1335  * \param p_log libvlc log iterator
1336  * \param exception an initialized exception pointer
1337  */
1338 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1339
1340 /**
1341  * Return the next log message.
1342  *
1343  * The message contents must not be freed
1344  *
1345  * \param p_log libvlc log iterator
1346  * \param exception an initialized exception pointer
1347  */
1348 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1349                                                                struct libvlc_log_message_t *buffer,
1350                                                                libvlc_exception_t *p_e );
1351
1352 /** @} */
1353
1354 /*****************************************************************************
1355  * Playlist (Deprecated)
1356  *****************************************************************************/
1357 /** defgroup libvlc_playlist Playlist
1358  * \ingroup libvlc
1359  * LibVLC Playlist handling
1360  * @{
1361  */
1362
1363 /**
1364  * Set the playlist's loop attribute. If set, the playlist runs continuously
1365  * and wraps around when it reaches the end.
1366  *
1367  * \param p_instance the playlist instance
1368  * \param loop the loop attribute. 1 sets looping, 0 disables it
1369  * \param p_e an initialized exception pointer
1370  */
1371 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
1372                                           libvlc_exception_t * );
1373
1374 /**
1375  * Start playing.
1376  *
1377  * Additionnal playlist item options can be specified for addition to the
1378  * item before it is played.
1379  *
1380  * \param p_instance the playlist instance
1381  * \param i_id the item to play. If this is a negative number, the next
1382  *        item will be selected. Otherwise, the item with the given ID will be
1383  *        played
1384  * \param i_options the number of options to add to the item
1385  * \param ppsz_options the options to add to the item
1386  * \param p_e an initialized exception pointer
1387  */
1388 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
1389                                           char **, libvlc_exception_t * );
1390
1391 /**
1392  * Toggle the playlist's pause status.
1393  *
1394  * If the playlist was running, it is paused. If it was paused, it is resumed.
1395  *
1396  * \param p_instance the playlist instance to pause
1397  * \param p_e an initialized exception pointer
1398  */
1399 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
1400                                            libvlc_exception_t * );
1401
1402 /**
1403  * Checks whether the playlist is running
1404  *
1405  * \param p_instance the playlist instance
1406  * \param p_e an initialized exception pointer
1407  * \return 0 if the playlist is stopped or paused, 1 if it is running
1408  */
1409 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
1410                                               libvlc_exception_t * );
1411
1412 /**
1413  * Get the number of items in the playlist
1414  *
1415  * \param p_instance the playlist instance
1416  * \param p_e an initialized exception pointer
1417  * \return the number of items
1418  */
1419 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
1420                                                 libvlc_exception_t * );
1421
1422 /**
1423  * Lock the playlist.
1424  *
1425  * \param p_instance the playlist instance
1426  */
1427 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
1428
1429 /**
1430  * Unlock the playlist.
1431  *
1432  * \param p_instance the playlist instance
1433  */
1434 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
1435
1436 /**
1437  * Stop playing.
1438  *
1439  * \param p_instance the playlist instance to stop
1440  * \param p_e an initialized exception pointer
1441  */
1442 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
1443                                           libvlc_exception_t * );
1444
1445 /**
1446  * Go to the next playlist item. If the playlist was stopped, playback
1447  * is started.
1448  *
1449  * \param p_instance the playlist instance
1450  * \param p_e an initialized exception pointer
1451  */
1452 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
1453                                           libvlc_exception_t * );
1454
1455 /**
1456  * Go to the previous playlist item. If the playlist was stopped, playback
1457  * is started.
1458  *
1459  * \param p_instance the playlist instance
1460  * \param p_e an initialized exception pointer
1461  */
1462 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
1463                                           libvlc_exception_t * );
1464
1465 /**
1466  * Empty a playlist. All items in the playlist are removed.
1467  *
1468  * \param p_instance the playlist instance
1469  * \param p_e an initialized exception pointer
1470  */
1471 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
1472                                            libvlc_exception_t * );
1473
1474 /**
1475  * Append an item to the playlist. The item is added at the end. If more
1476  * advanced options are required, \see libvlc_playlist_add_extended instead.
1477  *
1478  * \param p_instance the playlist instance
1479  * \param psz_uri the URI to open, using VLC format
1480  * \param psz_name a name that you might want to give or NULL
1481  * \param p_e an initialized exception pointer
1482  * \return the identifier of the new item
1483  */
1484 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
1485                                         const char *, libvlc_exception_t * );
1486
1487 /**
1488  * Append an item to the playlist. The item is added at the end, with
1489  * additional input options.
1490  *
1491  * \param p_instance the playlist instance
1492  * \param psz_uri the URI to open, using VLC format
1493  * \param psz_name a name that you might want to give or NULL
1494  * \param i_options the number of options to add
1495  * \param ppsz_options strings representing the options to add
1496  * \param p_e an initialized exception pointer
1497  * \return the identifier of the new item
1498  */
1499 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
1500                                                  const char *, int, const char **,
1501                                                  libvlc_exception_t * );
1502
1503 /**
1504  * Delete the playlist item with the given ID.
1505  *
1506  * \param p_instance the playlist instance
1507  * \param i_id the id to remove
1508  * \param p_e an initialized exception pointer
1509  * \return 0 in case of success, a non-zero value otherwise
1510  */
1511 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
1512                                                 libvlc_exception_t * );
1513
1514 /** Get the input that is currently being played by the playlist.
1515  *
1516  * \param p_instance the playlist instance to use
1517  * \param p_e an initialized exception pointern
1518  * \return a media instance object
1519  */
1520 VLC_DEPRECATED_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
1521                                 libvlc_instance_t *, libvlc_exception_t * );
1522
1523 /** @}*/
1524
1525 # ifdef __cplusplus
1526 }
1527 # endif
1528
1529 #endif /* <vlc/libvlc.h> */