Platforms to show: All Mac Windows Linux Cross-Platform

Back to VLCMediaPlayerMBS class.

VLCMediaPlayerMBS.Constructor(media as VLCMediaMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Create a Media Player object from a Media.

On success handle is not nil.

See also:

VLCMediaPlayerMBS.Constructor(VLCInstance as VLCInstanceMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Create an empty Media Player object.

On success handle is not nil.

See also:

VLCMediaPlayerMBS.CopyCGImage as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Copies current frame as CGImageMBS.

This method set HasNewFrame to false.

VLCMediaPlayerMBS.CopyMemory as memoryblock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Copies current frame as memoryblock.

This method set HasNewFrame to false.
The format depends on what you passed to VideoSetFormat.
Byte order usually is BGRA.

VLCMediaPlayerMBS.CopyPicture as Picture

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Copies current frame as picture.

This method set HasNewFrame to false.
If using CGContext, this returns a CGImageMBS. Else a Picture.

With version 19.0, this returns always a picture.

VLCMediaPlayerMBS.CopyToMemory(dest as Ptr, offset as Integer, RowBytes as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 13.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Copies current frame into a given memory block.

Offset: Position of first byte in memoryblock.
RowBytes: The row size in bytes of your memoryblock.

This way you can have your frame go into a buffer of bigger width/height representing an OpenGL texture for example.
Byte order usually is BGRA.

VLCMediaPlayerMBS.Destructor

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

VLCMediaPlayerMBS.GetChapterCountForTitle(title as Integer) as Integer

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

Return number of chapters in title, or -1.

VLCMediaPlayerMBS.GetChapterDescription(index as Integer) as VLCTrackDescriptionMBS

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 description of available chapters for specific title.

Return list containing description of available chapter for title with index.

VLCMediaPlayerMBS.GetMemory as Ptr

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 13.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns pointer to memory with current frame.

This method set HasNewFrame to false.
The format depends on what you passed to VideoSetFormat.

VLCMediaPlayerMBS.Navigate(Navigate as Integer)

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

VLCMediaPlayerMBS.NextChapter

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set next chapter (if applicable)

VLCMediaPlayerMBS.NextFrame

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Display the next frame (if supported)

VLCMediaPlayerMBS.Pause

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Toggle pause (no effect if there is no media)

See also:

VLCMediaPlayerMBS.Pause(pause 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
Pause or resume (no effect if there is no media)

pause: play/resume if false, pause if true.

See also:

VLCMediaPlayerMBS.Play 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
Plays video.

Return true if playback started (and was already started), or false on error.

VLCMediaPlayerMBS.PreviousChapter

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set previous chapter (if applicable)

VLCMediaPlayerMBS.SetAudioOutput(AudioOutputName as string) 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
Set the audio output.

Change will be applied after stop and play.
Name: name of audio output.
Return true on success.

VLCMediaPlayerMBS.SetAudioOutputDevice(AudioOutputName as string, deviceID 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 audio output device. Changes are only effective after stop and play.

AudioOutputName: name of audio output.
deviceID: device ID.

VLCMediaPlayerMBS.SetEqualizer(Equalizer as VLCEqualizerMBS = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Apply new equalizer settings to a media player.

It is possible to apply new equalizer settings to a media player whether the media player is currently playing media or not.
Invoking this method will immediately apply the new equalizer settings to the audio output of the currently playing media if there is any.
If there is no currently playing media, the new equalizer settings will be applied later if and when new media is played.

Equalizer settings will automatically be applied to subsequently played media.

To disable the equalizer for a media player invoke this method passing nil for the equalizer parameter.

The media player does not keep a reference to the supplied equalizer so it is safe for an application to release the equalizer reference any time after this method returns.

Requires VLC 2.2.

VLCMediaPlayerMBS.SetSubtitleFile(filename as string) 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
Set new video subtitle file.

filename: new video subtitle file
Returns the success status.

VLCMediaPlayerMBS.SetVideoTitleDisplay(position as Integer, timeout as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set if, and how, the video title will be shown when media is played.

position: position at which to display the title, or kVideoTitleDisplayPositionDisable to prevent the title from being displayed.
timeout: title display timeout in milliseconds (ignored if libvlc_position_disable)

Requires VLC 2.1.

VLCMediaPlayerMBS.Stop

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Stop (no effect if there is no media)

VLCMediaPlayerMBS.ToggleFullScreen

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Toggle fullscreen status on non-embedded video outputs.

See also Fullscreen property.

VLCMediaPlayerMBS.ToggleMute

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

VLCMediaPlayerMBS.ToggleTeletext

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Toggle teletext transparent status on video output.

The items on this page are in the following plugins: MBS VLC Plugin.


The biggest plugin in space...