/**@class android.hardware.camera2.CaptureRequest implements android.os.Parcelable @extends android.hardware.camera2.CameraMetadata <p>An immutable package of settings and outputs needed to capture a single image from the camera device.</p> <p>Contains the configuration for the capture hardware (sensor, lens, flash), the processing pipeline, the control algorithms, and the output buffers. Also contains the list of target Surfaces to send image data to for this capture.</p> <p>CaptureRequests can be created by using a {@link android.hardware.camera2.CaptureRequest.Builder} instance, obtained by calling {@link android.hardware.camera2.CameraDevice#createCaptureRequest}</p> <p>CaptureRequests are given to {@link android.hardware.camera2.CameraCaptureSession#capture} or {@link android.hardware.camera2.CameraCaptureSession#setRepeatingRequest} to capture images from a camera.</p> <p>Each request can specify a different subset of target Surfaces for the camera to send the captured data to. All the surfaces used in a request must be part of the surface list given to the last call to {@link android.hardware.camera2.CameraDevice#createCaptureSession}, when the request is submitted to the session.</p> <p>For example, a request meant for repeating preview might only include the Surface for the preview SurfaceView or SurfaceTexture, while a high-resolution still capture would also include a Surface from a ImageReader configured for high-resolution JPEG images.</p> <p>A reprocess capture request allows a previously-captured image from the camera device to be sent back to the device for further processing. It can be created with {@link android.hardware.camera2.CameraDevice#createReprocessCaptureRequest}, and used with a reprocessable capture session created with {@link android.hardware.camera2.CameraDevice#createReprocessableCaptureSession}.</p> @see CameraCaptureSession#capture @see CameraCaptureSession#setRepeatingRequest @see CameraCaptureSession#captureBurst @see CameraCaptureSession#setRepeatingBurst @see CameraDevice#createCaptureRequest @see CameraDevice#createReprocessCaptureRequest */ var CaptureRequest = { /** @hide */ REQUEST_TYPE_REGULAR : "0", /** @hide */ REQUEST_TYPE_REPROCESS : "1", /** @hide */ REQUEST_TYPE_ZSL_STILL : "2", /** Note: To add another request type, the FrameNumberTracker in CameraDeviceImpl must be adjusted accordingly. @hide */ REQUEST_TYPE_COUNT : "3", /***/ CREATOR : "null", /** <p>The mode control selects how the image data is converted from the sensor's native color into linear sRGB color.</p> <p>When auto-white balance (AWB) is enabled with {@link android.hardware.camera2.CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this control is overridden by the AWB routine. When AWB is disabled, the application controls how the color mapping is performed.</p> <p>We define the expected processing pipeline below. For consistency across devices, this is always the case with TRANSFORM_MATRIX.</p> <p>When either FULL or HIGH_QUALITY is used, the camera device may do additional processing but {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the camera device (in the results) and be roughly correct.</p> <p>Switching to TRANSFORM_MATRIX and using the data provided from FAST or HIGH_QUALITY will yield a picture with the same white point as what was produced by the camera device in the earlier frame.</p> <p>The expected processing pipeline is as follows:</p> <p><img alt="White balance processing pipeline" src="/reference/images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> <p>The white balance is encoded by two values, a 4-channel white-balance gain vector (applied in the Bayer domain), and a 3x3 color transform matrix (applied after demosaic).</p> <p>The 4-channel white-balance gains are defined as:</p> <pre><code>{@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] </code></pre> <p>where <code>G_even</code> is the gain for green pixels on even rows of the output, and <code>G_odd</code> is the gain for green pixels on the odd rows. These may be identical for a given camera device implementation; if the camera device does not support a separate gain for even/odd green channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to <code>G_even</code> in the output result metadata.</p> <p>The matrices for color transforms are defined as a 9-entry vector:</p> <pre><code>{@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] </code></pre> <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> <p>with colors as follows:</p> <pre><code>r' = I0r + I1g + I2b g' = I3r + I4g + I5b b' = I6r + I7g + I8b </code></pre> <p>Both the input and output value ranges must match. Overflow/underflow values are clipped to fit within the range.</p> <p><b>Possible values:</b> <ul> <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li> <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li> <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> </ul></p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#COLOR_CORRECTION_GAINS @see CaptureRequest#COLOR_CORRECTION_TRANSFORM @see CaptureRequest#CONTROL_AWB_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX @see #COLOR_CORRECTION_MODE_FAST @see #COLOR_CORRECTION_MODE_HIGH_QUALITY */ COLOR_CORRECTION_MODE : "null", /** <p>A color transform matrix to use to transform from sensor RGB color space to output linear sRGB color space.</p> <p>This matrix is either set by the camera device when the request {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or directly by the application in the request when the {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> <p>In the latter case, the camera device may round the matrix to account for precision issues; the final rounded matrix should be reported back in this matrix result metadata. The transform should keep the magnitude of the output color values within <code>[0, 1.0]</code> (assuming input color values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> <p>The valid range of each matrix element varies on different devices, but values within [-1.5, 3.0] are guaranteed not to be clipped.</p> <p><b>Units</b>: Unitless scale factors</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#COLOR_CORRECTION_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL */ COLOR_CORRECTION_TRANSFORM : "null", /** <p>Gains applying to Bayer raw color channels for white-balance.</p> <p>These per-channel gains are either set by the camera device when the request {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or directly by the application in the request when the {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> <p>The gains in the result metadata are the gains actually applied by the camera device to the current frame.</p> <p>The valid range of gains varies on different devices, but gains between [1.0, 3.0] are guaranteed not to be clipped. Even if a given device allows gains below 1.0, this is usually not recommended because this can create color artifacts.</p> <p><b>Units</b>: Unitless gain factors</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#COLOR_CORRECTION_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL */ COLOR_CORRECTION_GAINS : "null", /** <p>Mode of operation for the chromatic aberration correction algorithm.</p> <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light can not focus on the same point after exiting from the lens. This metadata defines the high level control of chromatic aberration correction algorithm, which aims to minimize the chromatic artifacts that may occur along the object boundaries in an image.</p> <p>FAST/HIGH_QUALITY both mean that camera device determined aberration correction will be applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality aberration correction algorithms, even if it slows down capture rate. FAST means the camera device will not slow down capture rate when applying aberration correction.</p> <p>LEGACY devices will always be in FAST mode.</p> <p><b>Possible values:</b> <ul> <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li> <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li> <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES @see #COLOR_CORRECTION_ABERRATION_MODE_OFF @see #COLOR_CORRECTION_ABERRATION_MODE_FAST @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY */ COLOR_CORRECTION_ABERRATION_MODE : "null", /** <p>The desired setting for the camera device's auto-exposure algorithm's antibanding compensation.</p> <p>Some kinds of lighting fixtures, such as some fluorescent lights, flicker at the rate of the power supply frequency (60Hz or 50Hz, depending on country). While this is typically not noticeable to a person, it can be visible to a camera device. If a camera sets its exposure time to the wrong value, the flicker may become visible in the viewfinder as flicker or in a final captured image, as a set of variable-brightness bands across the image.</p> <p>Therefore, the auto-exposure routines of camera devices include antibanding routines that ensure that the chosen exposure value will not cause such banding. The choice of exposure time depends on the rate of flicker, which the camera device can detect automatically, or the expected rate can be selected by the application using this control.</p> <p>A given camera device may not support all of the possible options for the antibanding mode. The {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains the available modes for a given camera device.</p> <p>AUTO mode is the default if it is available on given camera device. When AUTO mode is not available, the default will be either 50HZ or 60HZ, and both 50HZ and 60HZ will be available.</p> <p>If manual exposure control is enabled (by setting {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} to OFF), then this setting has no effect, and the application must ensure it selects exposure times that do not cause banding issues. The {@link android.hardware.camera2.CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist the application in this.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li> <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li> <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li> <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li> </ul></p> <p><b>Available values for this device:</b><br></p> <p>{@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_MODE @see CaptureResult#STATISTICS_SCENE_FLICKER @see #CONTROL_AE_ANTIBANDING_MODE_OFF @see #CONTROL_AE_ANTIBANDING_MODE_50HZ @see #CONTROL_AE_ANTIBANDING_MODE_60HZ @see #CONTROL_AE_ANTIBANDING_MODE_AUTO */ CONTROL_AE_ANTIBANDING_MODE : "null", /** <p>Adjustment to auto-exposure (AE) target image brightness.</p> <p>The adjustment is measured as a count of steps, with the step size defined by {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the allowed range by {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p> <p>For example, if the exposure value (EV) step is 0.333, '6' will mean an exposure compensation of +2 EV; -3 will mean an exposure compensation of -1 EV. One EV represents a doubling of image brightness. Note that this control will only be effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control will take effect even when {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> <p>In the event of exposure compensation value being changed, camera device may take several frames to reach the newly requested exposure target. During that time, {@link android.hardware.camera2.CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING state. Once the new exposure target is reached, {@link android.hardware.camera2.CaptureResult#CONTROL_AE_STATE android.control.aeState} will change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or FLASH_REQUIRED (if the scene is too dark for still capture).</p> <p><b>Units</b>: Compensation steps</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP @see CaptureRequest#CONTROL_AE_LOCK @see CaptureRequest#CONTROL_AE_MODE @see CaptureResult#CONTROL_AE_STATE */ CONTROL_AE_EXPOSURE_COMPENSATION : "null", /** <p>Whether auto-exposure (AE) is currently locked to its latest calculated values.</p> <p>When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters, and will not change exposure settings until the lock is set to <code>false</code> (OFF).</p> <p>Note that even when AE is locked, the flash may be fired if the {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p> <p>When {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock is ON, the camera device will still adjust its exposure value.</p> <p>If AE precapture is triggered (see {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) when AE is already locked, the camera device will not change the exposure time ({@link android.hardware.camera2.CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link android.hardware.camera2.CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) parameters. The flash may be fired if the {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed. Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.</p> <p>When an AE precapture sequence is triggered, AE unlock will not be able to unlock the AE if AE is locked by the camera device internally during precapture metering sequence In other words, submitting requests with AE unlock has no effect for an ongoing precapture metering sequence. Otherwise, the precapture metering sequence will never succeed in a sequence of preview requests where AE lock is always set to <code>false</code>.</p> <p>Since the camera device has a pipeline of in-flight requests, the settings that get locked do not necessarily correspond to the settings that were present in the latest capture result received from the camera device, since additional captures and AE updates may have occurred even before the result was sent out. If an application is switching between automatic and manual control and wishes to eliminate any flicker during the switch, the following procedure is recommended:</p> <ol> <li>Starting in auto-AE mode:</li> <li>Lock AE</li> <li>Wait for the first result to be output that has the AE locked</li> <li>Copy exposure settings from that result into a request, set the request to manual AE</li> <li>Submit the capture request, proceed to run manual AE as desired.</li> </ol> <p>See {@link android.hardware.camera2.CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER @see CaptureResult#CONTROL_AE_STATE @see CaptureRequest#SENSOR_EXPOSURE_TIME @see CaptureRequest#SENSOR_SENSITIVITY */ CONTROL_AE_LOCK : "null", /** <p>The desired mode for the camera device's auto-exposure routine.</p> <p>This control is only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> <p>When set to any of the ON modes, the camera device's auto-exposure routine is enabled, overriding the application's selected exposure time, sensor sensitivity, and frame duration ({@link android.hardware.camera2.CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link android.hardware.camera2.CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link android.hardware.camera2.CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes is selected, the camera device's flash unit controls are also overridden.</p> <p>The FLASH modes are only available if the camera device has a flash unit ({@link android.hardware.camera2.CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> <p>If flash TORCH mode is desired, this field must be set to ON or OFF, and {@link android.hardware.camera2.CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> <p>When set to any of the ON modes, the values chosen by the camera device auto-exposure routine for the overridden fields for a given capture will be available in its CaptureResult.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_AE_MODE_OFF OFF}</li> <li>{@link #CONTROL_AE_MODE_ON ON}</li> <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li> <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li> <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li> <li>{@link #CONTROL_AE_MODE_ON_EXTERNAL_FLASH ON_EXTERNAL_FLASH}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES @see CaptureRequest#CONTROL_MODE @see CameraCharacteristics#FLASH_INFO_AVAILABLE @see CaptureRequest#FLASH_MODE @see CaptureRequest#SENSOR_EXPOSURE_TIME @see CaptureRequest#SENSOR_FRAME_DURATION @see CaptureRequest#SENSOR_SENSITIVITY @see #CONTROL_AE_MODE_OFF @see #CONTROL_AE_MODE_ON @see #CONTROL_AE_MODE_ON_AUTO_FLASH @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE @see #CONTROL_AE_MODE_ON_EXTERNAL_FLASH */ CONTROL_AE_MODE : "null", /** <p>List of metering areas to use for auto-exposure adjustment.</p> <p>Not available if {@link android.hardware.camera2.CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0. Otherwise will always be present.</p> <p>The maximum number of regions supported by the device is determined by the value of {@link android.hardware.camera2.CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p> <p>For devices not supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system always follows that of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with (0,0) being the top-left pixel in the active pixel array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the bottom-right pixel in the active pixel array.</p> <p>For devices supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system depends on the mode being set. When the distortion correction mode is OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}, with <code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}.height - 1) being the bottom-right pixel in the pre-correction active pixel array. When the distortion correction mode is not OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the top-left pixel of the active array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the bottom-right pixel in the active pixel array.</p> <p>The weight must be within <code>[0, 1000]</code>, and represents a weight for every pixel in the area. This means that a large metering area with the same weight as a smaller area will have more effect in the metering result. Metering areas can partially overlap and the camera device will add the weights in the overlap region.</p> <p>The weights are relative to weights of other exposure metering regions, so if only one region is used, all non-zero weights will have the same effect. A region with 0 weight is ignored.</p> <p>If all regions have 0 weight, then no specific metering area needs to be used by the camera device.</p> <p>If the metering region is outside the used {@link android.hardware.camera2.CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, the camera device will ignore the sections outside the crop region and output only the intersection rectangle as the metering region in the result metadata. If the region is entirely outside the crop region, it will be ignored and not reported in the result metadata.</p> <p><b>Units</b>: Pixel coordinates within {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p><b>Range of valid values:</b><br> Coordinates must be between <code>[(0,0), (width, height))</code> of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE @see CaptureRequest#DISTORTION_CORRECTION_MODE @see CaptureRequest#SCALER_CROP_REGION @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE @see CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE */ CONTROL_AE_REGIONS : "null", /** <p>Range over which the auto-exposure routine can adjust the capture frame rate to maintain good exposure.</p> <p>Only constrains auto-exposure (AE) algorithm, not manual control of {@link android.hardware.camera2.CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and {@link android.hardware.camera2.CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p> <p><b>Units</b>: Frames per second (FPS)</p> <p><b>Range of valid values:</b><br> Any of the entries in {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES @see CaptureRequest#SENSOR_EXPOSURE_TIME @see CaptureRequest#SENSOR_FRAME_DURATION */ CONTROL_AE_TARGET_FPS_RANGE : "null", /** <p>Whether the camera device will trigger a precapture metering sequence when it processes this request.</p> <p>This entry is normally set to IDLE, or is not included at all in the request settings. When included and set to START, the camera device will trigger the auto-exposure (AE) precapture metering sequence.</p> <p>When set to CANCEL, the camera device will cancel any active precapture metering trigger, and return to its initial AE state. If a precapture metering sequence is already completed, and the camera device has implicitly locked the AE for subsequent still capture, the CANCEL trigger will unlock the AE and return to its initial AE state.</p> <p>The precapture sequence should be triggered before starting a high-quality still capture for final metering decisions to be made, and for firing pre-capture flash pulses to estimate scene brightness and required final capture flash power, when the flash is enabled.</p> <p>Normally, this entry should be set to START for only a single request, and the application should wait until the sequence completes before starting a new one.</p> <p>When a precapture metering sequence is finished, the camera device may lock the auto-exposure routine internally to be able to accurately expose the subsequent still capture image (<code>{@link android.hardware.camera2.CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} == STILL_CAPTURE</code>). For this case, the AE may not resume normal scan if no subsequent still capture is submitted. To ensure that the AE routine restarts normal scan, the application should submit a request with <code>{@link android.hardware.camera2.CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == true</code>, followed by a request with <code>{@link android.hardware.camera2.CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == false</code>, if the application decides not to submit a still capture request after the precapture sequence completes. Alternatively, for API level 23 or newer devices, the CANCEL can be used to unlock the camera device internally locked AE if the application doesn't submit a still capture request after the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not be used in devices that have earlier API levels.</p> <p>The exact effect of auto-exposure (AE) precapture trigger depends on the current AE mode and state; see {@link android.hardware.camera2.CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition details.</p> <p>On LEGACY-level devices, the precapture trigger is not supported; capturing a high-resolution JPEG image will automatically trigger a precapture sequence before the high-resolution capture, including potentially firing a pre-capture flash.</p> <p>Using the precapture trigger and the auto-focus trigger {@link android.hardware.camera2.CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} simultaneously is allowed. However, since these triggers often require cooperation between the auto-focus and auto-exposure routines (for example, the may need to be enabled for a focus sweep), the camera device may delay acting on a later trigger until the previous trigger has been fully handled. This may lead to longer intervals between the trigger and changes to {@link android.hardware.camera2.CaptureResult#CONTROL_AE_STATE android.control.aeState} indicating the start of the precapture sequence, for example.</p> <p>If both the precapture and the auto-focus trigger are activated on the same request, then the camera device will complete them in the optimal order for that device.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li> <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li> <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL CANCEL}</li> </ul></p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Limited capability</b> - Present on all camera devices that report being at least {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_AE_LOCK @see CaptureResult#CONTROL_AE_STATE @see CaptureRequest#CONTROL_AF_TRIGGER @see CaptureRequest#CONTROL_CAPTURE_INTENT @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE @see #CONTROL_AE_PRECAPTURE_TRIGGER_START @see #CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL */ CONTROL_AE_PRECAPTURE_TRIGGER : "null", /** <p>Whether auto-focus (AF) is currently enabled, and what mode it is set to.</p> <p>Only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus (i.e. <code>{@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>). Also note that when {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AF is device dependent. It is recommended to lock AF by using {@link android.hardware.camera2.CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} before setting {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} to OFF, or set AF mode to OFF when AE is OFF.</p> <p>If the lens is controlled by the camera device auto-focus algorithm, the camera device will report the current AF status in {@link android.hardware.camera2.CaptureResult#CONTROL_AF_STATE android.control.afState} in result metadata.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_AF_MODE_OFF OFF}</li> <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li> <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li> <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li> <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li> <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AE_MODE @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES @see CaptureResult#CONTROL_AF_STATE @see CaptureRequest#CONTROL_AF_TRIGGER @see CaptureRequest#CONTROL_MODE @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE @see #CONTROL_AF_MODE_OFF @see #CONTROL_AF_MODE_AUTO @see #CONTROL_AF_MODE_MACRO @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE @see #CONTROL_AF_MODE_EDOF */ CONTROL_AF_MODE : "null", /** <p>List of metering areas to use for auto-focus.</p> <p>Not available if {@link android.hardware.camera2.CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0. Otherwise will always be present.</p> <p>The maximum number of focus areas supported by the device is determined by the value of {@link android.hardware.camera2.CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p> <p>For devices not supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system always follows that of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with (0,0) being the top-left pixel in the active pixel array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the bottom-right pixel in the active pixel array.</p> <p>For devices supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system depends on the mode being set. When the distortion correction mode is OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}, with <code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}.height - 1) being the bottom-right pixel in the pre-correction active pixel array. When the distortion correction mode is not OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the top-left pixel of the active array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the bottom-right pixel in the active pixel array.</p> <p>The weight must be within <code>[0, 1000]</code>, and represents a weight for every pixel in the area. This means that a large metering area with the same weight as a smaller area will have more effect in the metering result. Metering areas can partially overlap and the camera device will add the weights in the overlap region.</p> <p>The weights are relative to weights of other metering regions, so if only one region is used, all non-zero weights will have the same effect. A region with 0 weight is ignored.</p> <p>If all regions have 0 weight, then no specific metering area needs to be used by the camera device. The capture result will either be a zero weight region as well, or the region selected by the camera device as the focus area of interest.</p> <p>If the metering region is outside the used {@link android.hardware.camera2.CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, the camera device will ignore the sections outside the crop region and output only the intersection rectangle as the metering region in the result metadata. If the region is entirely outside the crop region, it will be ignored and not reported in the result metadata.</p> <p><b>Units</b>: Pixel coordinates within {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p><b>Range of valid values:</b><br> Coordinates must be between <code>[(0,0), (width, height))</code> of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF @see CaptureRequest#DISTORTION_CORRECTION_MODE @see CaptureRequest#SCALER_CROP_REGION @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE @see CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE */ CONTROL_AF_REGIONS : "null", /** <p>Whether the camera device will trigger autofocus for this request.</p> <p>This entry is normally set to IDLE, or is not included at all in the request settings.</p> <p>When included and set to START, the camera device will trigger the autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> <p>When set to CANCEL, the camera device will cancel any active trigger, and return to its initial AF state.</p> <p>Generally, applications should set this entry to START or CANCEL for only a single capture, and then return it to IDLE (or not set at all). Specifying START for multiple captures in a row means restarting the AF operation over and over again.</p> <p>See {@link android.hardware.camera2.CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p> <p>Using the autofocus trigger and the precapture trigger {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} simultaneously is allowed. However, since these triggers often require cooperation between the auto-focus and auto-exposure routines (for example, the may need to be enabled for a focus sweep), the camera device may delay acting on a later trigger until the previous trigger has been fully handled. This may lead to longer intervals between the trigger and changes to {@link android.hardware.camera2.CaptureResult#CONTROL_AF_STATE android.control.afState}, for example.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li> <li>{@link #CONTROL_AF_TRIGGER_START START}</li> <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li> </ul></p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER @see CaptureResult#CONTROL_AF_STATE @see #CONTROL_AF_TRIGGER_IDLE @see #CONTROL_AF_TRIGGER_START @see #CONTROL_AF_TRIGGER_CANCEL */ CONTROL_AF_TRIGGER : "null", /** <p>Whether auto-white balance (AWB) is currently locked to its latest calculated values.</p> <p>When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters, and will not change color balance settings until the lock is set to <code>false</code> (OFF).</p> <p>Since the camera device has a pipeline of in-flight requests, the settings that get locked do not necessarily correspond to the settings that were present in the latest capture result received from the camera device, since additional captures and AWB updates may have occurred even before the result was sent out. If an application is switching between automatic and manual control and wishes to eliminate any flicker during the switch, the following procedure is recommended:</p> <ol> <li>Starting in auto-AWB mode:</li> <li>Lock AWB</li> <li>Wait for the first result to be output that has the AWB locked</li> <li>Copy AWB settings from that result into a request, set the request to manual AWB</li> <li>Submit the capture request, proceed to run manual AWB as desired.</li> </ol> <p>Note that AWB lock is only meaningful when {@link android.hardware.camera2.CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes, AWB is already fixed to a specific setting.</p> <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.</p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AWB_MODE */ CONTROL_AWB_LOCK : "null", /** <p>Whether auto-white balance (AWB) is currently setting the color transform fields, and what its illumination target is.</p> <p>This control is only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> <p>When set to the ON mode, the camera device's auto-white balance routine is enabled, overriding the application's selected {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}. Note that when {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AWB is device dependent. It is recommened to also set AWB mode to OFF or lock AWB by using {@link android.hardware.camera2.CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} before setting AE mode to OFF.</p> <p>When set to the OFF mode, the camera device's auto-white balance routine is disabled. The application manually controls the white balance by {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> <p>When set to any other modes, the camera device's auto-white balance routine is disabled. The camera device uses each particular illumination target for white balance adjustment. The application's values for {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and {@link android.hardware.camera2.CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li> <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li> <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li> <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li> <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li> <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li> <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li> <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li> <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p> <p>This key is available on all devices.</p> @see CaptureRequest#COLOR_CORRECTION_GAINS @see CaptureRequest#COLOR_CORRECTION_MODE @see CaptureRequest#COLOR_CORRECTION_TRANSFORM @see CaptureRequest#CONTROL_AE_MODE @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES @see CaptureRequest#CONTROL_AWB_LOCK @see CaptureRequest#CONTROL_MODE @see #CONTROL_AWB_MODE_OFF @see #CONTROL_AWB_MODE_AUTO @see #CONTROL_AWB_MODE_INCANDESCENT @see #CONTROL_AWB_MODE_FLUORESCENT @see #CONTROL_AWB_MODE_WARM_FLUORESCENT @see #CONTROL_AWB_MODE_DAYLIGHT @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT @see #CONTROL_AWB_MODE_TWILIGHT @see #CONTROL_AWB_MODE_SHADE */ CONTROL_AWB_MODE : "null", /** <p>List of metering areas to use for auto-white-balance illuminant estimation.</p> <p>Not available if {@link android.hardware.camera2.CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0. Otherwise will always be present.</p> <p>The maximum number of regions supported by the device is determined by the value of {@link android.hardware.camera2.CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p> <p>For devices not supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system always follows that of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with (0,0) being the top-left pixel in the active pixel array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the bottom-right pixel in the active pixel array.</p> <p>For devices supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system depends on the mode being set. When the distortion correction mode is OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}, with <code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}.height - 1) being the bottom-right pixel in the pre-correction active pixel array. When the distortion correction mode is not OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the top-left pixel of the active array, and ({@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the bottom-right pixel in the active pixel array.</p> <p>The weight must range from 0 to 1000, and represents a weight for every pixel in the area. This means that a large metering area with the same weight as a smaller area will have more effect in the metering result. Metering areas can partially overlap and the camera device will add the weights in the overlap region.</p> <p>The weights are relative to weights of other white balance metering regions, so if only one region is used, all non-zero weights will have the same effect. A region with 0 weight is ignored.</p> <p>If all regions have 0 weight, then no specific metering area needs to be used by the camera device.</p> <p>If the metering region is outside the used {@link android.hardware.camera2.CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, the camera device will ignore the sections outside the crop region and output only the intersection rectangle as the metering region in the result metadata. If the region is entirely outside the crop region, it will be ignored and not reported in the result metadata.</p> <p><b>Units</b>: Pixel coordinates within {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p><b>Range of valid values:</b><br> Coordinates must be between <code>[(0,0), (width, height))</code> of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB @see CaptureRequest#DISTORTION_CORRECTION_MODE @see CaptureRequest#SCALER_CROP_REGION @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE @see CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE */ CONTROL_AWB_REGIONS : "null", /** <p>Information to the camera device 3A (auto-exposure, auto-focus, auto-white balance) routines about the purpose of this capture, to help the camera device to decide optimal 3A strategy.</p> <p>This control (except for MANUAL) is only effective if <code>{@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> <p>All intents are supported by all devices, except that: * ZERO_SHUTTER_LAG will be supported if {@link android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains PRIVATE_REPROCESSING or YUV_REPROCESSING. * MANUAL will be supported if {@link android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains MANUAL_SENSOR. * MOTION_TRACKING will be supported if {@link android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains MOTION_TRACKING.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li> <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li> <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li> <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li> <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li> <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li> <li>{@link #CONTROL_CAPTURE_INTENT_MOTION_TRACKING MOTION_TRACKING}</li> </ul></p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_MODE @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES @see #CONTROL_CAPTURE_INTENT_CUSTOM @see #CONTROL_CAPTURE_INTENT_PREVIEW @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG @see #CONTROL_CAPTURE_INTENT_MANUAL @see #CONTROL_CAPTURE_INTENT_MOTION_TRACKING */ CONTROL_CAPTURE_INTENT : "null", /** <p>A special color effect to apply.</p> <p>When this mode is set, a color effect will be applied to images produced by the camera device. The interpretation and implementation of these color effects is left to the implementor of the camera device, and should not be depended on to be consistent (or present) across all devices.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li> <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li> <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li> <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li> <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li> <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li> <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li> <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li> <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS @see #CONTROL_EFFECT_MODE_OFF @see #CONTROL_EFFECT_MODE_MONO @see #CONTROL_EFFECT_MODE_NEGATIVE @see #CONTROL_EFFECT_MODE_SOLARIZE @see #CONTROL_EFFECT_MODE_SEPIA @see #CONTROL_EFFECT_MODE_POSTERIZE @see #CONTROL_EFFECT_MODE_WHITEBOARD @see #CONTROL_EFFECT_MODE_BLACKBOARD @see #CONTROL_EFFECT_MODE_AQUA */ CONTROL_EFFECT_MODE : "null", /** <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control routines.</p> <p>This is a top-level 3A control switch. When set to OFF, all 3A control by the camera device is disabled. The application must set the fields for capture parameters itself.</p> <p>When set to AUTO, the individual algorithm controls in android.control.* are in effect, such as {@link android.hardware.camera2.CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> <p>When set to USE_SCENE_MODE, the individual controls in android.control.* are mostly disabled, and the camera device implements one of the scene mode settings (such as ACTION, SUNSET, or PARTY) as it wishes. The camera device scene mode 3A settings are provided by {@link android.hardware.camera2.CaptureResult capture results}.</p> <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference is that this frame will not be used by camera device background 3A statistics update, as if this frame is never captured. This mode can be used in the scenario where the application doesn't want a 3A manual control capture to affect the subsequent auto 3A capture results.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_MODE_OFF OFF}</li> <li>{@link #CONTROL_MODE_AUTO AUTO}</li> <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li> <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AVAILABLE_MODES android.control.availableModes}</p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AF_MODE @see CameraCharacteristics#CONTROL_AVAILABLE_MODES @see #CONTROL_MODE_OFF @see #CONTROL_MODE_AUTO @see #CONTROL_MODE_USE_SCENE_MODE @see #CONTROL_MODE_OFF_KEEP_STATE */ CONTROL_MODE : "null", /** <p>Control for which scene mode is currently active.</p> <p>Scene modes are custom camera modes optimized for a certain set of conditions and capture settings.</p> <p>This is the mode that that is active when <code>{@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, these modes will disable {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, {@link android.hardware.camera2.CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link android.hardware.camera2.CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p> <p>The interpretation and implementation of these scene modes is left to the implementor of the camera device. Their behavior will not be consistent across all devices, and any given device may only implement a subset of these modes.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li> <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li> <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li> <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li> <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li> <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li> <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li> <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li> <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li> <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li> <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li> <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li> <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li> <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li> <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li> <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li> <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li> <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li> <li>{@link #CONTROL_SCENE_MODE_HDR HDR}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_AF_MODE @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES @see CaptureRequest#CONTROL_AWB_MODE @see CaptureRequest#CONTROL_MODE @see #CONTROL_SCENE_MODE_DISABLED @see #CONTROL_SCENE_MODE_FACE_PRIORITY @see #CONTROL_SCENE_MODE_ACTION @see #CONTROL_SCENE_MODE_PORTRAIT @see #CONTROL_SCENE_MODE_LANDSCAPE @see #CONTROL_SCENE_MODE_NIGHT @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT @see #CONTROL_SCENE_MODE_THEATRE @see #CONTROL_SCENE_MODE_BEACH @see #CONTROL_SCENE_MODE_SNOW @see #CONTROL_SCENE_MODE_SUNSET @see #CONTROL_SCENE_MODE_STEADYPHOTO @see #CONTROL_SCENE_MODE_FIREWORKS @see #CONTROL_SCENE_MODE_SPORTS @see #CONTROL_SCENE_MODE_PARTY @see #CONTROL_SCENE_MODE_CANDLELIGHT @see #CONTROL_SCENE_MODE_BARCODE @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO @see #CONTROL_SCENE_MODE_HDR */ CONTROL_SCENE_MODE : "null", /** <p>Whether video stabilization is active.</p> <p>Video stabilization automatically warps images from the camera in order to stabilize motion between consecutive frames.</p> <p>If enabled, video stabilization can modify the {@link android.hardware.camera2.CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p> <p>Switching between different video stabilization modes may take several frames to initialize, the camera device will report the current mode in capture result metadata. For example, When "ON" mode is requested, the video stabilization modes in the first several capture results may still be "OFF", and it will become "ON" when the initialization is done.</p> <p>In addition, not all recording sizes or frame rates may be supported for stabilization by a device that reports stabilization support. It is guaranteed that an output targeting a MediaRecorder or MediaCodec will be stabilized if the recording resolution is less than or equal to 1920 x 1080 (width less than or equal to 1920, height less than or equal to 1080), and the recording frame rate is less than or equal to 30fps. At other sizes, the CaptureResult {@link android.hardware.camera2.CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode} field will return OFF if the recording output is not stabilized, or if there are no output Surface types that can be stabilized.</p> <p>If a camera device supports both this mode and OIS ({@link android.hardware.camera2.CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may produce undesirable interaction, so it is recommended not to enable both at the same time.</p> <p><b>Possible values:</b> <ul> <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li> <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li> </ul></p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE @see CaptureRequest#SCALER_CROP_REGION @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF @see #CONTROL_VIDEO_STABILIZATION_MODE_ON */ CONTROL_VIDEO_STABILIZATION_MODE : "null", /** <p>The amount of additional sensitivity boost applied to output images after RAW sensor data is captured.</p> <p>Some camera devices support additional digital sensitivity boosting in the camera processing pipeline after sensor RAW image is captured. Such a boost will be applied to YUV/JPEG format output images but will not have effect on RAW output formats like RAW_SENSOR, RAW10, RAW12 or RAW_OPAQUE.</p> <p>This key will be <code>null</code> for devices that do not support any RAW format outputs. For devices that do support RAW format outputs, this key will always present, and if a device does not support post RAW sensitivity boost, it will list <code>100</code> in this key.</p> <p>If the camera device cannot apply the exact boost requested, it will reduce the boost to the nearest supported value. The final boost value used will be available in the output capture result.</p> <p>For devices that support post RAW sensitivity boost, the YUV/JPEG output images of such device will have the total sensitivity of <code>{@link android.hardware.camera2.CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} * {@link android.hardware.camera2.CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST android.control.postRawSensitivityBoost} / 100</code> The sensitivity of RAW format images will always be <code>{@link android.hardware.camera2.CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}</code></p> <p>This control is only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} is set to OFF; otherwise the auto-exposure algorithm will override this value.</p> <p><b>Units</b>: ISO arithmetic units, the same as {@link android.hardware.camera2.CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE android.control.postRawSensitivityBoostRange}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_MODE @see CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST @see CameraCharacteristics#CONTROL_POST_RAW_SENSITIVITY_BOOST_RANGE @see CaptureRequest#SENSOR_SENSITIVITY */ CONTROL_POST_RAW_SENSITIVITY_BOOST : "null", /** <p>Allow camera device to enable zero-shutter-lag mode for requests with {@link android.hardware.camera2.CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} == STILL_CAPTURE.</p> <p>If enableZsl is <code>true</code>, the camera device may enable zero-shutter-lag mode for requests with STILL_CAPTURE capture intent. The camera device may use images captured in the past to produce output images for a zero-shutter-lag request. The result metadata including the {@link android.hardware.camera2.CaptureResult#SENSOR_TIMESTAMP android.sensor.timestamp} reflects the source frames used to produce output images. Therefore, the contents of the output images and the result metadata may be out of order compared to previous regular requests. enableZsl does not affect requests with other capture intents.</p> <p>For example, when requests are submitted in the following order: Request A: enableZsl is ON, {@link android.hardware.camera2.CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} is PREVIEW Request B: enableZsl is ON, {@link android.hardware.camera2.CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} is STILL_CAPTURE</p> <p>The output images for request B may have contents captured before the output images for request A, and the result metadata for request B may be older than the result metadata for request A.</p> <p>Note that when enableZsl is <code>true</code>, it is not guaranteed to get output images captured in the past for requests with STILL_CAPTURE capture intent.</p> <p>For applications targeting SDK versions O and newer, the value of enableZsl in TEMPLATE_STILL_CAPTURE template may be <code>true</code>. The value in other templates is always <code>false</code> if present.</p> <p>For applications targeting SDK versions older than O, the value of enableZsl in all capture templates is always <code>false</code> if present.</p> <p>For application-operated ZSL, use CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureRequest#CONTROL_CAPTURE_INTENT @see CaptureResult#SENSOR_TIMESTAMP */ CONTROL_ENABLE_ZSL : "null", /** <p>Operation mode for edge enhancement.</p> <p>Edge enhancement improves sharpness and details in the captured image. OFF means no enhancement will be applied by the camera device.</p> <p>FAST/HIGH_QUALITY both mean camera device determined enhancement will be applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality enhancement algorithms, even if it slows down capture rate. FAST means the camera device will not slow down capture rate when applying edge enhancement. FAST may be the same as OFF if edge enhancement will slow down capture rate. Every output stream will have a similar amount of enhancement applied.</p> <p>ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular buffer of high-resolution images during preview and reprocess image(s) from that buffer into a final capture when triggered by the user. In this mode, the camera device applies edge enhancement to low-resolution streams (below maximum recording resolution) to maximize preview quality, but does not apply edge enhancement to high-resolution streams, since those will be reprocessed later if necessary.</p> <p>For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively. The camera device may adjust its internal edge enhancement parameters for best image quality based on the {@link android.hardware.camera2.CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor}, if it is set.</p> <p><b>Possible values:</b> <ul> <li>{@link #EDGE_MODE_OFF OFF}</li> <li>{@link #EDGE_MODE_FAST FAST}</li> <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li> <li>{@link #EDGE_MODE_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR @see #EDGE_MODE_OFF @see #EDGE_MODE_FAST @see #EDGE_MODE_HIGH_QUALITY @see #EDGE_MODE_ZERO_SHUTTER_LAG */ EDGE_MODE : "null", /** <p>The desired mode for for the camera device's flash control.</p> <p>This control is only effective when flash unit is available (<code>{@link android.hardware.camera2.CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> <p>When this control is used, the {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> <p>When set to OFF, the camera device will not fire flash for this capture.</p> <p>When set to SINGLE, the camera device will fire flash regardless of the camera device's auto-exposure routine's result. When used in still capture case, this control should be used along with auto-exposure (AE) precapture metering sequence ({@link android.hardware.camera2.CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> <p>When set to TORCH, the flash will be on continuously. This mode can be used for use cases such as preview, auto-focus assist, still capture, or video recording.</p> <p>The flash status will be reported by {@link android.hardware.camera2.CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> <p><b>Possible values:</b> <ul> <li>{@link #FLASH_MODE_OFF OFF}</li> <li>{@link #FLASH_MODE_SINGLE SINGLE}</li> <li>{@link #FLASH_MODE_TORCH TORCH}</li> </ul></p> <p>This key is available on all devices.</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER @see CameraCharacteristics#FLASH_INFO_AVAILABLE @see CaptureResult#FLASH_STATE @see #FLASH_MODE_OFF @see #FLASH_MODE_SINGLE @see #FLASH_MODE_TORCH */ FLASH_MODE : "null", /** <p>Operational mode for hot pixel correction.</p> <p>Hotpixel correction interpolates out, or otherwise removes, pixels that do not accurately measure the incoming light (i.e. pixels that are stuck at an arbitrary value or are oversensitive).</p> <p><b>Possible values:</b> <ul> <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li> <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li> <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES @see #HOT_PIXEL_MODE_OFF @see #HOT_PIXEL_MODE_FAST @see #HOT_PIXEL_MODE_HIGH_QUALITY */ HOT_PIXEL_MODE : "null", /** <p>A location object to use when generating image GPS metadata.</p> <p>Setting a location object in a request will include the GPS coordinates of the location into any JPEG images captured based on the request. These coordinates can then be viewed by anyone who receives the JPEG image.</p> <p>This tag is also used for HEIC image capture.</p> <p>This key is available on all devices.</p> */ JPEG_GPS_LOCATION : "null", /** <p>GPS coordinates to include in output JPEG EXIF.</p> <p>This tag is also used for HEIC image capture.</p> <p><b>Range of valid values:</b><br> (-180 - 180], [-90,90], [-inf, inf]</p> <p>This key is available on all devices.</p> @hide */ JPEG_GPS_COORDINATES : "null", /** <p>32 characters describing GPS algorithm to include in EXIF.</p> <p>This tag is also used for HEIC image capture.</p> <p>This key is available on all devices.</p> @hide */ JPEG_GPS_PROCESSING_METHOD : "null", /** <p>Time GPS fix was made to include in EXIF.</p> <p>This tag is also used for HEIC image capture.</p> <p><b>Units</b>: UTC in seconds since January 1, 1970</p> <p>This key is available on all devices.</p> @hide */ JPEG_GPS_TIMESTAMP : "null", /** <p>The orientation for a JPEG image.</p> <p>The clockwise rotation angle in degrees, relative to the orientation to the camera, that the JPEG picture needs to be rotated by, to be viewed upright.</p> <p>Camera devices may either encode this value into the JPEG EXIF header, or rotate the image data to match this orientation. When the image data is rotated, the thumbnail data will also be rotated.</p> <p>Note that this orientation is relative to the orientation of the camera sensor, given by {@link android.hardware.camera2.CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p> <p>To translate from the device orientation given by the Android sensor APIs for camera sensors which are not EXTERNAL, the following sample code may be used:</p> <pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) { if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0; int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION); // Round device orientation to a multiple of 90 deviceOrientation = (deviceOrientation + 45) / 90 * 90; // Reverse device orientation for front-facing cameras boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT; if (facingFront) deviceOrientation = -deviceOrientation; // Calculate desired JPEG orientation relative to camera orientation to make // the image upright relative to the device orientation int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360; return jpegOrientation; } </code></pre> <p>For EXTERNAL cameras the sensor orientation will always be set to 0 and the facing will also be set to EXTERNAL. The above code is not relevant in such case.</p> <p>This tag is also used to describe the orientation of the HEIC image capture, in which case the rotation is reflected by {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag}, and not by rotating the image data itself.</p> <p><b>Units</b>: Degrees in multiples of 90</p> <p><b>Range of valid values:</b><br> 0, 90, 180, 270</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#SENSOR_ORIENTATION */ JPEG_ORIENTATION : "null", /** <p>Compression quality of the final JPEG image.</p> <p>85-95 is typical usage range. This tag is also used to describe the quality of the HEIC image capture.</p> <p><b>Range of valid values:</b><br> 1-100; larger is higher quality</p> <p>This key is available on all devices.</p> */ JPEG_QUALITY : "null", /** <p>Compression quality of JPEG thumbnail.</p> <p>This tag is also used to describe the quality of the HEIC image capture.</p> <p><b>Range of valid values:</b><br> 1-100; larger is higher quality</p> <p>This key is available on all devices.</p> */ JPEG_THUMBNAIL_QUALITY : "null", /** <p>Resolution of embedded JPEG thumbnail.</p> <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, but the captured JPEG will still be a valid image.</p> <p>For best results, when issuing a request for a JPEG image, the thumbnail size selected should have the same aspect ratio as the main JPEG output.</p> <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect ratio, the camera device creates the thumbnail by cropping it from the primary image. For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to generate the thumbnail image. The thumbnail image will always have a smaller Field Of View (FOV) than the primary image when aspect ratios differ.</p> <p>When an {@link android.hardware.camera2.CaptureRequest#JPEG_ORIENTATION android.jpeg.orientation} of non-zero degree is requested, the camera device will handle thumbnail rotation in one of the following ways:</p> <ul> <li>Set the {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag} and keep jpeg and thumbnail image data unrotated.</li> <li>Rotate the jpeg and thumbnail image data and not set {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag}. In this case, LIMITED or FULL hardware level devices will report rotated thumnail size in capture result, so the width and height will be interchanged if 90 or 270 degree orientation is requested. LEGACY device will always report unrotated thumbnail size.</li> </ul> <p>The tag is also used as thumbnail size for HEIC image format capture, in which case the the thumbnail rotation is reflected by {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag}, and not by rotating the thumbnail data itself.</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES @see CaptureRequest#JPEG_ORIENTATION */ JPEG_THUMBNAIL_SIZE : "null", /** <p>The desired lens aperture size, as a ratio of lens focal length to the effective aperture diameter.</p> <p>Setting this value is only supported on the camera devices that have a variable aperture lens.</p> <p>When this is supported and {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, this can be set along with {@link android.hardware.camera2.CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link android.hardware.camera2.CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link android.hardware.camera2.CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} to achieve manual exposure control.</p> <p>The requested aperture value may take several frames to reach the requested value; the camera device will report the current (intermediate) aperture size in capture result metadata while the aperture is changing. While the aperture is still changing, {@link android.hardware.camera2.CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> <p>When this is supported and {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of the ON modes, this will be overridden by the camera device auto-exposure algorithm, the overridden values are then provided back to the user in the corresponding result.</p> <p><b>Units</b>: The f-number (f/N)</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_AE_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES @see CaptureResult#LENS_STATE @see CaptureRequest#SENSOR_EXPOSURE_TIME @see CaptureRequest#SENSOR_FRAME_DURATION @see CaptureRequest#SENSOR_SENSITIVITY */ LENS_APERTURE : "null", /** <p>The desired setting for the lens neutral density filter(s).</p> <p>This control will not be supported on most camera devices.</p> <p>Lens filters are typically used to lower the amount of light the sensor is exposed to (measured in steps of EV). As used here, an EV step is the standard logarithmic representation, which are non-negative, and inversely proportional to the amount of light hitting the sensor. For example, setting this to 0 would result in no reduction of the incoming light, and setting this to 2 would mean that the filter is set to reduce incoming light by two stops (allowing 1/4 of the prior amount of light to the sensor).</p> <p>It may take several frames before the lens filter density changes to the requested value. While the filter density is still changing, {@link android.hardware.camera2.CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> <p><b>Units</b>: Exposure Value (EV)</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES @see CaptureResult#LENS_STATE */ LENS_FILTER_DENSITY : "null", /** <p>The desired lens focal length; used for optical zoom.</p> <p>This setting controls the physical focal length of the camera device's lens. Changing the focal length changes the field of view of the camera device, and is usually used for optical zoom.</p> <p>Like {@link android.hardware.camera2.CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link android.hardware.camera2.CaptureRequest#LENS_APERTURE android.lens.aperture}, this setting won't be applied instantaneously, and it may take several frames before the lens can change to the requested focal length. While the focal length is still changing, {@link android.hardware.camera2.CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> <p>Optical zoom will not be supported on most devices.</p> <p><b>Units</b>: Millimeters</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p> <p>This key is available on all devices.</p> @see CaptureRequest#LENS_APERTURE @see CaptureRequest#LENS_FOCUS_DISTANCE @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS @see CaptureResult#LENS_STATE */ LENS_FOCAL_LENGTH : "null", /** <p>Desired distance to plane of sharpest focus, measured from frontmost surface of the lens.</p> <p>This control can be used for setting manual focus, on devices that support the MANUAL_SENSOR capability and have a variable-focus lens (see {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}).</p> <p>A value of <code>0.0f</code> means infinity focus. The value set will be clamped to <code>[0.0f, {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}]</code>.</p> <p>Like {@link android.hardware.camera2.CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied instantaneously, and it may take several frames before the lens can move to the requested focus distance. While the lens is still moving, {@link android.hardware.camera2.CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> <p>LEGACY devices support at most setting this to <code>0.0f</code> for infinity focus.</p> <p><b>Units</b>: See {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p> <p><b>Range of valid values:</b><br> >= 0</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CaptureRequest#LENS_FOCAL_LENGTH @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE @see CaptureResult#LENS_STATE */ LENS_FOCUS_DISTANCE : "null", /** <p>Sets whether the camera device uses optical image stabilization (OIS) when capturing images.</p> <p>OIS is used to compensate for motion blur due to small movements of the camera during capture. Unlike digital image stabilization ({@link android.hardware.camera2.CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS makes use of mechanical elements to stabilize the camera sensor, and thus allows for longer exposure times before camera shake becomes apparent.</p> <p>Switching between different optical stabilization modes may take several frames to initialize, the camera device will report the current mode in capture result metadata. For example, When "ON" mode is requested, the optical stabilization modes in the first several capture results may still be "OFF", and it will become "ON" when the initialization is done.</p> <p>If a camera device supports both OIS and digital image stabilization ({@link android.hardware.camera2.CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable interaction, so it is recommended not to enable both at the same time.</p> <p>Not all devices will support OIS; see {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for available controls.</p> <p><b>Possible values:</b> <ul> <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li> <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Limited capability</b> - Present on all camera devices that report being at least {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION @see #LENS_OPTICAL_STABILIZATION_MODE_OFF @see #LENS_OPTICAL_STABILIZATION_MODE_ON */ LENS_OPTICAL_STABILIZATION_MODE : "null", /** <p>Mode of operation for the noise reduction algorithm.</p> <p>The noise reduction algorithm attempts to improve image quality by removing excessive noise added by the capture process, especially in dark conditions.</p> <p>OFF means no noise reduction will be applied by the camera device, for both raw and YUV domain.</p> <p>MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF. This mode is optional, may not be support by all devices. The application should check {@link android.hardware.camera2.CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes} before using it.</p> <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering will be applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality noise filtering algorithms, even if it slows down capture rate. FAST means the camera device will not slow down capture rate when applying noise filtering. FAST may be the same as MINIMAL if MINIMAL is listed, or the same as OFF if any noise filtering will slow down capture rate. Every output stream will have a similar amount of enhancement applied.</p> <p>ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular buffer of high-resolution images during preview and reprocess image(s) from that buffer into a final capture when triggered by the user. In this mode, the camera device applies noise reduction to low-resolution streams (below maximum recording resolution) to maximize preview quality, but does not apply noise reduction to high-resolution streams, since those will be reprocessed later if necessary.</p> <p>For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device may adjust the noise reduction parameters for best image quality based on the {@link android.hardware.camera2.CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor} if it is set.</p> <p><b>Possible values:</b> <ul> <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li> <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li> <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> <li>{@link #NOISE_REDUCTION_MODE_MINIMAL MINIMAL}</li> <li>{@link #NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR @see #NOISE_REDUCTION_MODE_OFF @see #NOISE_REDUCTION_MODE_FAST @see #NOISE_REDUCTION_MODE_HIGH_QUALITY @see #NOISE_REDUCTION_MODE_MINIMAL @see #NOISE_REDUCTION_MODE_ZERO_SHUTTER_LAG */ NOISE_REDUCTION_MODE : "null", /** <p>An application-specified ID for the current request. Must be maintained unchanged in output frame</p> <p><b>Units</b>: arbitrary integer assigned by application</p> <p><b>Range of valid values:</b><br> Any int</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @hide */ REQUEST_ID : "null", /** <p>The desired region of the sensor to read out for this capture.</p> <p>This control can be used to implement digital zoom.</p> <p>For devices not supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system always follows that of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the top-left pixel of the active array.</p> <p>For devices supporting {@link android.hardware.camera2.CaptureRequest#DISTORTION_CORRECTION_MODE android.distortionCorrection.mode} control, the coordinate system depends on the mode being set. When the distortion correction mode is OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}, with <code>(0, 0)</code> being the top-left pixel of the pre-correction active array. When the distortion correction mode is not OFF, the coordinate system follows {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the top-left pixel of the active array.</p> <p>Output streams use this rectangle to produce their output, cropping to a smaller region if necessary to maintain the stream's aspect ratio, then scaling the sensor input to match the output's configured resolution.</p> <p>The crop region is applied after the RAW to other color space (e.g. YUV) conversion. Since raw streams (e.g. RAW16) don't have the conversion stage, they are not croppable. The crop region will be ignored by raw streams.</p> <p>For non-raw streams, any additional per-stream cropping will be done to maximize the final pixel area of the stream.</p> <p>For example, if the crop region is set to a 4:3 aspect ratio, then 4:3 streams will use the exact crop region. 16:9 streams will further crop vertically (letterbox).</p> <p>Conversely, if the crop region is set to a 16:9, then 4:3 outputs will crop horizontally (pillarbox), and 16:9 streams will match exactly. These additional crops will be centered within the crop region.</p> <p>If the coordinate system is {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, the width and height of the crop region cannot be set to be smaller than <code>floor( activeArraySize.width / {@link android.hardware.camera2.CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and <code>floor( activeArraySize.height / {@link android.hardware.camera2.CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> <p>If the coordinate system is {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}, the width and height of the crop region cannot be set to be smaller than <code>floor( preCorrectionActiveArraySize.width / {@link android.hardware.camera2.CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and <code>floor( preCorrectionActiveArraySize.height / {@link android.hardware.camera2.CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> <p>The camera device may adjust the crop region to account for rounding and other hardware requirements; the final crop region used will be included in the output capture result.</p> <p><b>Units</b>: Pixel coordinates relative to {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} or {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize} depending on distortion correction capability and mode</p> <p>This key is available on all devices.</p> @see CaptureRequest#DISTORTION_CORRECTION_MODE @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE @see CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE */ SCALER_CROP_REGION : "null", /** <p>Duration each pixel is exposed to light.</p> <p>If the sensor can't expose this exact duration, it will shorten the duration exposed to the nearest possible value (rather than expose longer). The final exposure time used will be available in the output capture result.</p> <p>This control is only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} is set to OFF; otherwise the auto-exposure algorithm will override this value.</p> <p><b>Units</b>: Nanoseconds</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE */ SENSOR_EXPOSURE_TIME : "null", /** <p>Duration from start of frame exposure to start of next frame exposure.</p> <p>The maximum frame rate that can be supported by a camera subsystem is a function of many factors:</p> <ul> <li>Requested resolutions of output image streams</li> <li>Availability of binning / skipping modes on the imager</li> <li>The bandwidth of the imager interface</li> <li>The bandwidth of the various ISP processing blocks</li> </ul> <p>Since these factors can vary greatly between different ISPs and sensors, the camera abstraction tries to represent the bandwidth restrictions with as simple a model as possible.</p> <p>The model presented has the following characteristics:</p> <ul> <li>The image sensor is always configured to output the smallest resolution possible given the application's requested output stream sizes. The smallest resolution is defined as being at least as large as the largest requested output stream size; the camera pipeline must never digitally upsample sensor data when the crop region covers the whole sensor. In general, this means that if only small output stream resolutions are configured, the sensor can provide a higher frame rate.</li> <li>Since any request may use any or all the currently configured output streams, the sensor and ISP must be configured to support scaling a single capture to all the streams at the same time. This means the camera pipeline must be ready to produce the largest requested output size without any delay. Therefore, the overall frame rate of a given configured stream set is governed only by the largest requested stream resolution.</li> <li>Using more than one output stream in a request does not affect the frame duration.</li> <li>Certain format-streams may need to do additional background processing before data is consumed/produced by that stream. These processors can run concurrently to the rest of the camera pipeline, but cannot process more than 1 capture at a time.</li> </ul> <p>The necessary information for the application, given the model above, is provided via {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration }. These are used to determine the maximum frame rate / minimum frame duration that is possible for a given stream configuration.</p> <p>Specifically, the application can use the following rules to determine the minimum frame duration it can request from the camera device:</p> <ol> <li>Let the set of currently configured input/output streams be called <code>S</code>.</li> <li>Find the minimum frame durations for each stream in <code>S</code>, by looking it up in {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration } (with its respective size/format). Let this set of frame durations be called <code>F</code>.</li> <li>For any given request <code>R</code>, the minimum frame duration allowed for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams used in <code>R</code> be called <code>S_r</code>.</li> </ol> <p>If none of the streams in <code>S_r</code> have a stall time (listed in {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration } using its respective size/format), then the frame duration in <code>F</code> determines the steady state frame rate that the application will get if it uses <code>R</code> as a repeating request. Let this special kind of request be called <code>Rsimple</code>.</p> <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved by a single capture of a new request <code>Rstall</code> (which has at least one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the same minimum frame duration this will not cause a frame rate loss if all buffers from the previous <code>Rstall</code> have already been delivered.</p> <p>For more details about stalling, see {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration }.</p> <p>This control is only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} is set to OFF; otherwise the auto-exposure algorithm will override this value.</p> <p><b>Units</b>: Nanoseconds</p> <p><b>Range of valid values:</b><br> See {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}, {@link android.hardware.camera2.params.StreamConfigurationMap }. The duration is capped to <code>max(duration, exposureTime + overhead)</code>.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION */ SENSOR_FRAME_DURATION : "null", /** <p>The amount of gain applied to sensor data before processing.</p> <p>The sensitivity is the standard ISO sensitivity value, as defined in ISO 12232:2006.</p> <p>The sensitivity must be within {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and if if it less than {@link android.hardware.camera2.CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device is guaranteed to use only analog amplification for applying the gain.</p> <p>If the camera device cannot apply the exact sensitivity requested, it will reduce the gain to the nearest supported value. The final sensitivity used will be available in the output capture result.</p> <p>This control is only effective if {@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link android.hardware.camera2.CaptureRequest#CONTROL_MODE android.control.mode} is set to OFF; otherwise the auto-exposure algorithm will override this value.</p> <p><b>Units</b>: ISO arithmetic units</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY */ SENSOR_SENSITIVITY : "null", /** <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern when {@link android.hardware.camera2.CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> <p>Each color channel is treated as an unsigned 32-bit integer. The camera device then uses the most significant X bits that correspond to how many bits are in its Bayer raw sensor output.</p> <p>For example, a sensor with RAW10 Bayer output would use the 10 most significant bits from each color channel.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureRequest#SENSOR_TEST_PATTERN_MODE */ SENSOR_TEST_PATTERN_DATA : "null", /** <p>When enabled, the sensor sends a test pattern instead of doing a real exposure from the camera.</p> <p>When a test pattern is enabled, all manual sensor controls specified by android.sensor.* will be ignored. All other controls should work as normal.</p> <p>For example, if manual flash is enabled, flash firing should still occur (and that the test pattern remain unmodified, since the flash would not actually affect it).</p> <p>Defaults to OFF.</p> <p><b>Possible values:</b> <ul> <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li> <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li> <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li> <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li> <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li> <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES @see #SENSOR_TEST_PATTERN_MODE_OFF @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY @see #SENSOR_TEST_PATTERN_MODE_PN9 @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 */ SENSOR_TEST_PATTERN_MODE : "null", /** <p>Quality of lens shading correction applied to the image data.</p> <p>When set to OFF mode, no lens shading correction will be applied by the camera device, and an identity lens shading map data will be provided if <code>{@link android.hardware.camera2.CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens shading map with size of <code>[ 4, 3 ]</code>, the output {@link android.hardware.camera2.CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity map shown below:</p> <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] </code></pre> <p>When set to other modes, lens shading correction will be applied by the camera device. Applications can request lens shading map data by setting {@link android.hardware.camera2.CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens shading map data in {@link android.hardware.camera2.CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map data will be the one applied by the camera device for this capture request.</p> <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore the reliability of the map data may be affected by the AE and AWB algorithms. When AE and AWB are in AUTO modes({@link android.hardware.camera2.CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link android.hardware.camera2.CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> OFF), to get best results, it is recommended that the applications wait for the AE and AWB to be converged before using the returned shading map data.</p> <p><b>Possible values:</b> <ul> <li>{@link #SHADING_MODE_OFF OFF}</li> <li>{@link #SHADING_MODE_FAST FAST}</li> <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#SHADING_AVAILABLE_MODES android.shading.availableModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#CONTROL_AE_MODE @see CaptureRequest#CONTROL_AWB_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#SHADING_AVAILABLE_MODES @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE @see #SHADING_MODE_OFF @see #SHADING_MODE_FAST @see #SHADING_MODE_HIGH_QUALITY */ SHADING_MODE : "null", /** <p>Operating mode for the face detector unit.</p> <p>Whether face detection is enabled, and whether it should output just the basic fields or the full set of fields.</p> <p><b>Possible values:</b> <ul> <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li> <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li> <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p> <p>This key is available on all devices.</p> @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES @see #STATISTICS_FACE_DETECT_MODE_OFF @see #STATISTICS_FACE_DETECT_MODE_SIMPLE @see #STATISTICS_FACE_DETECT_MODE_FULL */ STATISTICS_FACE_DETECT_MODE : "null", /** <p>Operating mode for hot pixel map generation.</p> <p>If set to <code>true</code>, a hot pixel map is returned in {@link android.hardware.camera2.CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. If set to <code>false</code>, no hot pixel map will be returned.</p> <p><b>Range of valid values:</b><br> {@link android.hardware.camera2.CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureResult#STATISTICS_HOT_PIXEL_MAP @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES */ STATISTICS_HOT_PIXEL_MAP_MODE : "null", /** <p>Whether the camera device will output the lens shading map in output result metadata.</p> <p>When set to ON, android.statistics.lensShadingMap will be provided in the output result metadata.</p> <p>ON is always supported on devices with the RAW capability.</p> <p><b>Possible values:</b> <ul> <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li> <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES android.statistics.info.availableLensShadingMapModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF @see #STATISTICS_LENS_SHADING_MAP_MODE_ON */ STATISTICS_LENS_SHADING_MAP_MODE : "null", /** <p>A control for selecting whether optical stabilization (OIS) position information is included in output result metadata.</p> <p>Since optical image stabilization generally involves motion much faster than the duration of individualq image exposure, multiple OIS samples can be included for a single capture result. For example, if the OIS reporting operates at 200 Hz, a typical camera operating at 30fps may have 6-7 OIS samples per capture result. This information can be combined with the rolling shutter skew to account for lens motion during image exposure in post-processing algorithms.</p> <p><b>Possible values:</b> <ul> <li>{@link #STATISTICS_OIS_DATA_MODE_OFF OFF}</li> <li>{@link #STATISTICS_OIS_DATA_MODE_ON ON}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#STATISTICS_INFO_AVAILABLE_OIS_DATA_MODES android.statistics.info.availableOisDataModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_OIS_DATA_MODES @see #STATISTICS_OIS_DATA_MODE_OFF @see #STATISTICS_OIS_DATA_MODE_ON */ STATISTICS_OIS_DATA_MODE : "null", /** <p>Tonemapping / contrast / gamma curve for the blue channel, to use when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> <p>See android.tonemap.curveRed for more details.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CaptureRequest#TONEMAP_MODE @hide */ TONEMAP_CURVE_BLUE : "null", /** <p>Tonemapping / contrast / gamma curve for the green channel, to use when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> <p>See android.tonemap.curveRed for more details.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CaptureRequest#TONEMAP_MODE @hide */ TONEMAP_CURVE_GREEN : "null", /** <p>Tonemapping / contrast / gamma curve for the red channel, to use when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> <p>Each channel's curve is defined by an array of control points:</p> <pre><code>android.tonemap.curveRed = [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 2 <= N <= {@link android.hardware.camera2.CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> <p>These are sorted in order of increasing <code>Pin</code>; it is required that input values 0.0 and 1.0 are included in the list to define a complete mapping. For input values between control points, the camera device must linearly interpolate between the control points.</p> <p>Each curve can have an independent number of points, and the number of points can be less than max (that is, the request doesn't have to always provide a curve with number of points equivalent to {@link android.hardware.camera2.CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> <p>For devices with MONOCHROME capability, all three channels must have the same set of control points.</p> <p>A few examples, and their corresponding graphical mappings; these only specify the red channel and the precision is limited to 4 digits, for conciseness.</p> <p>Linear mapping:</p> <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] </code></pre> <p><img alt="Linear mapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> <p>Invert mapping:</p> <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] </code></pre> <p><img alt="Inverting mapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> <p>Gamma 1/2.2 mapping, with 16 control points:</p> <pre><code>android.tonemap.curveRed = [ 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] </code></pre> <p><img alt="Gamma = 1/2.2 tonemapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> <pre><code>android.tonemap.curveRed = [ 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] </code></pre> <p><img alt="sRGB tonemapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> <p><b>Range of valid values:</b><br> 0-1 on both input and output coordinates, normalized as a floating-point value such that 0 == black and 1 == white.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS @see CaptureRequest#TONEMAP_MODE @hide */ TONEMAP_CURVE_RED : "null", /** <p>Tonemapping / contrast / gamma curve to use when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> <p>The tonemapCurve consist of three curves for each of red, green, and blue channels respectively. The following example uses the red channel as an example. The same logic applies to green and blue channel. Each channel's curve is defined by an array of control points:</p> <pre><code>curveRed = [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 2 <= N <= {@link android.hardware.camera2.CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> <p>These are sorted in order of increasing <code>Pin</code>; it is always guaranteed that input values 0.0 and 1.0 are included in the list to define a complete mapping. For input values between control points, the camera device must linearly interpolate between the control points.</p> <p>Each curve can have an independent number of points, and the number of points can be less than max (that is, the request doesn't have to always provide a curve with number of points equivalent to {@link android.hardware.camera2.CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> <p>For devices with MONOCHROME capability, all three channels must have the same set of control points.</p> <p>A few examples, and their corresponding graphical mappings; these only specify the red channel and the precision is limited to 4 digits, for conciseness.</p> <p>Linear mapping:</p> <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] </code></pre> <p><img alt="Linear mapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> <p>Invert mapping:</p> <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] </code></pre> <p><img alt="Inverting mapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> <p>Gamma 1/2.2 mapping, with 16 control points:</p> <pre><code>curveRed = [ (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] </code></pre> <p><img alt="Gamma = 1/2.2 tonemapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> <pre><code>curveRed = [ (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] </code></pre> <p><img alt="sRGB tonemapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS @see CaptureRequest#TONEMAP_MODE */ TONEMAP_CURVE : "null", /** <p>High-level global contrast/gamma/tonemapping control.</p> <p>When switching to an application-defined contrast curve by setting {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined per-channel with a set of <code>(in, out)</code> points that specify the mapping from input high-bit-depth pixel value to the output low-bit-depth value. Since the actual pixel ranges of both input and output may change depending on the camera pipeline, the values are specified by normalized floating-point numbers.</p> <p>More-complex color mapping operations such as 3D color look-up tables, selective chroma enhancement, or other non-linear color transforms will be disabled when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> <p>When using either FAST or HIGH_QUALITY, the camera device will emit its own tonemap curve in {@link android.hardware.camera2.CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. These values are always available, and as close as possible to the actually used nonlinear/nonglobal transforms.</p> <p>If a request is sent with CONTRAST_CURVE with the camera device's provided curve in FAST or HIGH_QUALITY, the image's tonemap will be roughly the same.</p> <p><b>Possible values:</b> <ul> <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li> <li>{@link #TONEMAP_MODE_FAST FAST}</li> <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li> <li>{@link #TONEMAP_MODE_GAMMA_VALUE GAMMA_VALUE}</li> <li>{@link #TONEMAP_MODE_PRESET_CURVE PRESET_CURVE}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES @see CaptureRequest#TONEMAP_CURVE @see CaptureRequest#TONEMAP_MODE @see #TONEMAP_MODE_CONTRAST_CURVE @see #TONEMAP_MODE_FAST @see #TONEMAP_MODE_HIGH_QUALITY @see #TONEMAP_MODE_GAMMA_VALUE @see #TONEMAP_MODE_PRESET_CURVE */ TONEMAP_MODE : "null", /** <p>Tonemapping curve to use when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is GAMMA_VALUE</p> <p>The tonemap curve will be defined the following formula: * OUT = pow(IN, 1.0 / gamma) where IN and OUT is the input pixel value scaled to range [0.0, 1.0], pow is the power function and gamma is the gamma value specified by this key.</p> <p>The same curve will be applied to all color channels. The camera device may clip the input gamma value to its supported range. The actual applied value will be returned in capture result.</p> <p>The valid range of gamma value varies on different devices, but values within [1.0, 5.0] are guaranteed not to be clipped.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureRequest#TONEMAP_MODE */ TONEMAP_GAMMA : "null", /** <p>Tonemapping curve to use when {@link android.hardware.camera2.CaptureRequest#TONEMAP_MODE android.tonemap.mode} is PRESET_CURVE</p> <p>The tonemap curve will be defined by specified standard.</p> <p>sRGB (approximated by 16 control points):</p> <p><img alt="sRGB tonemapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> <p>Rec. 709 (approximated by 16 control points):</p> <p><img alt="Rec. 709 tonemapping curve" src="/reference/images/camera2/metadata/android.tonemap.curveRed/rec709_tonemap.png" /></p> <p>Note that above figures show a 16 control points approximation of preset curves. Camera devices may apply a different approximation to the curve.</p> <p><b>Possible values:</b> <ul> <li>{@link #TONEMAP_PRESET_CURVE_SRGB SRGB}</li> <li>{@link #TONEMAP_PRESET_CURVE_REC709 REC709}</li> </ul></p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureRequest#TONEMAP_MODE @see #TONEMAP_PRESET_CURVE_SRGB @see #TONEMAP_PRESET_CURVE_REC709 */ TONEMAP_PRESET_CURVE : "null", /** <p>This LED is nominally used to indicate to the user that the camera is powered on and may be streaming images back to the Application Processor. In certain rare circumstances, the OS may disable this when video is processed locally and not transmitted to any untrusted applications.</p> <p>In particular, the LED <em>must</em> always be on when the data could be transmitted off the device. The LED <em>should</em> always be on whenever data is stored locally on the device.</p> <p>The LED <em>may</em> be off if a trusted application is using the data that doesn't violate the above rules.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @hide */ LED_TRANSMIT : "null", /** <p>Whether black-level compensation is locked to its current values, or is free to vary.</p> <p>When set to <code>true</code> (ON), the values used for black-level compensation will not change until the lock is set to <code>false</code> (OFF).</p> <p>Since changes to certain capture parameters (such as exposure time) may require resetting of black level compensation, the camera device must report whether setting the black level lock was successful in the output result metadata.</p> <p>For example, if a sequence of requests is as follows:</p> <ul> <li>Request 1: Exposure = 10ms, Black level lock = OFF</li> <li>Request 2: Exposure = 10ms, Black level lock = ON</li> <li>Request 3: Exposure = 10ms, Black level lock = ON</li> <li>Request 4: Exposure = 20ms, Black level lock = ON</li> <li>Request 5: Exposure = 20ms, Black level lock = ON</li> <li>Request 6: Exposure = 20ms, Black level lock = ON</li> </ul> <p>And the exposure change in Request 4 requires the camera device to reset the black level offsets, then the output result metadata is expected to be:</p> <ul> <li>Result 1: Exposure = 10ms, Black level lock = OFF</li> <li>Result 2: Exposure = 10ms, Black level lock = ON</li> <li>Result 3: Exposure = 10ms, Black level lock = ON</li> <li>Result 4: Exposure = 20ms, Black level lock = OFF</li> <li>Result 5: Exposure = 20ms, Black level lock = ON</li> <li>Result 6: Exposure = 20ms, Black level lock = ON</li> </ul> <p>This indicates to the application that on frame 4, black levels were reset due to exposure value changes, and pixel values may not be consistent across captures.</p> <p>The camera device will maintain the lock to the extent possible, only overriding the lock to OFF when changes to other request parameters require a black level recalculation or reset.</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Full capability</b> - Present on all camera devices that report being {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL */ BLACK_LEVEL_LOCK : "null", /** <p>The amount of exposure time increase factor applied to the original output frame by the application processing before sending for reprocessing.</p> <p>This is optional, and will be supported if the camera device supports YUV_REPROCESSING capability ({@link android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains YUV_REPROCESSING).</p> <p>For some YUV reprocessing use cases, the application may choose to filter the original output frames to effectively reduce the noise to the same level as a frame that was captured with longer exposure time. To be more specific, assuming the original captured images were captured with a sensitivity of S and an exposure time of T, the model in the camera device is that the amount of noise in the image would be approximately what would be expected if the original capture parameters had been a sensitivity of S/effectiveExposureFactor and an exposure time of T*effectiveExposureFactor, rather than S and T respectively. If the captured images were processed by the application before being sent for reprocessing, then the application may have used image processing algorithms and/or multi-frame image fusion to reduce the noise in the application-processed images (input images). By using the effectiveExposureFactor control, the application can communicate to the camera device the actual noise level improvement in the application-processed image. With this information, the camera device can select appropriate noise reduction and edge enhancement parameters to avoid excessive noise reduction ({@link android.hardware.camera2.CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode}) and insufficient edge enhancement ({@link android.hardware.camera2.CaptureRequest#EDGE_MODE android.edge.mode}) being applied to the reprocessed frames.</p> <p>For example, for multi-frame image fusion use case, the application may fuse multiple output frames together to a final frame for reprocessing. When N image are fused into 1 image for reprocessing, the exposure time increase factor could be up to square root of N (based on a simple photon shot noise model). The camera device will adjust the reprocessing noise reduction and edge enhancement parameters accordingly to produce the best quality images.</p> <p>This is relative factor, 1.0 indicates the application hasn't processed the input buffer in a way that affects its effective exposure time.</p> <p>This control is only effective for YUV reprocessing capture request. For noise reduction reprocessing, it is only effective when <code>{@link android.hardware.camera2.CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode} != OFF</code>. Similarly, for edge enhancement reprocessing, it is only effective when <code>{@link android.hardware.camera2.CaptureRequest#EDGE_MODE android.edge.mode} != OFF</code>.</p> <p><b>Units</b>: Relative exposure time increase factor.</p> <p><b>Range of valid values:</b><br> >= 1.0</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> <p><b>Limited capability</b> - Present on all camera devices that report being at least {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the {@link android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> @see CaptureRequest#EDGE_MODE @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL @see CaptureRequest#NOISE_REDUCTION_MODE @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES */ REPROCESS_EFFECTIVE_EXPOSURE_FACTOR : "null", /** <p>Mode of operation for the lens distortion correction block.</p> <p>The lens distortion correction block attempts to improve image quality by fixing radial, tangential, or other geometric aberrations in the camera device's optics. If available, the {@link android.hardware.camera2.CameraCharacteristics#LENS_DISTORTION android.lens.distortion} field documents the lens's distortion parameters.</p> <p>OFF means no distortion correction is done.</p> <p>FAST/HIGH_QUALITY both mean camera device determined distortion correction will be applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality correction algorithms, even if it slows down capture rate. FAST means the camera device will not slow down capture rate when applying correction. FAST may be the same as OFF if any correction at all would slow down capture rate. Every output stream will have a similar amount of enhancement applied.</p> <p>The correction only applies to processed outputs such as YUV, Y8, JPEG, or DEPTH16; it is not applied to any RAW output.</p> <p>This control will be on by default on devices that support this control. Applications disabling distortion correction need to pay extra attention with the coordinate system of metering regions, crop region, and face rectangles. When distortion correction is OFF, metadata coordinates follow the coordinate system of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE android.sensor.info.preCorrectionActiveArraySize}. When distortion is not OFF, metadata coordinates follow the coordinate system of {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}. The camera device will map these metadata fields to match the corrected image produced by the camera device, for both capture requests and results. However, this mapping is not very precise, since rectangles do not generally map to rectangles when corrected. Only linear scaling between the active array and precorrection active array coordinates is performed. Applications that require precise correction of metadata need to undo that linear scaling, and apply a more complete correction that takes into the account the app's own requirements.</p> <p>The full list of metadata that is affected in this way by distortion correction is:</p> <ul> <li>{@link android.hardware.camera2.CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}</li> <li>{@link android.hardware.camera2.CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}</li> <li>{@link android.hardware.camera2.CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions}</li> <li>{@link android.hardware.camera2.CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}</li> <li>{@link android.hardware.camera2.CaptureResult#STATISTICS_FACES android.statistics.faces}</li> </ul> <p><b>Possible values:</b> <ul> <li>{@link #DISTORTION_CORRECTION_MODE_OFF OFF}</li> <li>{@link #DISTORTION_CORRECTION_MODE_FAST FAST}</li> <li>{@link #DISTORTION_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> </ul></p> <p><b>Available values for this device:</b><br> {@link android.hardware.camera2.CameraCharacteristics#DISTORTION_CORRECTION_AVAILABLE_MODES android.distortionCorrection.availableModes}</p> <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p> @see CaptureRequest#CONTROL_AE_REGIONS @see CaptureRequest#CONTROL_AF_REGIONS @see CaptureRequest#CONTROL_AWB_REGIONS @see CameraCharacteristics#DISTORTION_CORRECTION_AVAILABLE_MODES @see CameraCharacteristics#LENS_DISTORTION @see CaptureRequest#SCALER_CROP_REGION @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE @see CameraCharacteristics#SENSOR_INFO_PRE_CORRECTION_ACTIVE_ARRAY_SIZE @see CaptureResult#STATISTICS_FACES @see #DISTORTION_CORRECTION_MODE_OFF @see #DISTORTION_CORRECTION_MODE_FAST @see #DISTORTION_CORRECTION_MODE_HIGH_QUALITY */ DISTORTION_CORRECTION_MODE : "null", /**Get the type of the capture request Return one of REGULAR, ZSL_STILL, or REPROCESS. @hide */ getRequestType : function( ) {}, /**Get a capture request field value. <p>The field definitions can be found in {@link android.hardware.camera2.CaptureRequest}.</p> <p>Querying the value for the same key more than once will return a value which is equal to the previous queried value.</p> @param {Object {android.hardware.camera2.CaptureRequest.Key}} key The result field to read. @param key The result field to read. @return {Object {java.lang.Object}} The value of that key, or {@code null} if the field is not set. */ get : function( ) {}, /**{@inheritDoc} */ getKeys : function( ) {}, /**Retrieve the tag for this request, if any. <p>This tag is not used for anything by the camera device, but can be used by an application to easily identify a CaptureRequest when it is returned by {@link android.hardware.camera2.CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} </p> @return {Object {java.lang.Object}} the last tag Object set on this request, or {@code null} if no tag has been set. @see Builder#setTag */ getTag : function( ) {}, /**Determine if this is a reprocess capture request. <p>A reprocess capture request produces output images from an input buffer from the {@link android.hardware.camera2.CameraCaptureSession}'s input {@link Surface}. A reprocess capture request can be created by {@link android.hardware.camera2.CameraDevice#createReprocessCaptureRequest}.</p> @return {Boolean} {@code true} if this is a reprocess capture request. {@code false} if this is not a reprocess capture request. @see CameraDevice#createReprocessCaptureRequest */ isReprocess : function( ) {}, /**<p>Determine if this request is part of a constrained high speed request list that was created by {@link android.hardware.camera2.CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList}. A constrained high speed request list contains some constrained high speed capture requests with certain interleaved pattern that is suitable for high speed preview/video streaming. An active constrained high speed capture session only accepts constrained high speed request lists. This method can be used to do the sanity check when a constrained high speed capture session receives a request list via {@link android.hardware.camera2.CameraCaptureSession#setRepeatingBurst} or {@link android.hardware.camera2.CameraCaptureSession#captureBurst}. </p> @return {Boolean} {@code true} if this request is part of a constrained high speed request list, {@code false} otherwise. @hide */ isPartOfCRequestList : function( ) {}, /**Returns a copy of the underlying {@link android.hardware.camera2.CameraMetadataNative}. @hide */ getNativeCopy : function( ) {}, /**Get the reprocessable session ID this reprocess capture request is associated with. @return {Number} the reprocessable session ID this reprocess capture request is associated with @throws IllegalStateException if this capture request is not a reprocess capture request. @hide */ getReprocessableSessionId : function( ) {}, /**Determine whether this CaptureRequest is equal to another CaptureRequest. <p>A request is considered equal to another is if it's set of key/values is equal, it's list of output surfaces is equal, the user tag is equal, and the return values of isReprocess() are equal.</p> @param {Object {Object}} other Another instance of CaptureRequest. @return {Boolean} True if the requests are the same, false otherwise. */ equals : function( ) {}, /** */ hashCode : function( ) {}, /** */ describeContents : function( ) {}, /** */ writeToParcel : function( ) {}, /** @hide */ containsTarget : function( ) {}, /** @hide */ getTargets : function( ) {}, /**Retrieves the logical camera id. @hide */ getLogicalCameraId : function( ) {}, /** @hide */ convertSurfaceToStreamId : function( ) {}, /** @hide */ recoverStreamIdToSurface : function( ) {}, };