OSVR-Core
Functions
Analysis plugin functionality (base C API)

How to create an "analysis filter/plugin". More...

Functions

OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode osvrAnalysisSyncInit (OSVR_IN_PTR OSVR_PluginRegContext ctx, OSVR_IN_STRZ const char *name, OSVR_IN_PTR OSVR_DeviceInitOptions options, OSVR_OUT_PTR OSVR_DeviceToken *device, OSVR_OUT_PTR OSVR_ClientContext *clientCtx) OSVR_FUNC_NONNULL((1
 Initialize a synchronous analysis device token with the options specified, also returning the associated client context. More...
 

Detailed Description

How to create an "analysis filter/plugin".

Function Documentation

§ osvrAnalysisSyncInit()

OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode osvrAnalysisSyncInit ( OSVR_IN_PTR OSVR_PluginRegContext  ctx,
OSVR_IN_STRZ const char *  name,
OSVR_IN_PTR OSVR_DeviceInitOptions  options,
OSVR_OUT_PTR OSVR_DeviceToken device,
OSVR_OUT_PTR OSVR_ClientContext clientCtx 
)

Initialize a synchronous analysis device token with the options specified, also returning the associated client context.

Parameters
ctxThe plugin registration context received by your entry point function.
nameA unique name for the device, abiding by the rules for an element (directory) in a URL. The library makes a copy of this string.
optionsThe DeviceInitOptions for your device.
[out]deviceWill contain the unique device token assigned to your synchronous device.
[out]clientCtxWill contain the specialized client context for your analysis use. It is owned by the device token, and should not be updated or shutdown, but can otherwise be used as provided for in ClientKit.

This transfers ownership of the DeviceInitOptions, and all created objects associated with it, to the returned device token.