Banuba SDK
Class Methods | List of all members
BNBUtilityManager Class Reference

#import <BNBUtilityManager.h>

Inheritance diagram for BNBUtilityManager:

Class Methods

(void) + initialize:clientToken:
 
(void) + release
 
(void) + addResourcePath:
 Add resources search path. More...
 
(void) + removeResourcePath:
 Remove resources search path. More...
 
(void) + diagnosticCrash
 Diagnostic crash. More...
 
(nonnull NSString *) + cpuEnv
 Get information about CPU capabilities. More...
 
(BNBHardwareClass) + getHardwareClass
 Check device SoC class. More...
 
(void) + setLogLevel:
 
(void) + enableDiagnostics:
 Turns on SDK feature - analytics collection. More...
 
(void) + enableTelemetry
 Turns on SDK feature - telemetry collection. More...
 
(void) + setLogRecordCallback:lvl:
 Set callback to recieve log events from Banuba SDK. More...
 
(nonnull NSString *) + getBanubaSdkVersionString
 Returns SDK version as string. More...
 
(int32_t) + getBanubaSdkVersion
 Returns SDK version as number major = version / 10000000 minor = (version - major * 10000000) / 100000 patch = (version - major * 10000000 - minor * 100000) / 1000 revision = version % 1000. More...
 
(nonnull NSString *) + getBanubaSdkResourcesVersionString
 The Banuba SDK tracks the resource version it built for. More...
 
(int32_t) + getBanubaSdkResourcesVersion
 Returns version as number major = version / 10000000 minor = (version - major * 10000000) / 100000 patch = (version - major * 10000000 - minor * 100000) / 1000 revision = version % 1000. More...
 
(nonnull NSString *) + getBanubaSdkResourcesVersionArchiveString
 The Banuba SDK supports external resources archives. More...
 
(BOOL) + checkBanubaSdkResourcesVersion
 Checks if the current version of resources is equal to Banuba SDK expected resources version. More...
 
(BOOL) + checkBanubaSdkResourcesVersionIgnorePatch
 Checks if Banuba SDK treats as valid the version of external resources. More...
 
(void) + loadGlFunctions
 load GL functions, for dynamic libraries only should be called with active GL context More...
 

Detailed Description

Definition at line 16 of file BNBUtilityManager.h.

Method Documentation

◆ addResourcePath:

+ (void) addResourcePath: (nonnull NSString *)  resourcePath

Add resources search path.

◆ checkBanubaSdkResourcesVersion

+ (BOOL) checkBanubaSdkResourcesVersion

Checks if the current version of resources is equal to Banuba SDK expected resources version.

◆ checkBanubaSdkResourcesVersionIgnorePatch

+ (BOOL) checkBanubaSdkResourcesVersionIgnorePatch

Checks if Banuba SDK treats as valid the version of external resources.

◆ cpuEnv

+ (nonnull NSString *) cpuEnv

Get information about CPU capabilities.

Mainly for usage on Android

Returns
JSON-string describing CPU capabilties

◆ diagnosticCrash

+ (void) diagnosticCrash

Diagnostic crash.

Use this to check you crash analytics systems.

◆ enableDiagnostics:

+ (void) enableDiagnostics: (nonnull NSString *)  outputFolder

Turns on SDK feature - analytics collection.

Parameters
outputFolderhere log files would be written could be documents directory for mobile apps

◆ enableTelemetry

+ (void) enableTelemetry

Turns on SDK feature - telemetry collection.

◆ getBanubaSdkResourcesVersion

+ (int32_t) getBanubaSdkResourcesVersion

Returns version as number major = version / 10000000 minor = (version - major * 10000000) / 100000 patch = (version - major * 10000000 - minor * 100000) / 1000 revision = version % 1000.

◆ getBanubaSdkResourcesVersionArchiveString

+ (nonnull NSString *) getBanubaSdkResourcesVersionArchiveString

The Banuba SDK supports external resources archives.

After the initialization of the Banuba SDK, API provides the capability to request the version of the archive. Returns version of resources archive as string, represented in the following format “Major.Minor.Patch”. Such a version coincides with the Banuba SDK resources version if no external resources are used.

◆ getBanubaSdkResourcesVersionString

+ (nonnull NSString *) getBanubaSdkResourcesVersionString

The Banuba SDK tracks the resource version it built for.

Returns version of resources as string, represented in the following format “Major.Minor.Patch”.

◆ getBanubaSdkVersion

+ (int32_t) getBanubaSdkVersion

Returns SDK version as number major = version / 10000000 minor = (version - major * 10000000) / 100000 patch = (version - major * 10000000 - minor * 100000) / 1000 revision = version % 1000.

◆ getBanubaSdkVersionString

+ (nonnull NSString *) getBanubaSdkVersionString

Returns SDK version as string.

◆ getHardwareClass

+ (BNBHardwareClass) getHardwareClass

Check device SoC class.

On Android first call may require presence of OpenGL context to get info about GPU.

Returns
hardware class of device

◆ initialize:clientToken:

+ (void) initialize: (nonnull NSArray< NSString * > *)  resourcePaths
clientToken: (nonnull NSString *)  clientToken 

◆ loadGlFunctions

+ (void) loadGlFunctions

load GL functions, for dynamic libraries only should be called with active GL context

◆ release

+ (void) release

◆ removeResourcePath:

+ (void) removeResourcePath: (nonnull NSString *)  resourcePath

Remove resources search path.

◆ setLogLevel:

+ (void) setLogLevel: (BNBSeverityLevel)  level

◆ setLogRecordCallback:lvl:

+ (void) setLogRecordCallback: (nullable id< BNBLogRecordCallback >)  cb
lvl: (BNBSeverityLevel)  lvl 

Set callback to recieve log events from Banuba SDK.

Parameters
cbCallback
lvlrecieve logs with specified and higher levels

The documentation for this class was generated from the following file: