Constants

The following constants are available globally.

  • Sync the camera’s clock to the current system clock, if supported by the camera.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLConnectionFlagSyncCameraClockToSystemClock

    Swift

    let CBLConnectionFlagSyncCameraClockToSystemClock: String

  • Powers off the camera during disconnect, if supported by the camera. Requires CBLCameraSupportedFunctionalityPowerOffOnDisconnect.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLDisconnectionFlagPowerOffCamera

    Swift

    let CBLDisconnectionFlagPowerOffCamera: String

Live View

  • If set to @YES, image data will not be decoded in delivered live view frames, so the image property of delivered frames will be nil. All other properties will be populated as normal, including rawImageData. This can be useful if you have a frame rendering pipeline that doesn’t need NSImage/UIImage objects, as turning off image decoding can save a significant amount of CPU resources.

    When omitted from the options dictionary, the assumed value for this option is @NO.

    Note

    If you enable this option, it’s important to be aware that while a camera’s live view image pixel format is usually stable once a stream starts, some cameras can change pixel formats mid-stream. It’s important to be able to handle this if you’re working directly with the various rawPixel… properties on live view frames.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLLiveViewOptionSkipImageDecoding

    Swift

    let CBLLiveViewOptionSkipImageDecoding: String

  • If set to @YES and if supported by the particular camera model you’re connected to, live view will be configured to favour lower-quality image data in an attempt to achieve a higher live view frame rate. If set to @NO (or omitted), live view will be configured to favour the highest quality image.

    Setting this option after live view has started (with -applyLiveViewStreamOptions:) has no effect.

    When omitted from the options dictionary, the assumed value for this option is @NO.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLLiveViewOptionFavorHighFrameRate

    Swift

    let CBLLiveViewOptionFavorHighFrameRate: String

  • If you’re running in the iOS Simulator, set this key in NSUserDefaults to the name of your Mac’s WiFi interface (Macs with built-in Ethernet tend to have it on en1 and Macs without on en0) before calling -beginSearching otherwise detection may not work correctly. The value of this constant is the same as its name, and is only valid when running in the Simulator.

    Declaration

    Objective-C

    extern NSString
    *const _Nonnull CBLNetworkConfigurationSimulatorWiFiInterfaceOverride

    Swift

    let CBLNetworkConfigurationSimulatorWiFiInterfaceOverride: String

  • If there isn’t a common value translation for a property value, APIs will instead return this value.

    Declaration

    Objective-C

    extern const CBLPropertyCommonValue CBLPropertyCommonValueNone

    Swift

    let PropertyCommonValueNone: PropertyCommonValue

  • The camera is a Canon camera.

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilyCanon

    Swift

    let CameraFamilyCanon: CameraFamily

  • The camera is an Olympus camera.

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilyOlympus

    Swift

    let CameraFamilyOlympus: CameraFamily

  • The camera is a Nikon camera.

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilyNikon

    Swift

    let CameraFamilyNikon: CameraFamily

  • The camera is a Sony camera.

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilySony

    Swift

    let CameraFamilySony: CameraFamily

  • The camera is a Panasonic camera.

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilyPanasonic

    Swift

    let CameraFamilyPanasonic: CameraFamily

  • The camera is a Fujifilm camera.

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilyFuji

    Swift

    let CameraFamilyFuji: CameraFamily

  • The camera is a “generic” camera (typically an import-only camera connected via USB).

    Declaration

    Objective-C

    extern const CBLCameraFamily CBLCameraFamilyGeneric

    Swift

    let CameraFamilyGeneric: CameraFamily

  • The plugin info dictionary Info.plist key.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLCorePluginInfoDictionaryKey

    Swift

    let CBLCorePluginInfoDictionaryKey: String

  • The Info.plist plugin info dictionary key for the plugin’s entrypoint @objc class name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLCorePluginEntryPointClassNameKey

    Swift

    let CBLCorePluginEntryPointClassNameKey: String

  • The Info.plist plugin info dictionary key for the plugin’s display name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLCorePluginDisplayNameKey

    Swift

    let CBLCorePluginDisplayNameKey: String

  • The Info.plist plugin info dictionary key for the plugin’s minimum CascableCore version (i.e., 16.0.0).

    Declaration

    Objective-C

    extern NSString *const _Nonnull CBLCorePluginMinimumSDKVersionKey

    Swift

    let CBLCorePluginMinimumSDKVersionKey: String

  • Returns a detailed version string for the SDK.

    Declaration

    Objective-C

    static NSString *const CBLCoreVerboseVersion = @"16.0.0-g2f418540-dirty"

  • Returns the build number for the SDK.

    Declaration

    Objective-C

    static NSString *const CBLCoreBundleVersion = @"2054"

  • Posted when the device’s WiFi reachability status changes, or when the SSID of the connected WiFi network changes.

    Declaration

    Objective-C

    extern NSString *const CBLWiFiConnectivityDidChangeNotificationName

  • The domain string used with CascableCore NSError objects.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME NSString *const CBLErrorDomain

    Swift

    let CascableCoreErrorDomain: String

  • The error user info key for the underlying raw camera response code.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME NSString *const CBLUnderlyingResponseCodeKey

    Swift

    let UnderlyingResponseCodeKey: String

  • The error user info key for a description of the underlying raw camera response code.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME NSString *const CBLUnderlyingResponseCodeDescriptionKey

    Swift

    let UnderlyingResponseCodeDescriptionKey: String

  • The error user info key for a description of the error code (i.e., the CBLErrorCode code).

    Declaration

    Objective-C

    extern NS_SWIFT_NAME NSString *const CBLErrorCodeDescriptionKey

    Swift

    let ErrorCodeDescriptionKey: String