White balance mode#
Camera 1#
Sample code to monitor white balance mode:
/// Keep reference on MainCamera peripheral to get notified of changes.
private var cameraRef: Ref<MainCamera>?
/// Monitors and prints white balance mode.
func monitorWhiteBalanceMode(drone: Drone) {
cameraRef = drone.getPeripheral(Peripherals.mainCamera) { camera in
// called on main thread when the camera peripheral changes
if let camera = camera {
if camera.whiteBalanceSettings.supportedModes.isEmpty {
// setting value is not relevant if there is no supported value
print("No supported value")
} else {
// get setting value
let whiteBalanceMode = camera.whiteBalanceSettings.mode
print("Current value is: \(whiteBalanceMode)")
}
}
}
}
Example of output:
Current value is: automatic
Sample code to modify white balance mode:
/// Sets white balance mode.
func setWhiteBalanceMode(drone: Drone, mode: CameraWhiteBalanceMode) {
if let camera = drone.getPeripheral(Peripherals.mainCamera) {
// set setting value
camera.whiteBalance.mode = mode
}
}
Trying to change the setting value to an unsupported value has no effect.
Values supported by the camera are provided by CameraWhiteBalanceSettings.supportedModes
.
Camera 2#
Sample code to monitor white balance mode:
/// Keep reference on MainCamera2 peripheral to get notified of changes.
private var cameraRef: Ref<MainCamera2>?
/// Monitors and prints white balance mode.
func monitorWhiteBalanceMode(drone: Drone) {
cameraRef = drone.getPeripheral(Peripherals.mainCamera2) { camera in
// called on main thread when the camera peripheral changes
if let camera = camera {
// get configuration parameter
if let configParam = camera.config[Camera2Params.whiteBalanceMode] {
if configParam.currentSupportedValues.isEmpty {
// parameter value is not relevant
// if there is not supported values in current configuration
print("No supported value in current configuration")
} else {
// get parameter value
let whiteBalanceMode = configParam.value
print("Current value is: \(whiteBalanceMode)")
}
}
}
}
}
Example of output:
Current value is: automatic
Sample code to modify white balance mode:
/// Sets white balance mode.
func setWhiteBalanceMode(drone: Drone, mode: Camera2WhiteBalanceMode) {
if let camera = drone.getPeripheral(Peripherals.mainCamera2) {
// create configuration editor, starting from current configuration
let editor = camera.config.edit(fromScratch: false)
// retrieve configuration parameter
if let configParam = editor[Camera2Params.whiteBalanceMode] {
// change parameter value,
// and unset other parameters conflicting with this new value
configParam.value = mode
// complete configuration, by setting missing parameters values
editor.autoComplete()
// send new configuration to drone
_ = editor.commit()
}
}
}
Trying to change the parameter value to an unsupported value has no effect.
Values supported by the camera are provided by the parameter field configParam.overallSupportedValues
.