Contents

setTorchModeOn(level:)

Sets the illumination level when in torch mode.

Declaration

func setTorchModeOn(level torchLevel: Float) throws

Parameters

  • torchLevel:

    The new torch mode level. This value must be a floating-point number between 0.0 and 1.0. To set the torch mode level to the currently available maximum, specify the constant Maxavailabletorchlevel for this parameter.

Discussion

This method sets the torch mode to AVCaptureDevice.TorchMode.on and sets the level to the specified value. If the device doesn’t support this mode or if you specify a value for torchLevel that’s outside the accepted range, this method raises an exception. If the torch value is within the accepted range but greater than the currently supported maximum—perhaps because the device is overheating—this method returns false.

Before changing the value of this property, you must call lockForConfiguration() to acquire exclusive access to the device’s configuration properties. Otherwise, calling this method raises an exception. When you finish configuring the device, call unlockForConfiguration() to release the lock and allow other devices to configure the settings.

See Also

Configuring torch settings