X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc.h;h=8541768ff5f03c7b71e9d68eca7e4e950aec86b0;hb=c12acbd7d48431d7b5029d765e69e87378aca7a2;hp=2f4203f97838bd4937bca75a9cd29855f6fe4374;hpb=0b96b7ca02af144cbd93dea9f9393ffb7d1b3a15;p=vlc diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h index 2f4203f978..8541768ff5 100644 --- a/include/vlc/libvlc.h +++ b/include/vlc/libvlc.h @@ -1,11 +1,11 @@ /***************************************************************************** * libvlc.h: libvlc external API ***************************************************************************** - * Copyright (C) 1998-2005 the VideoLAN team + * Copyright (C) 1998-2009 the VideoLAN team * $Id$ * * Authors: Clément Stenac - * Jean-Paul Saman + * Jean-Paul Saman * Pierre d'Herbemont * * This program is free software; you can redistribute it and/or modify @@ -24,110 +24,116 @@ *****************************************************************************/ /** - * \defgroup libvlc libvlc - * This is libvlc, the base library of the VLC program. - * + * \file + * This file defines libvlc external API + */ + +/** + * \defgroup libvlc LibVLC + * LibVLC is the external programming interface of the VLC media player. + * It is used to embed VLC into other applications or frameworks. * @{ */ +#ifndef VLC_LIBVLC_H +#define VLC_LIBVLC_H 1 -#ifndef _LIBVLC_H -#define _LIBVLC_H 1 +#if defined (WIN32) && defined (DLL_EXPORT) +# define VLC_PUBLIC_API __declspec(dllexport) +#else +# define VLC_PUBLIC_API +#endif -#include +#ifdef __LIBVLC__ +/* Avoid unuseful warnings from libvlc with our deprecated APIs */ +# define VLC_DEPRECATED_API VLC_PUBLIC_API +#elif defined(__GNUC__) && \ + (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0) +# define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated)) +#else +# define VLC_DEPRECATED_API VLC_PUBLIC_API +#endif # ifdef __cplusplus extern "C" { # endif -/***************************************************************************** - * Exception handling - *****************************************************************************/ -/** \defgroup libvlc_exception libvlc_exception - * \ingroup libvlc_core - * LibVLC Exceptions handling +#include +#include + +/** \defgroup libvlc_core LibVLC core + * \ingroup libvlc + * Before it can do anything useful, LibVLC must be initialized. + * You can create one (or more) instance(s) of LibVLC in a given process, + * with libvlc_new() and destroy them with libvlc_release(). + * + * \version Unless otherwise stated, these functions are available + * from LibVLC versions numbered 1.1.0 or more. + * Earlier versions (0.9.x and 1.0.x) are not compatible. * @{ */ -/** - * Initialize an exception structure. This can be called several times to - * reuse an exception structure. - * - * \param p_exception the exception to initialize +/** \defgroup libvlc_error LibVLC error handling + * @{ */ -VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception ); /** - * Has an exception been raised? + * A human-readable error message for the last LibVLC error in the calling + * thread. The resulting string is valid until another error occurs (at least + * until the next LibVLC call). * - * \param p_exception the exception to query - * \return 0 if the exception was raised, 1 otherwise + * @warning + * This will be NULL if there was no error. */ -VLC_PUBLIC_API int -libvlc_exception_raised( const libvlc_exception_t *p_exception ); +VLC_PUBLIC_API const char *libvlc_errmsg (void); /** - * Raise an exception using a user-provided message. - * - * \param p_exception the exception to raise - * \param psz_format the exception message format string - * \param ... the format string arguments + * Clears the LibVLC error status for the current thread. This is optional. + * By default, the error status is automatically overridden when a new error + * occurs, and destroyed when the thread exits. */ -VLC_PUBLIC_API void -libvlc_exception_raise( libvlc_exception_t *p_exception, - const char *psz_format, ... ); +VLC_PUBLIC_API void libvlc_clearerr (void); /** - * Clear an exception object so it can be reused. - * The exception object must have be initialized. - * - * \param p_exception the exception to clear + * Sets the LibVLC error status and message for the current thread. + * Any previous error is overridden. + * \return a nul terminated string in any case */ -VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * ); +const char *libvlc_vprinterr (const char *fmt, va_list ap); /** - * Get an exception's message. - * - * \param p_exception the exception to query - * \return the exception message or NULL if not applicable (exception not - * raised, for example) + * Sets the LibVLC error status and message for the current thread. + * Any previous error is overridden. + * \return a nul terminated string in any case */ -VLC_PUBLIC_API const char * -libvlc_exception_get_message( const libvlc_exception_t *p_exception ); +const char *libvlc_printerr (const char *fmt, ...); /**@} */ -/***************************************************************************** - * Core handling - *****************************************************************************/ - -/** \defgroup libvlc_core libvlc_core - * \ingroup libvlc - * LibVLC Core - * @{ - */ - /** * Create and initialize a libvlc instance. - * - * \param argc the number of arguments - * \param argv command-line-type arguments. argv[0] must be the path of the - * calling program. - * \param p_e an initialized exception pointer - * \return the libvlc instance + * This functions accept a list of "command line" arguments similar to the + * main(). These arguments affect the LibVLC instance default configuration. + * + * \version + * Arguments are meant to be passed from the command line to LibVLC, just like + * VLC media player does. The list of valid arguments depends on the LibVLC + * version, the operating system and platform, and set of available LibVLC + * plugins. Invalid or unsupported arguments will cause the function to fail + * (i.e. return NULL). Also, some arguments may alter the behaviour or + * otherwise interfere with other LibVLC functions. + * + * \warning + * There is absolutely no warranty or promise of forward, backward and + * cross-platform compatibility with regards to libvlc_new() arguments. + * We recommend that you do not use them, other than when debugging. + * + * \param argc the number of arguments (should be 0) + * \param argv list of arguments (should be NULL) + * \return the libvlc instance or NULL in case of error */ VLC_PUBLIC_API libvlc_instance_t * -libvlc_new( int , const char *const *, libvlc_exception_t *); - -/** - * Return a libvlc instance identifier for legacy APIs. Use of this - * function is discouraged, you should convert your program to use the - * new API. - * - * \param p_instance the instance - * \return the instance identifier - */ -VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance ); +libvlc_new( int argc , const char *const *argv ); /** * Decrement the reference count of a libvlc instance, and destroy it @@ -135,7 +141,7 @@ VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance ); * * \param p_instance the instance to destroy */ -VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * ); +VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance ); /** * Increments the reference count of a libvlc instance. @@ -143,627 +149,114 @@ VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * ); * * \param p_instance the instance to reference */ -VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * ); +VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance ); /** - * Retrieve libvlc version. - * - * Example: "0.9.0-git Grishenko" - * - * \return a string containing the libvlc version - */ -VLC_PUBLIC_API const char * libvlc_get_version(); - -/** - * Retrieve libvlc compiler version. - * - * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)" - * - * \return a string containing the libvlc compiler version - */ -VLC_PUBLIC_API const char * libvlc_get_compiler(); - -/** - * Retrieve libvlc changeset. - * - * Example: "aa9bce0bc4" - * - * \return a string containing the libvlc changeset - */ -VLC_PUBLIC_API const char * libvlc_get_changeset(); - -/** @}*/ - -/***************************************************************************** - * media - *****************************************************************************/ -/** \defgroup libvlc_media libvlc_media - * \ingroup libvlc - * LibVLC Media - * @{ - */ - -/** - * Create a media with the given MRL. + * Try to start a user interface for the libvlc instance. * * \param p_instance the instance - * \param psz_mrl the MRL to read - * \param p_e an initialized exception pointer - * \return the newly created media + * \param name interface name, or NULL for default + * \return 0 on success, -1 on error. */ -VLC_PUBLIC_API libvlc_media_t * libvlc_media_new( - libvlc_instance_t *p_instance, - const char * psz_mrl, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API +int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name ); /** - * Create a media as an empty node with the passed name. + * Registers a callback for the LibVLC exit event. This is mostly useful if + * you have started at least one interface with libvlc_add_intf(). + * Typically, this function will wake up your application main loop (from + * another thread). * - * \param p_instance the instance - * \param psz_name the name of the node - * \param p_e an initialized exception pointer - * \return the new empty media + * \param p_instance LibVLC instance + * \param cb callback to invoke when LibVLC wants to exit + * \param opaque data pointer for the callback + * \warning This function and libvlc_wait() cannot be used at the same time. + * Use either or none of them but not both. */ -VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node( - libvlc_instance_t *p_instance, - const char * psz_name, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API +void libvlc_set_exit_handler( libvlc_instance_t *p_instance, + void (*cb) (void *), void *opaque ); /** - * Add an option to the media. - * - * This option will be used to determine how the media_player will - * read the media. This allows to use VLC's advanced - * reading/streaming options on a per-media basis. - * - * The options are detailed in vlc --long-help, for instance "--sout-all" + * Waits until an interface causes the instance to exit. + * You should start at least one interface first, using libvlc_add_intf(). * * \param p_instance the instance - * \param psz_mrl the MRL to read - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_media_add_option( - libvlc_media_t * p_md, - const char * ppsz_options, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API void libvlc_media_retain( - libvlc_media_t *p_meta_desc ); - -VLC_PUBLIC_API void libvlc_media_release( - libvlc_media_t *p_meta_desc ); - -VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * ); - -/** - * Read the meta of the media. - * - * \param p_meta_desc the media to read - * \param p_meta_desc the meta to read - * \param p_e an initialized exception pointer - * \return the media's meta - */ -VLC_PUBLIC_API char * libvlc_media_get_meta( - libvlc_media_t *p_meta_desc, - libvlc_meta_t e_meta, - libvlc_exception_t *p_e ); - -VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state( - libvlc_media_t *p_meta_desc, - libvlc_exception_t *p_e ); - -VLC_PUBLIC_API libvlc_media_list_t * - libvlc_media_subitems( libvlc_media_t *p_md, - libvlc_exception_t *p_e ); - -VLC_PUBLIC_API libvlc_event_manager_t * - libvlc_media_event_manager( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API libvlc_time_t - libvlc_media_get_duration( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API int - libvlc_media_is_preparsed( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API void - libvlc_media_set_user_data( libvlc_media_t * p_md, - void * p_new_user_data, - libvlc_exception_t * p_e); -VLC_PUBLIC_API void * - libvlc_media_get_user_data( libvlc_media_t * p_md, - libvlc_exception_t * p_e); - -/** @}*/ - -/***************************************************************************** - * Media Player - *****************************************************************************/ -/** \defgroup libvlc_media_player libvlc_media_player - * \ingroup libvlc - * LibVLC Media Player, object that let you play a media - * in a libvlc_drawable_t - * @{ - */ - -/** - * Create an empty Media Player object - * - * \param p_libvlc_instance the libvlc instance in which the Media Player - * should be created. - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * ); - -/** - * Create a Media Player object from a Media - * - * \param p_md the media. Afterwards the p_md can be safely - * destroyed. - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * ); - -/** - * Release a media_player after use - * - * \param p_mi the Media Player to free - */ -VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * ); -VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * ); - -/** Set the media that will be used by the media_player. If any, - * previous md will be released. - * - * \param p_mi the Media Player - * \param p_md the Media. Afterwards the p_md can be safely - * destroyed. - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * ); - -/** - * Get the media used by the media_player. - * - * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return the media associated with p_mi, or NULL if no - * media is associated - */ -VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get the Event Manager from which the media player send event. - * - * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return the event manager associated with p_mi - */ -VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Play - * - * \param p_mi the Media Player - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Pause - * - * \param p_mi the Media Player - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Stop - * - * \param p_mi the Media Player - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Set the drawable where the media player should render its video output - * - * \param p_mi the Media Player - * \param drawable the libvlc_drawable_t where the media player - * should render its video - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * ); - -/** - * Get the drawable where the media player should render its video output - * - * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return the libvlc_drawable_t where the media player - * should render its video - */ -VLC_PUBLIC_API libvlc_drawable_t - libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * ); - -/** \bug This might go away ... to be replaced by a broader system */ -VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length ( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time ( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API void libvlc_media_player_set_time ( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *); -VLC_PUBLIC_API float libvlc_media_player_get_position ( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API void libvlc_media_player_set_position ( libvlc_media_player_t *, float, libvlc_exception_t *); -VLC_PUBLIC_API void libvlc_media_player_set_chapter ( libvlc_media_player_t *, int, libvlc_exception_t *); -VLC_PUBLIC_API int libvlc_media_player_get_chapter (libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API float libvlc_media_player_get_rate ( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API void libvlc_media_player_set_rate ( libvlc_media_player_t *, float, libvlc_exception_t *); -VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state ( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *); - -/** - * Does this media player have a video output? - * - * \param p_md the media player - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *); - -/** - * Is this media player seekable? - * - * \param p_input the input - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e ); - -/** - * Can this media player be paused? - * - * \param p_input the input - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e ); - -/** \defgroup libvlc_video libvlc_video - * \ingroup libvlc_media_player - * LibVLC Video handling - * @{ - */ - -/** - * Toggle fullscreen status on video output. - * - * \param p_input the input - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Enable or disable fullscreen on a video output. - * - * \param p_input the input - * \param b_fullscreen boolean for fullscreen status - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * ); - -/** - * Get current fullscreen status. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the fullscreen status (boolean) - */ -VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get current video height. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the video height - */ -VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get current video width. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the video width - */ -VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get current video aspect ratio. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the video aspect ratio */ -VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API +void libvlc_wait( libvlc_instance_t *p_instance ); /** - * Set new video aspect ratio. + * Sets the application name. LibVLC passes this as the user agent string + * when a protocol requires it. * - * \param p_input the input - * \param psz_aspect new video aspect-ratio - * \param p_e an initialized exception pointer + * \param p_instance LibVLC instance + * \param name human-readable application name, e.g. "FooBar player 1.2.3" + * \param http HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0" + * \version LibVLC 1.1.1 or later */ -VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * ); +VLC_PUBLIC_API +void libvlc_set_user_agent( libvlc_instance_t *p_instance, + const char *name, const char *http ); /** - * Get current video subtitle. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the video subtitle selected - */ -VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Set new video subtitle. - * - * \param p_input the input - * \param i_spu new video subtitle to select - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * ); - -/** - * Get current crop filter geometry. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the crop filter geometry - */ -VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Set new crop filter geometry. - * - * \param p_input the input - * \param psz_geometry new crop filter geometry - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * ); - -/** - * Toggle teletext transparent status on video output. - * - * \param p_input the input - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get current teletext page requested. - * - * \param p_input the input - * \param p_e an initialized exception pointer - * \return the current teletext page requested. - */ -VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Set new teletext page to retrieve. - * - * \param p_input the input - * \param i_page teletex page number requested - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * ); - -/** - * Take a snapshot of the current video window. - * - * If i_width AND i_height is 0, original size is used. - * If i_width XOR i_height is 0, original aspect-ratio is preserved. - * - * \param p_input the input - * \param psz_filepath the path where to save the screenshot to - * \param i_width the snapshot's width - * \param i_height the snapshot's height - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * ); - -VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_player_t *, libvlc_exception_t *); - -/** - * Resize the current video output window. - * - * \param p_instance libvlc instance - * \param width new width for video output window - * \param height new height for video output window - * \param p_e an initialized exception pointer - * \return the success status (boolean) - */ -VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *); - -/** - * Change the parent for the current the video output. + * Retrieve libvlc version. * - * \param p_instance libvlc instance - * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32) - * \param p_e an initialized exception pointer - * \return the success status (boolean) - */ -VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * ); - -/** - * Tell windowless video output to redraw rectangular area (MacOS X only). + * Example: "1.1.0-git The Luggage" * - * \param p_instance libvlc instance - * \param area coordinates within video drawable - * \param p_e an initialized exception pointer + * \return a string containing the libvlc version */ -VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * ); +VLC_PUBLIC_API const char * libvlc_get_version(void); /** - * Set the default video output's parent. + * Retrieve libvlc compiler version. * - * This setting will be used as default for all video outputs. + * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)" * - * \param p_instance libvlc instance - * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32) - * \param p_e an initialized exception pointer + * \return a string containing the libvlc compiler version */ -VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * ); +VLC_PUBLIC_API const char * libvlc_get_compiler(void); /** - * Set the default video output parent. + * Retrieve libvlc changeset. * - * This setting will be used as default for all video outputs. + * Example: "aa9bce0bc4" * - * \param p_instance libvlc instance - * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32) - * \param p_e an initialized exception pointer + * \return a string containing the libvlc changeset */ -VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API const char * libvlc_get_changeset(void); -/** - * Set the default video output size. - * - * This setting will be used as default for all video outputs. - * - * \param p_instance libvlc instance - * \param width new width for video drawable - * \param height new height for video drawable - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * ); -/** - * Set the default video output viewport for a windowless video output - * (MacOS X only). - * - * This setting will be used as default for all video outputs. +/** \defgroup libvlc_event LibVLC asynchronous events + * LibVLC emits asynchronous events. * - * \param p_instance libvlc instance - * \param view coordinates within video drawable - * \param clip coordinates within video drawable - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * ); - -/** @} video */ - -/** \defgroup libvlc_audio libvlc_audio - * \ingroup libvlc_media_player - * LibVLC Audio handling + * Several LibVLC objects (such @ref libvlc_instance_t as + * @ref libvlc_media_player_t) generate events asynchronously. Each of them + * provides @ref libvlc_event_manager_t event manager. You can subscribe to + * events with libvlc_event_attach() and unsubscribe with + * libvlc_event_detach(). * @{ */ /** - * Toggle mute status. - * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * ); - -/** - * Get current mute status. - * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer - * \return the mute status (boolean) - */ -VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * ); - -/** - * Set mute status. - * - * \param p_instance libvlc instance - * \param status If status is true then mute, otherwise unmute - * \param p_e an initialized exception pointer + * Event manager that belongs to a libvlc object, and from whom events can + * be received. */ -VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * ); +typedef struct libvlc_event_manager_t libvlc_event_manager_t; -/** - * Get current audio level. - * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer - * \return the audio level (int) - */ -VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * ); +struct libvlc_event_t; /** - * Set current audio level. - * - * \param p_instance libvlc instance - * \param i_volume the volume (int) - * \param p_e an initialized exception pointer + * Type of a LibVLC event. */ -VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *); +typedef int libvlc_event_type_t; /** - * Get number of available audio tracks. - * - * \param p_mi media player - * \param p_e an initialized exception - * \return the number of available audio tracks (int) + * Callback function notification + * \param p_event the event triggering the callback */ -VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get current audio track. - * - * \param p_mi media player - * \param p_e an initialized exception pointer - * \return the audio track (int) - */ -VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Set current audio track. - * - * \param p_mi media player - * \param i_track the track (int) - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * ); - -/** - * Get current audio channel. - * - * \param p_instance vlc instance - * \param p_e an initialized exception pointer - * \return the audio channel (int) - */ -VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * ); - -/** - * Set current audio channel. - * - * \param p_instance vlc instance - * \param i_channel the audio channel (int) - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * ); - -/** @} audio */ - -/** @} media_player */ - -/***************************************************************************** - * Event handling - *****************************************************************************/ - -/** \defgroup libvlc_event libvlc_event - * \ingroup libvlc_core - * LibVLC Events - * @{ - */ - +typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * ); + /** * Register for an event notification. * @@ -773,13 +266,12 @@ VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_e * \param i_event_type the desired event to which we want to listen * \param f_callback the function to call when i_event_type occurs * \param user_data user provided data to carry with the event - * \param p_e an initialized exception pointer + * \return 0 on success, ENOMEM on error */ -VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager, - libvlc_event_type_t i_event_type, - libvlc_callback_t f_callback, - void *user_data, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager, + libvlc_event_type_t i_event_type, + libvlc_callback_t f_callback, + void *user_data ); /** * Unregister an event notification. @@ -788,90 +280,24 @@ VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager * \param i_event_type the desired event to which we want to unregister * \param f_callback the function to call when i_event_type occurs * \param p_user_data user provided data to carry with the event - * \param p_e an initialized exception pointer */ VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager, libvlc_event_type_t i_event_type, libvlc_callback_t f_callback, - void *p_user_data, - libvlc_exception_t *p_e ); + void *p_user_data ); /** * Get an event's type name. * - * \param i_event_type the desired event + * \param event_type the desired event */ VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type ); /** @} */ -/***************************************************************************** - * Media Library - *****************************************************************************/ -/** \defgroup libvlc_media_library libvlc_media_library - * \ingroup libvlc - * LibVLC Media Library - * @{ - */ -VLC_PUBLIC_API libvlc_media_library_t * - libvlc_media_library_new( libvlc_instance_t * p_inst, - libvlc_exception_t * p_e ); -VLC_PUBLIC_API void - libvlc_media_library_release( libvlc_media_library_t * p_mlib ); -VLC_PUBLIC_API void - libvlc_media_library_retain( libvlc_media_library_t * p_mlib ); - - -VLC_PUBLIC_API void - libvlc_media_library_load( libvlc_media_library_t * p_mlib, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API void - libvlc_media_library_save( libvlc_media_library_t * p_mlib, - libvlc_exception_t * p_e ); - -VLC_PUBLIC_API libvlc_media_list_t * - libvlc_media_library_media_list( libvlc_media_library_t * p_mlib, - libvlc_exception_t * p_e ); - - -/** @} */ - - -/***************************************************************************** - * Services/Media Discovery - *****************************************************************************/ -/** \defgroup libvlc_media_discoverer libvlc_media_discoverer - * \ingroup libvlc - * LibVLC Media Discoverer - * @{ - */ - -VLC_PUBLIC_API libvlc_media_discoverer_t * -libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst, - const char * psz_name, - libvlc_exception_t * p_e ); -VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis ); -VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis ); - -VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis ); - -VLC_PUBLIC_API libvlc_event_manager_t * - libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis ); - -VLC_PUBLIC_API int - libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis ); - -/**@} */ - - -/***************************************************************************** - * Message log handling - *****************************************************************************/ - -/** \defgroup libvlc_log libvlc_log - * \ingroup libvlc_core - * LibVLC Message Logging +/** \defgroup libvlc_log LibVLC logging + * libvlc_log_* functions provide access to the LibVLC messages log. + * This is used for debugging or by advanced users. * @{ */ @@ -879,44 +305,40 @@ VLC_PUBLIC_API int * Return the VLC messaging verbosity level. * * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \return verbosity level for messages */ -VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance ); /** * Set the VLC messaging verbosity level. * * \param p_instance libvlc log instance * \param level log level - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level ); /** * Open a VLC message log instance. * * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \return log message instance or NULL on error */ -VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance ); /** * Close a VLC message log instance. * - * \param p_log libvlc log instance - * \param p_e an initialized exception pointer + * \param p_log libvlc log instance or NULL */ -VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log ); /** * Returns the number of messages in a log instance. * - * \param p_log libvlc log instance - * \param p_e an initialized exception pointer + * \param p_log libvlc log instance or NULL + * \return number of log messages, 0 if p_log is NULL */ -VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *); +VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log ); /** * Clear a log instance. @@ -924,49 +346,48 @@ VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception * All messages in the log are removed. The log should be cleared on a * regular basis to avoid clogging. * - * \param p_log libvlc log instance - * \param p_e an initialized exception pointer + * \param p_log libvlc log instance or NULL */ -VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log ); /** * Allocate and returns a new iterator to messages in log. * * \param p_log libvlc log instance - * \param p_e an initialized exception pointer + * \return log iterator object or NULL on error */ -VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log ); /** * Release a previoulsy allocated iterator. * - * \param p_iter libvlc log iterator - * \param p_e an initialized exception pointer + * \param p_iter libvlc log iterator or NULL */ -VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); +VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter ); /** * Return whether log iterator has more messages. * - * \param p_iter libvlc log iterator - * \param p_e an initialized exception pointer + * \param p_iter libvlc log iterator or NULL + * \return true if iterator has more message objects, else false */ -VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); +VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter ); /** * Return the next log message. * * The message contents must not be freed * - * \param p_iter libvlc log iterator + * \param p_iter libvlc log iterator or NULL * \param p_buffer log buffer - * \param p_e an initialized exception pointer + * \return log message object or NULL if none left */ VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter, - libvlc_log_message_t *p_buffer, - libvlc_exception_t *p_e ); + libvlc_log_message_t *p_buffer ); /** @} */ +/** @} */ +/** @} */ # ifdef __cplusplus }