X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc.h;h=3c7566b47c28425fc9249d9f9ec3bd582f23eebf;hb=922aad511a40cf2f14b6a5255fb88835818c301b;hp=b0e0a312110d2041ec344703b08462956c630cee;hpb=8914d39a96c9131b1cbfc8f93869d310c16e9c34;p=vlc diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h index b0e0a31211..7214fd06e5 100644 --- a/include/vlc/libvlc.h +++ b/include/vlc/libvlc.h @@ -1,10 +1,12 @@ /***************************************************************************** - * libvlc.h: libvlc_* new external API + * libvlc.h: libvlc external API ***************************************************************************** - * Copyright (C) 1998-2005 the VideoLAN team - * $Id: vlc.h 13701 2005-12-12 17:58:56Z zorglub $ + * Copyright (C) 1998-2009 the VideoLAN team + * $Id$ * * Authors: Clément Stenac + * Jean-Paul Saman + * Pierre d'Herbemont * * 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 @@ -22,17 +24,35 @@ *****************************************************************************/ /** - * \defgroup libvlc Libvlc + * \file + * This file defines libvlc external API + */ + +/** + * \defgroup libvlc libvlc * This is libvlc, the base library of the VLC program. * * @{ */ - -#ifndef _LIBVLC_H -#define _LIBVLC_H 1 - -#include +#ifndef VLC_LIBVLC_H +#define VLC_LIBVLC_H 1 + +#if defined (WIN32) && defined (DLL_EXPORT) +# define VLC_PUBLIC_API __declspec(dllexport) +#else +# define VLC_PUBLIC_API +#endif + +#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" { @@ -41,54 +61,57 @@ extern "C" { /***************************************************************************** * Exception handling *****************************************************************************/ -/** defgroup libvlc_exception Exceptions - * \ingroup libvlc +/** \defgroup libvlc_exception libvlc_exception + * \ingroup libvlc_core * LibVLC Exceptions handling * @{ */ -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. + * 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 ? + * Has an exception been raised? + * * \param p_exception the exception to query - * \return 0 if no exception raised, 1 else + * \return 0 if the exception was raised, 1 otherwise */ -int libvlc_exception_raised( libvlc_exception_t *p_exception ); +VLC_PUBLIC_API int +libvlc_exception_raised( const libvlc_exception_t *p_exception ); /** - * Raise an exception + * Raise an exception using a user-provided message. + * * \param p_exception the exception to raise - * \param psz_message the exception message + * \param psz_format the exception message format string + * \param ... the format string arguments */ -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 + * The exception object must have 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 + * 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) + * \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 const char * +libvlc_exception_get_message( const libvlc_exception_t *p_exception ); /**@} */ @@ -96,443 +119,1523 @@ char* libvlc_exception_get_message( libvlc_exception_t *p_exception ); * Core handling *****************************************************************************/ -/** defgroup libvlc_core Core +/** \defgroup libvlc_core libvlc_core * \ingroup libvlc * LibVLC Core * @{ */ -/** This structure is opaque. It represents a libvlc instance */ -typedef struct libvlc_instance_t libvlc_instance_t; - /** - * Create an initialized libvlc instance + * Create and initialize a libvlc instance. + * * \param argc the number of arguments - * \param argv command-line-type arguments - * \param exception an initialized exception pointer + * \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 */ -libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_instance_t * +libvlc_new( int , const char *const *, libvlc_exception_t *); /** - * returns a libvlc instance identifier for legacy APIs - * \param p_instance the instance to destroy + * 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 */ -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 + * Decrement the reference count of a libvlc instance, and destroy it + * if it reaches zero. + * * \param p_instance the instance to destroy */ -void libvlc_destroy( libvlc_instance_t *); +VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * ); + +/** + * Increments the reference count of a libvlc instance. + * The initial reference count is 1 after libvlc_new() returns. + * + * \param p_instance the instance to reference + */ +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. + * + * Example: "0.9.0-git Grishenko" + * + * \return a string containing the libvlc version + */ +VLC_PUBLIC_API const char * libvlc_get_version(void); + +/** + * 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(void); + +/** + * Retrieve libvlc changeset. + * + * Example: "aa9bce0bc4" + * + * \return a string containing the libvlc changeset + */ +VLC_PUBLIC_API const char * libvlc_get_changeset(void); + +struct vlc_object_t; + +/** + * 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 libvlc instance + */ +VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *); + +/** + * 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 void libvlc_free( void *ptr ); /** @}*/ /***************************************************************************** - * Playlist + * media *****************************************************************************/ -/** defgroup libvlc_playlist Playlist +/** \defgroup libvlc_media libvlc_media * \ingroup libvlc - * LibVLC Playlist handling + * LibVLC Media * @{ */ /** - * Start playing. You can give some additionnal playlist item options - * that will be added to the item before playing it. + * Create a media with the given MRL. + * * \param p_instance the instance - * \param i_id the item to play. If this is a negative number, the next - * item will be selected. Else, the item with the given ID will be played - * \param i_options the number of options to add to the item - * \param ppsz_options the options to add to the item - * \param p_exception an initialized exception + * \param psz_mrl the MRL to read + * \param p_e an initialized exception pointer + * \return the newly created media */ -void libvlc_playlist_play( libvlc_instance_t*, int, int, char **, - libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_t * libvlc_media_new( + libvlc_instance_t *p_instance, + const char * psz_mrl, + libvlc_exception_t *p_e ); /** - * Pause a running playlist, resume if it was stopped - * \param p_instance the instance to pause - * \param p_exception an initialized exception + * Create a media 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 */ -void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * ); +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 ); /** - * Checks if the playlist is running + * 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" + * * \param p_instance the instance - * \param p_exception an initialized exception - * \return 0 if the playlist is stopped or paused, 1 if it is running + * \param ppsz_options the options (as a string) + * \param p_e an initialized exception pointer */ -int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * ); - +VLC_PUBLIC_API void libvlc_media_add_option( + libvlc_media_t * p_md, + const char * ppsz_options, + libvlc_exception_t * p_e ); /** - * Get the number of items in the playlist + * Add an option to the media from an untrusted source. + * + * 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 p_exception an initialized exception - * \return the number of items + * \param ppsz_options the options (as a string) + * \param p_e an initialized exception pointer */ -int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_add_option_untrusted( + libvlc_media_t * p_md, + const char * ppsz_options, + libvlc_exception_t * p_e ); + /** - * Stop playing - * \param p_instance the instance to stop - * \param p_exception an initialized exception + * Retain a reference to a media descriptor object (libvlc_media_t). Use + * libvlc_media_release() to decrement the reference count of a + * media descriptor object. + * + * \param p_meta_desc a media descriptor object. */ -void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_retain( + libvlc_media_t *p_meta_desc ); /** - * Go to next playlist item (starts playback if it was stopped) - * \param p_instance the instance to use - * \param p_exception an initialized exception + * Decrement the reference count of a media descriptor object. If the + * reference count is 0, then libvlc_media_release() will release the + * media descriptor object. It will send out an libvlc_MediaFreed event + * to all listeners. If the media descriptor object has been released it + * should not be used again. + * + * \param p_meta_desc a media descriptor object. */ -void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_release( + libvlc_media_t *p_meta_desc ); + /** - * Go to previous playlist item (starts playback if it was stopped) - * \param p_instance the instance to use - * \param p_exception an initialized exception + * Get the media resource locator (mrl) from a media descriptor object + * + * \param p_md a media descriptor object + * \param p_e an initialized exception object + * \return string with mrl of media descriptor object */ -void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md, + libvlc_exception_t * p_e ); /** - * Remove all playlist items - * \param p_instance the instance - * \param p_exception an initialized exception + * Duplicate a media descriptor object. + * + * \param p_meta_desc a media descriptor object. */ -void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * ); /** - * Go to next playlist item - * \param p_instance the instance - * \param p_exception an initialized exception + * Read the meta of the media. + * + * \param p_meta_desc the media to read + * \param e_meta_desc the meta to read + * \param p_e an initialized exception pointer + * \return the media's meta */ -void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * ); - +VLC_PUBLIC_API char * libvlc_media_get_meta( + libvlc_media_t *p_meta_desc, + libvlc_meta_t e_meta, + libvlc_exception_t *p_e ); /** - * Go to Previous playlist item - * \param p_instance the instance - * \param p_exception an initialized exception + * Get current state of media descriptor object. Possible media states + * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0, + * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused, + * libvlc_Stopped, libvlc_Ended, + * libvlc_Error). + * + * @see libvlc_state_t + * \param p_meta_desc a media descriptor object + * \param p_e an initialized exception object + * \return state of media descriptor object */ -void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state( + libvlc_media_t *p_meta_desc, + libvlc_exception_t *p_e ); /** - * Add an item at the end of the playlist - * If you need more advanced options, \see libvlc_playlist_add_extended - * \param p_instance the instance - * \param psz_uri the URI to open, using VLC format - * \param psz_name a name that you might want to give or NULL - * \return the identifier of the new item + * Get subitems of media descriptor object. This will increment + * the reference count of supplied media descriptor object. Use + * libvlc_media_list_release() to decrement the reference counting. + * + * \param p_md media descriptor object + * \param p_e initalized exception object + * \return list of media descriptor subitems or NULL */ -int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *, - libvlc_exception_t * ); - +VLC_PUBLIC_API libvlc_media_list_t * + libvlc_media_subitems( libvlc_media_t *p_md, + libvlc_exception_t *p_e ); /** - * Add an item at the end of the playlist, with additional input options - * \param p_instance the instance - * \param psz_uri the URI to open, using VLC format - * \param psz_name a name that you might want to give or NULL - * \param i_options the number of options to add - * \param ppsz_options strings representing the options to add - * \return the identifier of the new item + * Get event manager from media descriptor object. + * NOTE: this function doesn't increment reference counting. + * + * \param p_md a media descriptor object + * \param p_e an initialized exception object + * \return event manager object */ -int libvlc_playlist_add_extended( libvlc_instance_t *, const char *, - const char *, int, const char **, - libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_event_manager_t * + libvlc_media_event_manager( libvlc_media_t * p_md, + libvlc_exception_t * p_e ); +/** + * Get duration of media descriptor object item. + * + * \param p_md media descriptor object + * \param p_e an initialized exception object + * \return duration of media item + */ +VLC_PUBLIC_API libvlc_time_t + libvlc_media_get_duration( libvlc_media_t * p_md, + libvlc_exception_t * p_e ); -int libvlc_playlist_delete_item( libvlc_instance_t *, int, - libvlc_exception_t * ); - -typedef struct libvlc_input_t libvlc_input_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 +/** + * Get preparsed status for media descriptor object. + * + * \param p_md media descriptor object + * \param p_e an initialized exception object + * \return true if media object has been preparsed otherwise it returns false */ -libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *, - libvlc_exception_t * ); +VLC_PUBLIC_API int + libvlc_media_is_preparsed( libvlc_media_t * p_md, + libvlc_exception_t * p_e ); +/** + * Sets media descriptor's user_data. user_data is specialized data + * accessed by the host application, VLC.framework uses it as a pointer to + * an native object that references a libvlc_media_t pointer + * + * \param p_md media descriptor object + * \param p_new_user_data pointer to user data + * \param p_e an initialized exception object + */ +VLC_PUBLIC_API void + libvlc_media_set_user_data( libvlc_media_t * p_md, + void * p_new_user_data, + libvlc_exception_t * p_e); +/** + * Get media descriptor's user_data. user_data is specialized data + * accessed by the host application, VLC.framework uses it as a pointer to + * an native object that references a libvlc_media_t pointer + * + * \param p_md media descriptor object + * \param p_e an initialized exception object + */ +VLC_PUBLIC_API void * + libvlc_media_get_user_data( libvlc_media_t * p_md, + libvlc_exception_t * p_e); /** @}*/ /***************************************************************************** - * Input + * Media Player *****************************************************************************/ -/** defgroup libvlc_input Input +/** \defgroup libvlc_media_player libvlc_media_player * \ingroup libvlc - * LibVLC Input handling + * LibVLC Media Player, object that let you play a media + * in a custom drawable * @{ */ -/** Free an input object - * \param p_input the input to free +/** + * 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 */ -void libvlc_input_free( libvlc_input_t * ); +VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_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_bool_t libvlc_input_has_vout ( libvlc_input_t *, libvlc_exception_t *); -float libvlc_input_get_fps ( libvlc_input_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 * ); -/** defgroup libvlc_video Video - * \ingroup libvlc - * LibVLC Video handling - * @{ +/** + * Release a media_player after use + * Decrement the reference count of a media player object. If the + * reference count is 0, then libvlc_media_player_release() will + * release the media player object. If the media player object + * has been released, then it should not be used again. + * + * \param p_mi the Media Player to free */ +VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * ); /** - * Toggle fullscreen status on video output - * \param p_input the input - * \param p_exception an initialized exception + * Retain a reference to a media player object. Use + * libvlc_media_player_release() to decrement reference count. + * + * \param p_mi media player object */ -void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * ); /** - * Enable or disable fullscreen on a video output - * \param p_input the input - * \param b_fullscreen boolean for fullscreen status - * \param p_exception an initialized exception + * 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 */ -void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * ); /** - * Get current fullscreen status - * \param p_input the input - * \param p_exception an initialized exception - * \return the fullscreen status (boolean) + * 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 */ -int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * ); - +VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * ); + /** - * Get current video height - * \param p_input the input - * \param p_exception an initialized exception - * \return the video height + * 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 */ -int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * ); /** - * Get current video width - * \param p_input the input - * \param p_exception an initialized exception - * \return the video width + * is_playing + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return 1 if the media player is playing, 0 otherwise */ -int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * ); /** - * Take a snapshot of the current video window - * \param p_input the input - * \param psz_filepath the path where to save the screenshot to - * \param p_exception an initialized exception + * Play + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer */ -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_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * ); - /** - * Resize the 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) + * Pause + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer */ -void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *); - +VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, 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; + * 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 * ); /** - * Get current mute status - * \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) + * Set the agl handler where the media player should render its video output. + * + * \param p_mi the Media Player + * \param drawable the agl handler + * \param p_e an initialized exception pointer */ -int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable, libvlc_exception_t *p_e ); +/** + * Get the agl handler previously set with libvlc_media_player_set_agl(). + * + * \return the agl handler or 0 if none where set + */ +VLC_PUBLIC_API uint32_t libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi ); + +/** + * Set the agl handler where the media player should render its video output. + * + * \param p_mi the Media Player + * \param drawable the agl handler + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e ); -/** @} */ +/** + * Get the agl handler previously set with libvlc_media_player_set_agl(). + * + * \return the agl handler or 0 if none where set + */ +VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi ); /** - * defgroup libvlc_vlm VLM - * \ingroup libvlc - * LibVLC VLM handling - * @{ + * Set an X Window System drawable where the media player should render its + * video output. If LibVLC was built without X11 output support, then this has + * no effects. + * + * The specified identifier must correspond to an existing Input/Output class + * X11 window. Pixmaps are not supported. The caller shall ensure that + * the X11 server is the same as the one the VLC instance has been configured + * with. + * If XVideo is not used, it is assumed that the drawable has the + * following properties in common with the default X11 screen: depth, scan line + * pad, black pixel. This is a bug. + * + * \param p_mi the Media Player + * \param drawable the ID of the X window + * \param p_e an initialized exception pointer */ +VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e ); -/** defgroup libvlc_audio Audio - * \ingroup libvlc - * LibVLC Audio handling - * @{ +/** + * Get the X Window System window identifier previously set with + * libvlc_media_player_set_xwindow(). Note that this will return the identifier + * even if VLC is not currently using it (for instance if it is playing an + * audio-only input). + * + * \return an X window ID, or 0 if none where set. */ +VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi ); /** - * Get current mute status - * \param p_instance libvlc instance - * \param p_exception an initialized exception - * \return the mute status (boolean) + * Set a Win32/Win64 API window handle (HWND) where the media player should + * render its video output. If LibVLC was built without Win32/Win64 API output + * support, then this has no effects. + * + * \param p_mi the Media Player + * \param drawable windows handle of the drawable + * \param p_e an initialized exception pointer */ -vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e ); /** - * Set mute status - * \param p_instance libvlc instance - * \param status If status is VLC_TRUE then mute, otherwise unmute - * \param p_exception an initialized exception - * \return void + * Get the Windows API window handle (HWND) previously set with + * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC + * is not currently outputting any video to it. + * + * \return a window handle or NULL if there are none. */ -void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * ); +VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi ); + + +/** \bug This might go away ... to be replaced by a broader system */ /** - * Get current audio level - * \param p_instance libvlc instance - * \param p_exception an initialized exception - * \return the audio level (int) + * Get the current movie length (in ms). + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return the movie length (in ms). */ -int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *); +/** + * Get the current movie time (in ms). + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return the movie time (in ms). + */ +VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_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 + * Set the movie time (in ms). + * + * \param p_mi the Media Player + * \param the movie time (in ms). + * \param p_e an initialized exception pointer */ -void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *); -/** @} */ +/** + * Get movie position. + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return movie position + */ +VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *); + +/** + * Set movie position. + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return movie position + */ +VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *); +/** + * Set movie chapter + * + * \param p_mi the Media Player + * \param i_chapter chapter number to play + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *); /** - * Add a broadcast, with one input - * \param p_instance the instance - * \param psz_name the name of the new broadcast - * \param psz_input the input MRL - * \param psz_output the output MRL (the parameter to the "sout" variable) - * \param i_options number of additional options - * \param ppsz_options additional options - * \param b_enabled boolean for enabling the new broadcast - * \param b_loop Should this broadcast be played in loop ? - * \param p_exception an initialized exception + * Get movie chapter + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return chapter number currently playing */ -void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* , - int, char **, int, int, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * ); /** - * Delete a media (vod or broadcast) - * \param p_instance the instance - * \param psz_name the media to delete - * \param p_exception an initialized exception + * Get movie chapter count + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return number of chapters in movie */ -void libvlc_vlm_del_media( libvlc_instance_t *, char *, 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 *); /** - * Enable or disable a media (vod or broadcast) - * \param p_instance the instance - * \param psz_name the media to work on - * \param b_enabled the new status - * \param p_exception an initialized exception + * Get title chapter count + * + * \param p_mi the Media Player + * \param i_title title + * \param p_e an initialized exception pointer + * \return number of chapters in title */ -void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int, - libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title( + libvlc_media_player_t *, int, libvlc_exception_t *); /** - * Set the output for a media - * \param p_instance the instance - * \param psz_name the media to work on - * \param psz_output the output MRL (the parameter to the "sout" variable) - * \param p_exception an initialized exception + * Set movie title + * + * \param p_mi the Media Player + * \param i_title title number to play + * \param p_e an initialized exception pointer */ -void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*, - libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *); /** - * Set a media's input MRL. This will delete all existing inputs and - * 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 + * Get movie title + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return title number currently playing + */ +VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *); + +/** + * Get movie title count + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return title number count + */ +VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *); + +/** + * Set previous chapter + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer */ -void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*, - libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *); +/** + * Set next chapter + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *); +/** + * Get movie play rate + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return movie play rate + */ +VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *); /** - * Set output for a media - * \param p_instance the instance - * \param psz_name the media to work on - * \param b_loop the new status - * \param p_exception an initialized exception + * Set movie play rate + * + * \param p_mi the Media Player + * \param movie play rate to set + * \param p_e an initialized exception pointer */ -void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int, - libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *); +/** + * Get current movie state + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return current movie state as libvlc_state_t + */ +VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *); +/** + * Get movie fps rate + * + * \param p_mi the Media Player + * \param p_e an initialized exception pointer + * \return frames per second (fps) for this playing movie + */ +VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *); +/** end bug */ /** - * Edit the parameters of a media. This will delete all existing inputs and - * add the specified one. - * \param p_instance the instance - * \param psz_name the name of the new broadcast - * \param psz_input the input MRL - * \param psz_output the output MRL (the parameter to the "sout" variable) - * \param i_options number of additional options - * \param ppsz_options additional options - * \param b_enabled boolean for enabling the new broadcast - * \param b_loop Should this broadcast be played in loop ? - * \param p_exception an initialized exception + * Does this media player have a video output? + * + * \param p_md the media player + * \param p_e an initialized exception pointer */ -void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* , - int, char **, int, int, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, 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 * ); + * 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 ); /** - * Stops 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_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * ); + * 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 ); - /** - * 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 * ); - - + * Release (free) libvlc_track_description_t + * + * \param p_track_description the structure to release + */ +VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description ); + +/** \defgroup libvlc_video libvlc_video + * \ingroup libvlc_media_player + * LibVLC Video handling + * @{ + */ + +/** + * Toggle fullscreen status on video output. + * + * \param p_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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 * ); + +/** + * Get the number of available video subtitles. + * + * \param p_mediaplayer the media player + * \param p_e an initialized exception pointer + * \return the number of available video subtitles + */ +VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * ); + +/** + * Get the description of available video subtitles. + * + * \param p_mediaplayer the media player + * \param p_e an initialized exception pointer + * \return list containing description of available video subtitles + */ +VLC_PUBLIC_API libvlc_track_description_t * + libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * ); + +/** + * Set new video subtitle. + * + * \param p_mediaplayer the media player + * \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 * ); + +/** + * Set new video subtitle file. + * + * \param p_mediaplayer the media player + * \param psz_subtitle new video subtitle file + * \param p_e an initialized exception pointer + * \return the success status (boolean) + */ +VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * ); + +/** + * Get the description of available titles. + * + * \param p_mediaplayer the media player + * \param p_e an initialized exception pointer + * \return list containing description of available titles + */ +VLC_PUBLIC_API libvlc_track_description_t * + libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * ); + +/** + * Get the description of available chapters for specific title. + * + * \param p_mediaplayer the media player + * \param i_title selected title + * \param p_e an initialized exception pointer + * \return list containing description of available chapter for title i_title + */ +VLC_PUBLIC_API libvlc_track_description_t * + libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * ); + +/** + * Get current crop filter geometry. + * + * \param p_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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_mediaplayer the media player + * \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 * ); + +/** + * Get number of available video tracks. + * + * \param p_mi media player + * \param p_e an initialized exception + * \return the number of available video tracks (int) + */ +VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *, libvlc_exception_t * ); + +/** + * Get the description of available video tracks. + * + * \param p_mi media player + * \param p_e an initialized exception + * \return list with description of available video tracks + */ +VLC_PUBLIC_API libvlc_track_description_t * + libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * ); + +/** + * Get current video track. + * + * \param p_mi media player + * \param p_e an initialized exception pointer + * \return the video track (int) + */ +VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * ); + +/** + * Set video track. + * + * \param p_mi media player + * \param i_track the track (int) + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_video_set_track( 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_mi media player instance + * \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 *, const char *,unsigned int, unsigned int, libvlc_exception_t * ); + +/** + * Resize the current video output window. + * + * \param p_mi media player 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 *); + +/** + * Tell windowless video output to redraw rectangular area (MacOS X only). + * + * \param p_mi media player 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 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 p_mi media player 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 *, libvlc_media_player_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 + * @{ + */ + +/** + * Audio device types + */ +typedef enum libvlc_audio_output_device_types_t { + libvlc_AudioOutputDevice_Error = -1, + libvlc_AudioOutputDevice_Mono = 1, + libvlc_AudioOutputDevice_Stereo = 2, + libvlc_AudioOutputDevice_2F2R = 4, + libvlc_AudioOutputDevice_3F2R = 5, + libvlc_AudioOutputDevice_5_1 = 6, + libvlc_AudioOutputDevice_6_1 = 7, + libvlc_AudioOutputDevice_7_1 = 8, + libvlc_AudioOutputDevice_SPDIF = 10 +} libvlc_audio_output_device_types_t; + +/** + * Audio channels + */ +typedef enum libvlc_audio_output_channel_t { + libvlc_AudioChannel_Error = -1, + libvlc_AudioChannel_Stereo = 1, + libvlc_AudioChannel_RStereo = 2, + libvlc_AudioChannel_Left = 3, + libvlc_AudioChannel_Right = 4, + libvlc_AudioChannel_Dolbys = 5 +} libvlc_audio_output_channel_t; + + +/** + * Get the list of available audio outputs + * + * \param p_instance libvlc instance + * \param p_e an initialized exception pointer + * \return list of available audio outputs, at the end free it with +* \see libvlc_audio_output_list_release \see libvlc_audio_output_t + */ +VLC_PUBLIC_API libvlc_audio_output_t * + libvlc_audio_output_list_get( libvlc_instance_t *, + libvlc_exception_t * ); + +/** + * Free the list of available audio outputs + * + * \param p_list list with audio outputs for release + */ +VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * ); + +/** + * Set the audio output. + * Change will be applied after stop and play. + * + * \param p_instance libvlc instance + * \param psz_name name of audio output, + * use psz_name of \see libvlc_audio_output_t + * \return true if function succeded + */ +VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *, + const char * ); + +/** + * Get count of devices for audio output, these devices are hardware oriented + * like analor or digital output of sound card + * + * \param p_instance libvlc instance + * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t + * \return number of devices + */ +VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *, + const char * ); + +/** + * Get long name of device, if not available short name given + * + * \param p_instance libvlc instance + * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t + * \param i_device device index + * \return long name of device + */ +VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *, + const char *, + int ); + +/** + * Get id name of device + * + * \param p_instance libvlc instance + * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t + * \param i_device device index + * \return id name of device, use for setting device, need to be free after use + */ +VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *, + const char *, + int ); + +/** + * Set device for using + * + * \param p_instance libvlc instance + * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t + * \param psz_device_id device + */ +VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *, + const char *, + const char * ); + +/** + * Get current audio device type. Device type describes something like + * character of output sound - stereo sound, 2.1, 5.1 etc + * + * \param p_instance vlc instance + * \param p_e an initialized exception pointer + * \return the audio devices type \see libvlc_audio_output_device_types_t + */ +VLC_PUBLIC_API int libvlc_audio_output_get_device_type( + libvlc_instance_t *, libvlc_exception_t * ); + +/** + * Set current audio device type. + * + * \param p_instance vlc instance + * \param device_type the audio device type, + according to \see libvlc_audio_output_device_types_t + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *, + int, + libvlc_exception_t * ); + + +/** + * 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) + */ +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_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 player + * \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 the description of available audio tracks. + * + * \param p_mi media player + * \param p_e an initialized exception + * \return list with description of available audio tracks + */ +VLC_PUBLIC_API libvlc_track_description_t * + libvlc_audio_get_track_description( 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 \see libvlc_audio_output_channel_t + */ +VLC_PUBLIC_API int + libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * ); + +/** + * Set current audio channel. + * + * \param p_instance vlc instance + * \param channel the audio channel, \see libvlc_audio_output_channel_t + * \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 + * @{ + */ + +/** + * Register for an event notification. + * + * \param p_event_manager the event manager to which you want to attach to. + * Generally it is obtained by vlc_my_object_event_manager() where + * my_object is the object you want to listen to. + * \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 + */ +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 ); + +/** + * Unregister an event notification. + * + * \param p_event_manager the 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 ); + +/** + * Get an event's type name. + * + * \param i_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 ); + +/** + * Release media library object. This functions decrements the + * reference count of the media library object. If it reaches 0, + * then the object will be released. + * + * \param p_mlib media library object + */ +VLC_PUBLIC_API void + libvlc_media_library_release( libvlc_media_library_t * p_mlib ); + +/** + * Retain a reference to a media library object. This function will + * increment the reference counting for this object. Use + * libvlc_media_library_release() to decrement the reference count. + * + * \param p_mlib media library object + */ +VLC_PUBLIC_API void + libvlc_media_library_retain( libvlc_media_library_t * p_mlib ); + +/** + * Load media library. + * + * \param p_mlib media library object + * \param p_e an initialized exception object. + */ +VLC_PUBLIC_API void + libvlc_media_library_load( libvlc_media_library_t * p_mlib, + libvlc_exception_t * p_e ); + +/** + * Save media library. + * + * \param p_mlib media library object + * \param p_e an initialized exception object. + */ +VLC_PUBLIC_API void + libvlc_media_library_save( libvlc_media_library_t * p_mlib, + libvlc_exception_t * p_e ); + +/** + * Get media library subitems. + * + * \param p_mlib media library object + * \param p_e an initialized exception object. + * \return media list subitems + */ +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 + * @{ + */ + +/** + * Discover media service by name. + * + * \param p_inst libvlc instance + * \param psz_name service name + * \param p_e an initialized exception object + * \return media discover object + */ +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 ); + +/** + * Release media discover object. If the reference count reaches 0, then + * the object will be released. + * + * \param p_mdis media service discover object + */ +VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis ); + +/** + * Get media service discover object its localized name. + * + * \param media discover object + * \return localized name + */ +VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis ); + +/** + * Get media service discover media list. + * + * \param p_mdis media service discover object + * \return list of media items + */ +VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis ); + +/** + * Get event manager from media service discover object. + * + * \param p_mdis media service discover object + * \return event manager object. + */ +VLC_PUBLIC_API libvlc_event_manager_t * + libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis ); + +/** + * Query if media service discover object is running. + * + * \param p_mdis media service discover object + * \return true if running, false if not + */ +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 + * @{ + */ + +/** + * 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 ); + +/** + * 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 ); + +/** + * Open a VLC message log instance. + * + * \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 *); + +/** + * Close a VLC message log instance. + * + * \param p_log libvlc log instance + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *); + +/** + * Returns the number of messages in a log instance. + * + * \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 *); + +/** + * Clear a log instance. + * + * 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 + */ +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 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 *); + +/** + * Release a previoulsy allocated iterator. + * + * \param p_iter libvlc log iterator + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); + +/** + * Return whether log iterator has more messages. + * + * \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 ); + +/** + * Return the next log message. + * + * The message contents must not be freed + * + * \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, + libvlc_exception_t *p_e ); -/** @} */ /** @} */ # ifdef __cplusplus