VLCMediaPlayerMBS.VideoGetSize(num as Integer, byref px as UInt32, byref py as UInt32) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Get the pixel dimensions of a video.

num: number of the video (starting from, and most commonly 0)
px: get the pixel width [OUT]
py: get the pixel height [OUT]
Return true on success, false if the specified video does not exist.

VLCMediaPlayerMBS.VideoLogo(option as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Get/Set logo option as Integer.

Options that take a different type value are ignored.
Passing kLogoEnable as option value has the side effect of starting (arg not 0) or stopping (arg 0) the logo filter.
(Read and Write computed property)

VLCMediaPlayerMBS.VideoMarquee(option as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Get, Enable, disable or set an integer marquee option.

Setting kMarqueeEnable has the side effect of enabling (arg not 0) or disabling (arg 0) the marq filter.
(Read and Write computed property)

VLCMediaPlayerMBS.VideoMarqueeString(option as Integer) as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Get/Set a string marquee option value

(Read and Write computed property)

VLCMediaPlayerMBS.VideoSetCallback(width as integer, height as integer, CGContextHandle as integer = 0)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Sets video callbacks, so the plugin can provide current frame with CopyPicture method.

You can use CopyPicture and CopyMemory methods to query new frame content.
The hasNewFrame property tells you whether a new frame is available.
The plugin will optionally draw the frames into the CGContext you provide.
Please use CopyCGImage to get a CGImage from image buffer.

Some examples using this method:

• /VLC/Show two videos
• /VLC/Show video sample

VLCMediaPlayerMBS.VideoSetDeinterlace(Mode as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Enable or disable deinterlace filter.

Mode: Type of deinterlace filter, "" to disable.

VLCMediaPlayerMBS.VideoSetFormat(chroma as string, width as UInt32, height as UInt32, pitch as UInt32)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Set decoded video chroma and dimensions.

This only works in combination with SetVideoCallbacks().
chroma: a four-characters string identifying the chroma (e.g. "RV32" or "YUYV")
width: pixel width
height: pixel height
pitch: line pitch (in bytes)

All pixel planes are expected to have the same pitch.

VLCMediaPlayerMBS.VideoSetKeyInput(on as boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

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.

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.

This function is only implemented for X11 and Win32 at the moment.

on: true to handle key press events, false to ignore them.

VLCMediaPlayerMBS.VideoSetLogoString(option as Integer, logo as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Set logo option as string.

Options that take a different type value are ignored.

VLCMediaPlayerMBS.VideoSetMouseInput(on as boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

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".

This function is only implemented for X11 and Win32 at the moment.

on: true to handle mouse click events, false to ignore them.

VLCMediaPlayerMBS.VideoTakeSnapshot(num as Integer, path as string, width as Integer, height as Integer) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	VLC	MBS VLC Plugin	12.2	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Take a snapshot of the current video window.

If width AND height is 0, original size is used.
If width XOR height is 0, original aspect-ratio is preserved. (e.g. width = 0 and height = -1)

num: number of video output (typically 0 for the first/only one)
Path: the path where to save the screenshot to
Width: the snapshot's width
Height: the snapshot's height

Returns true on success, false if the video was not found

Some examples using this method:

• /VLC/Thumbnailer Console
• /VLC/Thumbnailer GUI