1 /*****************************************************************************
2 * libvlc.h: libvlc external API
3 *****************************************************************************
4 * Copyright (C) 1998-2005 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman@videolan.org>
9 * Pierre d'Herbemont <pdherbemont@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
28 * This file defines libvlc external API
32 * \defgroup libvlc libvlc
33 * This is libvlc, the base library of the VLC program.
39 #define VLC_LIBVLC_H 1
41 #if defined (WIN32) && defined (DLL_EXPORT)
42 # define VLC_PUBLIC_API __declspec(dllexport)
44 # define VLC_PUBLIC_API
48 /* Avoid unuseful warnings from libvlc with our deprecated APIs */
49 # define VLC_DEPRECATED_API VLC_PUBLIC_API
50 #elif defined(__GNUC__) && \
51 (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
52 # define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
54 # define VLC_DEPRECATED_API VLC_PUBLIC_API
61 /*****************************************************************************
63 *****************************************************************************/
64 /** \defgroup libvlc_exception libvlc_exception
65 * \ingroup libvlc_core
66 * LibVLC Exceptions handling
71 * Initialize an exception structure. This can be called several times to
72 * reuse an exception structure.
74 * \param p_exception the exception to initialize
76 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
79 * Has an exception been raised?
81 * \param p_exception the exception to query
82 * \return 0 if the exception was raised, 1 otherwise
85 libvlc_exception_raised( const libvlc_exception_t *p_exception );
88 * Raise an exception using a user-provided message.
90 * \param p_exception the exception to raise
91 * \param psz_format the exception message format string
92 * \param ... the format string arguments
95 libvlc_exception_raise( libvlc_exception_t *p_exception,
96 const char *psz_format, ... );
99 * Clear an exception object so it can be reused.
100 * The exception object must have be initialized.
102 * \param p_exception the exception to clear
104 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
107 * Get an exception's message.
109 * \param p_exception the exception to query
110 * \return the exception message or NULL if not applicable (exception not
111 * raised, for example)
113 VLC_PUBLIC_API const char *
114 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
118 /*****************************************************************************
120 *****************************************************************************/
122 /** \defgroup libvlc_core libvlc_core
129 * Create and initialize a libvlc instance.
131 * \param argc the number of arguments
132 * \param argv command-line-type arguments. argv[0] must be the path of the
134 * \param p_e an initialized exception pointer
135 * \return the libvlc instance
137 VLC_PUBLIC_API libvlc_instance_t *
138 libvlc_new( int , const char *const *, libvlc_exception_t *);
141 * Return a libvlc instance identifier for legacy APIs. Use of this
142 * function is discouraged, you should convert your program to use the
145 * \param p_instance the instance
146 * \return the instance identifier
148 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
151 * Decrement the reference count of a libvlc instance, and destroy it
152 * if it reaches zero.
154 * \param p_instance the instance to destroy
156 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
159 * Increments the reference count of a libvlc instance.
160 * The initial reference count is 1 after libvlc_new() returns.
162 * \param p_instance the instance to reference
164 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
167 * Try to start a user interface for the libvlc instance.
169 * \param p_instance the instance
170 * \param name interface name, or NULL for default
171 * \param p_exception an initialized exception pointer
174 void libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
175 libvlc_exception_t *p_exception );
178 * Waits until an interface causes the instance to exit.
179 * You should start at least one interface first, using libvlc_add_intf().
181 * \param p_instance the instance
184 void libvlc_wait( libvlc_instance_t *p_instance );
187 * Retrieve libvlc version.
189 * Example: "0.9.0-git Grishenko"
191 * \return a string containing the libvlc version
193 VLC_PUBLIC_API const char * libvlc_get_version(void);
196 * Retrieve libvlc compiler version.
198 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
200 * \return a string containing the libvlc compiler version
202 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
205 * Retrieve libvlc changeset.
207 * Example: "aa9bce0bc4"
209 * \return a string containing the libvlc changeset
211 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
216 * Return the libvlc internal object, the main object that all other depend on.
217 * Any of of this function should be considered an ugly hack and avoided at all
218 * cost. E.g. you need to expose some functionality that is not provided by the
219 * libvlc API directly with libvlccore.
220 * Remember to release the object with vlc_object_release( obj* )
222 * \param p_instance the libvlc instance
224 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *);
227 * Frees an heap allocation (char *) returned by a LibVLC API.
228 * If you know you're using the same underlying C run-time as the LibVLC
229 * implementation, then you can call ANSI C free() directly instead.
231 VLC_PUBLIC_API void libvlc_free( void *ptr );
235 /*****************************************************************************
237 *****************************************************************************/
238 /** \defgroup libvlc_media libvlc_media
245 * Create a media with the given MRL.
247 * \param p_instance the instance
248 * \param psz_mrl the MRL to read
249 * \param p_e an initialized exception pointer
250 * \return the newly created media
252 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
253 libvlc_instance_t *p_instance,
254 const char * psz_mrl,
255 libvlc_exception_t *p_e );
258 * Create a media as an empty node with the passed name.
260 * \param p_instance the instance
261 * \param psz_name the name of the node
262 * \param p_e an initialized exception pointer
263 * \return the new empty media
265 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
266 libvlc_instance_t *p_instance,
267 const char * psz_name,
268 libvlc_exception_t *p_e );
271 * Add an option to the media.
273 * This option will be used to determine how the media_player will
274 * read the media. This allows to use VLC's advanced
275 * reading/streaming options on a per-media basis.
277 * The options are detailed in vlc --long-help, for instance "--sout-all"
279 * \param p_instance the instance
280 * \param ppsz_options the options (as a string)
281 * \param p_e an initialized exception pointer
283 VLC_PUBLIC_API void libvlc_media_add_option(
284 libvlc_media_t * p_md,
285 const char * ppsz_options,
286 libvlc_exception_t * p_e );
288 * Add an option to the media from an untrusted source.
290 * This option will be used to determine how the media_player will
291 * read the media. This allows to use VLC's advanced
292 * reading/streaming options on a per-media basis.
294 * The options are detailed in vlc --long-help, for instance "--sout-all"
296 * \param p_instance the instance
297 * \param ppsz_options the options (as a string)
298 * \param p_e an initialized exception pointer
300 VLC_PUBLIC_API void libvlc_media_add_option_untrusted(
301 libvlc_media_t * p_md,
302 const char * ppsz_options,
303 libvlc_exception_t * p_e );
307 * Retain a reference to a media descriptor object (libvlc_media_t). Use
308 * libvlc_media_release() to decrement the reference count of a
309 * media descriptor object.
311 * \param p_meta_desc a media descriptor object.
313 VLC_PUBLIC_API void libvlc_media_retain(
314 libvlc_media_t *p_meta_desc );
317 * Decrement the reference count of a media descriptor object. If the
318 * reference count is 0, then libvlc_media_release() will release the
319 * media descriptor object. It will send out an libvlc_MediaFreed event
320 * to all listeners. If the media descriptor object has been released it
321 * should not be used again.
323 * \param p_meta_desc a media descriptor object.
325 VLC_PUBLIC_API void libvlc_media_release(
326 libvlc_media_t *p_meta_desc );
330 * Get the media resource locator (mrl) from a media descriptor object
332 * \param p_md a media descriptor object
333 * \param p_e an initialized exception object
334 * \return string with mrl of media descriptor object
336 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md,
337 libvlc_exception_t * p_e );
340 * Duplicate a media descriptor object.
342 * \param p_meta_desc a media descriptor object.
344 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * );
347 * Read the meta of the media.
349 * \param p_meta_desc the media to read
350 * \param e_meta_desc the meta to read
351 * \param p_e an initialized exception pointer
352 * \return the media's meta
354 VLC_PUBLIC_API char * libvlc_media_get_meta(
355 libvlc_media_t *p_meta_desc,
356 libvlc_meta_t e_meta,
357 libvlc_exception_t *p_e );
359 * Get current state of media descriptor object. Possible media states
360 * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
361 * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
362 * libvlc_Stopped, libvlc_Ended,
365 * @see libvlc_state_t
366 * \param p_meta_desc a media descriptor object
367 * \param p_e an initialized exception object
368 * \return state of media descriptor object
370 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
371 libvlc_media_t *p_meta_desc,
372 libvlc_exception_t *p_e );
375 * Get subitems of media descriptor object. This will increment
376 * the reference count of supplied media descriptor object. Use
377 * libvlc_media_list_release() to decrement the reference counting.
379 * \param p_md media descriptor object
380 * \param p_e initalized exception object
381 * \return list of media descriptor subitems or NULL
383 VLC_PUBLIC_API libvlc_media_list_t *
384 libvlc_media_subitems( libvlc_media_t *p_md,
385 libvlc_exception_t *p_e );
387 * Get event manager from media descriptor object.
388 * NOTE: this function doesn't increment reference counting.
390 * \param p_md a media descriptor object
391 * \param p_e an initialized exception object
392 * \return event manager object
394 VLC_PUBLIC_API libvlc_event_manager_t *
395 libvlc_media_event_manager( libvlc_media_t * p_md,
396 libvlc_exception_t * p_e );
399 * Get duration of media descriptor object item.
401 * \param p_md media descriptor object
402 * \param p_e an initialized exception object
403 * \return duration of media item
405 VLC_PUBLIC_API libvlc_time_t
406 libvlc_media_get_duration( libvlc_media_t * p_md,
407 libvlc_exception_t * p_e );
410 * Get preparsed status for media descriptor object.
412 * \param p_md media descriptor object
413 * \param p_e an initialized exception object
414 * \return true if media object has been preparsed otherwise it returns false
417 libvlc_media_is_preparsed( libvlc_media_t * p_md,
418 libvlc_exception_t * p_e );
421 * Sets media descriptor's user_data. user_data is specialized data
422 * accessed by the host application, VLC.framework uses it as a pointer to
423 * an native object that references a libvlc_media_t pointer
425 * \param p_md media descriptor object
426 * \param p_new_user_data pointer to user data
427 * \param p_e an initialized exception object
430 libvlc_media_set_user_data( libvlc_media_t * p_md,
431 void * p_new_user_data,
432 libvlc_exception_t * p_e);
435 * Get media descriptor's user_data. user_data is specialized data
436 * accessed by the host application, VLC.framework uses it as a pointer to
437 * an native object that references a libvlc_media_t pointer
439 * \param p_md media descriptor object
440 * \param p_e an initialized exception object
442 VLC_PUBLIC_API void *
443 libvlc_media_get_user_data( libvlc_media_t * p_md,
444 libvlc_exception_t * p_e);
448 /*****************************************************************************
450 *****************************************************************************/
451 /** \defgroup libvlc_media_player libvlc_media_player
453 * LibVLC Media Player, object that let you play a media
454 * in a custom drawable
459 * Create an empty Media Player object
461 * \param p_libvlc_instance the libvlc instance in which the Media Player
463 * \param p_e an initialized exception pointer
465 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
468 * Create a Media Player object from a Media
470 * \param p_md the media. Afterwards the p_md can be safely
472 * \param p_e an initialized exception pointer
474 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
477 * Release a media_player after use
478 * Decrement the reference count of a media player object. If the
479 * reference count is 0, then libvlc_media_player_release() will
480 * release the media player object. If the media player object
481 * has been released, then it should not be used again.
483 * \param p_mi the Media Player to free
485 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
488 * Retain a reference to a media player object. Use
489 * libvlc_media_player_release() to decrement reference count.
491 * \param p_mi media player object
493 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
496 * Set the media that will be used by the media_player. If any,
497 * previous md will be released.
499 * \param p_mi the Media Player
500 * \param p_md the Media. Afterwards the p_md can be safely
502 * \param p_e an initialized exception pointer
504 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
507 * Get the media used by the media_player.
509 * \param p_mi the Media Player
510 * \param p_e an initialized exception pointer
511 * \return the media associated with p_mi, or NULL if no
512 * media is associated
514 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
517 * Get the Event Manager from which the media player send event.
519 * \param p_mi the Media Player
520 * \param p_e an initialized exception pointer
521 * \return the event manager associated with p_mi
523 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
528 * \param p_mi the Media Player
529 * \param p_e an initialized exception pointer
530 * \return 1 if the media player is playing, 0 otherwise
532 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * );
537 * \param p_mi the Media Player
538 * \param p_e an initialized exception pointer
540 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
545 * \param p_mi the Media Player
546 * \param p_e an initialized exception pointer
548 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
553 * \param p_mi the Media Player
554 * \param p_e an initialized exception pointer
556 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
559 * Set an X Window System drawable where the media player should render its
560 * video output. If LibVLC was built without X11 output support, then this has
563 * The specified identifier must correspond to an existing Input/Output class
564 * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
565 * the X11 server is the same as the one the VLC instance has been configured
567 * If XVideo is <b>not</b> used, it is assumed that the drawable has the
568 * following properties in common with the default X11 screen: depth, scan line
569 * pad, black pixel. This is a bug.
571 * \param p_mi the Media Player
572 * \param drawable the ID of the X window
573 * \param p_e an initialized exception pointer
575 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
578 * Get the X Window System window identifier previously set with
579 * libvlc_media_player_set_xwindow(). Note that this will return the identifier
580 * even if VLC is not currently using it (for instance if it is playing an
583 * \return an X window ID, or 0 if none where set.
585 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
588 * Set a Win32/Win64 API window handle (HWND) where the media player should
589 * render its video output. If LibVLC was built without Win32/Win64 API output
590 * support, then this has no effects.
592 * \param p_mi the Media Player
593 * \param drawable windows handle of the drawable
594 * \param p_e an initialized exception pointer
596 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
599 * Get the Windows API window handle (HWND) previously set with
600 * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
601 * is not currently outputting any video to it.
603 * \return a window handle or NULL if there are none.
605 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
609 /** \bug This might go away ... to be replaced by a broader system */
612 * Get the current movie length (in ms).
614 * \param p_mi the Media Player
615 * \param p_e an initialized exception pointer
616 * \return the movie length (in ms).
618 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
621 * Get the current movie time (in ms).
623 * \param p_mi the Media Player
624 * \param p_e an initialized exception pointer
625 * \return the movie time (in ms).
627 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
630 * Set the movie time (in ms).
632 * \param p_mi the Media Player
633 * \param the movie time (in ms).
634 * \param p_e an initialized exception pointer
636 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
639 * Get movie position.
641 * \param p_mi the Media Player
642 * \param p_e an initialized exception pointer
643 * \return movie position
645 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
648 * Set movie position.
650 * \param p_mi the Media Player
651 * \param p_e an initialized exception pointer
652 * \return movie position
654 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
659 * \param p_mi the Media Player
660 * \param i_chapter chapter number to play
661 * \param p_e an initialized exception pointer
663 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
668 * \param p_mi the Media Player
669 * \param p_e an initialized exception pointer
670 * \return chapter number currently playing
672 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
675 * Get movie chapter count
677 * \param p_mi the Media Player
678 * \param p_e an initialized exception pointer
679 * \return number of chapters in movie
681 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
682 VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
685 * Get title chapter count
687 * \param p_mi the Media Player
688 * \param i_title title
689 * \param p_e an initialized exception pointer
690 * \return number of chapters in title
692 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
693 libvlc_media_player_t *, int, libvlc_exception_t *);
698 * \param p_mi the Media Player
699 * \param i_title title number to play
700 * \param p_e an initialized exception pointer
702 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
707 * \param p_mi the Media Player
708 * \param p_e an initialized exception pointer
709 * \return title number currently playing
711 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
714 * Get movie title count
716 * \param p_mi the Media Player
717 * \param p_e an initialized exception pointer
718 * \return title number count
720 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
723 * Set previous chapter
725 * \param p_mi the Media Player
726 * \param p_e an initialized exception pointer
728 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
733 * \param p_mi the Media Player
734 * \param p_e an initialized exception pointer
736 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
739 * Get movie play rate
741 * \param p_mi the Media Player
742 * \param p_e an initialized exception pointer
743 * \return movie play rate
745 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
748 * Set movie play rate
750 * \param p_mi the Media Player
751 * \param movie play rate to set
752 * \param p_e an initialized exception pointer
754 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
757 * Get current movie state
759 * \param p_mi the Media Player
760 * \param p_e an initialized exception pointer
761 * \return current movie state as libvlc_state_t
763 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
768 * \param p_mi the Media Player
769 * \param p_e an initialized exception pointer
770 * \return frames per second (fps) for this playing movie
772 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
777 * Does this media player have a video output?
779 * \param p_md the media player
780 * \param p_e an initialized exception pointer
782 VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
785 * Is this media player seekable?
787 * \param p_input the input
788 * \param p_e an initialized exception pointer
790 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
793 * Can this media player be paused?
795 * \param p_input the input
796 * \param p_e an initialized exception pointer
798 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
801 * Release (free) libvlc_track_description_t
803 * \param p_track_description the structure to release
805 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
807 /** \defgroup libvlc_video libvlc_video
808 * \ingroup libvlc_media_player
809 * LibVLC Video handling
814 * Toggle fullscreen status on video output.
816 * \param p_mediaplayer the media player
817 * \param p_e an initialized exception pointer
819 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
822 * Enable or disable fullscreen on a video output.
824 * \param p_mediaplayer the media player
825 * \param b_fullscreen boolean for fullscreen status
826 * \param p_e an initialized exception pointer
828 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
831 * Get current fullscreen status.
833 * \param p_mediaplayer the media player
834 * \param p_e an initialized exception pointer
835 * \return the fullscreen status (boolean)
837 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
840 * Get current video height.
842 * \param p_mediaplayer the media player
843 * \param p_e an initialized exception pointer
844 * \return the video height
846 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
849 * Get current video width.
851 * \param p_mediaplayer the media player
852 * \param p_e an initialized exception pointer
853 * \return the video width
855 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
858 * Get current video aspect ratio.
860 * \param p_mediaplayer the media player
861 * \param p_e an initialized exception pointer
862 * \return the video aspect ratio
864 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
867 * Set new video aspect ratio.
869 * \param p_mediaplayer the media player
870 * \param psz_aspect new video aspect-ratio
871 * \param p_e an initialized exception pointer
873 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
876 * Get current video subtitle.
878 * \param p_mediaplayer the media player
879 * \param p_e an initialized exception pointer
880 * \return the video subtitle selected
882 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
885 * Get the number of available video subtitles.
887 * \param p_mediaplayer the media player
888 * \param p_e an initialized exception pointer
889 * \return the number of available video subtitles
891 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
894 * Get the description of available video subtitles.
896 * \param p_mediaplayer the media player
897 * \param p_e an initialized exception pointer
898 * \return list containing description of available video subtitles
900 VLC_PUBLIC_API libvlc_track_description_t *
901 libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
904 * Set new video subtitle.
906 * \param p_mediaplayer the media player
907 * \param i_spu new video subtitle to select
908 * \param p_e an initialized exception pointer
910 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
913 * Set new video subtitle file.
915 * \param p_mediaplayer the media player
916 * \param psz_subtitle new video subtitle file
917 * \param p_e an initialized exception pointer
918 * \return the success status (boolean)
920 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
923 * Get the description of available titles.
925 * \param p_mediaplayer the media player
926 * \param p_e an initialized exception pointer
927 * \return list containing description of available titles
929 VLC_PUBLIC_API libvlc_track_description_t *
930 libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
933 * Get the description of available chapters for specific title.
935 * \param p_mediaplayer the media player
936 * \param i_title selected title
937 * \param p_e an initialized exception pointer
938 * \return list containing description of available chapter for title i_title
940 VLC_PUBLIC_API libvlc_track_description_t *
941 libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
944 * Get current crop filter geometry.
946 * \param p_mediaplayer the media player
947 * \param p_e an initialized exception pointer
948 * \return the crop filter geometry
950 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
953 * Set new crop filter geometry.
955 * \param p_mediaplayer the media player
956 * \param psz_geometry new crop filter geometry
957 * \param p_e an initialized exception pointer
959 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
962 * Toggle teletext transparent status on video output.
964 * \param p_mediaplayer the media player
965 * \param p_e an initialized exception pointer
967 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
970 * Get current teletext page requested.
972 * \param p_mediaplayer the media player
973 * \param p_e an initialized exception pointer
974 * \return the current teletext page requested.
976 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
979 * Set new teletext page to retrieve.
981 * \param p_mediaplayer the media player
982 * \param i_page teletex page number requested
983 * \param p_e an initialized exception pointer
985 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
988 * Get number of available video tracks.
990 * \param p_mi media player
991 * \param p_e an initialized exception
992 * \return the number of available video tracks (int)
994 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
997 * Get the description of available video tracks.
999 * \param p_mi media player
1000 * \param p_e an initialized exception
1001 * \return list with description of available video tracks
1003 VLC_PUBLIC_API libvlc_track_description_t *
1004 libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
1007 * Get current video track.
1009 * \param p_mi media player
1010 * \param p_e an initialized exception pointer
1011 * \return the video track (int)
1013 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1018 * \param p_mi media player
1019 * \param i_track the track (int)
1020 * \param p_e an initialized exception pointer
1022 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1025 * Take a snapshot of the current video window.
1027 * If i_width AND i_height is 0, original size is used.
1028 * If i_width XOR i_height is 0, original aspect-ratio is preserved.
1030 * \param p_mediaplayer the media player
1031 * \param psz_filepath the path where to save the screenshot to
1032 * \param i_width the snapshot's width
1033 * \param i_height the snapshot's height
1034 * \param p_e an initialized exception pointer
1036 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
1039 * Resize the current video output window.
1041 * \param p_instance libvlc instance
1042 * \param width new width for video output window
1043 * \param height new height for video output window
1044 * \param p_e an initialized exception pointer
1045 * \return the success status (boolean)
1047 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
1050 * Tell windowless video output to redraw rectangular area (MacOS X only).
1052 * \param p_instance libvlc instance
1053 * \param area coordinates within video drawable
1054 * \param p_e an initialized exception pointer
1056 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1059 * Set the default video output size.
1061 * This setting will be used as default for all video outputs.
1063 * \param p_instance libvlc instance
1064 * \param width new width for video drawable
1065 * \param height new height for video drawable
1066 * \param p_e an initialized exception pointer
1068 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
1071 * Set the default video output viewport for a windowless video output
1074 * This setting will be used as default for all video outputs.
1076 * \param p_instance libvlc instance
1077 * \param view coordinates within video drawable
1078 * \param clip coordinates within video drawable
1079 * \param p_e an initialized exception pointer
1081 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1085 /** \defgroup libvlc_audio libvlc_audio
1086 * \ingroup libvlc_media_player
1087 * LibVLC Audio handling
1092 * Audio device types
1094 typedef enum libvlc_audio_output_device_types_t {
1095 libvlc_AudioOutputDevice_Error = -1,
1096 libvlc_AudioOutputDevice_Mono = 1,
1097 libvlc_AudioOutputDevice_Stereo = 2,
1098 libvlc_AudioOutputDevice_2F2R = 4,
1099 libvlc_AudioOutputDevice_3F2R = 5,
1100 libvlc_AudioOutputDevice_5_1 = 6,
1101 libvlc_AudioOutputDevice_6_1 = 7,
1102 libvlc_AudioOutputDevice_7_1 = 8,
1103 libvlc_AudioOutputDevice_SPDIF = 10
1104 } libvlc_audio_output_device_types_t;
1109 typedef enum libvlc_audio_output_channel_t {
1110 libvlc_AudioChannel_Error = -1,
1111 libvlc_AudioChannel_Stereo = 1,
1112 libvlc_AudioChannel_RStereo = 2,
1113 libvlc_AudioChannel_Left = 3,
1114 libvlc_AudioChannel_Right = 4,
1115 libvlc_AudioChannel_Dolbys = 5
1116 } libvlc_audio_output_channel_t;
1120 * Get the list of available audio outputs
1122 * \param p_instance libvlc instance
1123 * \param p_e an initialized exception pointer
1124 * \return list of available audio outputs, at the end free it with
1125 * \see libvlc_audio_output_list_release \see libvlc_audio_output_t
1127 VLC_PUBLIC_API libvlc_audio_output_t *
1128 libvlc_audio_output_list_get( libvlc_instance_t *,
1129 libvlc_exception_t * );
1132 * Free the list of available audio outputs
1134 * \param p_list list with audio outputs for release
1136 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
1139 * Set the audio output.
1140 * Change will be applied after stop and play.
1142 * \param p_instance libvlc instance
1143 * \param psz_name name of audio output,
1144 * use psz_name of \see libvlc_audio_output_t
1145 * \return true if function succeded
1147 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
1151 * Get count of devices for audio output, these devices are hardware oriented
1152 * like analor or digital output of sound card
1154 * \param p_instance libvlc instance
1155 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1156 * \return number of devices
1158 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
1162 * Get long name of device, if not available short name given
1164 * \param p_instance libvlc instance
1165 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1166 * \param i_device device index
1167 * \return long name of device
1169 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
1174 * Get id name of device
1176 * \param p_instance libvlc instance
1177 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1178 * \param i_device device index
1179 * \return id name of device, use for setting device, need to be free after use
1181 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
1186 * Set device for using
1188 * \param p_instance libvlc instance
1189 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1190 * \param psz_device_id device
1192 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
1197 * Get current audio device type. Device type describes something like
1198 * character of output sound - stereo sound, 2.1, 5.1 etc
1200 * \param p_instance vlc instance
1201 * \param p_e an initialized exception pointer
1202 * \return the audio devices type \see libvlc_audio_output_device_types_t
1204 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1205 libvlc_instance_t *, libvlc_exception_t * );
1208 * Set current audio device type.
1210 * \param p_instance vlc instance
1211 * \param device_type the audio device type,
1212 according to \see libvlc_audio_output_device_types_t
1213 * \param p_e an initialized exception pointer
1215 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1217 libvlc_exception_t * );
1221 * Toggle mute status.
1223 * \param p_instance libvlc instance
1224 * \param p_e an initialized exception pointer
1226 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1229 * Get current mute status.
1231 * \param p_instance libvlc instance
1232 * \param p_e an initialized exception pointer
1233 * \return the mute status (boolean)
1235 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1240 * \param p_instance libvlc instance
1241 * \param status If status is true then mute, otherwise unmute
1242 * \param p_e an initialized exception pointer
1244 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1247 * Get current audio level.
1249 * \param p_instance libvlc instance
1250 * \param p_e an initialized exception pointer
1251 * \return the audio level (int)
1253 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1256 * Set current audio level.
1258 * \param p_instance libvlc instance
1259 * \param i_volume the volume (int)
1260 * \param p_e an initialized exception pointer
1262 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1265 * Get number of available audio tracks.
1267 * \param p_mi media player
1268 * \param p_e an initialized exception
1269 * \return the number of available audio tracks (int)
1271 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
1274 * Get the description of available audio tracks.
1276 * \param p_mi media player
1277 * \param p_e an initialized exception
1278 * \return list with description of available audio tracks
1280 VLC_PUBLIC_API libvlc_track_description_t *
1281 libvlc_audio_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
1284 * Get current audio track.
1286 * \param p_mi media player
1287 * \param p_e an initialized exception pointer
1288 * \return the audio track (int)
1290 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1293 * Set current audio track.
1295 * \param p_mi media player
1296 * \param i_track the track (int)
1297 * \param p_e an initialized exception pointer
1299 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1302 * Get current audio channel.
1304 * \param p_instance vlc instance
1305 * \param p_e an initialized exception pointer
1306 * \return the audio channel \see libvlc_audio_output_channel_t
1309 libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1312 * Set current audio channel.
1314 * \param p_instance vlc instance
1315 * \param channel the audio channel, \see libvlc_audio_output_channel_t
1316 * \param p_e an initialized exception pointer
1318 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1320 libvlc_exception_t * );
1324 /** @} media_player */
1326 /*****************************************************************************
1328 *****************************************************************************/
1330 /** \defgroup libvlc_event libvlc_event
1331 * \ingroup libvlc_core
1337 * Register for an event notification.
1339 * \param p_event_manager the event manager to which you want to attach to.
1340 * Generally it is obtained by vlc_my_object_event_manager() where
1341 * my_object is the object you want to listen to.
1342 * \param i_event_type the desired event to which we want to listen
1343 * \param f_callback the function to call when i_event_type occurs
1344 * \param user_data user provided data to carry with the event
1345 * \param p_e an initialized exception pointer
1347 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1348 libvlc_event_type_t i_event_type,
1349 libvlc_callback_t f_callback,
1351 libvlc_exception_t *p_e );
1354 * Unregister an event notification.
1356 * \param p_event_manager the event manager
1357 * \param i_event_type the desired event to which we want to unregister
1358 * \param f_callback the function to call when i_event_type occurs
1359 * \param p_user_data user provided data to carry with the event
1360 * \param p_e an initialized exception pointer
1362 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1363 libvlc_event_type_t i_event_type,
1364 libvlc_callback_t f_callback,
1366 libvlc_exception_t *p_e );
1369 * Get an event's type name.
1371 * \param i_event_type the desired event
1373 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1377 /*****************************************************************************
1379 *****************************************************************************/
1380 /** \defgroup libvlc_media_library libvlc_media_library
1382 * LibVLC Media Library
1385 VLC_PUBLIC_API libvlc_media_library_t *
1386 libvlc_media_library_new( libvlc_instance_t * p_inst,
1387 libvlc_exception_t * p_e );
1390 * Release media library object. This functions decrements the
1391 * reference count of the media library object. If it reaches 0,
1392 * then the object will be released.
1394 * \param p_mlib media library object
1397 libvlc_media_library_release( libvlc_media_library_t * p_mlib );
1400 * Retain a reference to a media library object. This function will
1401 * increment the reference counting for this object. Use
1402 * libvlc_media_library_release() to decrement the reference count.
1404 * \param p_mlib media library object
1407 libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
1410 * Load media library.
1412 * \param p_mlib media library object
1413 * \param p_e an initialized exception object.
1416 libvlc_media_library_load( libvlc_media_library_t * p_mlib,
1417 libvlc_exception_t * p_e );
1420 * Save media library.
1422 * \param p_mlib media library object
1423 * \param p_e an initialized exception object.
1426 libvlc_media_library_save( libvlc_media_library_t * p_mlib,
1427 libvlc_exception_t * p_e );
1430 * Get media library subitems.
1432 * \param p_mlib media library object
1433 * \param p_e an initialized exception object.
1434 * \return media list subitems
1436 VLC_PUBLIC_API libvlc_media_list_t *
1437 libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
1438 libvlc_exception_t * p_e );
1444 /*****************************************************************************
1445 * Services/Media Discovery
1446 *****************************************************************************/
1447 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
1449 * LibVLC Media Discoverer
1454 * Discover media service by name.
1456 * \param p_inst libvlc instance
1457 * \param psz_name service name
1458 * \param p_e an initialized exception object
1459 * \return media discover object
1461 VLC_PUBLIC_API libvlc_media_discoverer_t *
1462 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1463 const char * psz_name,
1464 libvlc_exception_t * p_e );
1467 * Release media discover object. If the reference count reaches 0, then
1468 * the object will be released.
1470 * \param p_mdis media service discover object
1472 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1475 * Get media service discover object its localized name.
1477 * \param media discover object
1478 * \return localized name
1480 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1483 * Get media service discover media list.
1485 * \param p_mdis media service discover object
1486 * \return list of media items
1488 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1491 * Get event manager from media service discover object.
1493 * \param p_mdis media service discover object
1494 * \return event manager object.
1496 VLC_PUBLIC_API libvlc_event_manager_t *
1497 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1500 * Query if media service discover object is running.
1502 * \param p_mdis media service discover object
1503 * \return true if running, false if not
1506 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1511 /*****************************************************************************
1512 * Message log handling
1513 *****************************************************************************/
1515 /** \defgroup libvlc_log libvlc_log
1516 * \ingroup libvlc_core
1517 * LibVLC Message Logging
1522 * Return the VLC messaging verbosity level.
1524 * \param p_instance libvlc instance
1525 * \param p_e an initialized exception pointer
1526 * \return verbosity level for messages
1528 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1529 libvlc_exception_t *p_e );
1532 * Set the VLC messaging verbosity level.
1534 * \param p_instance libvlc log instance
1535 * \param level log level
1536 * \param p_e an initialized exception pointer
1538 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1539 libvlc_exception_t *p_e );
1542 * Open a VLC message log instance.
1544 * \param p_instance libvlc instance
1545 * \param p_e an initialized exception pointer
1546 * \return log message instance
1548 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1551 * Close a VLC message log instance.
1553 * \param p_log libvlc log instance
1554 * \param p_e an initialized exception pointer
1556 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1559 * Returns the number of messages in a log instance.
1561 * \param p_log libvlc log instance
1562 * \param p_e an initialized exception pointer
1563 * \return number of log messages
1565 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1568 * Clear a log instance.
1570 * All messages in the log are removed. The log should be cleared on a
1571 * regular basis to avoid clogging.
1573 * \param p_log libvlc log instance
1574 * \param p_e an initialized exception pointer
1576 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1579 * Allocate and returns a new iterator to messages in log.
1581 * \param p_log libvlc log instance
1582 * \param p_e an initialized exception pointer
1583 * \return log iterator object
1585 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1588 * Release a previoulsy allocated iterator.
1590 * \param p_iter libvlc log iterator
1591 * \param p_e an initialized exception pointer
1593 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1596 * Return whether log iterator has more messages.
1598 * \param p_iter libvlc log iterator
1599 * \param p_e an initialized exception pointer
1600 * \return true if iterator has more message objects, else false
1602 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1605 * Return the next log message.
1607 * The message contents must not be freed
1609 * \param p_iter libvlc log iterator
1610 * \param p_buffer log buffer
1611 * \param p_e an initialized exception pointer
1612 * \return log message object
1614 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1615 libvlc_log_message_t *p_buffer,
1616 libvlc_exception_t *p_e );
1624 #endif /* <vlc/libvlc.h> */