VLCMediaPlayerMBS.ProgramScrambled as boolean

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

Check if the current program is scrambled.

true if the current program is scrambled.
Requires VLC 2.2.
(Read only property)

VLCMediaPlayerMBS.Rate as Double

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 the requested movie play rate.

Depending on the underlying media, the requested rate may be different from the real playback rate.
(Read and Write property)

VLCMediaPlayerMBS.Scale as Double

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 the current 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.
(Read and Write property)

VLCMediaPlayerMBS.SPU 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 current video subtitle.

Returns the video subtitle selected, or -1 if none.
(Read and Write property)

VLCMediaPlayerMBS.SPUCount 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 the number of available video subtitles.

(Read only property)

VLCMediaPlayerMBS.SPUDelay as Int64

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 the current subtitle delay.

This affects the timing of when the subtitle will be displayed.
Positive values means subtitles are 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.
(Read and Write property)

VLCMediaPlayerMBS.State 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 current movie state.

Returns the current state of the media player (playing, paused, ...)
(Read only property)

VLCMediaPlayerMBS.Tag as Variant

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

The tag value.

You can store whatever you like in this property.
(Read only property)

VLCMediaPlayerMBS.Time as Int64

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 the current movie time (in ms).

Return the movie time (in ms), or -1 if there is no media.
Set the movie time (in ms). This has no effect if no media is being played.
Not all formats and protocols support this.
(Read and Write property)

VLCMediaPlayerMBS.Title 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

Set/Get movie title.

Returns title number currently playing, or -1.
(Read and Write property)

VLCMediaPlayerMBS.TitleCount 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 movie title count.

Returns title number count, or -1.
(Read only property)

VLCMediaPlayerMBS.VideoTeleText 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 current teletext page requested.

(Read and Write property)

VLCMediaPlayerMBS.VideoTrack 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 video track.

(Read and Write property)

VLCMediaPlayerMBS.VideoTrackCount 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 number of available video tracks.

Returns the number of available video tracks.
(Read only property)

VLCMediaPlayerMBS.VideoTrackDescription as VLCTrackDescriptionMBS

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

Get the description of available video tracks.

Returns list with description of available video tracks, or nil on error.
(Read only property)

VLCMediaPlayerMBS.VLC as VLCInstanceMBS

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

The reference to the VLC instance.

(Read only property)

VLCMediaPlayerMBS.Volume 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

Current software audio volume.

The volume in percents.
0 = mute, 100 = nominal / 0dB.
(Read and Write property)

VLCMediaPlayerMBS.Width 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 current video width.

Returns the video pixel width or 0 if not applicable.
(Read only property)

VLCMediaPlayerMBS.WillPlay as boolean

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

Is the player able to play.

(Read only property)

VLCMediaPlayerMBS.XWindow as UInt32

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 an X Window System drawable where the media player should render its video output.

If LibVLC was built without X11 output support, then this has no effects.

The specified identifier must correspond to an existing Input/Output class 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. This function must be called before video playback is started; otherwise it will only take effect after playback stop and restart.

Get the X Window System window identifier previously set with this property. Note that this will return the identifier even if VLC is not currently using it (for instance if it is playing an audio-only input).
Currently not supported by our plugin.
(Read and Write property)

Some examples using this property:

• /VLC/Show video sample