RecFusion SDK
RecFusionSDK Class Reference

#include <RecFusion.h>

Global configuration object for the RecFusion SDK. More...

Detailed Description

Global configuration object for the RecFusion SDK.

Used to set license information and configure global options.

Static Public Member Functions

static void init (const char *logFilename="")
 Initialize the SDK. More...
 
static void deinit ()
 De-initialize the SDK.
 
static bool activate (const char *key, const char *code="")
 Activate the SDK license. More...
 
static const char * token ()
 Token needed for the offline acivation. More...
 
static bool validLicense ()
 Validity of SDK license. More...
 
static int majorVersion ()
 SDK major version. More...
 
static int minorVersion ()
 SDK minor version. More...
 
static int buildVersion ()
 SDK build version. More...
 

Member Function Documentation

◆ init()

static void init ( const char *  logFilename = "")
static

Initialize the SDK.

Parameters
filenameOptional filename to use for the file logger. No logging to file is performed if no filename is provided or if the provided filename is empty. File will be created if doesn't exist.

◆ activate()

static bool activate ( const char *  key,
const char *  code = "" 
)
static

Activate the SDK license.

Will do nothing if the license had already been activated.

Parameters
keyLicense key.
codeOptional activation code, needed for offline activation. In case of offline activation, send the key and token to suppo.nosp@m.rt@r.nosp@m.ecfus.nosp@m.ion..nosp@m.net to obtain the acivation code
Returns
True if license is valid, false otherwise.

◆ token()

static const char* token ( )
static

Token needed for the offline acivation.

Returns
Token

◆ validLicense()

static bool validLicense ( )
static

Validity of SDK license.

Returns
True if license is valid, false otherwise.

◆ majorVersion()

static int majorVersion ( )
static

SDK major version.

Returns
SDK major version.

◆ minorVersion()

static int minorVersion ( )
static

SDK minor version.

Returns
SDK minor version.

◆ buildVersion()

static int buildVersion ( )
static

SDK build version.

Returns
SDK build version.

The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close