Banuba SDK
BNBUtilityManager.h
Go to the documentation of this file.
1 // AUTOGENERATED FILE - DO NOT MODIFY!
2 // This file was generated by Djinni from recognizer.djinni
3 
4 #import "BNBHardwareClass.h"
6 #import "BNBSeverityLevel.h"
7 #import <Foundation/Foundation.h>
8 
9 
10 
11 #ifndef DJINNI_EXPORT
12  #define DJINNI_EXPORT __attribute__((__visibility__("default")))
13 #endif
14 
16 @interface BNBUtilityManager : NSObject
17 
18 + (void)initialize:(nonnull NSArray<NSString *> *)resourcePaths
19  clientToken:(nonnull NSString *)clientToken;
20 
21 + (void)release;
22 
23 /** Add resources search path */
24 + (void)addResourcePath:(nonnull NSString *)resourcePath;
25 
26 /** Remove resources search path */
27 + (void)removeResourcePath:(nonnull NSString *)resourcePath;
28 
29 /** Diagnostic crash. Use this to check you crash analytics systems. */
30 + (void)diagnosticCrash;
31 
32 /**
33  * Get information about CPU capabilities. Mainly for usage on Android
34  * @return JSON-string describing CPU capabilties
35  */
36 + (nonnull NSString *)cpuEnv;
37 
38 /**
39  * Check device SoC class.
40  * On Android first call may require presence of OpenGL context to
41  * get info about GPU.
42  * @return hardware class of device
43  */
44 + (BNBHardwareClass)getHardwareClass;
45 
46 + (void)setLogLevel:(BNBSeverityLevel)level;
47 
48 /**
49  * Turns on SDK feature - analytics collection
50  * @param outputFolder here log files would be written
51  * could be documents directory for mobile apps
52  */
53 + (void)enableDiagnostics:(nonnull NSString *)outputFolder;
54 
55 /** Turns on SDK feature - telemetry collection */
56 + (void)enableTelemetry;
57 
58 /**
59  * Set callback to recieve log events from Banuba SDK.
60  * @param cb Callback
61  * @param lvl recieve logs with specified and higher levels
62  */
63 + (void)setLogRecordCallback:(nullable id<BNBLogRecordCallback>)cb
64  lvl:(BNBSeverityLevel)lvl;
65 
66 /** Returns SDK version as string */
67 + (nonnull NSString *)getBanubaSdkVersionString;
68 
69 /**
70  * Returns SDK version as number
71  * major = version / 10000000
72  * minor = (version - major * 10000000) / 100000
73  * patch = (version - major * 10000000 - minor * 100000) / 1000
74  * revision = version % 1000
75  */
76 + (int32_t)getBanubaSdkVersion;
77 
78 /**
79  * The Banuba SDK tracks the resource version it built for.
80  * Returns version of resources as string, represented in the following format
81  * “Major.Minor.Patch”.
82  */
83 + (nonnull NSString *)getBanubaSdkResourcesVersionString;
84 
85 /**
86  * Returns version as number
87  * major = version / 10000000
88  * minor = (version - major * 10000000) / 100000
89  * patch = (version - major * 10000000 - minor * 100000) / 1000
90  * revision = version % 1000
91  */
93 
94 /**
95  * The Banuba SDK supports external resources archives.
96  * After the initialization of the Banuba SDK,
97  * API provides the capability to request the version of the archive.
98  * Returns version of resources archive as string,
99  * represented in the following format “Major.Minor.Patch”.
100  * Such a version coincides with the Banuba SDK resources version
101  * if no external resources are used.
102  */
103 + (nonnull NSString *)getBanubaSdkResourcesVersionArchiveString;
104 
105 /**
106  * Checks if the current version of resources
107  * is equal to Banuba SDK expected resources version
108  */
110 
111 /** Checks if Banuba SDK treats as valid the version of external resources */
113 
114 /**
115  * load GL functions, for dynamic libraries only
116  * should be called with active GL context
117  */
118 + (void)loadGlFunctions;
119 
120 @end
+[BNBUtilityManager getBanubaSdkVersionString]
nonnull NSString * getBanubaSdkVersionString()
Returns SDK version as string.
BNBHardwareClass.h
+[BNBUtilityManager getBanubaSdkResourcesVersionString]
nonnull NSString * getBanubaSdkResourcesVersionString()
The Banuba SDK tracks the resource version it built for.
+[BNBUtilityManager getHardwareClass]
BNBHardwareClass getHardwareClass()
Check device SoC class.
BNBSeverityLevel.h
DJINNI_EXPORT
#define DJINNI_EXPORT
Definition: BNBUtilityManager.h:12
+[BNBUtilityManager release]
void release()
+[BNBUtilityManager getBanubaSdkResourcesVersion]
int32_t getBanubaSdkResourcesVersion()
Returns version as number major = version / 10000000 minor = (version - major * 10000000) / 100000 pa...
+[BNBUtilityManager getBanubaSdkResourcesVersionArchiveString]
nonnull NSString * getBanubaSdkResourcesVersionArchiveString()
The Banuba SDK supports external resources archives.
+[BNBUtilityManager checkBanubaSdkResourcesVersionIgnorePatch]
BOOL checkBanubaSdkResourcesVersionIgnorePatch()
Checks if Banuba SDK treats as valid the version of external resources.
+[BNBUtilityManager checkBanubaSdkResourcesVersion]
BOOL checkBanubaSdkResourcesVersion()
Checks if the current version of resources is equal to Banuba SDK expected resources version.
+[BNBUtilityManager cpuEnv]
nonnull NSString * cpuEnv()
Get information about CPU capabilities.
+[BNBUtilityManager enableTelemetry]
void enableTelemetry()
Turns on SDK feature - telemetry collection.
+[BNBUtilityManager getBanubaSdkVersion]
int32_t getBanubaSdkVersion()
Returns SDK version as number major = version / 10000000 minor = (version - major * 10000000) / 10000...
BNBLogRecordCallback-p
Definition: BNBLogRecordCallback.h:8
+[BNBUtilityManager diagnosticCrash]
void diagnosticCrash()
Diagnostic crash.
BNBUtilityManager
Definition: BNBUtilityManager.h:16
+[BNBUtilityManager loadGlFunctions]
void loadGlFunctions()
load GL functions, for dynamic libraries only should be called with active GL context
BNBLogRecordCallback.h