Camera.Parameters.AutoWhiteBalanceLock Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
deprecated
Gets the state of the auto-white balance lock. -or- Sets the auto-white balance lock state.
[System.Obsolete("deprecated")]
public virtual bool AutoWhiteBalanceLock { [Android.Runtime.Register("getAutoWhiteBalanceLock", "()Z", "GetGetAutoWhiteBalanceLockHandler")] get; [Android.Runtime.Register("setAutoWhiteBalanceLock", "(Z)V", "GetSetAutoWhiteBalanceLock_ZHandler")] set; }[<System.Obsolete("deprecated")>]
[<get: Android.Runtime.Register("getAutoWhiteBalanceLock", "()Z", "GetGetAutoWhiteBalanceLockHandler")>]
[<set: Android.Runtime.Register("setAutoWhiteBalanceLock", "(Z)V", "GetSetAutoWhiteBalanceLock_ZHandler")>]
member this.AutoWhiteBalanceLock : bool with get, setProperty Value
State of the auto-white balance lock. Returns true if auto-white balance is currently locked, and false otherwise.
- Attributes
Remarks
Property getter documentation:
Gets the state of the auto-white balance lock. Applications should check #isAutoWhiteBalanceLockSupported before using this method. See #setAutoWhiteBalanceLock for details about the lock.
Java documentation for android.hardware.Camera.Parameters.getAutoWhiteBalanceLock().
Property setter documentation:
Sets the auto-white balance lock state. Applications should check #isAutoWhiteBalanceLockSupported before using this method.
If set to true, the camera auto-white balance routine will immediately pause until the lock is set to false.
If auto-white balance is already locked, setting this to true again has no effect (the driver will not recalculate white balance values).
Stopping preview with #stopPreview(), or triggering still image capture with #takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback), will not change the the lock.
Changing the white balance mode with #setWhiteBalance will release the auto-white balance lock if it is set.
Exposure compensation, AE lock, and AWB lock can be used to capture an exposure-bracketed burst of images, for example. Auto-white balance state, including the lock state, will not be maintained after camera #release() is called. Locking auto-white balance after #open() but before the first call to #startPreview() will not allow the auto-white balance routine to run at all, and may result in severely incorrect color in captured images.
Java documentation for android.hardware.Camera.Parameters.setAutoWhiteBalanceLock(boolean).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.