Common to every plugin. More...

Functions
const GUID	splitcam::plugin::getPluginInterfaceId ()

const wchar_t *	splitcam::plugin::getPluginId ()

const wchar_t *	splitcam::plugin::getPluginName ()

const wchar_t *	splitcam::plugin::getPluginProvider ()

const splitcam::plugin::Version	splitcam::plugin::getPluginVersion ()

splitcam::plugin::PluginType	splitcam::plugin::getType ()

bool	splitcam::plugin::init ()

void	splitcam::plugin::release ()

Detailed Description

Common to every plugin.

Function Documentation

◆ getPluginId()

const wchar_t* splitcam::plugin::getPluginId ( )

This function provides SplitCam with a unique identifier of the current plugin. The plugin identifier is used to distinguish this plugin from other plugins loaded by SplitCam.

Returns: A plugin developer assigned unique identifier

◆ getPluginInterfaceId()

const GUID splitcam::plugin::getPluginInterfaceId ( )

SplitCam calls this function to get the plugin interface identifier. The interface identifier defines the function set supported by the current plugin module.

Returns: GUID of the supported plugin interface version

◆ getPluginName()

const wchar_t* splitcam::plugin::getPluginName ( )

Plugin name will be used in SplitCam user interface as a display element for this plugin instance. This name is how user sees your plugin.

Returns: Human readable name of the plugin

◆ getPluginProvider()

const wchar_t* splitcam::plugin::getPluginProvider ( )

Provides SplitCam with a name of plugin developer. This may be your company name or trademark. The plugin developer decides what this value really presents.

Returns: Human readable name of plugin developer

◆ getPluginVersion()

const splitcam::plugin::Version splitcam::plugin::getPluginVersion ( )

Current version of the plugin as defined by plugin developer. If several plugins having the same ID are available to end user SplitCam may choose the one having the greatest version and ignore other plugins with the same ID. The plugin ID is returned by getPluginId function.

Returns: Plugin version structure as splitcam::plugin::Version

◆ getType()

splitcam::plugin::PluginType splitcam::plugin::getType ( )

Currently only one plugin type is supported by SplitCam: image source. This plugin type can provide SplitCam with a source of still images or videos. The plugin developer decides how often the image is updated. To update the image you call IImageSource::DataCallback callback function.

More plugin types will be added to future versions of SplitCam.

Returns: plugin type as splitcam::plugin::PluginType

◆ init()

bool splitcam::plugin::init ( )

SplitCam calls init() function to give the plugin a chance to initialize itself. The init() is called only if the plugin is recognized and required function sets are verified by SplitCam. If this function returns false then the plugin will be unloaded and not used by SplitCam.

Returns: Boolean value indicating success or failure during initialization

◆ release()

void splitcam::plugin::release ( )

SplitCam calls release() to notify the plugin that it should prepare itself for being unloaded. Any resources should be freed and any plugin specific operations related to plugin unloading should be performed inside this function.

Functions