X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc.h;h=6a56774bb95eade041fcfc85962de338462add39;hb=56c88f31f0447a542da6af099590bd3c19a05af4;hp=96bcbb2670ddd7444d35639d61310d3ddc6f2709;hpb=449fd28aaf007c6411251dae9d0dbfdc65b135d1;p=vlc diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h index 96bcbb2670..6a56774bb9 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 @@ -23,6 +23,11 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ +/** + * \file + * This file defines libvlc external API + */ + /** * \defgroup libvlc libvlc * This is libvlc, the base library of the VLC program. @@ -30,16 +35,31 @@ * @{ */ +#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 +#include + /***************************************************************************** * Exception handling *****************************************************************************/ @@ -145,6 +165,26 @@ VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * ); */ VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * ); +/** + * Try to start a user interface for the libvlc instance. + * + * \param p_instance the instance + * \param name interface name, or NULL for default + * \param p_exception an initialized exception pointer + */ +VLC_PUBLIC_API +void libvlc_add_intf( libvlc_instance_t *p_instance, const char *name, + libvlc_exception_t *p_exception ); + +/** + * 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 + */ +VLC_PUBLIC_API +void libvlc_wait( libvlc_instance_t *p_instance ); + /** * Retrieve libvlc version. * @@ -152,7 +192,7 @@ VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * ); * * \return a string containing the libvlc version */ -VLC_PUBLIC_API const char * libvlc_get_version(); +VLC_PUBLIC_API const char * libvlc_get_version(void); /** * Retrieve libvlc compiler version. @@ -161,7 +201,7 @@ VLC_PUBLIC_API const char * libvlc_get_version(); * * \return a string containing the libvlc compiler version */ -VLC_PUBLIC_API const char * libvlc_get_compiler(); +VLC_PUBLIC_API const char * libvlc_get_compiler(void); /** * Retrieve libvlc changeset. @@ -170,600 +210,56 @@ VLC_PUBLIC_API const char * libvlc_get_compiler(); * * \return a string containing the libvlc changeset */ -VLC_PUBLIC_API const char * libvlc_get_changeset(); +VLC_PUBLIC_API const char * libvlc_get_changeset(void); -/** @}*/ - -/***************************************************************************** - * Media descriptor - *****************************************************************************/ -/** \defgroup libvlc_media libvlc_media - * \ingroup libvlc - * LibVLC Media Descriptor - * @{ - */ +struct vlc_object_t; /** - * Create a media descriptor with the given MRL. + * Return the libvlc internal object, the main object that all other depend on. + * Any of of this function should be considered an ugly hack and avoided at all + * cost. E.g. you need to expose some functionality that is not provided by the + * libvlc API directly with libvlccore. + * Remember to release the object with vlc_object_release( obj* ) * - * \param p_instance the instance - * \param psz_mrl the MRL to read - * \param p_e an initialized exception pointer - * \return the newly created media descriptor + * \param p_instance the libvlc instance */ -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 struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *); /** - * Create a media descriptor as an empty node with the passed name. - * - * \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 descriptor - */ -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 ); - -/** - * Add an option to the media descriptor. - * - * 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" - * - * \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 descriptor. - * - * \param p_meta_desc the media descriptor to read - * \param p_meta_desc the meta to read - * \param p_e an initialized exception pointer - * \return the media descriptor's meta + * Frees an heap allocation (char *) returned by a LibVLC API. + * If you know you're using the same underlying C run-time as the LibVLC + * implementation, then you can call ANSI C free() directly instead. */ -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); +VLC_PUBLIC_API void libvlc_free( void *ptr ); /** @}*/ /***************************************************************************** - * Media Instance + * Event handling *****************************************************************************/ -/** \defgroup libvlc_media_player libvlc_media_player - * \ingroup libvlc - * LibVLC Media Instance, object that let you play a media descriptor - * in a libvlc_drawable_t - * @{ - */ - -/** - * Create an empty Media Instance object - * - * \param p_libvlc_instance the libvlc instance in which the Media Instance - * 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 Instance object from a Media Descriptor - * - * \param p_md the media descriptor. 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 Instance 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 descriptor that will be used by the media_player. If any, - * previous md will be released. - * - * \param p_mi the Media Instance - * \param p_md the Media Descriptor. 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 descriptor used by the media_player. - * - * \param p_mi the Media Instance - * \param p_e an initialized exception pointer - * \return the media descriptor associated with p_mi, or NULL if no - * media descriptor 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 instance send event. - * - * \param p_mi the Media Instance - * \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 Instance - * \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 Instance - * \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 Instance - * \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 instance should render its video output - * - * \param p_mi the Media Instance - * \param drawable the libvlc_drawable_t where the media instance - * 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 instance should render its video output - * - * \param p_mi the Media Instance - * \param p_e an initialized exception pointer - * \return the libvlc_drawable_t where the media instance - * 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 instance have a video output? - * - * \param p_md the media instance - * \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 instance 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 instance 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 * ); - -/** - * Set new video aspect ratio. - * - * \param p_input the input - * \param psz_aspect new video aspect-ratio - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * ); - -/** - * 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. - * - * \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). - * - * \param p_instance libvlc instance - * \param area coordinates within video drawable - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * ); - -/** - * Set the default video output's parent. - * - * This setting will be used as default for all video outputs. - * - * \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 - */ -VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * ); - -/** - * Set the default video output parent. - * - * This setting will be used as default for all video outputs. - * - * \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 - */ -VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * ); - -/** - * 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. - * - * \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 +/** \defgroup libvlc_event libvlc_event + * \ingroup libvlc_core + * LibVLC Events * @{ */ /** - * 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 - */ -VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * ); - -/** - * Get current audio level. - * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer - * \return the audio level (int) + * Event manager that belongs to a libvlc object, and from whom events can + * be received. */ -VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * ); +typedef struct libvlc_event_manager_t libvlc_event_manager_t; +typedef struct libvlc_event_t libvlc_event_t; +typedef uint32_t libvlc_event_type_t; + /** - * Set current audio level. - * - * \param p_instance libvlc instance - * \param i_volume the volume (int) - * \param p_e an initialized exception pointer - */ -VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *); - -/** - * Get number of available audio tracks. - * - * \param p_mi media instance - * \param p_e an initialized exception - * \return the number of available audio tracks (int) - */ -VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * ); - -/** - * Get current audio track. - * - * \param p_input input instance - * \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_input input instance - * \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 input 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 input 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 - * @{ + * Callback function notification + * \param p_event the event triggering the callback */ +typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * ); + /** * Register for an event notification. * @@ -805,66 +301,6 @@ VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_ty /** @} */ -/***************************************************************************** - * 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 *****************************************************************************/ @@ -880,6 +316,7 @@ VLC_PUBLIC_API int * * \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 ); @@ -899,6 +336,7 @@ VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, uns * * \param p_instance libvlc instance * \param p_e an initialized exception pointer + * \return log message instance */ VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *); @@ -915,6 +353,7 @@ VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *); * * \param p_log libvlc log instance * \param p_e an initialized exception pointer + * \return number of log messages */ VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *); @@ -934,6 +373,7 @@ VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *); * * \param p_log libvlc log instance * \param p_e an initialized exception pointer + * \return log iterator object */ VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *); @@ -950,6 +390,7 @@ VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, lib * * \param p_iter libvlc log iterator * \param p_e an initialized exception pointer + * \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 ); @@ -961,6 +402,7 @@ VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_ * \param p_iter libvlc log iterator * \param p_buffer log buffer * \param p_e an initialized exception pointer + * \return log message object */ VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter, libvlc_log_message_t *p_buffer,