Platforms to show: All Mac Windows Linux Cross-Platform

Back to VLCInstanceMBS class.

VLCInstanceMBS.ClearError

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Clears the LibVLC error status for the current thread.

This is optional.
By default, the error status is automatically overridden when a new error occurs, and destroyed when the thread exits.

VLCInstanceMBS.Clock as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return the current time as defined by LibVLC.

The unit is the microsecond.
Time increases monotonically (regardless of time zone changes and RTC adjustements).
The origin is arbitrary but consistent across the whole system (e.g. the system uptim, the time since the system was booted). On systems that support it, the POSIX monotonic clock is used.

VLCInstanceMBS.ErrorMessage as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns an human-readable error message for the last VLC error in the calling thread.

VLCInstanceMBS.GetChangeset as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Retrieve libvlc changeset.

Example: "aa9bce0bc4"
Return a string containing the libvlc changeset.

VLCInstanceMBS.GetCompiler as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Retrieve libvlc compiler version.

Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
Return a string containing the libvlc compiler version.

VLCInstanceMBS.getenv(name as string) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries the environment variable with given name.

VLCInstanceMBS.GetLoadError as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns error string from LoadLibrary function.

Some examples using this method:

VLCInstanceMBS.GetVersion as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Retrieve libvlc version.

Example: "1.1.0-git The Luggage"
Return a string containing the libvlc version.

VLCInstanceMBS.LoadLibrary(path as folderitem) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Loads the vlc library.

Returns true on success and false on failure.
Please point to libVLC.dylib on Mac and libVLC.dll on Windows.

See also:

VLCInstanceMBS.LoadLibrary(path as string) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Loads the vlc library.

Returns true on success and false on failure.
Please point to libVLC.dylib on Mac and libVLC.dll on Windows.

See also:

VLCInstanceMBS.setlocale(category as Integer, locale as string) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method VLC MBS VLC Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Sets the locale to use.

The Setlocale function sets the C library's notion of natural language formatting style for particular sets of routines. Each such style is called a 'locale' and is invoked using an appropriate name passed as a C string.

The setlocale() function recognizes several categories of routines. These are the categories and the sets of routines they select:

LocaleAllSet the entire locale generically.
LocaleCollateSet a locale for string collation routines. This controls alphabetic ordering in strcoll() and strxfrm().
LocaleCTypeSet a locale for the ctype and multibyte functions. This controls recognition of upper and lower case, alphabetic or non-alphabetic characters, and so on.
LocaleMessagesSet a locale for message catalogs, see catopen function.
LocaleMonetarySet a locale for formatting monetary values; this affects the localeconv() function.
LocaleNumericSet a locale for formatting numbers. This controls the formatting of decimal points in input and output of floating point numbers in functions such as printf() and scanf(), as well as values returned by localeconv().
LocaleTimeSet a locale for formatting dates and times using the strftime() function.

Only three locales are defined by default: the empty string "" (which denotes the native environment) and the "C" and "POSIX" locales (which denote the C-language environment). By default, C programs start in the "C" locale.

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


The biggest plugin in space...