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 $
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
26 * \defgroup libvlc Libvlc
27 * This is libvlc, the base library of the VLC program.
37 #include <vlc/libvlc_structures.h>
43 /*****************************************************************************
45 *****************************************************************************/
46 /** defgroup libvlc_exception Exceptions
48 * LibVLC Exceptions handling
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
57 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
60 * Has an exception been raised ?
61 * \param p_exception the exception to query
62 * \return 0 if no exception raised, 1 else
65 libvlc_exception_raised( const libvlc_exception_t *p_exception );
69 * \param p_exception the exception to raise
70 * \param psz_message the exception message
73 libvlc_exception_raise( libvlc_exception_t *p_exception,
74 const char *psz_format, ... );
77 * Clear an exception object so it can be reused.
78 * The exception object must be initialized
79 * \param p_exception the exception to clear
81 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
84 * Get exception message
85 * \param p_exception the exception to query
86 * \return the exception message or NULL if not applicable (exception not raised
89 VLC_PUBLIC_API const char *
90 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
94 /*****************************************************************************
96 *****************************************************************************/
98 /** defgroup libvlc_core Core
105 * Create an initialized libvlc instance.
106 * \param argc the number of arguments
107 * \param argv command-line-type arguments
108 * \param exception an initialized exception pointer
110 VLC_PUBLIC_API libvlc_instance_t *
111 libvlc_new( int , const char *const *, libvlc_exception_t *);
114 * Returns a libvlc instance identifier for legacy APIs. Use of this
115 * function is discouraged, you should convert your program to use the
117 * \param p_instance the instance
119 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
122 * Decrements the reference count of a libvlc instance, and destroys it
123 * if it reaches zero.
124 * \param p_instance the instance to destroy
126 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *, libvlc_exception_t * );
129 * Increments the reference count of a libvlc instance.
130 * The reference count is initially one when libvlc_new() returns.
132 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
136 /*****************************************************************************
138 *****************************************************************************/
139 /** defgroup libvlc_media_descriptor Media Descriptor
141 * LibVLC Media Descriptor
146 * Create a media descriptor with the given mrl.
147 * \param p_instance the instance
148 * \param psz_mrl the mrl to read
150 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
151 libvlc_instance_t *p_instance,
152 const char * psz_mrl,
153 libvlc_exception_t *p_e );
156 * Add an option to the media descriptor,
157 * This option will be used to determine how the media_instance will
158 * read the media_descriptor. This allow to use VLC advanced
159 * reading/streaming options in a per-media basis.
161 * The options are detailled in vlc --long-help, for instance "--sout-all"
162 * \param p_instance the instance
163 * \param psz_mrl the mrl to read
165 VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
166 libvlc_media_descriptor_t * p_md,
167 const char * ppsz_options,
168 libvlc_exception_t * p_e );
170 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
171 libvlc_media_descriptor_t *p_meta_desc );
173 VLC_PUBLIC_API void libvlc_media_descriptor_release(
174 libvlc_media_descriptor_t *p_meta_desc );
176 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
177 libvlc_exception_t * p_e );
180 * Read the meta of the media descriptor.
181 * \param p_meta_desc the media descriptor to read
182 * \param p_meta_desc the meta to read
184 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
185 libvlc_media_descriptor_t *p_meta_desc,
186 libvlc_meta_t e_meta,
187 libvlc_exception_t *p_e );
190 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
192 const libvlc_tag_t tag,
193 libvlc_exception_t *p_e );
195 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
197 const libvlc_tag_t tag,
198 libvlc_exception_t *p_e );
201 libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
203 libvlc_exception_t *p_e );
205 VLC_PUBLIC_API libvlc_tag_t
206 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
209 libvlc_exception_t *p_e );
211 VLC_PUBLIC_API libvlc_media_list_t *
212 libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
213 libvlc_exception_t *p_e );
215 VLC_PUBLIC_API libvlc_event_manager_t *
216 libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
217 libvlc_exception_t * p_e );
219 VLC_PUBLIC_API vlc_int64_t
220 libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
221 libvlc_exception_t * p_e );
223 VLC_PUBLIC_API vlc_bool_t
224 libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
225 libvlc_exception_t * p_e );
228 libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
229 void * p_new_user_data,
230 libvlc_exception_t * p_e);
231 VLC_PUBLIC_API void *
232 libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
233 libvlc_exception_t * p_e);
237 /*****************************************************************************
239 *****************************************************************************/
240 /** defgroup libvlc_playlist Playlist
242 * LibVLC Playlist handling
249 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
250 libvlc_exception_t * );
253 * Start playing. You can give some additionnal playlist item options
254 * that will be added to the item before playing it.
255 * \param p_instance the instance
256 * \param i_id the item to play. If this is a negative number, the next
257 * item will be selected. Else, the item with the given ID will be played
258 * \param i_options the number of options to add to the item
259 * \param ppsz_options the options to add to the item
260 * \param p_exception an initialized exception
262 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
263 libvlc_exception_t * );
266 * Pause a running playlist, resume if it was stopped
267 * \param p_instance the instance to pause
268 * \param p_exception an initialized exception
270 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
273 * Checks if the playlist is running
274 * \param p_instance the instance
275 * \param p_exception an initialized exception
276 * \return 0 if the playlist is stopped or paused, 1 if it is running
278 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
281 * Get the number of items in the playlist
282 * \param p_instance the instance
283 * \param p_exception an initialized exception
284 * \return the number of items
286 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
289 * Lock the playlist instance
290 * \param p_instance the instance
292 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
295 * Unlock the playlist instance
296 * \param p_instance the instance
298 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
302 * \param p_instance the instance to stop
303 * \param p_exception an initialized exception
305 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
308 * Go to next playlist item (starts playback if it was stopped)
309 * \param p_instance the instance to use
310 * \param p_exception an initialized exception
312 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
315 * Go to previous playlist item (starts playback if it was stopped)
316 * \param p_instance the instance to use
317 * \param p_exception an initialized exception
319 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
322 * Remove all playlist items
323 * \param p_instance the instance
324 * \param p_exception an initialized exception
326 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
329 * Add an item at the end of the playlist
330 * If you need more advanced options, \see libvlc_playlist_add_extended
331 * \param p_instance the instance
332 * \param psz_uri the URI to open, using VLC format
333 * \param psz_name a name that you might want to give or NULL
334 * \return the identifier of the new item
336 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
337 libvlc_exception_t * );
340 * Add an item at the end of the playlist, with additional input options
341 * \param p_instance the instance
342 * \param psz_uri the URI to open, using VLC format
343 * \param psz_name a name that you might want to give or NULL
344 * \param i_options the number of options to add
345 * \param ppsz_options strings representing the options to add
346 * \param p_exception an initialized exception
347 * \return the identifier of the new item
349 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
350 const char *, int, const char **,
351 libvlc_exception_t * );
354 * Delete the playlist item with the given ID.
355 * \param p_instance the instance
356 * \param i_id the id to remove
357 * \param p_exception an initialized exception
360 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
361 libvlc_exception_t * );
363 /** Get the input that is currently being played by the playlist
364 * \param p_instance the instance to use
365 * \param p_exception an initialized excecption
366 * \return an input object
368 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
369 libvlc_instance_t *, libvlc_exception_t * );
373 /*****************************************************************************
375 *****************************************************************************/
376 /** defgroup libvlc_media_instance Media Instance
378 * LibVLC Media Instance
382 /** Create an empty Media Instance object
383 * \param p_libvlc_instance the libvlc instance in which the Media Instance
384 * should be (not used for now).
386 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
388 /** Create a Media Instance object from a Media Descriptor
389 * \param p_md the media descriptor. Afterwards the p_md can safely be
392 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
394 /** Release a media_instance after use
395 * \param p_mi the Media Instance to free
397 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
398 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
400 /** Set the media descriptor that will be used by the media_instance. If any,
401 * previous md will be released.
402 * \param p_mi the Media Instance
403 * \param p_md the Media Descriptor. Afterwards the p_md can safely be
406 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
408 /** Get the media descriptor used by the media_instance (if any). A copy of
409 * the md is returned. NULL is returned if no media instance is associated.
410 * \param p_mi the Media Instance
412 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
414 /** Get the Event Manager from which the media instance send event.
415 * \param p_mi the Media Instance
417 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
419 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
420 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
421 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
423 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
425 /** \bug This might go away ... to be replaced by a broader system */
426 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
427 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *);
428 VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
429 VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *);
430 VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *);
431 VLC_PUBLIC_API void libvlc_media_instance_set_chapter ( libvlc_media_instance_t *, int, libvlc_exception_t *);
432 VLC_PUBLIC_API int libvlc_media_instance_get_chapter (libvlc_media_instance_t *, libvlc_exception_t *);
433 VLC_PUBLIC_API int libvlc_media_instance_get_chapter_count( libvlc_media_instance_t *, libvlc_exception_t *);
434 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *);
435 VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *);
436 VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *);
437 VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *);
440 * Does this input have a video output ?
441 * \param p_input the input
442 * \param p_exception an initialized exception
444 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
445 VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
450 /*****************************************************************************
452 *****************************************************************************/
453 /** defgroup libvlc_tag_query Tag Query
458 VLC_PUBLIC_API libvlc_tag_query_t *
459 libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
462 libvlc_tag_query_release( libvlc_tag_query_t * );
465 libvlc_tag_query_retain( libvlc_tag_query_t * );
468 libvlc_tag_query_set_match_tag_and_key( libvlc_tag_query_t * p_q,
471 libvlc_exception_t * );
473 VLC_PUBLIC_API vlc_bool_t
474 libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
475 libvlc_exception_t * );
479 /*****************************************************************************
481 *****************************************************************************/
482 /** defgroup libvlc_media_list MediaList
487 VLC_PUBLIC_API libvlc_media_list_t *
488 libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
491 libvlc_media_list_release( libvlc_media_list_t * );
494 libvlc_media_list_retain( libvlc_media_list_t * );
497 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
498 const char * psz_uri,
499 libvlc_exception_t * p_e );
502 libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
503 libvlc_media_descriptor_t *,
504 libvlc_exception_t *);
506 VLC_PUBLIC_API libvlc_media_descriptor_t *
507 libvlc_media_list_media_descriptor( libvlc_media_list_t *,
508 libvlc_exception_t *);
511 libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
512 libvlc_media_descriptor_t *,
513 libvlc_exception_t * );
515 libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
516 libvlc_media_descriptor_t *,
518 libvlc_exception_t * );
520 libvlc_media_list_remove_index( libvlc_media_list_t *, int,
521 libvlc_exception_t * );
524 libvlc_media_list_count( libvlc_media_list_t * p_mlist,
525 libvlc_exception_t * p_e );
527 VLC_PUBLIC_API libvlc_media_descriptor_t *
528 libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
529 libvlc_exception_t * );
531 libvlc_media_list_index_of_item( libvlc_media_list_t *,
532 libvlc_media_descriptor_t *,
533 libvlc_exception_t * );
536 libvlc_media_list_lock( libvlc_media_list_t * );
538 libvlc_media_list_unlock( libvlc_media_list_t * );
540 VLC_PUBLIC_API libvlc_media_list_view_t *
541 libvlc_media_list_flat_view( libvlc_media_list_t *,
542 libvlc_exception_t * );
544 VLC_PUBLIC_API libvlc_media_list_view_t *
545 libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
546 libvlc_exception_t * );
548 VLC_PUBLIC_API libvlc_event_manager_t *
549 libvlc_media_list_event_manager( libvlc_media_list_t *,
550 libvlc_exception_t * );
554 /*****************************************************************************
556 *****************************************************************************/
557 /** defgroup libvlc_media_list_view MediaListView
559 * LibVLC Media List View
563 libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
566 libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
568 VLC_PUBLIC_API libvlc_event_manager_t *
569 libvlc_media_list_view_event_manager( libvlc_media_list_view_t * p_mlv );
572 libvlc_media_list_view_count( libvlc_media_list_view_t * p_mlv,
573 libvlc_exception_t * p_e );
575 VLC_PUBLIC_API libvlc_media_descriptor_t *
576 libvlc_media_list_view_item_at_index( libvlc_media_list_view_t * p_mlv,
578 libvlc_exception_t * p_e );
580 VLC_PUBLIC_API libvlc_media_list_view_t *
581 libvlc_media_list_view_children_at_index( libvlc_media_list_view_t * p_mlv,
583 libvlc_exception_t * p_e );
587 libvlc_media_list_view_index_of_item( libvlc_media_list_view_t * p_mlv,
588 libvlc_media_descriptor_t * p_md,
589 libvlc_exception_t * p_e );
592 libvlc_media_list_view_insert_at_index( libvlc_media_list_view_t * p_mlv,
593 libvlc_media_descriptor_t * p_md,
595 libvlc_exception_t * p_e );
598 libvlc_media_list_view_remove_at_index( libvlc_media_list_view_t * p_mlv,
600 libvlc_exception_t * p_e );
603 libvlc_media_list_view_add_item( libvlc_media_list_view_t * p_mlv,
604 libvlc_media_descriptor_t * p_md,
605 libvlc_exception_t * p_e );
609 /*****************************************************************************
610 * Dynamic Media List (Deprecated)
611 *****************************************************************************/
612 /** defgroup libvlc_media_list MediaList
617 VLC_PUBLIC_API libvlc_dynamic_media_list_t *
618 libvlc_dynamic_media_list_new( libvlc_media_list_t * p_mlist,
619 libvlc_tag_query_t * p_query,
621 libvlc_exception_t * p_e );
623 libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
626 libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
628 libvlc_media_list_t *
629 libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
630 libvlc_exception_t * p_e );
634 /*****************************************************************************
636 *****************************************************************************/
637 /** defgroup libvlc_media_library Media Library
639 * LibVLC Media Library
642 VLC_PUBLIC_API libvlc_media_library_t *
643 libvlc_media_library_new( libvlc_instance_t * p_inst,
644 libvlc_exception_t * p_e );
646 libvlc_media_library_release( libvlc_media_library_t * p_mlib );
648 libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
652 libvlc_media_library_load( libvlc_media_library_t * p_mlib,
653 libvlc_exception_t * p_e );
656 libvlc_media_library_save( libvlc_media_library_t * p_mlib,
657 libvlc_exception_t * p_e );
659 VLC_PUBLIC_API libvlc_media_list_t *
660 libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
661 libvlc_exception_t * p_e );
666 /*****************************************************************************
668 *****************************************************************************/
669 /** defgroup libvlc_media_list_player MediaListPlayer
671 * LibVLC Media List Player
674 VLC_PUBLIC_API libvlc_media_list_player_t *
675 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
676 libvlc_exception_t * p_e );
678 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
681 libvlc_media_list_player_set_media_instance(
682 libvlc_media_list_player_t * p_mlp,
683 libvlc_media_instance_t * p_mi,
684 libvlc_exception_t * p_e );
687 libvlc_media_list_player_set_media_list(
688 libvlc_media_list_player_t * p_mlp,
689 libvlc_media_list_t * p_mlist,
690 libvlc_exception_t * p_e );
693 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
694 libvlc_exception_t * p_e );
697 libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
698 libvlc_exception_t * p_e );
701 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
702 libvlc_exception_t * p_e );
704 VLC_PUBLIC_API libvlc_state_t
705 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
706 libvlc_exception_t * p_e );
709 libvlc_media_list_player_play_item_at_index(
710 libvlc_media_list_player_t * p_mlp,
712 libvlc_exception_t * p_e );
715 libvlc_media_list_player_play_item(
716 libvlc_media_list_player_t * p_mlp,
717 libvlc_media_descriptor_t * p_md,
718 libvlc_exception_t * p_e );
721 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
722 libvlc_exception_t * p_e );
724 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
725 libvlc_exception_t * p_e );
729 /** defgroup libvlc_video Video
731 * LibVLC Video handling
736 * Toggle fullscreen status on video output
737 * \param p_input the input
738 * \param p_exception an initialized exception
740 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
743 * Enable or disable fullscreen on a video output
744 * \param p_input the input
745 * \param b_fullscreen boolean for fullscreen status
746 * \param p_exception an initialized exception
748 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
751 * Get current fullscreen status
752 * \param p_input the input
753 * \param p_exception an initialized exception
754 * \return the fullscreen status (boolean)
756 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
759 * Get current video height
760 * \param p_input the input
761 * \param p_exception an initialized exception
762 * \return the video height
764 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
767 * Get current video width
768 * \param p_input the input
769 * \param p_exception an initialized exception
770 * \return the video width
772 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
775 * Get current video aspect ratio
776 * \param p_input the input
777 * \param p_exception an initialized exception
778 * \return the video aspect ratio
780 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
783 * Set new video aspect ratio
784 * \param p_input the input
785 * \param psz_aspect new video aspect-ratio
786 * \param p_exception an initialized exception
788 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
791 * Get current video subtitle
792 * \param p_input the input
793 * \param p_exception an initialized exception
794 * \return the video subtitle selected
796 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
799 * Set new video subtitle
800 * \param p_input the input
801 * \param i_spu new video subtitle to select
802 * \param p_exception an initialized exception
804 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
807 * Get current crop filter geometry
808 * \param p_input the input
809 * \param p_exception an initialized exception
810 * \return the crop filter geometry
812 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
815 * Set new crop filter geometry
816 * \param p_input the input
817 * \param psz_geometry new crop filter geometry
818 * \param p_exception an initialized exception
820 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
823 * Toggle teletext transparent status on video output
824 * \param p_input the input
825 * \param p_exception an initialized exception
827 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
830 * Get current teletext page requested.
831 * \param p_input the input
832 * \param p_exception an initialized exception
833 * \return the current teletext page requested.
835 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
838 * Set new teletext page to retrieve
839 * \param p_input the input
840 * \param i_page teletex page number requested
841 * \param p_exception an initialized exception
843 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
846 * Take a snapshot of the current video window
847 * If i_width AND i_height is 0, original size is used
848 * if i_width XOR i_height is 0, original aspect-ratio is preserved
849 * \param p_input the input
850 * \param psz_filepath the path where to save the screenshot to
851 * \param i_width the snapshot's width
852 * \param i_height the snapshot's height
853 * \param p_exception an initialized exception
855 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
857 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
860 * Resize the current video output window
861 * \param p_instance libvlc instance
862 * \param width new width for video output window
863 * \param height new height for video output window
864 * \param p_exception an initialized exception
865 * \return the success status (boolean)
867 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
870 * change the parent for the current the video output
871 * \param p_instance libvlc instance
872 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
873 * \param p_exception an initialized exception
874 * \return the success status (boolean)
876 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
879 * Tell windowless video output to redraw rectangular area (MacOS X only)
880 * \param p_instance libvlc instance
881 * \param area coordinates within video drawable
882 * \param p_exception an initialized exception
884 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
887 * Set the default video output parent
888 * this settings will be used as default for all video outputs
889 * \param p_instance libvlc instance
890 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
891 * \param p_exception an initialized exception
893 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
896 * Set the default video output parent
897 * this settings will be used as default for all video outputs
898 * \param p_instance libvlc instance
899 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
900 * \param p_exception an initialized exception
902 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
905 * Set the default video output size
906 * this settings will be used as default for all video outputs
907 * \param p_instance libvlc instance
908 * \param width new width for video drawable
909 * \param height new height for video drawable
910 * \param p_exception an initialized exception
912 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
915 * Set the default video output viewport for a windowless video output (MacOS X only)
916 * this settings will be used as default for all video outputs
917 * \param p_instance libvlc instance
918 * \param view coordinates within video drawable
919 * \param clip coordinates within video drawable
920 * \param p_exception an initialized exception
922 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
926 /** defgroup libvlc_audio Audio
928 * LibVLC Audio handling
934 * \param p_instance libvlc instance
935 * \param p_exception an initialized exception
938 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
941 * Get current mute status
942 * \param p_instance libvlc instance
943 * \param p_exception an initialized exception
944 * \return the mute status (boolean)
946 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
950 * \param p_instance libvlc instance
951 * \param status If status is VLC_TRUE then mute, otherwise unmute
952 * \param p_exception an initialized exception
955 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
958 * Get current audio level
959 * \param p_instance libvlc instance
960 * \param p_exception an initialized exception
961 * \return the audio level (int)
963 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
966 * Set current audio level
967 * \param p_instance libvlc instance
968 * \param i_volume the volume (int)
969 * \param p_exception an initialized exception
971 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
974 * Get number of available audio tracks
975 * \param p_mi media instance
976 * \param p_e an initialized exception
977 * \return the number of available audio tracks (int)
979 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_instance_t *, libvlc_exception_t * );
982 + * Get current audio track
983 + * \param p_input input instance
984 + * \param p_exception an initialized exception
985 + * \return the audio track (int)
987 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
990 * Set current audio track
991 * \param p_input input instance
992 * \param i_track the track (int)
993 * \param p_exception an initialized exception
995 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
998 * Get current audio channel
999 * \param p_instance input instance
1000 * \param p_exception an initialized exception
1001 * \return the audio channel (int)
1003 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1006 * Set current audio channel
1007 * \param p_instance input instance
1008 * \param i_channel the audio channel (int)
1009 * \param p_exception an initialized exception
1011 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
1015 /*****************************************************************************
1016 * Services/Media Discovery
1017 *****************************************************************************/
1018 /** defgroup libvlc_media_discoverer Media Discoverer
1020 * LibVLC Media Discoverer
1024 VLC_PUBLIC_API libvlc_media_discoverer_t *
1025 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1026 const char * psz_name,
1027 libvlc_exception_t * p_e );
1028 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1029 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1031 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1035 /*****************************************************************************
1037 *****************************************************************************/
1038 /** defgroup libvlc_vlm VLM
1045 * Add a broadcast, with one input
1046 * \param p_instance the instance
1047 * \param psz_name the name of the new broadcast
1048 * \param psz_input the input MRL
1049 * \param psz_output the output MRL (the parameter to the "sout" variable)
1050 * \param i_options number of additional options
1051 * \param ppsz_options additional options
1052 * \param b_enabled boolean for enabling the new broadcast
1053 * \param b_loop Should this broadcast be played in loop ?
1054 * \param p_exception an initialized exception
1056 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
1057 int, char **, int, int, libvlc_exception_t * );
1060 * Delete a media (vod or broadcast)
1061 * \param p_instance the instance
1062 * \param psz_name the media to delete
1063 * \param p_exception an initialized exception
1065 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1068 * Enable or disable a media (vod or broadcast)
1069 * \param p_instance the instance
1070 * \param psz_name the media to work on
1071 * \param b_enabled the new status
1072 * \param p_exception an initialized exception
1074 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
1075 libvlc_exception_t *);
1078 * Set the output for a media
1079 * \param p_instance the instance
1080 * \param psz_name the media to work on
1081 * \param psz_output the output MRL (the parameter to the "sout" variable)
1082 * \param p_exception an initialized exception
1084 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
1085 libvlc_exception_t *);
1088 * Set a media's input MRL. This will delete all existing inputs and
1089 * add the specified one.
1090 * \param p_instance the instance
1091 * \param psz_name the media to work on
1092 * \param psz_input the input MRL
1093 * \param p_exception an initialized exception
1095 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
1096 libvlc_exception_t *);
1099 * Add a media's input MRL. This will add the specified one.
1100 * \param p_instance the instance
1101 * \param psz_name the media to work on
1102 * \param psz_input the input MRL
1103 * \param p_exception an initialized exception
1105 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1106 libvlc_exception_t *p_exception );
1108 * Set output for a media
1109 * \param p_instance the instance
1110 * \param psz_name the media to work on
1111 * \param b_loop the new status
1112 * \param p_exception an initialized exception
1114 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1115 libvlc_exception_t *);
1118 * Edit the parameters of a media. This will delete all existing inputs and
1119 * add the specified one.
1120 * \param p_instance the instance
1121 * \param psz_name the name of the new broadcast
1122 * \param psz_input the input MRL
1123 * \param psz_output the output MRL (the parameter to the "sout" variable)
1124 * \param i_options number of additional options
1125 * \param ppsz_options additional options
1126 * \param b_enabled boolean for enabling the new broadcast
1127 * \param b_loop Should this broadcast be played in loop ?
1128 * \param p_exception an initialized exception
1130 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1131 int, char **, int, int, libvlc_exception_t * );
1134 * Plays the named broadcast.
1135 * \param p_instance the instance
1136 * \param psz_name the name of the broadcast
1137 * \param p_exception an initialized exception
1139 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1142 * Stops the named broadcast.
1143 * \param p_instance the instance
1144 * \param psz_name the name of the broadcast
1145 * \param p_exception an initialized exception
1147 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1150 * Pauses the named broadcast.
1151 * \param p_instance the instance
1152 * \param psz_name the name of the broadcast
1153 * \param p_exception an initialized exception
1155 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1158 * Seeks in the named broadcast.
1159 * \param p_instance the instance
1160 * \param psz_name the name of the broadcast
1161 * \param f_percentage the percentage to seek to
1162 * \param p_exception an initialized exception
1164 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1165 float, libvlc_exception_t * );
1168 * Return information of the named broadcast.
1169 * \param p_instance the instance
1170 * \param psz_name the name of the broadcast
1171 * \param p_exception an initialized exception
1173 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1175 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1176 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1177 char *, int , libvlc_exception_t * );
1179 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1180 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1181 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1182 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1183 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1184 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1185 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1187 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1191 /*****************************************************************************
1192 * Message log handling
1193 *****************************************************************************/
1195 /** defgroup libvlc_log Log
1197 * LibVLC Message Logging
1202 * Returns the VLC messaging verbosity level
1203 * \param p_instance libvlc instance
1204 * \param exception an initialized exception pointer
1206 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1207 libvlc_exception_t *p_e );
1210 * Set the VLC messaging verbosity level
1211 * \param p_log libvlc log instance
1212 * \param exception an initialized exception pointer
1214 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1215 libvlc_exception_t *p_e );
1218 * Open an instance to VLC message log
1219 * \param p_instance libvlc instance
1220 * \param exception an initialized exception pointer
1222 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1225 * Close an instance of VLC message log
1226 * \param p_log libvlc log instance
1227 * \param exception an initialized exception pointer
1229 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1232 * Returns the number of messages in log
1233 * \param p_log libvlc log instance
1234 * \param exception an initialized exception pointer
1236 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1239 * Clear all messages in log
1240 * the log should be cleared on a regular basis to avoid clogging
1241 * \param p_log libvlc log instance
1242 * \param exception an initialized exception pointer
1244 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1247 * Allocate and returns a new iterator to messages in log
1248 * \param p_log libvlc log instance
1249 * \param exception an initialized exception pointer
1251 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1254 * Releases a previoulsy allocated iterator
1255 * \param p_log libvlc log iterator
1256 * \param exception an initialized exception pointer
1258 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1261 * Returns whether log iterator has more messages
1262 * \param p_log libvlc log iterator
1263 * \param exception an initialized exception pointer
1265 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1268 * Returns next log message
1269 * the content of message must not be freed
1270 * \param p_log libvlc log iterator
1271 * \param exception an initialized exception pointer
1273 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1274 struct libvlc_log_message_t *buffer,
1275 libvlc_exception_t *p_e );
1279 /*****************************************************************************
1281 *****************************************************************************/
1283 /** defgroup libvlc_callbacks Callbacks
1290 * Register for an event notification
1291 * \param p_event_manager the event manager to which you want to attach to
1292 * Generally it is obtained by vlc_my_object_event_manager() where my_object
1293 * Is the object you want to listen to.
1294 * \param i_event_type the desired event to which we want to listen
1295 * \param f_callback the function to call when i_event_type occurs
1296 * \param user_data user provided data to carry with the event
1297 * \param p_e an initialized exception pointer
1299 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1300 libvlc_event_type_t i_event_type,
1301 libvlc_callback_t f_callback,
1303 libvlc_exception_t *p_e );
1306 * Unregister an event notification
1307 * \param p_event_manager the event manager
1308 * \param i_event_type the desired event to which we want to unregister
1309 * \param f_callback the function to call when i_event_type occurs
1310 * \param p_e an initialized exception pointer
1312 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1313 libvlc_event_type_t i_event_type,
1314 libvlc_callback_t f_callback,
1316 libvlc_exception_t *p_e );
1319 * Get an event type name
1320 * \param i_event_type the desired event
1322 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1331 #endif /* <vlc/libvlc.h> */