VLC 4.0.0-dev
Loading...
Searching...
No Matches
LibVLC video controls
Collaboration diagram for LibVLC video controls:

Enumerations

enum  libvlc_video_logo_option_t {
  libvlc_logo_enable , libvlc_logo_file , libvlc_logo_x , libvlc_logo_y ,
  libvlc_logo_delay , libvlc_logo_repeat , libvlc_logo_opacity , libvlc_logo_position
}
 option values for libvlc_video_{get,set}_logo_{int,string} More...
 
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
}
 option values for libvlc_video_{get,set}_adjust_{int,float,bool} More...
 

Functions

LIBVLC_API void libvlc_toggle_fullscreen (libvlc_media_player_t *p_mi)
 Toggle fullscreen status on non-embedded video outputs.
 
LIBVLC_API void libvlc_set_fullscreen (libvlc_media_player_t *p_mi, bool b_fullscreen)
 Enable or disable fullscreen.
 
LIBVLC_API bool libvlc_get_fullscreen (libvlc_media_player_t *p_mi)
 Get current fullscreen status.
 
LIBVLC_API void libvlc_video_set_key_input (libvlc_media_player_t *p_mi, unsigned on)
 Enable or disable key press events handling, according to the LibVLC hotkeys configuration.
 
LIBVLC_API void libvlc_video_set_mouse_input (libvlc_media_player_t *p_mi, unsigned on)
 Enable or disable mouse click events handling.
 
LIBVLC_API int libvlc_video_get_size (libvlc_media_player_t *p_mi, unsigned num, unsigned *px, unsigned *py)
 Get the pixel dimensions of a video.
 
LIBVLC_API int libvlc_video_get_cursor (libvlc_media_player_t *p_mi, unsigned num, int *px, int *py)
 Get the mouse pointer coordinates over a video.
 
LIBVLC_API float libvlc_video_get_scale (libvlc_media_player_t *p_mi)
 Get the current video scaling factor.
 
LIBVLC_API void libvlc_video_set_scale (libvlc_media_player_t *p_mi, float f_factor)
 Set the video scaling factor.
 
LIBVLC_API char * libvlc_video_get_aspect_ratio (libvlc_media_player_t *p_mi)
 Get current video aspect ratio.
 
LIBVLC_API void libvlc_video_set_aspect_ratio (libvlc_media_player_t *p_mi, const char *psz_aspect)
 Set new video aspect ratio.
 
LIBVLC_API libvlc_video_viewpoint_tlibvlc_video_new_viewpoint (void)
 Create a video viewpoint structure.
 
LIBVLC_API int libvlc_video_update_viewpoint (libvlc_media_player_t *p_mi, const libvlc_video_viewpoint_t *p_viewpoint, bool b_absolute)
 Update the video viewpoint information.
 
LIBVLC_API int64_t libvlc_video_get_spu_delay (libvlc_media_player_t *p_mi)
 Get the current subtitle delay.
 
LIBVLC_API float libvlc_video_get_spu_text_scale (libvlc_media_player_t *p_mi)
 Get the current subtitle text scale.
 
LIBVLC_API void libvlc_video_set_spu_text_scale (libvlc_media_player_t *p_mi, float f_scale)
 Set the subtitle text scale.
 
LIBVLC_API int libvlc_video_set_spu_delay (libvlc_media_player_t *p_mi, int64_t i_delay)
 Set the subtitle delay.
 
LIBVLC_API int libvlc_media_player_get_full_title_descriptions (libvlc_media_player_t *p_mi, libvlc_title_description_t ***titles)
 Get the full description of available titles.
 
LIBVLC_API void libvlc_title_descriptions_release (libvlc_title_description_t **p_titles, unsigned i_count)
 Release a title description.
 
LIBVLC_API int libvlc_media_player_get_full_chapter_descriptions (libvlc_media_player_t *p_mi, int i_chapters_of_title, libvlc_chapter_description_t ***pp_chapters)
 Get the full description of available chapters.
 
