WTStartupConfiguration Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | NSCopying |
| 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.
captureDeviceResolution
The capture device resolution that should be used when the SDK starts. If the resolution is not supported by the current device, then a default resolution is used.
@property (nonatomic, assign) WTCaptureDeviceResolution captureDeviceResolutionDiscussion
@default WTCaptureDeviceResolution_SD_640x480
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 captureDevicePositionDiscussion
@default AVCaptureDevicePositionBack
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 captureDeviceFocusModeDiscussion
Warning: Most front cameras do not support a specific focus mode. They will always fall back to a continuous focus mode
@default AVCaptureFocusModeContinuousAutoFocus
Declared In
WTStartupConfiguration.h
captureDeviceFocusDistance
The capture device focus distance that should be used when the SDK starts. In case the focus distance is not supported by the current device, then a default focus distance is used.
@property (nonatomic, assign) float captureDeviceFocusDistanceDiscussion
Warning: Setting the focus distance is only supported since iOS 10. All devices with a lower iOS version will use the default focus distance.
@default -1.0
Declared In
WTStartupConfiguration.h
)
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 API_UNAVAILABLE ( macos )Discussion
Please refer to the official AVCaptureAutoFocusRangeRestriction documentation for more information.
@default AVCaptureAutoFocusRangeRestrictionNone
Declared In
WTStartupConfiguration.h
targetFrameRate
The target frame rate at which the SDK should run.
@property (nonatomic, assign) CMTime targetFrameRateDiscussion
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.
@default WTMakeTargetFrameRate30FPS
Declared In
WTStartupConfiguration.h
shouldExcludeBinnedVideoFormats
Per default the Wikitude SDK would not consider capture device formats that are binned.
@property (nonatomic, assign) BOOL shouldExcludeBinnedVideoFormatsDiscussion
Binned videos have a pixel dimension of the given format, but the actual content might have a lower resolution. The content is then upscaled to fill the actual format dimension. This upscaling leads then to rendering artifacts in the camera image.
If this limitation should be disabled, this property can be set to NO. The default value is YES.
@default YES
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 shouldUseSystemDeviceSensorCalibrationDisplayDiscussion
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.
@default NO
Declared In
WTStartupConfiguration.h
externalCMMotionManagerDataAccessMode
Defines if an CMMotionManager instance can be created internally or not. If not, the given subclass of type WTExternalCMMotionManagerDataAccessMode defines how external CMMotionManager is accessed.
@property (nonatomic, strong) WTExternalCMMotionManagerDataAccessMode *externalCMMotionManagerDataAccessModeDiscussion
@default nil
Declared In
WTStartupConfiguration.h
+ transferStartupConfiguration:toStartupConfiguration:
Utility method to transfer a certain startup configuration to a different one.
+ (void)transferStartupConfiguration:(WTStartupConfiguration *)sourceStartupConfiguration toStartupConfiguration:(WTStartupConfiguration *)destinationStartupConfigurationParameters
sourceStartupConfiguration |
The startup configuration from which values are read |
|---|---|
destinationStartupConfiguration |
The startup configuraiton to which values should be written to |
Declared In
WTStartupConfiguration.h