GSCameraPhotoSettings

@objc
public protocol GSCameraPhotoSettings

Settings to configure photo mode and options

Note

This protocol is for Objective-C compatibility only.

  • Tells if a setting value has been changed and is waiting for change confirmation.

    Declaration

    Swift

    var updating: Bool { get }

  • Photo mode.

    Declaration

    Swift

    var mode: CameraPhotoMode { get set }

  • Photo format.

    Declaration

    Swift

    var format: CameraPhotoFormat { get set }

  • Photo file format.

    Declaration

    Swift

    var fileFormat: CameraPhotoFileFormat { get set }

  • Burst value when mode is burst.

    Declaration

    Swift

    var burstValue: CameraBurstValue { get set }

  • Bracketing value when mode is bracketing.

    Declaration

    Swift

    var bracketingValue: CameraBracketingValue { get set }

  • Whether HDR is available in the current mode, format and file format.

    Declaration

    Swift

    var hdrAvailable: Bool { get }

  • Current time-lapse interval value (in seconds) when the photo mode is time_lapse. Ignored in other modes.

    Declaration

    Swift

    var timelapseCaptureInterval: Double { get set }

  • Current GPS-lapse interval value (in meters) when the photo mode is gps_lapse. Ignored in other modes.

    Declaration

    Swift

    var gpslapseCaptureInterval: Double { get set }

  • Minimum supported timelapseInterval.

    Declaration

    Swift

    var gsMinSupportedTimelapseIntervals: Double { get }

  • Maximum supported timelapseInterval.

    Declaration

    Swift

    var gsMaxSupportedTimelapseIntervals: Double { get }

  • Minimum supported gpslapseInterval.

    Declaration

    Swift

    var gsMinSupportedGpslapseIntervals: Double { get }

  • Maximum supported gpslapseInterval.

    Declaration

    Swift

    var gsMaxSupportedGpslapseIntervals: Double { get }

  • Checks if a photo mode is supported.

    Declaration

    Swift

    func isModeSupported(_ mode: CameraPhotoMode) -> Bool

    Parameters

    mode

    mode to check

    Return Value

    true if the mode is supported

  • Checks if a photo format is supported in the current mode.

    Declaration

    Swift

    func isFormatSupported(_ format: CameraPhotoFormat) -> Bool

    Parameters

    format

    photo format to check

    Return Value

    true if the photo format is supported in the current mode

  • Checks if a photo format is supported in a specific mode.

    Declaration

    Swift

    func isFormatSupported(_ format: CameraPhotoFormat, forMode mode: CameraPhotoMode) -> Bool

    Parameters

    mode

    mode to check if a photo format is supported
    format

    photo format to check

    Return Value

    true if the photo format is supported in specified mode

  • Checks if a photo file format is supported in the current mode.

    Declaration

    Swift

    func isFileFormatSupported(_ fileformat: CameraPhotoFileFormat) -> Bool

    Parameters

    fileformat

    file format to check

    Return Value

    true if the file format is supported in the current mode

  • Checks if a photo file format is supported in a specific photo mode and format.

    Declaration

    Swift

    func isFileFormatSupported(_ fileformat: CameraPhotoFileFormat, forPhotoMode: CameraPhotoMode,
                           andPhotoFormat photoFormat: CameraPhotoFormat) -> Bool

    Parameters

    mode

    mode to check if a photo format is supported
    photoFormat

    photo format to check if a file format is supported
    fileFormat

    file format to check

    Return Value

    true if the file format is supported in specified mode and format

  • Checks if a burst value is supported.

    Declaration

    Swift

    func isBurstValueSupported(_ burstValue: CameraBurstValue) -> Bool

    Parameters

    burstValue

    burst value to check

    Return Value

    true if the burst value is supported

  • Checks if a bracketing value is supported.

    Declaration

    Swift

    func isBracketingValueSupported(_ bracketingValue: CameraBracketingValue) -> Bool

    Parameters

    bracketingValue

    bracketing value to check

    Return Value

    true if the bracketing value is supported

  • Tells whether HDR is available for specific mode, format and file format.

    Declaration

    Swift

    @objc(isHdrAvailableForMode:format:fileFormat:)
func hdrAvailable(forMode mode: CameraPhotoMode, format: CameraPhotoFormat, fileFormat: CameraPhotoFileFormat)
    -> Bool

    Parameters

    mode

    the photo mode
    format

    the photo format
    fileFormat

    the photo file format

    Return Value

    true if hdr is available in the given mode, format and file format

  • Changes photo mode, format, file format, burst and bracketing value.

    Declaration

    Swift

    @objc(setMode:format:fileformat:burstValue:bracketingValue:gpslapseCaptureIntervalValue:timelapseCaptureIntervalValue:)
func gsSet(mode: CameraPhotoMode, format: CameraPhotoFormat, fileFormat: CameraPhotoFileFormat,
           burstValue: Int, bracketingValue: Int, gpslapseCaptureIntervalValue: Double,
           timelapseCaptureIntervalValue: Double)

    Parameters

    mode

    photo mode
    format

    photo format
    fileFormat

    photo file format,
    burstValue

    burst value when photo mode is burst, -1 to keep current burst value
    bracketingValue

    bracketing value when photo mode is bracketing, -1 to keep current bracketing value
    captureInterval

    capture interval Current time-lapse interval value (in seconds) when the photo mode is time_lapse. Current GPS-lapse interval value (in meters) when the photo mode is gps_lapse. Ignored in other modes.