LIBVLC_API void libvlc_chapter_descriptions_release (libvlc_chapter_description_t **p_chapters, unsigned i_count)
 Release a chapter description.
 
LIBVLC_API void libvlc_video_set_crop_ratio (libvlc_media_player_t *mp, unsigned num, unsigned den)
 Set/unset the video crop ratio.
 
LIBVLC_API void libvlc_video_set_crop_window (libvlc_media_player_t *mp, unsigned x, unsigned y, unsigned width, unsigned height)
 Set the video crop window.
 
LIBVLC_API void libvlc_video_set_crop_border (libvlc_media_player_t *mp, unsigned left, unsigned right, unsigned top, unsigned bottom)
 Set the video crop borders.
 
LIBVLC_API int libvlc_video_get_teletext (libvlc_media_player_t *p_mi)
 Get current teletext page requested or 0 if it's disabled.
 
LIBVLC_API void libvlc_video_set_teletext (libvlc_media_player_t *p_mi, int i_page)
 Set new teletext page to retrieve.
 
LIBVLC_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)
 Take a snapshot of the current video window.
 
LIBVLC_API void libvlc_video_set_deinterlace (libvlc_media_player_t *p_mi, int deinterlace, const char *psz_mode)
 Enable or disable deinterlace filter.
 
LIBVLC_API int libvlc_video_get_marquee_int (libvlc_media_player_t *p_mi, unsigned option)
 Get an integer marquee option value.
 
LIBVLC_API void libvlc_video_set_marquee_int (libvlc_media_player_t *p_mi, unsigned option, int i_val)
 Enable, disable or set an integer marquee option.
 
LIBVLC_API void libvlc_video_set_marquee_string (libvlc_media_player_t *p_mi, unsigned option, const char *psz_text)
 Set a marquee string option.
 
LIBVLC_API int libvlc_video_get_logo_int (libvlc_media_player_t *p_mi, unsigned option)
 Get integer logo option.
 
LIBVLC_API void libvlc_video_set_logo_int (libvlc_media_player_t *p_mi, unsigned option, int value)
 Set logo option as integer.
 
LIBVLC_API void libvlc_video_set_logo_string (libvlc_media_player_t *p_mi, unsigned option, const char *psz_value)
 Set logo option as string.
 
LIBVLC_API int libvlc_video_get_adjust_int (libvlc_media_player_t *p_mi, unsigned option)
 Get integer adjust option.
 
LIBVLC_API void libvlc_video_set_adjust_int (libvlc_media_player_t *p_mi, unsigned option, int value)
 Set adjust option as integer.
 
LIBVLC_API float libvlc_video_get_adjust_float (libvlc_media_player_t *p_mi, unsigned option)
 Get float adjust option.
 
LIBVLC_API void libvlc_video_set_adjust_float (libvlc_media_player_t *p_mi, unsigned option, float value)
 Set adjust option as float.
 

Detailed Description

Enumeration Type Documentation

◆ libvlc_video_adjust_option_t

option values for libvlc_video_{get,set}_adjust_{int,float,bool}

Enumerator
libvlc_adjust_Enable 
libvlc_adjust_Contrast 
libvlc_adjust_Brightness 
libvlc_adjust_Hue 
libvlc_adjust_Saturation 
libvlc_adjust_Gamma 

◆ libvlc_video_logo_option_t

option values for libvlc_video_{get,set}_logo_{int,string}

Enumerator
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 

Function Documentation

◆ libvlc_chapter_descriptions_release()

LIBVLC_API void libvlc_chapter_descriptions_release ( libvlc_chapter_description_t **  p_chapters,
unsigned  i_count 
)

Release a chapter description.

Version
LibVLC 3.0.0 and later
Parameters
p_chapterschapter description array to release
i_countnumber of chapter descriptions to release

◆ libvlc_get_fullscreen()

LIBVLC_API bool libvlc_get_fullscreen ( libvlc_media_player_t p_mi)

Get current fullscreen status.

Parameters
p_mithe media player
Returns
the fullscreen status (boolean)
Return values
falsemedia player is windowed
truemedia player is in fullscreen mode

◆ libvlc_media_player_get_full_chapter_descriptions()

LIBVLC_API int libvlc_media_player_get_full_chapter_descriptions ( libvlc_media_player_t p_mi,
int  i_chapters_of_title,
libvlc_chapter_description_t ***  pp_chapters 
)

Get the full description of available chapters.

Version
LibVLC 3.0.0 and later.
Parameters
p_mithe media player
i_chapters_of_titleindex of the title to query for chapters (uses current title if set to -1)
[out]pp_chaptersaddress to store an allocated array of chapter descriptions descriptions (must be freed with libvlc_chapter_descriptions_release() by the caller)
Returns
the number of chapters (-1 on error)

◆ libvlc_media_player_get_full_title_descriptions()

LIBVLC_API int libvlc_media_player_get_full_title_descriptions ( libvlc_media_player_t p_mi,
libvlc_title_description_t ***  titles 
)

Get the full description of available titles.

Version
LibVLC 3.0.0 and later.
Parameters
p_mithe media player
[out]titlesaddress to store an allocated array of title descriptions descriptions (must be freed with libvlc_title_descriptions_release() by the caller)
Returns
the number of titles (-1 on error)

◆ libvlc_set_fullscreen()

LIBVLC_API void libvlc_set_fullscreen ( libvlc_media_player_t p_mi,
bool  b_fullscreen 
)

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.
Note
This setting applies to any and all current or future active video tracks and windows for the given media player. The choice of fullscreen output for each window is left to the operating system.
Parameters
p_mithe media player
b_fullscreenboolean for fullscreen status

◆ libvlc_title_descriptions_release()

LIBVLC_API void libvlc_title_descriptions_release ( libvlc_title_description_t **  p_titles,
unsigned  i_count 
)

Release a title description.

Version
LibVLC 3.0.0 and later
Parameters
p_titlestitle description array to release
i_countnumber of title descriptions to release

◆ libvlc_toggle_fullscreen()

LIBVLC_API void libvlc_toggle_fullscreen ( libvlc_media_player_t p_mi)

Toggle fullscreen status on non-embedded video outputs.

Warning
The same limitations applies to this function as to libvlc_set_fullscreen().
Parameters
p_mithe media player

◆ libvlc_video_get_adjust_float()

LIBVLC_API float libvlc_video_get_adjust_float ( libvlc_media_player_t p_mi,
unsigned  option 
)

Get float adjust option.

Parameters
p_milibvlc media player instance
optionadjust option to get, values of libvlc_video_adjust_option_t
Version
LibVLC 1.1.1 and later.

◆ libvlc_video_get_adjust_int()

LIBVLC_API int libvlc_video_get_adjust_int ( libvlc_media_player_t p_mi,
unsigned  option 
)

Get integer adjust option.

Parameters
p_milibvlc media player instance
optionadjust option to get, values of libvlc_video_adjust_option_t
Version
LibVLC 1.1.1 and later.

◆ libvlc_video_get_aspect_ratio()

LIBVLC_API char * libvlc_video_get_aspect_ratio ( libvlc_media_player_t p_mi)

Get current video aspect ratio.

Parameters
p_mithe media player
Returns
the video aspect ratio or NULL if unspecified (the result must be released with free() or libvlc_free()).

◆ libvlc_video_get_cursor()

LIBVLC_API int libvlc_video_get_cursor ( libvlc_media_player_t p_mi,
unsigned  num,
int *  px,
int *  py 
)

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.
Parameters
p_mimedia player
numnumber of the video (starting from, and most commonly 0)
[out]pxpointer to get the abscissa
[out]pypointer to get the ordinate
Returns
0 on success, -1 if the specified video does not exist

◆ libvlc_video_get_logo_int()

LIBVLC_API int libvlc_video_get_logo_int ( libvlc_media_player_t p_mi,
unsigned  option 
)

Get integer logo option.

