X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_media_player.h;h=fd97ff30b2b23ed8ab678b5208339a84ca8fc087;hb=09020b63ba7513eeaff38f1cc40e2b4937c61030;hp=3f73ea854740311d8121e01546c1748777bca5ea;hpb=a6bb43df184076e378d7c0bcf8b1df06db2ee7eb;p=vlc diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h index 3f73ea8547..fd97ff30b2 100644 --- a/include/vlc/libvlc_media_player.h +++ b/include/vlc/libvlc_media_player.h @@ -31,6 +31,10 @@ #ifndef VLC_LIBVLC_MEDIA_PLAYER_H #define VLC_LIBVLC_MEDIA_PLAYER_H 1 +# ifdef __cplusplus +extern "C" { +# endif + /***************************************************************************** * Media Player *****************************************************************************/ @@ -52,7 +56,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 +68,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 +80,39 @@ 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; /** * 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 * ); /** * 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 * ); /** * Release a media_player after use @@ -121,78 +140,82 @@ 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 *, libvlc_media_t * ); /** * Get the media used by the media_player. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer * \return the media associated with p_mi, or NULL if no * media is associated */ -VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t * ); /** * Get the Event Manager from which the media player send event. * * \param p_mi the Media Player - * \param p_e an initialized exception pointer * \return the event manager associated with p_mi */ -VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t * ); /** * 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 * ); /** * 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 void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * ); +VLC_PUBLIC_API int libvlc_media_player_play ( libvlc_media_player_t * ); /** - * 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 * ); /** - * 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 * ); /** - * Set the agl handler where the media player should render its video output. + * Set the NSView handler where the media player should render its video output. + * + * The object minimal_macosx expects is of kind NSObject and should + * respect the protocol: + * + * @protocol VLCOpenGLVideoViewEmbedding + * - (void)addVoutSubview:(NSView *)view; + * - (void)removeVoutSubview:(NSView *)view; + * @end + * + * 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 NSView handler */ -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 uint32_t libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi ); - +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. * @@ -200,11 +223,12 @@ VLC_PUBLIC_API uint32_t libvlc_media_player_get_nsobject ( libvlc_media_player_t * \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 ); @@ -224,9 +248,8 @@ VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_m * * \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 +257,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 +269,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,164 +290,156 @@ 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 * ); /** * 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 * ); /** - * 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 */ -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 *, libvlc_time_t ); /** * 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 * ); /** - * 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 *, float ); /** - * 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 *, int ); /** - * 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 * ); /** * 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 *, 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_get_chapter_count( libvlc_media_player_t * ); + +/** + * Is the player able to play + * + * \param p_mi the Media Player + * \return boolean + */ +VLC_PUBLIC_API int libvlc_media_player_will_play( libvlc_media_player_t * ); /** * 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 *, int ); /** * 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 *, int ); /** * 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 * ); /** * 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 * ); /** - * 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 * ); /** - * 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 * ); /** * Get movie play rate * * \param p_mi the Media Player - * \param p_e an initialized exception pointer - * \return movie play rate + * \return movie play rate, or zero in case of error */ -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 * ); /** * Set movie play rate * * \param p_mi the Media Player * \param movie play rate to set - * \param p_e an initialized exception pointer + * \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 *, float ); /** * 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 *); +VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_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 + * \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 * ); /** end bug */ @@ -431,25 +447,32 @@ VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvl * Does this media player have a video output? * * \param p_md the media player - * \param p_e an initialized exception pointer */ -VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *); +VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_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 ); +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 */ -VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e ); +VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi ); + + +/** + * Display the next frame (if supported) + * + * \param p_input the libvlc_media_player_t instance + */ +VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_input ); + + /** * Release (free) libvlc_track_description_t @@ -465,7 +488,10 @@ VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t */ /** - * Toggle fullscreen status on video output. + * Toggle fullscreen status on a non-embedded video output. + * + * @warning The same limitations applies to this function + * as to libvlc_set_fullscreen(). * * \param p_mediaplayer the media player * \param p_e an initialized exception pointer @@ -473,7 +499,15 @@ VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * ); /** - * Enable or disable fullscreen on a video output. + * Enable or disable fullscreen on a non-embedded video output. + * + * @warning With most window managers, only a top-level windows can switch to + * full-screen mode. Hence, this function will not operate properly if + * libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was + * used to embed the video in a non-LibVLC widget. If you want to to render an + * embedded LibVLC video full-screen, the parent embedding widget must expanded + * to full screen (LibVLC cannot take care of that). + * LibVLC will then automatically resize the video as appropriate. * * \param p_mediaplayer the media player * \param b_fullscreen boolean for fullscreen status @@ -490,6 +524,39 @@ VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_ */ VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * ); +/** + * 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 at the moment. + * + * \param mp 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 *mp, 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 \func libvlc_video_set_key_input(). + * + * \warning This function is only implemented for X11 at the moment. + * + * \param mp 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 *mp, unsigned on ); + /** * Get current video height. * @@ -513,6 +580,7 @@ VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_excep * See also libvlc_video_set_scale(). * * \param p_mediaplayer the media player + * \param p_e an initialized exception pointer * \return the currently configured zoom factor, or 0. if the video is set * to fit to the output window/drawable automatically. */ @@ -529,6 +597,7 @@ VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *, * * \param p_mediaplayer the media player * \param i_factor the scaling factor, or zero + * \param p_e an initialized exception pointer */ VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float, libvlc_exception_t *p_e ); @@ -549,7 +618,7 @@ VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, lib * \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 * ); +VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, const char *, libvlc_exception_t * ); /** * Get current video subtitle. @@ -577,7 +646,7 @@ VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_e * \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 * ); /** * Set new video subtitle. @@ -596,7 +665,7 @@ VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_ * \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 *, const char * ); /** * Get the description of available titles. @@ -606,7 +675,7 @@ VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char * \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 * ); /** * Get the description of available chapters for specific title. @@ -617,7 +686,7 @@ VLC_PUBLIC_API libvlc_track_description_t * * \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 *, int ); /** * Get current crop filter geometry. @@ -635,7 +704,7 @@ VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, li * \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 * ); +VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, const char *, libvlc_exception_t * ); /** * Toggle teletext transparent status on video output. @@ -643,44 +712,25 @@ VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, cha * \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 * ); +VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_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 * ); +VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_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 + * \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 * ); /** * Get current video track. @@ -714,6 +764,112 @@ VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc */ VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * ); +/** + * Enable or disable deinterlace filter + * + * \param p_mi libvlc media player + * \param b_enable boolean to enable or disable deinterlace filter + * \param psz_mode type of deinterlace filter to use + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *, + int , const char *, + libvlc_exception_t *); + +/** + * 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 + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *, + unsigned, libvlc_exception_t * ); + +/** + * 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 + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *, + unsigned, libvlc_exception_t * ); + +/** + * 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 + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *, + unsigned, int, libvlc_exception_t * ); + +/** + * 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 + * \param p_e an initialized exception pointer + */ +VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *, + unsigned, const char *, libvlc_exception_t * ); + +/** 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 + * \param p_e an pointer to an initialized exception object + */ +VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi, + unsigned option, libvlc_exception_t *p_e ); + +/** + * Set logo option as integer. Options that take a different type value + * cause an invalid argument exception. + * 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 + * \param p_e an pointer to an initialized exception object + */ +VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi, + unsigned option, int value, libvlc_exception_t *p_e ); + +/** + * Set logo option as string. Options that take a different type value + * cause an invalid argument exception. + * + * \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 + * \param p_e an pointer to an initialized exception object + */ +VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi, + unsigned option, const char *psz_value, libvlc_exception_t *p_e ); + + /** @} video */ /** \defgroup libvlc_audio libvlc_audio @@ -754,13 +910,12 @@ 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 * ); /** * Free the list of available audio outputs @@ -773,12 +928,12 @@ 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 mp 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 *, +VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *, const char * ); /** @@ -817,13 +972,13 @@ VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *, int ); /** - * Set device for using + * Set audio output device. Changes are only effective after stop and play. * - * \param p_instance libvlc instance + * \param mp 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 *, +VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *, const char *, const char * ); @@ -831,130 +986,122 @@ VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *, * 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 mp 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 * ); + libvlc_media_player_t * ); /** * Set current audio device type. * - * \param p_instance vlc instance + * \param mp 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 *, + int ); /** * Toggle mute status. * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \param mp 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 * ); /** * Get current mute status. * - * \param p_instance libvlc instance - * \param p_e an initialized exception pointer + * \param mp 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 * ); /** * Set mute status. * - * \param p_instance libvlc instance + * \param mp 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 *, int ); /** * Get current audio level. * - * \param p_instance libvlc instance + * \param mp media player * \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 * ); +VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t * ); /** * Set current audio level. * - * \param p_instance libvlc instance + * \param mp 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 *, int ); /** * 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 * ); - /** +/** * 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 * ); /** * 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 * ); /** * 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 *, int ); /** * Get current audio channel. * - * \param p_instance vlc instance - * \param p_e an initialized exception pointer + * \param mp 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 * ); /** * 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 *, int ); /** @} audio */ /** @} media_player */ +# ifdef __cplusplus +} +# endif + #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */