BASS_PluginLoad


Plugs an "add-on" into the standard stream and sample creation functions.

HPLUGIN BASS_PluginLoad(
    char *file,
    DWORD flags
);

Parameters

fileFilename of the add-on/plugin.
flagsA combination of these flags.
BASS_UNICODEfile is in UTF-16 form. Otherwise it is ANSI on Windows or Windows CE, and UTF-8 on other platforms.

Return value

If successful, the loaded plugin's handle is returned, else 0 is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_FILEOPENThe file could not be opened.
BASS_ERROR_FILEFORMThe file is not a plugin.
BASS_ERROR_VERSIONThe plugin requires a different BASS version. Due to the use of the "stdcall" calling-convention, and so risk of stack faults from unexpected API differences, an add-on won't load at all on Windows if the BASS version is unsupported, and a BASS_ERROR_FILEFORM error will be generated instead of this.
BASS_ERROR_ALREADYThe plugin is already loaded.

Remarks

There are 2 ways in which add-ons can provide support for additional formats. They can provide dedicated functions to create streams of the specific format(s) they support and/or they can plug into the standard stream creation functions: BASS_StreamCreateFile, BASS_StreamCreateURL, and BASS_StreamCreateFileUser. This function enables the latter method. Both methods can be used side by side. The obvious advantage of the plugin system is convenience, while the dedicated functions can provide extra options that are not possible via the shared function interfaces. See an add-on's documentation for more specific details on it.

As well as the stream creation functions, plugins also add their additional format support to BASS_SampleLoad.

Information on what file formats a plugin supports is available via the BASS_PluginGetInfo function.

When using multiple plugins, the stream/sample creation functions will try each of them in the order that they were loaded via this function, until one that accepts the file is found.

When an add-on is already loaded (eg. if you are using functions from it), the plugin system will use the same instance (the reference count will just be incremented); there will not be 2 copies of the add-on in memory.

Platform-specific

Dynamic libraries are not permitted on iOS, so add-ons are provided as static libraries instead, which means this function has to work a little differently. The add-on needs to be linked into the executable, and a "plugin" symbol declared and passed to this function (instead of a filename). See the example below.

Example

Plugin the FLAC add-on.
#ifdef _WIN32 // Windows/CE
    BASS_PluginLoad("bassflac.dll", 0);
#elif __linux__ // Linux
    BASS_PluginLoad("libbassflac.so", 0);
#elif TARGET_OS_IPHONE // iOS
    extern void BASSFLACplugin;
    BASS_PluginLoad(&BASSFLACplugin, 0);
#else // OSX
    BASS_PluginLoad("libbassflac.dylib", 0);
#endif

See also

BASS_PluginFree, BASS_PluginGetInfo