Parameters
p_milibvlc media player instance
optionlogo option to get, values of libvlc_video_logo_option_t

◆ libvlc_video_get_marquee_int()

LIBVLC_API int libvlc_video_get_marquee_int ( libvlc_media_player_t p_mi,
unsigned  option 
)

Get an integer marquee option value.

Parameters
p_milibvlc media player
optionmarq option to get
See also
libvlc_video_marquee_option_t

◆ libvlc_video_get_scale()

LIBVLC_API float libvlc_video_get_scale ( libvlc_media_player_t p_mi)

Get the current video scaling factor.

See also libvlc_video_set_scale().

Parameters
p_mithe media player
Returns
the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically.

◆ libvlc_video_get_size()

LIBVLC_API int libvlc_video_get_size ( libvlc_media_player_t p_mi,
unsigned  num,
unsigned *  px,
unsigned *  py 
)

Get the pixel dimensions of a video.

Parameters
p_mimedia player
numnumber of the video (starting from, and most commonly 0)
[out]pxpointer to get the pixel width
[out]pypointer to get the pixel height
Returns
0 on success, -1 if the specified video does not exist

◆ libvlc_video_get_spu_delay()

LIBVLC_API int64_t libvlc_video_get_spu_delay ( libvlc_media_player_t p_mi)

Get the current subtitle delay.

Positive values means subtitles are being displayed later, negative values earlier.

Parameters
p_mimedia player
Returns
time (in microseconds) the display of subtitles is being delayed
Version
LibVLC 2.0.0 or later

◆ libvlc_video_get_spu_text_scale()

LIBVLC_API float libvlc_video_get_spu_text_scale ( libvlc_media_player_t p_mi)

Get the current subtitle text scale.

The scale factor is expressed as a percentage of the default size, where 1.0 represents 100 percent.

Parameters
p_mimedia player
Version
LibVLC 4.0.0 or later

◆ libvlc_video_get_teletext()

LIBVLC_API int libvlc_video_get_teletext ( libvlc_media_player_t p_mi)

Get current teletext page requested or 0 if it's disabled.

Teletext is disabled by default, call libvlc_video_set_teletext() to enable it.

Parameters
p_mithe media player
Returns
the current teletext page requested.

◆ libvlc_video_new_viewpoint()

LIBVLC_API libvlc_video_viewpoint_t * libvlc_video_new_viewpoint ( void  )

Create a video viewpoint structure.

Version
LibVLC 3.0.0 and later
Returns
video viewpoint or NULL (the result must be released with free()).

◆ libvlc_video_set_adjust_float()

LIBVLC_API void libvlc_video_set_adjust_float ( libvlc_media_player_t p_mi,
unsigned  option,
float  value 
)

Set adjust option as float.

Options that take a different type value are ignored.

Parameters
p_milibvlc media player instance
optionadjust option to set, values of libvlc_video_adjust_option_t
valueadjust option value
Version
LibVLC 1.1.1 and later.

◆ libvlc_video_set_adjust_int()

LIBVLC_API void libvlc_video_set_adjust_int ( libvlc_media_player_t p_mi,
unsigned  option,
int  value 
)

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.

Parameters
p_milibvlc media player instance
optionadjust option to set, values of libvlc_video_adjust_option_t
valueadjust option value
Version
LibVLC 1.1.1 and later.

◆ libvlc_video_set_aspect_ratio()

LIBVLC_API void libvlc_video_set_aspect_ratio ( libvlc_media_player_t p_mi,
const char *  psz_aspect 
)

Set new video aspect ratio.

Parameters
p_mithe media player
psz_aspectnew video aspect-ratio or NULL to reset to default
Note
Invalid aspect ratios are ignored.

◆ libvlc_video_set_crop_border()

LIBVLC_API void libvlc_video_set_crop_border ( libvlc_media_player_t mp,
unsigned  left,
unsigned  right,
unsigned  top,
unsigned  bottom 
)

Set the video crop borders.

This function selects the size of video edges to be cropped out.

