Platforms to show: All Mac Windows Linux Cross-Platform

Back to VLCInstanceMBS class.

VLCInstanceMBS.AddUserInterface(name 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
Try to start a user interface for the libvlc instance.

name: interface name, or nil for default.
Return true on success, false on error.

VLCInstanceMBS.AudioOutputDevices(ModuleName as string) as VLCAudioOutputDeviceMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets a list of audio output devices for a given audio output module.

Not all audio outputs support this. In particular, an empty (nil)
list of devices does not imply that the specified audio output does
not work.

The list might 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.

Modulename: audio output name.

Returns a nil-terminated linked list of potential audio output devices.
Requires VLC 2.1.

VLCInstanceMBS.ClearLog

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Unsets the logging callback for a LibVLC instance.

This is rarely needed: the callback is implicitly unset when the instance is destroyed.
This function will wait for any pending callbacks invocation to complete
(causing a deadlock if called from within the callback).

Requires VLC 2.1.

VLCInstanceMBS.Constructor(args() 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 and initialize a libvlc instance.

This functions accept a list of "command line" arguments similar to the main(). These arguments affect the LibVLC instance default configuration.

Arguments are meant to be passed from the command line to LibVLC, just like VLC media player does. The list of valid arguments depends on the LibVLC version, the operating system and platform, and set of available LibVLC plugins. Invalid or unsupported arguments will cause the function to fail (i.e. return nil). Also, some arguments may alter the behaviour or otherwise interfere with other LibVLC functions.

There is absolutely no warranty or promise of forward, backward and cross-platform compatibility with regards to this Constructor() arguments. We recommend that you do not use them, other than when debugging.

On success handle property is not nil.
For Version 19.0 of the plugins, please do not pass app path as first argument.

For MacOS, please set VLC_PLUGIN_PATH environment variable for the path to the plugins folder.

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

VLCInstanceMBS.ExitHandler as VLCExitHandlerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Registers a callback for the LibVLC exit event.

This is mostly useful if you have started at least one interface with AddUserInterface. Typically, this function will wake up your application main loop (from another thread).

This function and WaitUserInterface() cannot be used at the same time.
Use either or none of them but not both.
(Read and Write computed property)

VLCInstanceMBS.GetAudioFilterList as VLCModuleDescriptionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns a list of audio filters that are available.

Return a list of module descriptions.

VLCInstanceMBS.GetAudioOutputDeviceCount(AudioOutputName as string) 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 of devices for audio output, these devices are hardware oriented like analor or digital output of sound card.

AudioOutputName: name of audio output.
Returns number of devices.

VLCInstanceMBS.GetAudioOutputDeviceID(AudioOutputName as string, index 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
Get id name of device.

AudioOutputName: name of audio output.
Index: device index.
Returns id name of device, use for setting device.

VLCInstanceMBS.GetAudioOutputDeviceLongName(AudioOutputName as string, index 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
Get long name of device, if not available short name given.

AudioOutputName: name of audio output.
Index: Device Index.
Returns long name of device.

VLCInstanceMBS.GetAudioOutputList as VLCAudioOutputMBS

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 list of available audio outputs.
Example

Dim v As VLCInstanceMBS // your VLC instance

Dim OutputModules() As String
Dim outputModule As VLCAudioOutputMBS = v.GetAudioOutputList
While outputModule <> Nil
Dim OutputModuleName As String = outputModule.Name
OutputModules.append OutputModuleName+": "+outputModule.Description
outputModule = outputModule.NextOutput
Wend

MessageBox Join(OutputModules, EndOfLine)

Returns list of available audio outputs. In case of error, nil is returned.

VLCInstanceMBS.GetVideoFilterList as VLCModuleDescriptionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns a list of video filters that are available.

Return a list of module descriptions

VLCInstanceMBS.SetAppID(ID as string, Version as string, Icon as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Sets some meta-information about the application.

See also SetUserAgent().

id: Java-style application identifier, e.g. "com.acme.foobar"
version: application version numbers, e.g. "1.2.3"
icon: application icon name, e.g. "foobar"

Requires VLC 2.1.

VLCInstanceMBS.SetLogEvent

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Sets the logging callback for a LibVLC instance.

This function is thread-safe: it will wait for any pending callbacks
invocation to complete.

Some log messages (especially debug) are emitted by LibVLC while
is being initialized. These messages cannot be captured with this interface.

A deadlock may occur if this function is called from the event.

Requires VLC 2.1.

VLCInstanceMBS.SetLogFile(File as FolderItem)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Sets up logging to a file.

Requires VLC 2.1.

VLCInstanceMBS.SetUserAgent(AppName as string, httpUserAgent 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
Sets the application name.

VLC passes this as the user agent string when a protocol requires it.

name: human-readable application name, e.g. "FooBar player 1.2.3"
http: HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0"

VLCInstanceMBS.WaitUserInterface

Type Topic Plugin Version macOS Windows Linux iOS Targets
method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Waits until an interface causes the instance to exit.

You should start at least one interface first, using AddUserInterface.

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


The biggest plugin in space...