int bottom, right;
} libvlc_rectangle_t;
+/**
+ * Marq int options definition
+ */
+typedef enum libvlc_video_marquee_int_option_t {
+ libvlc_marquee_Enabled = 0,
+ 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_int_option_t;
+
+/**
+ * Marq string options definition
+ */
+typedef enum libvlc_video_marquee_string_option_t {
+ libvlc_marquee_Text = 0
+} libvlc_video_marquee_string_option_t;
+
/**
* Create an empty Media Player object
VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_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 VLCOpenGLVoutEmbedding
+ * - (void)addVoutSubview:(NSView *)view;
+ * - (void)removeVoutSubview:(NSView *)view;
+ *
+ * - (void)enterFullscreen;
+ * - (void)leaveFullscreen;
+ *
+ * - (BOOL)stretchesVideo;
+ * - (void)setOnTop: (BOOL)ontop; // Do we really want that in protocol?
+ * @end
+ *
+ * You can find a live example in VLCVideoView in VLCKit.framework.
+ *
* \param p_mi the Media Player
- * \param drawable the agl handler
+ * \param drawable the NSView handler
* \param p_e an initialized exception pointer
*/
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().
+ * 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.
/**
* 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 );
* 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 );
* 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 );
* Set movie position.
*
* \param p_mi the Media Player
+ * \param f_pos the position
* \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 *);
* \return number of chapters in movie
*/
VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
+
+/**
+ * Will the player play
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return boolean
+ */
VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
/**
*/
VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
+
+/**
+ * Display the next frame
+ *
+ * \param p_input the libvlc_media_player_t instance
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_input,
+ libvlc_exception_t *p_e );
+
+
+
/**
* Release (free) 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
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
*/
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.
*
* 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.
*/
*
* \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 );
* \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.
* \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 *, libvlc_exception_t * );
/**
* Get the description of available titles.
* \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.
*/
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 option value (option which return an int)
+ *
+ * \param p_mi libvlc media player
+ * \param option marq option to get
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API int libvlc_video_get_marquee_option_as_int( libvlc_media_player_t *,
+ libvlc_video_marquee_int_option_t,
+ libvlc_exception_t * );
+
+/**
+ * Get an option value (option which return a string)
+ *
+ * \param p_mi libvlc media player
+ * \param option marq option to get
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API char *libvlc_video_get_marquee_option_as_string( libvlc_media_player_t *,
+ libvlc_video_marquee_string_option_t,
+ libvlc_exception_t * );
+
+/**
+ * Enable, disable or set a marq option (only int)
+ *
+ * \param p_mi libvlc media player
+ * \param option marq option to set
+ * \param i_val marq option value
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_int( libvlc_media_player_t *,
+ libvlc_video_marquee_int_option_t,
+ int, libvlc_exception_t * );
+
+/**
+ * Set a marq option (only string)
+ *
+ * \param p_mi libvlc media player
+ * \param option marq option to set
+ * \param psz_text marq option value
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_string( libvlc_media_player_t *,
+ libvlc_video_marquee_string_option_t,
+ const char *,
+ libvlc_exception_t * );
+
/** @} video */
/** \defgroup libvlc_audio libvlc_audio
* 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 * );
+VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_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 * );
+VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_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 * );
+VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int );
/**
* Get current audio level.
* \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_instance_t * );
/**
* Set current audio level.
*/
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
projects / vlc / blobdiff