To unset the video crop borders, set all borders to zero.

A call to this function overrides any previous call to any of libvlc_video_set_crop_ratio(), libvlc_video_set_crop_border() and/or libvlc_video_set_crop_window().

Parameters
mpthe media player
leftnumber of sample columns to crop on the left
rightnumber of sample columns to crop on the right
topnumber of sample rows to crop on the top
bottomnumber of sample rows to corp on the bottom
Version
LibVLC 4.0.0 and later

◆ libvlc_video_set_crop_ratio()

LIBVLC_API void libvlc_video_set_crop_ratio ( libvlc_media_player_t mp,
unsigned  num,
unsigned  den 
)

Set/unset the video crop ratio.

This function forces a crop ratio on any and all video tracks rendered by the media player. If the display aspect ratio of a video does not match the crop ratio, either the top and bottom, or the left and right of the video will be cut out to fit the crop ratio.

For instance, a ratio of 1:1 will force the video to a square shape.

To disable video crop, set a crop ratio with zero as denominator.

A call to this function overrides any previous call to any of libvlc_video_set_crop_ratio(), libvlc_video_set_crop_border() and/or libvlc_video_set_crop_window().

See also
libvlc_video_set_aspect_ratio()
Parameters
mpthe media player
numcrop ratio numerator (ignored if denominator is 0)
dencrop ratio denominator (or 0 to unset the crop ratio)
Version
LibVLC 4.0.0 and later

◆ libvlc_video_set_crop_window()

LIBVLC_API void libvlc_video_set_crop_window ( libvlc_media_player_t mp,
unsigned  x,
unsigned  y,
unsigned  width,
unsigned  height 
)

Set the video crop window.

This function selects a sub-rectangle of video to show. Any pixels outside the rectangle will not be shown.

To unset the video crop window, use libvlc_video_set_crop_ratio() or libvlc_video_set_crop_border().

A call to this function overrides any previous call to any of libvlc_video_set_crop_ratio(), libvlc_video_set_crop_border() and/or libvlc_video_set_crop_window().

Parameters
mpthe media player
xabscissa (i.e. leftmost sample column offset) of the crop window
yordinate (i.e. topmost sample row offset) of the crop window
widthsample width of the crop window (cannot be zero)
heightsample height of the crop window (cannot be zero)
Version
LibVLC 4.0.0 and later

◆ libvlc_video_set_deinterlace()

LIBVLC_API void libvlc_video_set_deinterlace ( libvlc_media_player_t p_mi,
int  deinterlace,
const char *  psz_mode 
)

Enable or disable deinterlace filter.

Parameters
p_milibvlc media player
deinterlacestate -1: auto (default), 0: disabled, 1: enabled
psz_modetype of deinterlace filter, NULL for current/default filter
Version
LibVLC 4.0.0 and later

◆ libvlc_video_set_key_input()

LIBVLC_API void libvlc_video_set_key_input ( libvlc_media_player_t p_mi,
unsigned  on 
)

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.
Parameters
p_mithe media player
ontrue to handle key press events, false to ignore them.

◆ libvlc_video_set_logo_int()

LIBVLC_API void libvlc_video_set_logo_int ( libvlc_media_player_t p_mi,
unsigned  option,
int  value 
)

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.

Parameters
p_milibvlc media player instance
optionlogo option to set, values of libvlc_video_logo_option_t
valuelogo option value

◆ libvlc_video_set_logo_string()

LIBVLC_API void libvlc_video_set_logo_string ( libvlc_media_player_t p_mi,
unsigned  option,
const char *  psz_value 
)

Set logo option as string.

Options that take a different type value are ignored.

Parameters
p_milibvlc media player instance
optionlogo option to set, values of libvlc_video_logo_option_t
psz_valuelogo option value

◆ libvlc_video_set_marquee_int()

LIBVLC_API void libvlc_video_set_marquee_int ( libvlc_media_player_t p_mi,
unsigned  option,
int  i_val 
)

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.

