Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

VLCMediaPlayerMBS.Constructor(media as VLCMediaMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Create a Media Player object from a Media.
Notes: On success handle is not nil.

See also:

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Constructor(VLCInstance as VLCInstanceMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Create an empty Media Player object.
Notes: On success handle is not nil.

See also:

Feedback, Comments & Corrections

VLCMediaPlayerMBS.CopyMemory as memoryblock
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Copies current frame as memoryblock.
Notes:
This method set HasNewFrame to false.
The format depends on what you passed to VideoSetFormat.
Byte order usually is BGRA.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.CopyPicture as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Copies current frame as picture.
Notes:
This method set HasNewFrame to false.
If using CGContext, this returns a CGImageMBS. Else a Picture.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.CopyToMemory(dest as Ptr, offset as Integer, RowBytes as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 13.4 Yes Yes Yes Yes No
Function: Copies current frame into a given memory block.
Notes:
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.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Destructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: The destructor.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.GetChapterCountForTitle(title as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Get title chapter count.
Notes: Return number of chapters in title, or -1.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.GetChapterDescription(index as Integer) as VLCTrackDescriptionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Get the description of available chapters for specific title.
Notes: Return list containing description of available chapter for title with index.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.GetMemory as Ptr
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 13.4 Yes Yes Yes Yes No
Function: Returns pointer to memory with current frame.
Notes:
This method set HasNewFrame to false.
The format depends on what you passed to VideoSetFormat.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Navigate(Navigate as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Navigate through DVD Menu.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.NextChapter
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Set next chapter (if applicable)

Feedback, Comments & Corrections

VLCMediaPlayerMBS.NextFrame
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Display the next frame (if supported)

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Pause
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Toggle pause (no effect if there is no media)

See also:

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Pause(pause as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Pause or resume (no effect if there is no media)
Notes: pause: play/resume if false, pause if true.

See also:

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Play as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Plays video.
Notes: Return true if playback started (and was already started), or false on error.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.PreviousChapter
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Set previous chapter (if applicable)

Feedback, Comments & Corrections

VLCMediaPlayerMBS.SetAudioOutput(AudioOutputName as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Set the audio output.
Notes:
Change will be applied after stop and play.
Name: name of audio output.
Return true on success.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.SetAudioOutputDevice(AudioOutputName as string, deviceID as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Set audio output device. Changes are only effective after stop and play.
Notes:
AudioOutputName: name of audio output.
deviceID: device ID.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.SetEqualizer(Equalizer as VLCEqualizerMBS = nil)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 15.3 Yes Yes Yes Yes No
Function: Apply new equalizer settings to a media player.
Notes:
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.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.SetSubtitleFile(filename as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Set new video subtitle file.
Notes:
filename: new video subtitle file
Returns the success status.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.SetVideoTitleDisplay(position as Integer, timeout as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 15.3 Yes Yes Yes Yes No
Function: Set if, and how, the video title will be shown when media is played.
Notes:
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.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.Stop
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Stop (no effect if there is no media)

Feedback, Comments & Corrections

VLCMediaPlayerMBS.ToggleFullScreen
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Toggle fullscreen status on non-embedded video outputs.
Notes: See also Fullscreen property.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.ToggleMute
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Toggle mute status.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.ToggleTeletext
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Toggle teletext transparent status on video output.

Feedback, Comments & Corrections

VLCMediaPlayerMBS.VideoAdjust(option as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Get/set adjust option as Integer.
Notes:
option: See kAdjust* constants.
Options that take a different type value are ignored.

Using kAdjustEnable with value 0 stops adjust filter. With other values you start adjust filter.
(Read and Write computed property)

Feedback, Comments & Corrections

VLCMediaPlayerMBS.VideoAdjustFloat(option as Integer) as single
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Get/set adjust option as float.
Notes:
option: See kAdjust* constants.
Options that take a different type value are ignored.
(Read and Write computed property)

Feedback, Comments & Corrections

VLCMediaPlayerMBS.VideoGetCursor(num as Integer, byref px as Integer, byref py as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Get the mouse pointer coordinates over a video.
Notes:
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.

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.

LibVLC does not support multiple pointers (it does of course support multiple input devices sharing the same pointer) at the moment.

num: number of the video (starting from, and most commonly 0)
px: get the abscissa.
py: get the ordinate.
Returns true on success, false if the specified video does not exist

Feedback, Comments & Corrections

VLCMediaPlayerMBS.VideoGetSize(num as Integer, byref px as UInt32, byref py as UInt32) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method VLC MBS VLC Plugin 12.2 Yes Yes Yes Yes No
Function: Get the pixel dimensions of a video.
Notes:
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.

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo tutorial videos