Instance Property

automaticallyEnablesLowLightBoostWhenAvailable

A Boolean value that indicates whether the capture device should automatically switch to low light boost mode when necessary.

Declaration

var automaticallyEnablesLowLightBoostWhenAvailable: Bool { get set }

Discussion

On an AVCaptureDevice object where isLowLightBoostSupported is true, a special low light boost mode may be engaged to improve image quality. When the automaticallyEnablesLowLightBoostWhenAvailable property is set to true, the capture device switches at its discretion to a special boost mode under low light. When the scene becomes sufficiently lit, the device switches back to normal operation. An AVCaptureDevice that supports this feature may only engage boost mode for certain source formats or resolutions.

The default value of this property is false. Setting this property throws an invalidArgumentException if isLowLightBoostSupported is false. The AVCaptureDevice object must be locked for configuration using lockForConfiguration() before clients can set this method, otherwise an genericException is thrown.

Clients may observe changes to the isLowLightBoostEnabled property using Key-value observing to know when the boost mode engages. The switch between normal operation and low light boost mode may drop one or more video frames.

See Also

Managing Low Light Settings

var isLowLightBoostSupported: Bool

A Boolean value that indicates whether the capture device supports boosting images in low light conditions.

var isLowLightBoostEnabled: Bool

A Boolean value that indicates whether the capture device’s low light boost feature is enabled.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software