The SDK provides several options that can be configured at the app level to customize its behavior.
This section provides developers with the necessary tools to customize the behavior and functionality of the SDK according to their needs. By proper setting of these options, they can seamlessly integrate the features of the SDK with their applications and deliver personalized user experience.
In this documentation, we will walk you through the various settings available and explain how each setting influences the behavior of the SDK. You will find detailed descriptions and usage examples to better understand the functions and their parameters.
Please refer to the following sections for detailed information on each setting, including usage examples.
Let's dive in and discover the functions that will empower you to make the most of our iOS library!
To set app options for the iOS SDK, you will need to create a new instance of the Application class in your app module and set the desired options:
{% tabs %} {% tab title="Swift" %}
let options: GizoAppOptions = GizoAppOptions()
options.analysisSetting.modelName = "ArtiSense3.mlmodelc"
options.analysisSetting.allowAnalysis = true
options.analysisSetting.saveTtcCsvFile = true
options.analysisSetting.saveMatrixFile = true
options.gpsSetting.allowGps = true
options.gpsSetting.saveCsvFile = true
options.imuSetting.allowMagneticSensor = true
options.imuSetting.allowMagneticSensor = true
options.imuSetting.allowMagneticSensor = true
options.imuSetting.saveCsvFile = true
options.batterySetting.checkBattery = true
options.orientationSetting.allowGravitySensor = true
options.videoSetting.allowRecording = true
Gizo.initialize(delegate: self, options: options){% endtab %} {% endtabs %}
In the example above, we initialize the SDK instance, then we will create a new instance of the GizoAppOptions class and set the desired options.
Here are the available options that can be set in the Application class:
| Option | Default Value | Description |
|---|---|---|
| debug(Boolean) | true | Set to enable debugging log feature. |
| folderName(String) | "Gizo" | Set to save files in a download folder with this name. |
analysisSetting | null | Set to activate analyzing model and main export of the SDK. |
imuSetting | null | Set to activate motion sensors such as AccelerationSensor, GyroscopeSensor, MagneticSensor, and GravitySensor and get callbacks. |
gpsSetting | null | Set to provide location information. |
videoSetting | null | Set to change the video information. |
batterySetting | null | Set the required actions based on the battery level. |
orientationSetting | null | Set to activate the gravity sensor. |
- GizoAnalysisSetting allows developers to gain data based on the frame captured from the camera and get object detection and depth estimation.
- GizoImuSetting allows developers to utilize the sensors that make up the device's IMU. An IMU typically consists of the accelerometer, gyroscope, and magnetometer. Gravity and linear acceleration are estimated from the IMU data.
- GizoGpsSetting provides instructions on enabling GPS, accessing location, speed, the direction of movement (heading), and speed limit.
- GizoVideoSetting refers to the configuring and utilizing video-related features and components within an iOS application. Video settings include settings, such as capturing video from the device’s camera, or streaming video content.
- GizoBatterySetting refers to the configuration and management options related to the battery level of device. These settings allow developers and/or users to monitor and control the battery usage of their mobile devices.
- GizoOrientationSetting refers to checking the orientation of the device, which should be in a proper position, i.e. landscape with +y axis in the direction of vehicle +y axis.
.png)