Platforms to show: All Mac Windows Linux Cross-Platform

Back to VLCMediaListMBS class.

VLCMediaListMBS.AddMedia(item as VLCMediaMBS) 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
Add media instance to media list.

item: a media instance
Return true on success, false if the media list is read-only.
The Lock should be held upon entering this function.

VLCMediaListMBS.Constructor(vlc 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 list.

On success the handle property is not zero.

VLCMediaListMBS.Count 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 count on media list items.

The Lock should be held upon entering this function.
Return number of items in media list.

VLCMediaListMBS.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.

VLCMediaListMBS.GetMedia 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
Get media instance from this media list instance.

The Lock should NOT be held upon entering this function.
Returns media instance or nil.

VLCMediaListMBS.IndexOfItem(item as VLCMediaMBS) 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
Find index position of List media instance in media list.

Warning: the function will return the first matched position.
The Lock should be held upon entering this function.

Returns position of media instance or -1 if media not found.

VLCMediaListMBS.InsertMedia(item as VLCMediaMBS, index as Integer) 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
Insert media instance in media list on a position.

The Lock should be held upon entering this function.
item: a media instance
index: position in array where to insert

Return true on success, false if the media list is read-only.

VLCMediaListMBS.isReadOnly 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
Whether this media list is read-only from a user point of view.

Returns true if readonly and false if read/write.

VLCMediaListMBS.ItemAtIndex(index as Integer) 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
List media instance in media list at a position.

The Lock should be held upon entering this function.
index: position in array where to get item.
Returns instance at position index, or nil if not found.

VLCMediaListMBS.Lock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get lock on media list items.

VLCMediaListMBS.Remove(index as Integer) 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
Remove media instance from media list on a position.

The Lock should be held upon entering this function.
index: position in array where to insert
Returns true on success, false if the list is read-only or the item was not found.

VLCMediaListMBS.SetMedia(item 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
Associate media instance with this media list instance.

If another media instance was present it will be released.
The Lock should NOT be held upon entering this function.

VLCMediaListMBS.Unlock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Release lock on media list items.

The Lock should be held upon entering this function.

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


The biggest plugin in space...