WTStartupConfiguration Class Reference
Inherits from | NSObject |
---|---|
Declared in | WTStartupConfiguration.h |
Overview
WTStartupConfiguration represents configuration values that are used during the SDK startup. If any of the defined properties can not be applied, an error is given to the debug delegate and also an error message is printed in the Xcode console.
captureDevicePreset
The capture device preset that should be used when the SDK starts. If the preset is not supported by the current device, then a default preset is used.
@property (nonatomic, strong) NSString *captureDevicePreset
Declared In
WTStartupConfiguration.h
captureDevicePosition
The capture device position that should be used when the SDK starts. If the position is not supported by the current device, then a default position is used.
@property (nonatomic, assign) AVCaptureDevicePosition captureDevicePosition
Declared In
WTStartupConfiguration.h
captureDeviceFocusMode
The capture device focus mode that should be used when the SDK starts. If the given focus mode is not supported by the current device, then a default focus mode is used.
@property (nonatomic, assign) AVCaptureFocusMode captureDeviceFocusMode
Discussion
Warning: Most front cameras do not support a specific focus mode. They will always fall back to a continuous focus mode
Declared In
WTStartupConfiguration.h
captureDeviceFocusRangeRestriction
The capture device focus range restriction that should be used when the SDK starts. If the given focus range restriction is not supported by the current device, then this property is ignored.
@property (nonatomic, assign) AVCaptureAutoFocusRangeRestriction captureDeviceFocusRangeRestriction
Discussion
Please refer to the official AVCaptureAutoFocusRangeRestriction documentation for more information.
Declared In
WTStartupConfiguration.h
targetFrameRate
The target frame rate at which the SDK should run.
@property (nonatomic, assign) CMTime targetFrameRate
Discussion
Use the convenience function WTMakeTargetFrameRate60FPS or WTMakeTargetFrameRate30FPS to construct a correct CMTime struct for a desired frame rate. The default value is 30 FPS.
Warning: If the given frame rate can not be applied for the current device, the default value will be used.
Declared In
WTStartupConfiguration.h
cameraRenderingTargetTexture
The target texture that should be used to draw the camera frame onto.
@property (nonatomic, assign) GLuint cameraRenderingTargetTexture
Discussion
@default -1
You should only use this property if your application has already setup a fixed rendering pipeline and wants the Wikitude SDK to draw the camera frame onto a very specific OpenGL ES 2 texture. Under normal circumstances, WTRenderingMode_External should be used if the Wikitude SDK should draw the camera frame in an already existing rendering environment.
Declared In
WTStartupConfiguration.h
shouldUseSystemDeviceSensorCalibrationDisplay
Defines if the iOS SDK device sensor calibration display should be shown or not in case device sensors calibration is needed.
@property (nonatomic, assign) BOOL shouldUseSystemDeviceSensorCalibrationDisplay
Discussion
@default NO
For iOS 9, the current view controller will receive calls to -viewWillDisappear:/-viewWillAppear: in case the system calibration screen is shown. Please make sure that the Wikitude SDK is not stopped/started as this would constantly switch between the calibration view and Wikitude SDK view. Implement the Wikitude SDK delegate method -: in order to observe the calibration status and to not pause the Wikitude SDK during that time.
Declared In
WTStartupConfiguration.h