Platforms to show: All Mac Windows Linux Cross-Platform
Back to VLCMediaPlayerMBS class.
VLCMediaPlayerMBS.AGL 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 |
Returns the agl handler or 0 if none where set.
(Read and Write property)
VLCMediaPlayerMBS.AspectRatio 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 |
Set new video aspect-ratio or "" to reset to default. Invalid aspect ratios are ignored.
Get the video aspect ratio or "" if unspecified.
The value must be something like "4:3", "16:9", "16:10", ...
(Read and Write property)
VLCMediaPlayerMBS.AudioChannel 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 |
(Read and Write property)
VLCMediaPlayerMBS.AudioDelay 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 |
The audio delay will be reset to zero each time the media changes.
(Read and Write property)
VLCMediaPlayerMBS.AudioOutputDevices as VLCAudioOutputDeviceMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | VLC | MBS VLC Plugin | 15.3 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
See also SetAudioOutputDevice method.
Not all audio outputs support enumerating devices.
The audio output may be functional even if the list is empty (nil).
The list may not be exhaustive.
Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device.
Returns a nil-terminated linked list of potential audio output devices.
Requires LibVLC 2.2.0 or later.
(Read only property)
VLCMediaPlayerMBS.AudioOutputDeviceType 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 |
Device type describes something like character of output sound - stereo sound, 2.1, 5.1 etc.
(Read and Write property)
VLCMediaPlayerMBS.AudioTrack 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 or set current audio track.
(Read and Write property)
VLCMediaPlayerMBS.AudioTrackCount 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 |
Returns the number of available audio tracks (int), or -1 if unavailable.
(Read only property)
VLCMediaPlayerMBS.CanPause 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 |
Returns true if the media player can pause.
(Read only property)
VLCMediaPlayerMBS.Chapter 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 |
Returns chapter number currently playing, or -1 if there is no media.
Sets movie chapter (if applicable).
(Read and Write property)
VLCMediaPlayerMBS.ChapterCount 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 |
Returns number of chapters in movie, or -1.
(Read only property)
VLCMediaPlayerMBS.CropGeometry 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 |
Returns the crop filter geometry or "" if unset.
Set with new crop filter geometry ("" to unset).
Seems to be broken in our tests inside libVLC.
(Read and Write property)
VLCMediaPlayerMBS.FPS 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 |
Returns frames per second (fps) for this playing movie, or 0 if unspecified.
(Read only property)
VLCMediaPlayerMBS.FullScreen 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 |
With most window managers, only a top-level windows can be in full-screen mode. Hence, this function will not operate properly if XWindow property 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.
(Read and Write property)
VLCMediaPlayerMBS.GetAudioTrackDescription 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 |
Returns list with description of available audio tracks, or nil.
(Read only property)
VLCMediaPlayerMBS.GetSPUDescription 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 |
Return list containing description of available video subtitles or nil.
(Read only property)
VLCMediaPlayerMBS.GetVideoTitleDescription 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 |
Return list containing description of available titles.
(Read only property)
VLCMediaPlayerMBS.Handle 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 |
(Read and Write property)
VLCMediaPlayerMBS.HasNewFrame 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 |
(Read and Write property)
Some examples using this property:
VLCMediaPlayerMBS.HasVOut 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 |
Return the number of video outputs.
(Read only property)
VLCMediaPlayerMBS.Height 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 |
Returns the video pixel height or 0 if not applicable.
(Read only property)
VLCMediaPlayerMBS.HWND 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 |
If LibVLC was built without Win32/Win64 API output support, then this has no effects.
Get the Windows API window handle (HWND) previously set with this property. The handle will be returned even if LibVLC is not currently outputting any video to it.
Currently not supported by our plugin.
(Read and Write property)
VLCMediaPlayerMBS.IsPlaying 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 |
(Read only property)
VLCMediaPlayerMBS.IsSeekable 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 |
Returns true if the media player can seek.
(Read only property)
VLCMediaPlayerMBS.Length 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 |
Return the movie length (in ms), or -1 if there is no media.
(Read only property)
VLCMediaPlayerMBS.Media as VLCMediaMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | VLC | MBS VLC Plugin | 12.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read and Write property)
VLCMediaPlayerMBS.Mute 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 |
If true then mute, otherwise unmute.
(Read and Write property)
VLCMediaPlayerMBS.NSObject as Ptr
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | VLC | MBS VLC Plugin | 12.2 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Currently not supported by our plugin.
(Read and Write property)
Some examples using this property:
VLCMediaPlayerMBS.Position 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 |
Movie position as percentage between 0.0 and 1.0.
Returns movie position, or -1. in case of error.
Set movie position. This has no effect if playback is not enabled. This might not work depending on the underlying input format and protocol.
(Read and Write property)
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 |
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 |
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 |
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 |
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 |
(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 |
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 |
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 |
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 |
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 |
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 |
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 |
(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 |
(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 |
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 |
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 |
(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 |
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 |
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 |
(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 |
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:
The items on this page are in the following plugins: MBS VLC Plugin.