X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_media_player.h;h=105090eafc13e384e06fbeee2935c4c595a5958a;hb=57a4f916876060dc51583f40483522a0ad1de8bc;hp=4694698088d030f953363baeb4a6465e114e4d26;hpb=658686029ee756fbf4beb8e0cdcc4b0bc5dd18ed;p=vlc diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h index 4694698088..105090eafc 100644 --- a/include/vlc/libvlc_media_player.h +++ b/include/vlc/libvlc_media_player.h @@ -1,7 +1,7 @@ /***************************************************************************** * libvlc_media_player.h: libvlc_media_player external API ***************************************************************************** - * Copyright (C) 1998-2009 the VideoLAN team + * Copyright (C) 1998-2010 the VideoLAN team * $Id$ * * Authors: Clément Stenac @@ -31,13 +31,16 @@ #ifndef VLC_LIBVLC_MEDIA_PLAYER_H #define VLC_LIBVLC_MEDIA_PLAYER_H 1 +# ifdef __cplusplus +extern "C" { +# endif + /***************************************************************************** * Media Player *****************************************************************************/ -/** \defgroup libvlc_media_player libvlc_media_player +/** \defgroup libvlc_media_player LibVLC media player * \ingroup libvlc - * LibVLC Media Player, object that let you play a media - * in a custom drawable + * A LibVLC media player plays one media (usually in a custom drawable). * @{ */ @@ -52,7 +55,7 @@ typedef struct libvlc_track_description_t int i_id; char *psz_name; struct libvlc_track_description_t *p_next; - + } libvlc_track_description_t; /** @@ -64,7 +67,7 @@ typedef struct libvlc_audio_output_t char *psz_name; char *psz_description; struct libvlc_audio_output_t *p_next; - + } libvlc_audio_output_t; /** @@ -76,24 +79,51 @@ typedef struct libvlc_rectangle_t int bottom, right; } libvlc_rectangle_t; +/** + * Marq options definition + */ +typedef enum libvlc_video_marquee_option_t { + libvlc_marquee_Enable = 0, + libvlc_marquee_Text, /** string argument */ + libvlc_marquee_Color, + libvlc_marquee_Opacity, + libvlc_marquee_Position, + libvlc_marquee_Refresh, + libvlc_marquee_Size, + libvlc_marquee_Timeout, + libvlc_marquee_X, + libvlc_marquee_Y +} libvlc_video_marquee_option_t; + +/** + * Navigation mode + */ +typedef enum libvlc_navigate_mode_t +{ + libvlc_navigate_activate = 0, + libvlc_navigate_up, + libvlc_navigate_down, + libvlc_navigate_left, + libvlc_navigate_right, +} libvlc_navigate_mode_t; /** * Create an empty Media Player object * * \param p_libvlc_instance the libvlc instance in which the Media Player * should be created. - * \param p_e an initialized exception pointer + * \return a new media player object, or NULL on error. */ -VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *p_libvlc_instance ); /** * 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 + * \return a new media player object, or NULL on error. */ -VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *p_md ); /** * Release a media_player after use @@ -104,7 +134,7 @@ VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvl * * \param p_mi the Media Player to free */ -VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * ); +VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t *p_mi ); /** * Retain a reference to a media player object. Use @@ -112,7 +142,7 @@ VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * ); * * \param p_mi media player object */ -VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * ); +VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t *p_mi ); /** * Set the media that will be used by the media_player. If any, @@ -121,90 +151,170 @@ VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * ); * \param p_mi the Media Player * \param p_md the Media. Afterwards the p_md can be safely * destroyed. - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *p_mi, + libvlc_media_t *p_md ); /** * Get the media used by the media_player. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer * \return the media associated with p_mi, or NULL if no * media is associated */ -VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *p_mi ); /** * Get the Event Manager from which the media player send event. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer * \return the event manager associated with p_mi */ -VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *p_mi ); /** * 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 */ -VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *p_mi ); /** * Play * * \param p_mi the Media Player - * \param p_e an initialized exception pointer + * \return 0 if playback started (and was already started), or -1 on error. + */ +VLC_PUBLIC_API int libvlc_media_player_play ( libvlc_media_player_t *p_mi ); + +/** + * Pause or resume (no effect if there is no media) + * + * \param mp the Media Player + * \param do_pause play/resume if zero, pause if non-zero + * \version LibVLC 1.1.1 or later */ -VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_set_pause ( libvlc_media_player_t *mp, + int do_pause ); /** - * Pause + * Toggle pause (no effect if there is no media) * * \param p_mi the Media Player - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *p_mi ); /** - * Stop + * Stop (no effect if there is no media) * * \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 * ); +VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *p_mi ); /** - * Set the agl handler where the media player should render its video output. + * Set callbacks and private data to render decoded video to a custom area + * in memory. Use libvlc_video_set_format() to configure the decoded format. + * + * Whenever a new video frame needs to be decoded, the lock callback is + * invoked. Depending on the video chroma, one or three pixel planes of + * adequate dimensions must be returned via the second parameter. Those + * planes must be aligned on 32-bytes boundaries. + * + * When the video frame is decoded, the unlock callback is invoked. The + * second parameter to the callback corresponds is the return value of the + * lock callback. The third parameter conveys the pixel planes for convenience. + * + * When the video frame needs to be shown, as determined by the media playback + * clock, the display callback is invoked. The second parameter also conveys + * the return value from the lock callback. + * + * \param mp the media player + * \param lock callback to allocate video memory + * \param unlock callback to release video memory + * \param opaque private pointer for the three callbacks (as first parameter) + * \version LibVLC 1.1.1 or later + */ +VLC_PUBLIC_API +void libvlc_video_set_callbacks( libvlc_media_player_t *mp, + void *(*lock) (void *opaque, void **plane), + void (*unlock) (void *opaque, void *picture, void *const *plane), + void (*display) (void *opaque, void *picture), + void *opaque ); + +/** + * Set decoded video chroma and dimensions. This only works in combination with + * libvlc_video_set_callbacks(). + * + * \param mp the media player + * \param chroma a four-characters string identifying the chroma + * (e.g. "RV32" or "I420") + * \param width pixel width + * \param height pixel height + * \param pitch line pitch (in bytes) + * \version LibVLC 1.1.1 or later + */ +VLC_PUBLIC_API +void libvlc_video_set_format( libvlc_media_player_t *mp, const char *chroma, + unsigned width, unsigned height, + unsigned pitch ); + +/** + * Set the NSView handler where the media player should render its video output. + * + * Use the vout called "macosx". + * + * The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding + * protocol: + * + * @begincode + * \@protocol VLCOpenGLVideoViewEmbedding + * - (void)addVoutSubview:(NSView *)view; + * - (void)removeVoutSubview:(NSView *)view; + * \@end + * @endcode + * + * Or it can be an NSView object. + * + * If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then + * the following code should work: + * @begincode + * { + * NSView *video = [[NSView alloc] init]; + * QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent); + * libvlc_media_player_set_nsobject(mp, video); + * [video release]; + * } + * @endcode + * + * You can find a live example in VLCVideoView in VLCKit.framework. * * \param p_mi the Media Player - * \param drawable the agl handler - * \param p_e an initialized exception pointer + * \param drawable the drawable that is either an NSView or an object following + * the VLCOpenGLVideoViewEmbedding protocol. */ -VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable, libvlc_exception_t *p_e ); +VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable ); /** - * Get the agl handler previously set with libvlc_media_player_set_agl(). + * Get the NSView handler previously set with libvlc_media_player_set_nsobject(). * - * \return the agl handler or 0 if none where set + * \param p_mi the Media Player + * \return the NSView handler or 0 if none where set */ VLC_PUBLIC_API void * 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 ); +VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable ); /** * Get the agl handler previously set with libvlc_media_player_set_agl(). * + * \param p_mi the Media Player * \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 ); @@ -218,15 +328,11 @@ VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_m * 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 ); +VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable ); /** * Get the X Window System window identifier previously set with @@ -234,6 +340,7 @@ VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_m * even if VLC is not currently using it (for instance if it is playing an * audio-only input). * + * \param p_mi the Media Player * \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 ); @@ -245,15 +352,15 @@ VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t * * \param p_mi the Media Player * \param drawable windows handle of the drawable - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e ); +VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable ); /** * 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. * + * \param p_mi the Media Player * \return a window handle or NULL if there are none. */ VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi ); @@ -266,190 +373,203 @@ VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi * 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). + * \return the movie length (in ms), or -1 if there is no media. */ -VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *p_mi ); /** * 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). + * \return the movie time (in ms), or -1 if there is no media. */ -VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *p_mi ); /** - * Set the movie time (in ms). + * Set the movie time (in ms). This has no effect if no media is being played. + * Not all formats and protocols support this. * * \param p_mi the Media Player - * \param the movie time (in ms). - * \param p_e an initialized exception pointer + * \param i_time the movie time (in ms). */ -VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvlc_time_t i_time ); /** * Get movie position. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return movie position + * \return movie position, or -1. in case of error */ -VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *p_mi ); /** - * Set movie position. + * Set movie position. This has no effect if playback is not enabled. + * This might not work depending on the underlying input format and protocol. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return movie position + * \param f_pos the position */ -VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *p_mi, float f_pos ); /** - * Set movie chapter + * Set movie chapter (if applicable). * * \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 *); +VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *p_mi, int i_chapter ); /** - * Get movie chapter + * Get movie chapter. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return chapter number currently playing + * \return chapter number currently playing, or -1 if there is no media. */ -VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *p_mi ); /** * Get movie chapter count * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return number of chapters in movie + * \return number of chapters in movie, or -1. + */ +VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *p_mi ); + +/** + * Is the player able to play + * + * \param p_mi the Media Player + * \return boolean */ -VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *); -VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_player_will_play( libvlc_media_player_t *p_mi ); /** * 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 + * \return number of chapters in title, or -1 */ VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title( - libvlc_media_player_t *, int, libvlc_exception_t *); + libvlc_media_player_t *p_mi, int i_title ); /** * Set movie title * * \param p_mi the Media Player * \param i_title title number to play - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *p_mi, int i_title ); /** * Get movie title * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return title number currently playing + * \return title number currently playing, or -1 */ -VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *p_mi ); /** * Get movie title count * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return title number count + * \return title number count, or -1 */ -VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *p_mi ); /** - * Set previous chapter + * Set previous chapter (if applicable) * * \param p_mi the Media Player - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *p_mi ); /** - * Set next chapter + * Set next chapter (if applicable) * * \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 *); +VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *p_mi ); /** - * Get movie play rate + * Get the requested movie play rate. + * @warning Depending on the underlying media, the requested rate may be + * different from the real playback 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 *); +VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *p_mi ); /** * Set movie play rate * * \param p_mi the Media Player - * \param movie play rate to set - * \param p_e an initialized exception pointer + * \param rate movie play rate to set + * \return -1 if an error was detected, 0 otherwise (but even then, it might + * not actually work depending on the underlying media protocol) */ -VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_player_set_rate( libvlc_media_player_t *p_mi, float rate ); /** * 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 + * \return the current state of the media player (playing, paused, ...) \see libvlc_state_t */ -VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *p_mi ); /** * 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 + * \return frames per second (fps) for this playing movie, or 0 if unspecified */ -VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *p_mi ); /** end bug */ /** - * Does this media player have a video output? + * How many video outputs does this media player have? * - * \param p_md the media player - * \param p_e an initialized exception pointer + * \param p_mi the media player + * \return the number of video outputs */ -VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi ); /** * Is this media player seekable? * - * \param p_input the input - * \param p_e an initialized exception pointer + * \param p_mi the media player + * \return true if the media player can seek */ -VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e ); +VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi ); /** * Can this media player be paused? * - * \param p_input the input - * \param p_e an initialized exception pointer + * \param p_mi the media player + * \return true if the media player can pause + */ +VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi ); + + +/** + * Display the next frame (if supported) + * + * \param p_mi the media player + */ +VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_mi ); + +/** + * Navigate through DVD Menu + * + * \param p_mi the Media Player + * \param navigate the Navigation mode + * \version libVLC 1.2.0 or later */ -VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e ); +VLC_PUBLIC_API void libvlc_media_player_navigate( libvlc_media_player_t* p_mi, + unsigned navigate ); /** * Release (free) libvlc_track_description_t @@ -458,66 +578,144 @@ VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, l */ 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 +/** \defgroup libvlc_video LibVLC video controls * @{ */ /** - * Toggle fullscreen status on video output. + * Toggle fullscreen status on non-embedded video outputs. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer + * @warning The same limitations applies to this function + * as to libvlc_set_fullscreen(). + * + * \param p_mi the media player */ -VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi ); /** - * Enable or disable fullscreen on a video output. + * Enable or disable fullscreen. + * + * @warning With most window managers, only a top-level windows can be in + * full-screen mode. Hence, this function will not operate properly if + * libvlc_media_player_set_xwindow() was used to embed the video in a + * non-top-level window. In that case, the embedding window must be reparented + * to the root window before fullscreen mode is enabled. You will want + * to reparent it back to its normal parent when disabling fullscreen. * - * \param p_mediaplayer the media player + * \param p_mi 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 * ); +VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen ); /** * Get current fullscreen status. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer + * \param p_mi the media player * \return the fullscreen status (boolean) */ -VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *p_mi ); + +/** + * Enable or disable key press events handling, according to the LibVLC hotkeys + * configuration. By default and for historical reasons, keyboard events are + * handled by the LibVLC video widget. + * + * \note On X11, there can be only one subscriber for key press and mouse + * click events per window. If your application has subscribed to those events + * for the X window ID of the video widget, then LibVLC will not be able to + * handle key presses and mouse clicks in any case. + * + * \warning This function is only implemented for X11 and Win32 at the moment. + * + * \param p_mi the media player + * \param on true to handle key press events, false to ignore them. + */ +VLC_PUBLIC_API +void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on ); + +/** + * Enable or disable mouse click events handling. By default, those events are + * handled. This is needed for DVD menus to work, as well as a few video + * filters such as "puzzle". + * + * \note See also libvlc_video_set_key_input(). + * + * \warning This function is only implemented for X11 and Win32 at the moment. + * + * \param p_mi the media player + * \param on true to handle mouse click events, false to ignore them. + */ +VLC_PUBLIC_API +void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on ); + +/** + * Get the pixel dimensions of a video. + * + * \param p_mi media player + * \param num number of the video (starting from, and most commonly 0) + * \param px pointer to get the pixel width [OUT] + * \param py pointer to get the pixel height [OUT] + * \return 0 on success, -1 if the specified video does not exist + */ +VLC_PUBLIC_API +int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num, + unsigned *px, unsigned *py ); /** * Get current video height. + * You should use libvlc_video_get_size() instead. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer - * \return the video height + * \param p_mi the media player + * \return the video pixel height or 0 if not applicable */ -VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_DEPRECATED_API +int libvlc_video_get_height( libvlc_media_player_t *p_mi ); /** * Get current video width. + * You should use libvlc_video_get_size() instead. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer - * \return the video width + * \param p_mi the media player + * \return the video pixel width or 0 if not applicable */ -VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_DEPRECATED_API +int libvlc_video_get_width( libvlc_media_player_t *p_mi ); + +/** + * Get the mouse pointer coordinates over a video. + * Coordinates are expressed in terms of the decoded video resolution, + * not in terms of pixels on the screen/viewport (to get the latter, + * you can query your windowing system directly). + * + * Either of the coordinates may be negative or larger than the corresponding + * dimension of the video, if the cursor is outside the rendering area. + * + * @warning The coordinates may be out-of-date if the pointer is not located + * on the video rendering area. LibVLC does not track the pointer if it is + * outside of the video widget. + * + * @note LibVLC does not support multiple pointers (it does of course support + * multiple input devices sharing the same pointer) at the moment. + * + * \param p_mi media player + * \param num number of the video (starting from, and most commonly 0) + * \param px pointer to get the abscissa [OUT] + * \param py pointer to get the ordinate [OUT] + * \return 0 on success, -1 if the specified video does not exist + */ +VLC_PUBLIC_API +int libvlc_video_get_cursor( libvlc_media_player_t *p_mi, unsigned num, + int *px, int *py ); /** * Get the current video scaling factor. * See also libvlc_video_set_scale(). * - * \param p_mediaplayer the media player + * \param p_mi the media player * \return the currently configured zoom factor, or 0. if the video is set * to fit to the output window/drawable automatically. */ -VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *p_mi ); /** * Set the video scaling factor. That is the ratio of the number of pixels on @@ -527,178 +725,165 @@ VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *, * * Note that not all video outputs support scaling. * - * \param p_mediaplayer the media player - * \param i_factor the scaling factor, or zero + * \param p_mi the media player + * \param f_factor the scaling factor, or zero */ -VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *p_mi, float f_factor ); /** * Get current video aspect ratio. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer - * \return the video aspect ratio + * \param p_mi the media player + * \return the video aspect ratio or NULL if unspecified + * (the result must be released with free() or libvlc_free()). */ -VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi ); /** * 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 + * \param p_mi the media player + * \param psz_aspect new video aspect-ratio or NULL to reset to default + * \note Invalid aspect ratios are ignored. */ -VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi, const char *psz_aspect ); /** * Get current video subtitle. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer - * \return the video subtitle selected + * \param p_mi the media player + * \return the video subtitle selected, or -1 if none */ -VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *p_mi ); /** * Get the number of available video subtitles. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer + * \param p_mi the media player * \return the number of available video subtitles */ -VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi ); /** * Get the description of available video subtitles. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer + * \param p_mi the media player * \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 * ); + libvlc_video_get_spu_description( libvlc_media_player_t *p_mi ); /** * Set new video subtitle. * - * \param p_mediaplayer the media player + * \param p_mi the media player * \param i_spu new video subtitle to select - * \param p_e an initialized exception pointer + * \return 0 on success, -1 if out of range */ -VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu ); /** * Set new video subtitle file. * - * \param p_mediaplayer the media player + * \param p_mi 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 * ); +VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi, const char *psz_subtitle ); /** * Get the description of available titles. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer + * \param p_mi the media player * \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 * ); + libvlc_video_get_title_description( libvlc_media_player_t *p_mi ); /** * Get the description of available chapters for specific title. * - * \param p_mediaplayer the media player + * \param p_mi 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 * ); + libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi, int i_title ); /** * Get current crop filter geometry. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer - * \return the crop filter geometry + * \param p_mi the media player + * \return the crop filter geometry or NULL if unset */ -VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi ); /** * 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 + * \param p_mi the media player + * \param psz_geometry new crop filter geometry (NULL to unset) */ -VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API +void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi, const char *psz_geometry ); /** * Get current teletext page requested. * - * \param p_mediaplayer the media player - * \param p_e an initialized exception pointer + * \param p_mi the media player * \return the current teletext page requested. */ -VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *p_mi ); /** * Set new teletext page to retrieve. * - * \param p_mediaplayer the media player + * \param p_mi 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 * ); +VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page ); + +/** + * Toggle teletext transparent status on video output. + * + * \param p_mi the media player + */ +VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *p_mi ); /** * 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 * ); +VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *p_mi ); /** * 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 + * \return list with description of available video tracks, or NULL on error */ VLC_PUBLIC_API libvlc_track_description_t * - libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * ); + libvlc_video_get_track_description( libvlc_media_player_t *p_mi ); /** * Get current video track. * * \param p_mi media player - * \param p_e an initialized exception pointer - * \return the video track (int) + * \return the video track (int) or -1 if none */ -VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *p_mi ); /** * Set video track. * * \param p_mi media player * \param i_track the track (int) - * \param p_e an initialized exception pointer + * \return 0 on success, -1 if out of range */ -VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * ); +VLC_PUBLIC_API +int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track ); /** * Take a snapshot of the current video window. @@ -707,18 +892,172 @@ VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc * If i_width XOR i_height is 0, original aspect-ratio is preserved. * * \param p_mi media player instance + * \param num number of video output (typically 0 for the first/only one) * \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 + * \return 0 on success, -1 if the video was not found + */ +VLC_PUBLIC_API +int libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num, + const char *psz_filepath, unsigned int i_width, + unsigned int i_height ); + +/** + * Enable or disable deinterlace filter + * + * \param p_mi libvlc media player + * \param psz_mode type of deinterlace filter, NULL to disable + */ +VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi, + const char *psz_mode ); + +/** + * Get an integer marquee option value + * + * \param p_mi libvlc media player + * \param option marq option to get \see libvlc_video_marquee_int_option_t + */ +VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi, + unsigned option ); + +/** + * Get a string marquee option value + * + * \param p_mi libvlc media player + * \param option marq option to get \see libvlc_video_marquee_string_option_t + */ +VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi, + unsigned option ); + +/** + * Enable, disable or set an integer marquee option + * + * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0) + * or disabling (arg 0) the marq filter. + * + * \param p_mi libvlc media player + * \param option marq option to set \see libvlc_video_marquee_int_option_t + * \param i_val marq option value + */ +VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi, + unsigned option, int i_val ); + +/** + * Set a marquee string option + * + * \param p_mi libvlc media player + * \param option marq option to set \see libvlc_video_marquee_string_option_t + * \param psz_text marq option value + */ +VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi, + unsigned option, const char *psz_text ); + +/** option values for libvlc_video_{get,set}_logo_{int,string} */ +enum libvlc_video_logo_option_t { + libvlc_logo_enable, + libvlc_logo_file, /**< string argument, "file,d,t;file,d,t;..." */ + libvlc_logo_x, + libvlc_logo_y, + libvlc_logo_delay, + libvlc_logo_repeat, + libvlc_logo_opacity, + libvlc_logo_position, +}; + +/** + * Get integer logo option. + * + * \param p_mi libvlc media player instance + * \param option logo option to get, values of libvlc_video_logo_option_t + */ +VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi, + unsigned option ); + +/** + * Set logo option as integer. Options that take a different type value + * are ignored. + * Passing libvlc_logo_enable as option value has the side effect of + * starting (arg !0) or stopping (arg 0) the logo filter. + * + * \param p_mi libvlc media player instance + * \param option logo option to set, values of libvlc_video_logo_option_t + * \param value logo option value + */ +VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi, + unsigned option, int value ); + +/** + * Set logo option as string. Options that take a different type value + * are ignored. + * + * \param p_mi libvlc media player instance + * \param option logo option to set, values of libvlc_video_logo_option_t + * \param psz_value logo option value + */ +VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi, + unsigned option, const char *psz_value ); + + +/** option values for libvlc_video_{get,set}_adjust_{int,float,bool} */ +enum libvlc_video_adjust_option_t { + libvlc_adjust_Enable = 0, + libvlc_adjust_Contrast, + libvlc_adjust_Brightness, + libvlc_adjust_Hue, + libvlc_adjust_Saturation, + libvlc_adjust_Gamma, +}; + +/** + * Get integer adjust option. + * + * \param p_mi libvlc media player instance + * \param option adjust option to get, values of libvlc_video_adjust_option_t + * \version LibVLC 1.1.1 and later. + */ +VLC_PUBLIC_API int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi, + unsigned option ); + +/** + * Set adjust option as integer. Options that take a different type value + * are ignored. + * Passing libvlc_adjust_enable as option value has the side effect of + * starting (arg !0) or stopping (arg 0) the adjust filter. + * + * \param p_mi libvlc media player instance + * \param option adust option to set, values of libvlc_video_adjust_option_t + * \param value adjust option value + * \version LibVLC 1.1.1 and later. + */ +VLC_PUBLIC_API void libvlc_video_set_adjust_int( libvlc_media_player_t *p_mi, + unsigned option, int value ); + +/** + * Get float adjust option. + * + * \param p_mi libvlc media player instance + * \param option adjust option to get, values of libvlc_video_adjust_option_t + * \version LibVLC 1.1.1 and later. + */ +VLC_PUBLIC_API float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi, + unsigned option ); + +/** + * Set adjust option as float. Options that take a different type value + * are ignored. + * + * \param p_mi libvlc media player instance + * \param option adust option to set, values of libvlc_video_adjust_option_t + * \param value adjust option value + * \version LibVLC 1.1.1 and later. */ -VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_video_set_adjust_float( libvlc_media_player_t *p_mi, + unsigned option, float value ); /** @} video */ -/** \defgroup libvlc_audio libvlc_audio - * \ingroup libvlc_media_player - * LibVLC Audio handling +/** \defgroup libvlc_audio LibVLC audio controls * @{ */ @@ -754,32 +1093,31 @@ typedef enum 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 + * \return list of available audio outputs. It must be freed it with +* \see libvlc_audio_output_list_release \see libvlc_audio_output_t . + * In case of error, NULL is returned. */ VLC_PUBLIC_API libvlc_audio_output_t * - libvlc_audio_output_list_get( libvlc_instance_t *, - libvlc_exception_t * ); + libvlc_audio_output_list_get( libvlc_instance_t *p_instance ); /** * 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 * ); +VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t *p_list ); /** * Set the audio output. * Change will be applied after stop and play. * - * \param p_instance libvlc instance + * \param p_mi media player * \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 * ); +VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *p_mi, + const char *psz_name ); /** * Get count of devices for audio output, these devices are hardware oriented @@ -789,8 +1127,8 @@ VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *, * \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 * ); +VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *p_instance, + const char *psz_audio_output ); /** * Get long name of device, if not available short name given @@ -800,9 +1138,9 @@ VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_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 ); +VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *p_instance, + const char *psz_audio_output, + int i_device ); /** * Get id name of device @@ -812,149 +1150,157 @@ VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_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 ); +VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *p_instance, + const char *psz_audio_output, + int i_device ); /** - * Set device for using + * Set audio output device. Changes are only effective after stop and play. * - * \param p_instance libvlc instance + * \param p_mi media player * \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 * ); +VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *p_mi, + const char *psz_audio_output, + const char *psz_device_id ); /** * 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 + * \param p_mi media player * \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 * ); +VLC_PUBLIC_API int libvlc_audio_output_get_device_type( libvlc_media_player_t *p_mi ); /** * Set current audio device type. * - * \param p_instance vlc instance + * \param p_mi 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 * ); +VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_media_player_t *p_mi, + int device_type ); /** * Toggle mute status. * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \param p_mi media player */ -VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_media_player_t *p_mi ); /** * Get current mute status. * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \param p_mi media player * \return the mute status (boolean) */ -VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi ); /** * Set mute status. * - * \param p_instance libvlc instance + * \param p_mi media player * \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 * ); +VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_media_player_t *p_mi, int status ); /** * Get current audio level. * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \param p_mi media player * \return the audio level (int) */ -VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t *p_mi ); /** * Set current audio level. * - * \param p_instance libvlc instance + * \param p_mi media player * \param i_volume the volume (int) - * \param p_e an initialized exception pointer + * \return 0 if the volume was set, -1 if it was out of range */ -VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_audio_set_volume( libvlc_media_player_t *p_mi, int i_volume ); /** * 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) + * \return the number of available audio tracks (int), or -1 if unavailable */ -VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi ); - /** +/** * 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 + * \return list with description of available audio tracks, or NULL */ VLC_PUBLIC_API libvlc_track_description_t * - libvlc_audio_get_track_description( libvlc_media_player_t *, libvlc_exception_t * ); + libvlc_audio_get_track_description( libvlc_media_player_t *p_mi ); /** * Get current audio track. * * \param p_mi media player - * \param p_e an initialized exception pointer - * \return the audio track (int) + * \return the audio track (int), or -1 if none. */ -VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *p_mi ); /** * Set current audio track. * * \param p_mi media player * \param i_track the track (int) - * \param p_e an initialized exception pointer + * \return 0 on success, -1 on error */ -VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track ); /** * Get current audio channel. * - * \param p_instance vlc instance - * \param p_e an initialized exception pointer + * \param p_mi media player * \return the audio channel \see libvlc_audio_output_channel_t */ -VLC_PUBLIC_API int - libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_media_player_t *p_mi ); /** * Set current audio channel. * - * \param p_instance vlc instance + * \param p_mi media player * \param channel the audio channel, \see libvlc_audio_output_channel_t - * \param p_e an initialized exception pointer + * \return 0 on success, -1 on error */ -VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, - int, - libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_audio_set_channel( libvlc_media_player_t *p_mi, int channel ); + +/** + * Get current audio delay. + * + * \param p_mi media player + * \return the audio delay (microseconds) + * \version LibVLC 1.1.1 or later + */ +VLC_PUBLIC_API int64_t libvlc_audio_get_delay( libvlc_media_player_t *p_mi ); + +/** + * Set current audio delay. The audio delay will be reset to zero each time the media changes. + * + * \param p_mi media player + * \param i_delay the audio delay (microseconds) + * \return 0 on success, -1 on error + * \version LibVLC 1.1.1 or later + */ +VLC_PUBLIC_API int libvlc_audio_set_delay( libvlc_media_player_t *p_mi, int64_t i_delay ); /** @} audio */ /** @} media_player */ +# ifdef __cplusplus +} +# endif + #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */