Platforms to show: All Mac Windows Linux Cross-Platform

Back to VLCMediaMBS class.

VLCMediaMBS.AddOption(options 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
Add an option to the media.

This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis.

The options are detailed in vlc --long-help, for instance "--sout-all"

VLCMediaMBS.AddOptionFlag(options as string, flags 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
Add an option to the media with configurable flags.

This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis.

The options are detailed in vlc --long-help, for instance "--sout-all"

VLCMediaMBS.Clone 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
Creates a duplicate of media object.

VLCMediaMBS.Constructor(original 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
Creates a copy of the media object.

See also:

VLCMediaMBS.Constructor(vlc as VLCInstanceMBS, URL 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
Create a media with a certain given media resource location, for instance a valid URL.

Do not pass a file path here! This is for URLs.

URL: the media location

To refer to a local file with this function, the file://... URI syntax must be used (see IETF RFC3986).
We recommend using MediaWithPath() instead when dealing with local files.

See also:

VLCMediaMBS.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 to cleanup the media.

VLCMediaMBS.Duration as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get duration (in ms) of media descriptor object item.

Return duration of media item or -1 on error.

VLCMediaMBS.IsParsed 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 Parsed status for media descriptor object.

Returns true if media object has been parsed otherwise it returns false.

VLCMediaMBS.Meta(type as Integer) 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
Read the meta of the media.

If the media has not yet been parsed this will return an empty string.

This methods automatically calls ParseAsync(), so after calling it you may receive a MediaMetaChanged event. If you prefer a synchronous version ensure that you call Parse() before get_meta().

VLCMediaMBS.MRL 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
Get the media resource locator (mrl) from a media descriptor object.

VLCMediaMBS.Parse

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

This fetches (local) meta data and tracks information.
The method is synchronous.

VLCMediaMBS.ParseAsync

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

This fetches (local) meta data and tracks information.
The method is the asynchronous of Parse.
To track when this is over you can listen to MediaParsedChanged event. However if the media was already parsed you will not receive this event.

VLCMediaMBS.SaveMeta 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
Save the meta previously set.

Return true if the write operation was successfull.

VLCMediaMBS.SetMeta(meta as Integer, value 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 the meta of the media

This function will not save the meta, call SaveMeta in order to save the meta.

meta: Which meta data. See kMeta* constants.
Value: the media's meta

VLCMediaMBS.State 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 current state of media descriptor object.

See kState* constants.

VLCMediaMBS.Stats as VLCMediaStatsMBS

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 current statistics about the media.

Returns statistics for media.

VLCMediaMBS.SubItems as VLCMediaListMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get subitems of media descriptor object.

VLCMediaMBS.TrackInfos as VLCMediaTrackInfoMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get media descriptor's elementary streams description.

Note, you need to call Parse or play the media at least once before calling this function.
Not doing this will result in an empty array.

Some examples using this method:

VLCMediaMBS.Tracks as VLCMediaTrackMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get media descriptor's elementary streams description.

Note, you need to call Parse or play the media at least once before calling this function.
Not doing this will result in an empty array.

Requires LibVLC 2.1.0 and later.

Returns an array of track objects.

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


The biggest plugin in space...