Parameters
p_milibvlc media player
optionmarq option to set
See also
libvlc_video_marquee_option_t
Parameters
i_valmarq option value

◆ libvlc_video_set_marquee_string()

LIBVLC_API void libvlc_video_set_marquee_string ( libvlc_media_player_t p_mi,
unsigned  option,
const char *  psz_text 
)

Set a marquee string option.

Parameters
p_milibvlc media player
optionmarq option to set
See also
libvlc_video_marquee_option_t
Parameters
psz_textmarq option value

◆ libvlc_video_set_mouse_input()

LIBVLC_API void libvlc_video_set_mouse_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".

See also
libvlc_video_set_key_input().
Warning
This function is only implemented for X11 and Win32 at the moment.
Parameters
p_mithe media player
ontrue to handle mouse click events, false to ignore them.

◆ libvlc_video_set_scale()

LIBVLC_API void libvlc_video_set_scale ( libvlc_media_player_t p_mi,
float  f_factor 
)

Set the video scaling factor.

That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window/drawable (in windowed mode) or the entire screen.

Note that not all video outputs support scaling.

Parameters
p_mithe media player
f_factorthe scaling factor, or zero

◆ libvlc_video_set_spu_delay()

LIBVLC_API int libvlc_video_set_spu_delay ( libvlc_media_player_t p_mi,
int64_t  i_delay 
)

Set the subtitle delay.

This affects the timing of when the subtitle will be displayed. Positive values result in subtitles being displayed later, while negative values will result in subtitles being displayed earlier.

The subtitle delay will be reset to zero each time the media changes.

Parameters
p_mimedia player
i_delaytime (in microseconds) the display of subtitles should be delayed
Returns
0 on success, -1 on error
Version
LibVLC 2.0.0 or later

◆ libvlc_video_set_spu_text_scale()

LIBVLC_API void libvlc_video_set_spu_text_scale ( libvlc_media_player_t p_mi,
float  f_scale 
)

Set the subtitle text scale.

The scale factor is expressed as a percentage of the default size, where 1.0 represents 100 percent.

A value of 0.5 would result in text half the normal size, and a value of 2.0 would result in text twice the normal size.

The minimum acceptable value for the scale factor is 0.1.

The maximum is 5.0 (five times normal size).

Parameters
p_mimedia player
f_scalescale factor in the range [0.1;5.0] (default: 1.0)
Version
LibVLC 4.0.0 or later

◆ libvlc_video_set_teletext()

LIBVLC_API void libvlc_video_set_teletext ( libvlc_media_player_t p_mi,
int  i_page 
)

Set new teletext page to retrieve.

This function can also be used to send a teletext key.

Parameters
p_mithe media player
i_pageteletex page number requested. This value can be 0 to disable teletext, a number in the range ]0;1000[ to show the requested page, or a libvlc_teletext_key_t. 100 is the default teletext page.

◆ libvlc_video_take_snapshot()

LIBVLC_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 
)

Take a snapshot of the current video window.

If i_width AND i_height is 0, original size is used. If i_width XOR i_height is 0, original aspect-ratio is preserved.

Parameters
p_mimedia player instance
numnumber of video output (typically 0 for the first/only one)
psz_filepaththe path of a file or a folder to save the screenshot into
i_widththe snapshot's width
i_heightthe snapshot's height
Returns
0 on success, -1 if the video was not found

◆ libvlc_video_update_viewpoint()

LIBVLC_API int libvlc_video_update_viewpoint ( libvlc_media_player_t p_mi,
const libvlc_video_viewpoint_t p_viewpoint,
bool  b_absolute 
)

Update the video viewpoint information.

Note
It is safe to call this function before the media player is started.
Version
LibVLC 3.0.0 and later
Parameters
p_mithe media player
p_viewpointvideo viewpoint allocated via libvlc_video_new_viewpoint()
b_absoluteif true replace the old viewpoint with the new one. If false, increase/decrease it.
Returns
-1 in case of error, 0 otherwise
Note
the values are set asynchronously, it will be used by the next frame displayed.