X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc.h;h=a3cb4180cdf77b7a98f92467748d1497c8092c77;hb=65bc2af721125f840e7d4efc2fff48ae3e80d934;hp=28f73c17e3eff899853cfa6b6b6b3815bb144938;hpb=44de024820ed206165d81338c36439e786fe2f65;p=vlc diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h index 28f73c17e3..a3cb4180cd 100644 --- a/include/vlc/libvlc.h +++ b/include/vlc/libvlc.h @@ -5,6 +5,7 @@ * $Id: vlc.h 13701 2005-12-12 17:58:56Z zorglub $ * * Authors: Clément Stenac + * Jean-Paul Saman * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -33,6 +34,7 @@ #define _LIBVLC_H 1 #include +#include # ifdef __cplusplus extern "C" { @@ -47,40 +49,33 @@ extern "C" { * @{ */ -struct libvlc_exception_t -{ - int b_raised; - char *psz_message; -}; -typedef struct libvlc_exception_t libvlc_exception_t; - /** * Initialize an exception structure. This can be called several times to reuse * an exception structure. * \param p_exception the exception to initialize */ -void libvlc_exception_init( libvlc_exception_t *p_exception ); +VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception ); /** * Has an exception been raised ? * \param p_exception the exception to query * \return 0 if no exception raised, 1 else */ -int libvlc_exception_raised( libvlc_exception_t *p_exception ); +VLC_PUBLIC_API int libvlc_exception_raised( libvlc_exception_t *p_exception ); /** * Raise an exception * \param p_exception the exception to raise * \param psz_message the exception message */ -void libvlc_exception_raise( libvlc_exception_t *p_exception, char *psz_format, ... ); +VLC_PUBLIC_API void libvlc_exception_raise( libvlc_exception_t *p_exception, const char *psz_format, ... ); /** * Clear an exception object so it can be reused. * The exception object must be initialized * \param p_exception the exception to clear */ -void libvlc_exception_clear( libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * ); /** * Get exception message @@ -88,7 +83,7 @@ void libvlc_exception_clear( libvlc_exception_t * ); * \return the exception message or NULL if not applicable (exception not raised * for example) */ -char* libvlc_exception_get_message( libvlc_exception_t *p_exception ); +VLC_PUBLIC_API char* libvlc_exception_get_message( libvlc_exception_t *p_exception ); /**@} */ @@ -102,16 +97,13 @@ char* libvlc_exception_get_message( libvlc_exception_t *p_exception ); * @{ */ -/** This structure is opaque. It represents a libvlc instance */ -typedef struct libvlc_instance_t libvlc_instance_t; - /** * Create an initialized libvlc instance * \param argc the number of arguments * \param argv command-line-type arguments * \param exception an initialized exception pointer */ -libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *); /** * Returns a libvlc instance identifier for legacy APIs. Use of this @@ -119,13 +111,52 @@ libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *); * new API. * \param p_instance the instance */ -int libvlc_get_vlc_id( libvlc_instance_t *p_instance ); +VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance ); /** - * Destroy a libvlc instance + * Destroy a libvlc instance. * \param p_instance the instance to destroy */ -void libvlc_destroy( libvlc_instance_t *); +VLC_PUBLIC_API void libvlc_destroy( libvlc_instance_t *, libvlc_exception_t * ); + +/** @}*/ + + +/***************************************************************************** + * Media descriptor + *****************************************************************************/ +/** defgroup libvlc_media_descriptor Media Descriptor + * \ingroup libvlc + * LibVLC Media Descriptor + * @{ + */ + +/** + * Create a media descriptor with the given mrl. + * \param p_instance the instance + * \param psz_mrl the mrl to read + */ +VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new( + libvlc_instance_t *p_instance, + const char * psz_mrl, + libvlc_exception_t *p_e ); + +/** + * Destroy a media descriptor object. + * \param p_meta_desc the md to destroy + */ +VLC_PUBLIC_API void libvlc_media_descriptor_destroy( + libvlc_media_descriptor_t *p_meta_desc ); + +/** + * Read the meta of the media descriptor. + * \param p_meta_desc the media descriptor to read + * \param p_meta_desc the meta to read + */ +VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta( + libvlc_media_descriptor_t *p_meta_desc, + libvlc_meta_t e_meta, + libvlc_exception_t *p_e ); /** @}*/ @@ -138,6 +169,12 @@ void libvlc_destroy( libvlc_instance_t *); * @{ */ +/** + * Set loop variable + */ +VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t, + libvlc_exception_t * ); + /** * Start playing. You can give some additionnal playlist item options * that will be added to the item before playing it. @@ -148,15 +185,15 @@ void libvlc_destroy( libvlc_instance_t *); * \param ppsz_options the options to add to the item * \param p_exception an initialized exception */ -void libvlc_playlist_play( libvlc_instance_t*, int, int, char **, - libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **, + libvlc_exception_t * ); /** * Pause a running playlist, resume if it was stopped * \param p_instance the instance to pause * \param p_exception an initialized exception */ -void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * ); /** * Checks if the playlist is running @@ -164,7 +201,7 @@ void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * ); * \param p_exception an initialized exception * \return 0 if the playlist is stopped or paused, 1 if it is running */ -int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * ); /** * Get the number of items in the playlist @@ -172,35 +209,47 @@ int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * ); * \param p_exception an initialized exception * \return the number of items */ -int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * ); + +/** + * Lock the playlist instance + * \param p_instance the instance + */ +VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * ); + +/** + * Unlock the playlist instance + * \param p_instance the instance + */ +VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * ); /** * Stop playing * \param p_instance the instance to stop * \param p_exception an initialized exception */ -void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * ); /** * Go to next playlist item (starts playback if it was stopped) * \param p_instance the instance to use * \param p_exception an initialized exception */ -void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * ); /** * Go to previous playlist item (starts playback if it was stopped) * \param p_instance the instance to use * \param p_exception an initialized exception */ -void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * ); /** * Remove all playlist items * \param p_instance the instance * \param p_exception an initialized exception */ -void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * ); /** * Add an item at the end of the playlist @@ -210,8 +259,8 @@ void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * ); * \param psz_name a name that you might want to give or NULL * \return the identifier of the new item */ -int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *, - libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *, + libvlc_exception_t * ); /** * Add an item at the end of the playlist, with additional input options @@ -223,54 +272,96 @@ int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *, * \param p_exception an initialized exception * \return the identifier of the new item */ -int libvlc_playlist_add_extended( libvlc_instance_t *, const char *, - const char *, int, const char **, - libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *, + const char *, int, const char **, + libvlc_exception_t * ); -/** +/** * Delete the playlist item with the given ID. * \param p_instance the instance * \param i_id the id to remove * \param p_exception an initialized exception * \return */ -int libvlc_playlist_delete_item( libvlc_instance_t *, int, - libvlc_exception_t * ); - -typedef struct libvlc_input_t libvlc_input_t; +VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int, + libvlc_exception_t * ); /* Get the input that is currently being played by the playlist * \param p_instance the instance to use * \param p_exception an initialized excecption * \return an input object */ -libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *, - libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance( + libvlc_instance_t *, libvlc_exception_t * ); /** @}*/ /***************************************************************************** - * Input + * Media Instance *****************************************************************************/ -/** defgroup libvlc_input Input +/** defgroup libvlc_media_instance Media Instance * \ingroup libvlc - * LibVLC Input handling + * LibVLC Media Instance * @{ */ -/** Free an input object - * \param p_input the input to free +/** Create an empty Media Instance object + * \param p_libvlc_instance the libvlc instance in which the Media Instance + * should be (not used for now). + */ +VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_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 safely be + * destroyed. + */ +VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * ); + +/** Release a media_instance after use + * \param p_mi the Media Instance to free + */ +VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * ); + +/** Set the media descriptor that will be used by the media_instance. If any, + * previous md will be released. + * \param p_mi the Media Instance + * \param p_md the Media Descriptor. Afterwards the p_md can safely be + * destroyed. */ -void libvlc_input_free( libvlc_input_t * ); +VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * ); + +/** Get the media descriptor used by the media_instance (if any). A copy of + * the md is returned. NULL is returned if no media instance is associated. + * \param p_mi the Media Instance + * \param p_md the Media Descriptor. Afterwards the p_md can safely be + * destroyed. + */ +VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * ); + + +VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * ); /// \bug This might go away ... to be replaced by a broader system -vlc_int64_t libvlc_input_get_length ( libvlc_input_t *, libvlc_exception_t *); -vlc_int64_t libvlc_input_get_time ( libvlc_input_t *, libvlc_exception_t *); -void libvlc_input_set_time ( libvlc_input_t *, vlc_int64_t, libvlc_exception_t *); -float libvlc_input_get_position ( libvlc_input_t *, libvlc_exception_t *); -void libvlc_input_set_position ( libvlc_input_t *, float, libvlc_exception_t *); -vlc_bool_t libvlc_input_will_play ( libvlc_input_t *, libvlc_exception_t *); - +VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *); +VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *); +VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *); + +/** + * Does this input have a video output ? + * \param p_input the input + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *); + + /** @} */ /** defgroup libvlc_video Video @@ -284,15 +375,15 @@ vlc_bool_t libvlc_input_will_play ( libvlc_input_t *, libvlc_exception_t * * \param p_input the input * \param p_exception an initialized exception */ -vlc_bool_t libvlc_input_has_vout ( libvlc_input_t *, libvlc_exception_t *); -float libvlc_input_get_fps ( libvlc_input_t *, libvlc_exception_t *); +VLC_PUBLIC_API vlc_bool_t libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *); +VLC_PUBLIC_API float libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *); /** * Toggle fullscreen status on video output * \param p_input the input * \param p_exception an initialized exception */ -void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * ); /** * Enable or disable fullscreen on a video output @@ -300,7 +391,7 @@ void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * ); * \param b_fullscreen boolean for fullscreen status * \param p_exception an initialized exception */ -void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * ); /** * Get current fullscreen status @@ -308,15 +399,15 @@ void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * ); * \param p_exception an initialized exception * \return the fullscreen status (boolean) */ -int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * ); - +VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * ); + /** * Get current video height * \param p_input the input * \param p_exception an initialized exception * \return the video height */ -int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * ); /** * Get current video width @@ -324,7 +415,71 @@ int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * ); * \param p_exception an initialized exception * \return the video width */ -int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * ); + +/** + * Get current video aspect ratio + * \param p_input the input + * \param p_exception an initialized exception + * \return the video aspect ratio + */ +VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * ); + +/** + * Set new video aspect ratio + * \param p_input the input + * \param psz_aspect new video aspect-ratio + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * ); + +/** + * Get current video subtitle + * \param p_input the input + * \param p_exception an initialized exception + * \return the video subtitle selected + */ +VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * ); + +/** + * Set new video subtitle + * \param p_input the input + * \param i_spu new video subtitle to select + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * ); + +/** + * Get current crop filter geometry + * \param p_input the input + * \param p_exception an initialized exception + * \return the crop filter geometry + */ +VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * ); + +/** + * Set new crop filter geometry + * \param p_input the input + * \param psz_geometry new crop filter geometry + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * ); + +/** + * Get current teletext page requested. + * \param p_input the input + * \param p_exception an initialized exception + * \return the current teletext page requested. + */ +VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * ); + +/** + * Set new teletext page to retrieve + * \param p_input the input + * \param i_page teletex page number requested + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * ); /** * Take a snapshot of the current video window @@ -332,38 +487,74 @@ int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * ); * \param psz_filepath the path where to save the screenshot to * \param p_exception an initialized exception */ -void libvlc_video_take_snapshot( libvlc_input_t *, char *, libvlc_exception_t * ); - -int libvlc_video_destroy( libvlc_input_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * ); + +VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *); - /** - * Resize the video output window + * 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_exception an initialized exception - * \return the mute status (boolean) + * \return the success status (boolean) */ -void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *); - +VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *); + /** -* Downcast to this general type as placeholder for a platform specific one, such as: -* Drawable on X11, -* CGrafPort on MacOSX, -* HWND on win32 -*/ -typedef int libvlc_drawable_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_exception an initialized exception + * \return the success status (boolean) + */ +VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * ); /** - * Get current mute status + * Tell windowless video output to redraw rectangular area (MacOS X only) + * \param p_instance libvlc instance + * \param area coordinates within video drawable + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * ); + +/** + * Set the default video output parent + * this settings 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_exception an initialized exception - * \return the mute status (boolean) */ -int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * ); +/** + * Set the default video output parent + * this settings 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_exception an initialized exception + */ +VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * ); + +/** + * Set the default video output size + * this settings 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_exception an initialized exception + */ +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 settings 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_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * ); /** @} */ @@ -380,13 +571,21 @@ int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception * @{ */ +/** + * Toggle mute status + * \param p_instance libvlc instance + * \param p_exception an initialized exception + * \return void + */ +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_exception an initialized exception * \return the mute status (boolean) */ -vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * ); /** * Set mute status @@ -395,8 +594,7 @@ vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * ); * \param p_exception an initialized exception * \return void */ -void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * ); - +VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * ); /** * Get current audio level @@ -404,17 +602,47 @@ void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * \param p_exception an initialized exception * \return the audio level (int) */ -int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * ); - +VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * ); /** * Set current audio level * \param p_instance libvlc instance * \param i_volume the volume (int) * \param p_exception an initialized exception - * \return void */ -void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *); + +/** ++ * Get current audio track ++ * \param p_input input instance ++ * \param p_exception an initialized exception ++ * \return the audio track (int) ++ */ +VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * ); + +/** + * Set current audio track + * \param p_input input instance + * \param i_track the track (int) + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * ); + +/** + * Get current audio channel + * \param p_instance input instance + * \param p_exception an initialized exception + * \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_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * ); /** @} */ @@ -431,8 +659,8 @@ void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *); * \param b_loop Should this broadcast be played in loop ? * \param p_exception an initialized exception */ -void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* , - int, char **, int, int, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* , + int, char **, int, int, libvlc_exception_t * ); /** * Delete a media (vod or broadcast) @@ -440,7 +668,7 @@ void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* , * \param psz_name the media to delete * \param p_exception an initialized exception */ -void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * ); /** * Enable or disable a media (vod or broadcast) @@ -449,8 +677,8 @@ void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * ); * \param b_enabled the new status * \param p_exception an initialized exception */ -void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int, - libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int, + libvlc_exception_t *); /** * Set the output for a media @@ -459,8 +687,8 @@ void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int, * \param psz_output the output MRL (the parameter to the "sout" variable) * \param p_exception an initialized exception */ -void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*, - libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*, + libvlc_exception_t *); /** * Set a media's input MRL. This will delete all existing inputs and @@ -470,9 +698,18 @@ void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*, * \param psz_input the input MRL * \param p_exception an initialized exception */ -void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*, - libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*, + libvlc_exception_t *); +/** + * Add a media's input MRL. This will add the specified one. + * \param p_instance the instance + * \param psz_name the media to work on + * \param psz_input the input MRL + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *, + libvlc_exception_t *p_exception ); /** * Set output for a media * \param p_instance the instance @@ -480,11 +717,8 @@ void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*, * \param b_loop the new status * \param p_exception an initialized exception */ -void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int, - libvlc_exception_t *); - - - +VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int, + libvlc_exception_t *); /** * Edit the parameters of a media. This will delete all existing inputs and @@ -499,16 +733,16 @@ void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int, * \param b_loop Should this broadcast be played in loop ? * \param p_exception an initialized exception */ -void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* , - int, char **, int, int, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* , + int, char **, int, int, libvlc_exception_t * ); /** * Plays the named broadcast. * \param p_instance the instance * \param psz_name the name of the broadcast * \param p_exception an initialized exception - */ -void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * ); + */ +VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * ); /** * Stops the named broadcast. @@ -516,22 +750,187 @@ void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * ) * \param psz_name the name of the broadcast * \param p_exception an initialized exception */ -void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * ); - /** * Pauses the named broadcast. * \param p_instance the instance * \param psz_name the name of the broadcast * \param p_exception an initialized exception */ -void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * ); - +VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * ); +/** + * Seeks in the named broadcast. + * \param p_instance the instance + * \param psz_name the name of the broadcast + * \param f_percentage the percentage to seek to + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *, + float, libvlc_exception_t * ); + +/** + * Return information of the named broadcast. + * \param p_instance the instance + * \param psz_name the name of the broadcast + * \param p_exception an initialized exception + */ +VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * ); + +#define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\ +returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \ + char *, int , libvlc_exception_t * ); + +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1); +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1); +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1); +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1); +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0); +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0); +VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0); + +#undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE + +/** @} */ +/** @} */ + +/***************************************************************************** + * Message log handling + *****************************************************************************/ + +/** defgroup libvlc_log Log + * \ingroup libvlc + * LibVLC Message Logging + * @{ + */ + +/** + * Returns the VLC messaging verbosity level + * \param p_instance libvlc instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance, + libvlc_exception_t *p_e ); + +/** + * Set the VLC messaging verbosity level + * \param p_log libvlc log instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level, + libvlc_exception_t *p_e ); + +/** + * Open an instance to VLC message log + * \param p_instance libvlc instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *); + +/** + * Close an instance of VLC message log + * \param p_log libvlc log instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *); + +/** + * Returns the number of messages in log + * \param p_log libvlc log instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *); + +/** + * Clear all messages in log + * the log should be cleared on a regular basis to avoid clogging + * \param p_log libvlc log instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *); + +/** + * Allocate and returns a new iterator to messages in log + * \param p_log libvlc log instance + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *); + +/** + * Releases a previoulsy allocated iterator + * \param p_log libvlc log iterator + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); + +/** + * Returns whether log iterator has more messages + * \param p_log libvlc log iterator + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); + +/** + * Returns next log message + * the content of message must not be freed + * \param p_log libvlc log iterator + * \param exception an initialized exception pointer + */ +VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter, + struct libvlc_log_message_t *buffer, + libvlc_exception_t *p_e ); /** @} */ + +/***************************************************************************** + * Callbacks handling + *****************************************************************************/ + +/** defgroup libvlc_callbacks Callbacks + * \ingroup libvlc + * LibVLC Event Callbacks + * @{ + */ + +/** + * Register for a callback notification + * \param p_instance the libvlc instance + * \param i_event_type the desired event mask 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 + */ +VLC_PUBLIC_API void libvlc_event_add_callback( libvlc_instance_t *p_instance, + libvlc_event_type_t i_event_type, + libvlc_callback_t f_callback, + void *user_data, + libvlc_exception_t *p_e ); + +/** + * Unregister all callbacks notification from an instance + * \param p_instance the libvlc instance + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance, + libvlc_exception_t *p_e ); + +/** + * Unregister a callback notification + * \param p_instance the libvlc instance + * \param i_event_type the desired event mask to which we want to unregister + * \param f_callback the function to call when i_event_type occurs + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_event_remove_callback( libvlc_instance_t *p_instance, + libvlc_event_type_t i_event_type, + libvlc_callback_t f_callback, + void *p_user_data, + libvlc_exception_t *p_e ); + /** @} */ + # ifdef __cplusplus } # endif