CameraPhotoSettings
public protocol CameraPhotoSettings : AnyObject
Camera photo setting.
Allows to configure the camera photo mode and parameters, such as:
- Photo format,
- Photo file format,
- Burst value (for {@link Mode#BURST burst mode},
- Bracketing value (for {@link Mode#BRACKETING bracketing mode}.
-
Tells if a setting value has been changed and is waiting for change confirmation.
Declaration
Swift
var updating: Bool { get }
-
Supported photo modes. An empty set means that the whole setting is currently unsupported.
Declaration
Swift
var supportedModes: Set<CameraPhotoMode> { get }
-
Supported photo format in the current mode.
Declaration
Swift
var supportedFormats: Set<CameraPhotoFormat> { get }
-
Supported file formats in the current mode.
Declaration
Swift
var supportedFileFormats: Set<CameraPhotoFileFormat> { get }
-
Supported burst values when mode is
burst
.Declaration
Swift
var supportedBurstValues: Set<CameraBurstValue> { get }
-
Supported bracketing values when mode is
bracketing
.Declaration
Swift
var supportedBracketingValues: Set<CameraBracketingValue> { get }
-
Whether HDR is available in the current mode, format and file format
Declaration
Swift
var hdrAvailable: Bool { get }
-
Photo mode. Value should be considered meaningless in case the set of
supportedModes
is empty.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 }
-
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 }
-
Range of supported timelapseInterval.
Declaration
Swift
var supportedTimelapseIntervals: ClosedRange<Double> { get }
-
Range of supported gpslapseInterval.
Declaration
Swift
var supportedGpslapseIntervals: ClosedRange<Double> { get }
-
Gets supported photo formats for a specific photo mode.
Declaration
Swift
func supportedFormats(forMode mode: CameraPhotoMode) -> Set<CameraPhotoFormat>
Parameters
mode
the photo mode
Return Value
supported photo formats for the mode
-
Gets supported photo file formats for a specific photo mode and format.
Declaration
Swift
func supportedFileFormats(forMode mode: CameraPhotoMode, format: CameraPhotoFormat) -> Set<CameraPhotoFileFormat>
Parameters
mode
photo mode
format
the photo format
Return Value
supported photo file formats for specified mode and format
-
Tells whether HDR is available for specific mode, format and file format.
Declaration
Swift
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 supported in the given mode, format and file format -
set(mode:
format: fileFormat: burstValue: bracketingValue: gpslapseCaptureIntervalValue: timelapseCaptureIntervalValue: ) Changes photo mode, format, file format, burst and bracketing values.
Declaration
Swift
func set(mode: CameraPhotoMode, format: CameraPhotoFormat, fileFormat: CameraPhotoFileFormat, burstValue: CameraBurstValue?, bracketingValue: CameraBracketingValue?, gpslapseCaptureIntervalValue: Double?, timelapseCaptureIntervalValue: Double?)
Parameters
mode
photo mode
format
photo format
fileFormat
photo file format
burstValue
burst value when photo mode is
burst
bracketingValue
bracketing value when photo mode is
bracketing
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.