Added in API level 1
Deprecated in API level 21

Parameters

open class Parameters
kotlin.Any
   ↳ android.hardware.Camera.Parameters

Camera service settings.

To make camera parameters take effect, applications have to call Camera#setParameters(Camera.Parameters). For example, after Camera.Parameters#setWhiteBalance is called, white balance is not actually changed until Camera#setParameters(Camera.Parameters) is called with the changed parameters object.

Different devices may have different camera capabilities, such as picture size or flash modes. The application should query the camera capabilities before setting parameters. For example, the application should call Camera.Parameters#getSupportedColorEffects() before calling Camera.Parameters#setColorEffect(String). If the camera does not support color effects, Camera.Parameters#getSupportedColorEffects() will return null.

Summary

Constants
static String

static String

static String

static String

static String

static String

static String

static String

static String

static String

static String

static String

static String

static String

Flash will be fired automatically when required.
static String

Flash will not be fired.
static String

Flash will always be fired during snapshot.
static String

Flash will be fired in red-eye reduction mode.
static String

Constant emission of light during preview, auto-focus and snapshot.
static Int

The array index of far focus distance for use with getFocusDistances(float[]).
static Int

The array index of near focus distance for use with getFocusDistances(float[]).
static Int

The array index of optimal focus distance for use with getFocusDistances(float[]).
static String

Auto-focus mode.
static String

Continuous auto focus mode intended for taking pictures.
static String

Continuous auto focus mode intended for video recording.
static String

Extended depth of field (EDOF).
static String

Focus is fixed.
static String

Focus is set at infinity.
static String

Macro (close-up) focus mode.
static Int

The array index of maximum preview fps for use with getPreviewFpsRange(int[]) or getSupportedPreviewFpsRange().
static Int

The array index of minimum preview fps for use with getPreviewFpsRange(int[]) or getSupportedPreviewFpsRange().
static String

Take photos of fast moving objects.
static String

Scene mode is off.
static String

Applications are looking for a barcode.
static String

Take pictures on the beach.
static String

Capture the naturally warm color of scenes lit by candles.
static String

For shooting firework displays.
static String

Capture a scene using high dynamic range imaging techniques.
static String

Take pictures on distant objects.
static String

Take photos at night.
static String

Take people pictures at night.
static String

Take indoor low-light shot.
static String

Take people pictures.
static String

Take pictures on the snow.
static String

Take photos of fast moving objects.
static String

Avoid blurry pictures (for example, due to hand shake).
static String

Take sunset photos.
static String

Take photos in a theater.
static String

static String

static String

static String

static String

static String

static String

static String

Public methods
open String!

Creates a single string with all the parameters set in this Parameters object.
open String!
get(key: String!)

Returns the value of a String parameter.
open String!

Gets the current antibanding setting.
open Boolean

Gets the state of the auto-exposure lock.
open Boolean

Gets the state of the auto-white balance lock.
open String!

Gets the current color effect setting.
open Int

Gets the current exposure compensation index.
open Float

Gets the exposure compensation step.
open String!

Gets the current flash mode setting.
open Float

Gets the focal length (in millimeter) of the camera.
open MutableList<Camera.Area!>!

Gets the current focus areas.
open Unit

Gets the distances from the camera to where an object appears to be in focus.
open String!

Gets the current focus mode setting.
open Float

Gets the horizontal angle of view in degrees.
open Int
getInt(key: String!)

Returns the value of an integer parameter.
open Int

Returns the quality setting for the JPEG picture.
open Int

Returns the quality setting for the EXIF thumbnail in Jpeg picture.
open Camera.Size!

Returns the dimensions for EXIF thumbnail in Jpeg picture.
open Int

Gets the maximum exposure compensation index.
open Int

Gets the maximum number of detected faces supported.
open Int

Gets the maximum number of focus areas supported.
open Int

Gets the maximum number of metering areas supported.
open Int

Gets the maximum zoom value allowed for snapshot.
open MutableList<Camera.Area!>!

Gets the current metering areas.
open Int

Gets the minimum exposure compensation index.
open Int

Returns the image format for pictures.
open Camera.Size!

Returns the dimension setting for pictures.
open Camera.Size!

Returns the preferred or recommended preview size (width and height) in pixels for video recording.
open Int

Returns the image format for preview frames got from PreviewCallback.
open Unit

Returns the current minimum and maximum preview fps.
open Int

Returns the setting for the rate at which preview frames are received.
open Camera.Size!

Returns the dimensions setting for preview pictures.
open String!

Gets the current scene mode setting.
open MutableList<String!>!

Gets the supported antibanding values.
open MutableList<String!>!

Gets the supported color effects.
open MutableList<String!>!

Gets the supported flash modes.
open MutableList<String!>!

Gets the supported focus modes.
open MutableList<Camera.Size!>!

Gets the supported jpeg thumbnail sizes.
open MutableList<Int!>!

Gets the supported picture formats.
open MutableList<Camera.Size!>!

Gets the supported picture sizes.
open MutableList<Int!>!

Gets the supported preview formats.
open MutableList<IntArray!>!

Gets the supported preview fps (frame-per-second) ranges.
open MutableList<Int!>!

Gets the supported preview frame rates.
open MutableList<Camera.Size!>!

Gets the supported preview sizes.
open MutableList<String!>!

Gets the supported scene modes.
open MutableList<Camera.Size!>!

Gets the supported video frame sizes that can be used by MediaRecorder.
open MutableList<String!>!

Gets the supported white balance.
open Float

Gets the vertical angle of view in degrees.
open Boolean

Get the current state of video stabilization.
open String!

Gets the current white balance setting.
open Int

Gets current zoom value.
open MutableList<Int!>!

Gets the zoom ratios of all zoom values.
open Boolean

Returns true if auto-exposure locking is supported.
open Boolean

Returns true if auto-white balance locking is supported.
open Boolean

Returns true if smooth zoom is supported.
open Boolean

Returns true if video snapshot is supported.
open Boolean

Returns true if video stabilization is supported.
open Boolean

Returns true if zoom is supported.
open Unit
remove(key: String!)
open Unit

Removes GPS latitude, longitude, altitude, and timestamp from the parameters.
open Unit
set(key: String!, value: String!)

Sets a String parameter.
open Unit
set(key: String!, value: Int)

Sets an integer parameter.
open Unit
setAntibanding(antibanding: String!)

Sets the antibanding.
open Unit

Sets the auto-exposure lock state.
open Unit

Sets the auto-white balance lock state.
open Unit

Sets the current color effect setting.
open Unit

Sets the exposure compensation index.
open Unit

Sets the flash mode.
open Unit

Sets focus areas.
open Unit

Sets the focus mode.
open Unit

Sets GPS altitude.
open Unit

Sets GPS latitude coordinate.
open Unit
setGpsLongitude(longitude: Double)

Sets GPS longitude coordinate.
open Unit
setGpsProcessingMethod(processing_method: String!)

Sets GPS processing method.
open Unit
setGpsTimestamp(timestamp: Long)

Sets GPS timestamp.
open Unit
setJpegQuality(quality: Int)

Sets Jpeg quality of captured picture.
open Unit

Sets the quality of the EXIF thumbnail in Jpeg picture.
open Unit
setJpegThumbnailSize(width: Int, height: Int)

Sets the dimensions for EXIF thumbnail in Jpeg picture.
open Unit

Sets metering areas.
open Unit
setPictureFormat(pixel_format: Int)

Sets the image format for pictures.
open Unit
setPictureSize(width: Int, height: Int)

Sets the dimensions for pictures.
open Unit
setPreviewFormat(pixel_format: Int)

Sets the image format for preview pictures.
open Unit
setPreviewFpsRange(min: Int, max: Int)

Sets the minimum and maximum preview fps.
open Unit

Sets the rate at which preview frames are received.
open Unit
setPreviewSize(width: Int, height: Int)

Sets the dimensions for preview pictures.
open Unit

Sets recording mode hint.
open Unit
setRotation(rotation: Int)

Sets the clockwise rotation angle in degrees relative to the orientation of the camera.
open Unit

Sets the scene mode.
open Unit

Enables and disables video stabilization.
open Unit

Sets the white balance.
open Unit
setZoom(value: Int)

Sets current zoom value.
open Unit
unflatten(flattened: String!)

Takes a flattened string of parameters and adds each one to this Parameters object.

Constants

ANTIBANDING_50HZ

Added in API level 5
Deprecated in API level 21
static val ANTIBANDING_50HZ: String

Deprecated: Deprecated in Java. 

Value: "50hz"

ANTIBANDING_60HZ

Added in API level 5
Deprecated in API level 21
static val ANTIBANDING_60HZ: String

Deprecated: Deprecated in Java. 

Value: "60hz"

ANTIBANDING_AUTO

Added in API level 5
Deprecated in API level 21
static val ANTIBANDING_AUTO: String

Deprecated: Deprecated in Java. 

Value: "auto"

ANTIBANDING_OFF

Added in API level 5
Deprecated in API level 21
static val ANTIBANDING_OFF: String

Deprecated: Deprecated in Java. 

Value: "off"

EFFECT_AQUA

Added in API level 5
Deprecated in API level 21
static val EFFECT_AQUA: String

Deprecated: Deprecated in Java. 

Value: "aqua"

EFFECT_BLACKBOARD

Added in API level 5
Deprecated in API level 21
static val EFFECT_BLACKBOARD: String

Deprecated: Deprecated in Java. 

Value: "blackboard"

EFFECT_MONO

Added in API level 5
Deprecated in API level 21
static val EFFECT_MONO: String

Deprecated: Deprecated in Java. 

Value: "mono"

EFFECT_NEGATIVE

Added in API level 5
Deprecated in API level 21
static val EFFECT_NEGATIVE: String

Deprecated: Deprecated in Java. 

Value: "negative"

EFFECT_NONE

Added in API level 5
Deprecated in API level 21
static val EFFECT_NONE: String

Deprecated: Deprecated in Java. 

Value: "none"

EFFECT_POSTERIZE

Added in API level 5
Deprecated in API level 21
static val EFFECT_POSTERIZE: String

Deprecated: Deprecated in Java. 

Value: "posterize"

EFFECT_SEPIA

Added in API level 5
Deprecated in API level 21
static val EFFECT_SEPIA: String

Deprecated: Deprecated in Java. 

Value: "sepia"

EFFECT_SOLARIZE

Added in API level 5
Deprecated in API level 21
static val EFFECT_SOLARIZE: String

Deprecated: Deprecated in Java. 

Value: "solarize"

EFFECT_WHITEBOARD

Added in API level 5
Deprecated in API level 21
static val EFFECT_WHITEBOARD: String

Deprecated: Deprecated in Java. 

Value: "whiteboard"

FLASH_MODE_AUTO

Added in API level 5
Deprecated in API level 21
static val FLASH_MODE_AUTO: String

Deprecated: Deprecated in Java.

Flash will be fired automatically when required. The flash may be fired during preview, auto-focus, or snapshot depending on the driver.

Value: "auto"

FLASH_MODE_OFF

Added in API level 5
Deprecated in API level 21
static val FLASH_MODE_OFF: String

Deprecated: Deprecated in Java.

Flash will not be fired.

Value: "off"

FLASH_MODE_ON

Added in API level 5
Deprecated in API level 21
static val FLASH_MODE_ON: String

Deprecated: Deprecated in Java.

Flash will always be fired during snapshot. The flash may also be fired during preview or auto-focus depending on the driver.

Value: "on"

FLASH_MODE_RED_EYE

Added in API level 5
Deprecated in API level 21
static val FLASH_MODE_RED_EYE: String

Deprecated: Deprecated in Java.

Flash will be fired in red-eye reduction mode.

Value: "red-eye"

FLASH_MODE_TORCH

Added in API level 5
Deprecated in API level 21
static val FLASH_MODE_TORCH: String

Deprecated: Deprecated in Java.

Constant emission of light during preview, auto-focus and snapshot. This can also be used for video recording.

Value: "torch"

FOCUS_DISTANCE_FAR_INDEX

Added in API level 9
Deprecated in API level 21
static val FOCUS_DISTANCE_FAR_INDEX: Int

Deprecated: Deprecated in Java.

The array index of far focus distance for use with getFocusDistances(float[]).

Value: 2

FOCUS_DISTANCE_NEAR_INDEX

Added in API level 9
Deprecated in API level 21
static val FOCUS_DISTANCE_NEAR_INDEX: Int

Deprecated: Deprecated in Java.

The array index of near focus distance for use with getFocusDistances(float[]).

Value: 0

FOCUS_DISTANCE_OPTIMAL_INDEX

Added in API level 9
Deprecated in API level 21
static val FOCUS_DISTANCE_OPTIMAL_INDEX: Int

Deprecated: Deprecated in Java.

The array index of optimal focus distance for use with getFocusDistances(float[]).

Value: 1

FOCUS_MODE_AUTO

Added in API level 5
Deprecated in API level 21
static val FOCUS_MODE_AUTO: String

Deprecated: Deprecated in Java.

Auto-focus mode. Applications should call autoFocus(android.hardware.Camera.AutoFocusCallback) to start the focus in this mode.

Value: "auto"

FOCUS_MODE_CONTINUOUS_PICTURE

Added in API level 14
Deprecated in API level 21
static val FOCUS_MODE_CONTINUOUS_PICTURE: String

Deprecated: Deprecated in Java.

Continuous auto focus mode intended for taking pictures. The camera continuously tries to focus. The speed of focus change is more aggressive than FOCUS_MODE_CONTINUOUS_VIDEO. Auto focus starts when the parameter is set.

Applications can call autoFocus(android.hardware.Camera.AutoFocusCallback) in this mode. If the autofocus is in the middle of scanning, the focus callback will return when it completes. If the autofocus is not scanning, the focus callback will immediately return with a boolean that indicates whether the focus is sharp or not. The apps can then decide if they want to take a picture immediately or to change the focus mode to auto, and run a full autofocus cycle. The focus position is locked after autoFocus call. If applications want to resume the continuous focus, cancelAutoFocus must be called. Restarting the preview will not resume the continuous autofocus. To stop continuous focus, applications should change the focus mode to other modes.

Value: "continuous-picture"

FOCUS_MODE_CONTINUOUS_VIDEO

Added in API level 9
Deprecated in API level 21
static val FOCUS_MODE_CONTINUOUS_VIDEO: String

Deprecated: Deprecated in Java.

Continuous auto focus mode intended for video recording. The camera continuously tries to focus. This is the best choice for video recording because the focus changes smoothly . Applications still can call takePicture(android.hardware.Camera.ShutterCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback) in this mode but the subject may not be in focus. Auto focus starts when the parameter is set.

Since API level 14, applications can call autoFocus(android.hardware.Camera.AutoFocusCallback) in this mode. The focus callback will immediately return with a boolean that indicates whether the focus is sharp or not. The focus position is locked after autoFocus call. If applications want to resume the continuous focus, cancelAutoFocus must be called. Restarting the preview will not resume the continuous autofocus. To stop continuous focus, applications should change the focus mode to other modes.

Value: "continuous-video"

FOCUS_MODE_EDOF

Added in API level 8
Deprecated in API level 21
static val FOCUS_MODE_EDOF: String

Deprecated: Deprecated in Java.

Extended depth of field (EDOF). Focusing is done digitally and continuously. Applications should not call autoFocus(android.hardware.Camera.AutoFocusCallback) in this mode.

Value: "edof"

FOCUS_MODE_FIXED

Added in API level 5
Deprecated in API level 21
static val FOCUS_MODE_FIXED: String

Deprecated: Deprecated in Java.

Focus is fixed. The camera is always in this mode if the focus is not adjustable. If the camera has auto-focus, this mode can fix the focus, which is usually at hyperfocal distance. Applications should not call autoFocus(android.hardware.Camera.AutoFocusCallback) in this mode.

Value: "fixed"

FOCUS_MODE_INFINITY

Added in API level 5
Deprecated in API level 21
static val FOCUS_MODE_INFINITY: String

Deprecated: Deprecated in Java.

Focus is set at infinity. Applications should not call autoFocus(android.hardware.Camera.AutoFocusCallback) in this mode.

Value: "infinity"

FOCUS_MODE_MACRO

Added in API level 5
Deprecated in API level 21
static val FOCUS_MODE_MACRO: String

Deprecated: Deprecated in Java.

Macro (close-up) focus mode. Applications should call autoFocus(android.hardware.Camera.AutoFocusCallback) to start the focus in this mode.

Value: "macro"

PREVIEW_FPS_MAX_INDEX

Added in API level 9
Deprecated in API level 21
static val PREVIEW_FPS_MAX_INDEX: Int

Deprecated: Deprecated in Java.

The array index of maximum preview fps for use with getPreviewFpsRange(int[]) or getSupportedPreviewFpsRange().

Value: 1

PREVIEW_FPS_MIN_INDEX

Added in API level 9
Deprecated in API level 21
static val PREVIEW_FPS_MIN_INDEX: Int

Deprecated: Deprecated in Java.

The array index of minimum preview fps for use with getPreviewFpsRange(int[]) or getSupportedPreviewFpsRange().

Value: 0

SCENE_MODE_ACTION

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_ACTION: String

Deprecated: Deprecated in Java.

Take photos of fast moving objects. Same as SCENE_MODE_SPORTS.

Value: "action"

SCENE_MODE_AUTO

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_AUTO: String

Deprecated: Deprecated in Java.

Scene mode is off.

Value: "auto"

SCENE_MODE_BARCODE

Added in API level 8
Deprecated in API level 21
static val SCENE_MODE_BARCODE: String

Deprecated: Deprecated in Java.

Applications are looking for a barcode. Camera driver will be optimized for barcode reading.

Value: "barcode"

SCENE_MODE_BEACH

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_BEACH: String

Deprecated: Deprecated in Java.

Take pictures on the beach.

Value: "beach"

SCENE_MODE_CANDLELIGHT

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_CANDLELIGHT: String

Deprecated: Deprecated in Java.

Capture the naturally warm color of scenes lit by candles.

Value: "candlelight"

SCENE_MODE_FIREWORKS

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_FIREWORKS: String

Deprecated: Deprecated in Java.

For shooting firework displays.

Value: "fireworks"

SCENE_MODE_HDR

Added in API level 17
Deprecated in API level 21
static val SCENE_MODE_HDR: String

Deprecated: Deprecated in Java.

Capture a scene using high dynamic range imaging techniques. The camera will return an image that has an extended dynamic range compared to a regular capture. Capturing such an image may take longer than a regular capture.

Value: "hdr"

SCENE_MODE_LANDSCAPE

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_LANDSCAPE: String

Deprecated: Deprecated in Java.

Take pictures on distant objects.

Value: "landscape"

SCENE_MODE_NIGHT

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_NIGHT: String

Deprecated: Deprecated in Java.

Take photos at night.

Value: "night"

SCENE_MODE_NIGHT_PORTRAIT

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_NIGHT_PORTRAIT: String

Deprecated: Deprecated in Java.

Take people pictures at night.

Value: "night-portrait"

SCENE_MODE_PARTY

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_PARTY: String

Deprecated: Deprecated in Java.

Take indoor low-light shot.

Value: "party"

SCENE_MODE_PORTRAIT

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_PORTRAIT: String

Deprecated: Deprecated in Java.

Take people pictures.

Value: "portrait"

SCENE_MODE_SNOW

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_SNOW: String

Deprecated: Deprecated in Java.

Take pictures on the snow.

Value: "snow"

SCENE_MODE_SPORTS

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_SPORTS: String

Deprecated: Deprecated in Java.

Take photos of fast moving objects. Same as SCENE_MODE_ACTION.

Value: "sports"

SCENE_MODE_STEADYPHOTO

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_STEADYPHOTO: String

Deprecated: Deprecated in Java.

Avoid blurry pictures (for example, due to hand shake).

Value: "steadyphoto"

SCENE_MODE_SUNSET

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_SUNSET: String

Deprecated: Deprecated in Java.

Take sunset photos.

Value: "sunset"

SCENE_MODE_THEATRE

Added in API level 5
Deprecated in API level 21
static val SCENE_MODE_THEATRE: String

Deprecated: Deprecated in Java.

Take photos in a theater. Flash light is off.

Value: "theatre"

WHITE_BALANCE_AUTO

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_AUTO: String

Deprecated: Deprecated in Java. 

Value: "auto"

WHITE_BALANCE_CLOUDY_DAYLIGHT

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_CLOUDY_DAYLIGHT: String

Deprecated: Deprecated in Java. 

Value: "cloudy-daylight"

WHITE_BALANCE_DAYLIGHT

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_DAYLIGHT: String

Deprecated: Deprecated in Java. 

Value: "daylight"

WHITE_BALANCE_FLUORESCENT

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_FLUORESCENT: String

Deprecated: Deprecated in Java. 

Value: "fluorescent"

WHITE_BALANCE_INCANDESCENT

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_INCANDESCENT: String

Deprecated: Deprecated in Java. 

Value: "incandescent"

WHITE_BALANCE_SHADE

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_SHADE: String

Deprecated: Deprecated in Java. 

Value: "shade"

WHITE_BALANCE_TWILIGHT

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_TWILIGHT: String

Deprecated: Deprecated in Java. 

Value: "twilight"

WHITE_BALANCE_WARM_FLUORESCENT

Added in API level 5
Deprecated in API level 21
static val WHITE_BALANCE_WARM_FLUORESCENT: String

Deprecated: Deprecated in Java. 

Value: "warm-fluorescent"

Public methods

flatten

Added in API level 1
open fun flatten(): String!

Deprecated: Deprecated in Java.

Creates a single string with all the parameters set in this Parameters object.

The unflatten(java.lang.String) method does the reverse.

Return
String! a String with all values from this Parameters object, in semi-colon delimited key-value pairs

get

Added in API level 1
open fun get(key: String!): String!

Deprecated: Deprecated in Java.

Returns the value of a String parameter.

Parameters
key String!: the key name for the parameter
Return
String! the String value of the parameter

getAntibanding

Added in API level 5
Deprecated in API level 21
open fun getAntibanding(): String!

Deprecated: Deprecated in Java.

Gets the current antibanding setting.

Return
String! current antibanding. null if antibanding setting is not supported.

getAutoExposureLock

Added in API level 14
Deprecated in API level 21
open fun getAutoExposureLock(): Boolean

Deprecated: Deprecated in Java.

Gets the state of the auto-exposure lock. Applications should check isAutoExposureLockSupported before using this method. See setAutoExposureLock for details about the lock.

Return
Boolean State of the auto-exposure lock. Returns true if auto-exposure is currently locked, and false otherwise.

getAutoWhiteBalanceLock

Added in API level 14
Deprecated in API level 21
open fun getAutoWhiteBalanceLock(): Boolean

Deprecated: Deprecated in Java.

Gets the state of the auto-white balance lock. Applications should check isAutoWhiteBalanceLockSupported before using this method. See setAutoWhiteBalanceLock for details about the lock.

Return
Boolean State of the auto-white balance lock. Returns true if auto-white balance is currently locked, and false otherwise.

getColorEffect

Added in API level 5
Deprecated in API level 21
open fun getColorEffect(): String!

Deprecated: Deprecated in Java.

Gets the current color effect setting.

Return
String! current color effect. null if color effect setting is not supported.

getExposureCompensation

Added in API level 8
Deprecated in API level 21
open fun getExposureCompensation(): Int

Deprecated: Deprecated in Java.

Gets the current exposure compensation index.

Return
Int current exposure compensation index. The range is getMinExposureCompensation to getMaxExposureCompensation. 0 means exposure is not adjusted.

getExposureCompensationStep

Added in API level 8
Deprecated in API level 21
open fun getExposureCompensationStep(): Float

Deprecated: Deprecated in Java.

Gets the exposure compensation step.

Return
Float exposure compensation step. Applications can get EV by multiplying the exposure compensation index and step. Ex: if exposure compensation index is -6 and step is 0.333333333, EV is -2.

getFlashMode

Added in API level 5
Deprecated in API level 21
open fun getFlashMode(): String!

Deprecated: Deprecated in Java.

Gets the current flash mode setting.

Return
String! current flash mode. null if flash mode setting is not supported.

getFocalLength

Added in API level 8
Deprecated in API level 21
open fun getFocalLength(): Float

Deprecated: Deprecated in Java.

Gets the focal length (in millimeter) of the camera.

Return
Float the focal length. Returns -1.0 when the device doesn't report focal length information.

getFocusAreas

Added in API level 14
Deprecated in API level 21
open fun getFocusAreas(): MutableList<Camera.Area!>!

Deprecated: Deprecated in Java.

Gets the current focus areas. Camera driver uses the areas to decide focus.

Before using this API or setFocusAreas(java.util.List), apps should call getMaxNumFocusAreas() to know the maximum number of focus areas first. If the value is 0, focus area is not supported.

Each focus area is a rectangle with specified weight. The direction is relative to the sensor orientation, that is, what the sensor sees. The direction is not affected by the rotation or mirroring of setDisplayOrientation(int). Coordinates of the rectangle range from -1000 to 1000. (-1000, -1000) is the upper left point. (1000, 1000) is the lower right point. The width and height of focus areas cannot be 0 or negative.

The weight must range from 1 to 1000. The weight should be interpreted as a per-pixel weight - all pixels in the area have the specified weight. This means a small area with the same weight as a larger area will have less influence on the focusing than the larger area. Focus areas can partially overlap and the driver will add the weights in the overlap region.

A special case of a null focus area list means the driver is free to select focus targets as it wants. For example, the driver may use more signals to select focus areas and change them dynamically. Apps can set the focus area list to null if they want the driver to completely control focusing.

Focus areas are relative to the current field of view (getZoom()). No matter what the zoom level is, (-1000,-1000) represents the top of the currently visible camera frame. The focus area cannot be set to be outside the current field of view, even when using zoom.

Focus area only has effect if the current focus mode is FOCUS_MODE_AUTO, FOCUS_MODE_MACRO, FOCUS_MODE_CONTINUOUS_VIDEO, or FOCUS_MODE_CONTINUOUS_PICTURE.

Return
MutableList<Camera.Area!>! a list of current focus areas

getFocusDistances

Added in API level 9
Deprecated in API level 21
open fun getFocusDistances(output: FloatArray!): Unit

Deprecated: Deprecated in Java.

Gets the distances from the camera to where an object appears to be in focus. The object is sharpest at the optimal focus distance. The depth of field is the far focus distance minus near focus distance.

Focus distances may change after calling autoFocus(android.hardware.Camera.AutoFocusCallback), cancelAutoFocus, or startPreview(). Applications can call getParameters() and this method anytime to get the latest focus distances. If the focus mode is FOCUS_MODE_CONTINUOUS_VIDEO, focus distances may change from time to time.

This method is intended to estimate the distance between the camera and the subject. After autofocus, the subject distance may be within near and far focus distance. However, the precision depends on the camera hardware, autofocus algorithm, the focus area, and the scene. The error can be large and it should be only used as a reference.

Far focus distance >= optimal focus distance >= near focus distance. If the focus distance is infinity, the value will be Float.POSITIVE_INFINITY.

Parameters
output FloatArray!: focus distances in meters. output must be a float array with three elements. Near focus distance, optimal focus distance, and far focus distance will be filled in the array.

getFocusMode

Added in API level 5
Deprecated in API level 21
open fun getFocusMode(): String!

Deprecated: Deprecated in Java.

Gets the current focus mode setting.

Return
String! current focus mode. This method will always return a non-null value. Applications should call autoFocus(android.hardware.Camera.AutoFocusCallback) to start the focus if focus mode is FOCUS_MODE_AUTO or FOCUS_MODE_MACRO.

getHorizontalViewAngle

Added in API level 8
Deprecated in API level 21
open fun getHorizontalViewAngle(): Float

Deprecated: Deprecated in Java.

Gets the horizontal angle of view in degrees.

Return
Float horizontal angle of view. Returns -1.0 when the device doesn't report view angle information.

getInt

Added in API level 1
open fun getInt(key: String!): Int

Deprecated: Deprecated in Java.

Returns the value of an integer parameter.

Parameters
key String!: the key name for the parameter
Return
Int the int value of the parameter

getJpegQuality

Added in API level 5
Deprecated in API level 21
open fun getJpegQuality(): Int

Deprecated: Deprecated in Java.

Returns the quality setting for the JPEG picture.

Return
Int the JPEG picture quality setting.

getJpegThumbnailQuality

Added in API level 5
Deprecated in API level 21
open fun getJpegThumbnailQuality(): Int

Deprecated: Deprecated in Java.

Returns the quality setting for the EXIF thumbnail in Jpeg picture.

Return
Int the JPEG quality setting of the EXIF thumbnail.

getJpegThumbnailSize

Added in API level 5
Deprecated in API level 21
open fun getJpegThumbnailSize(): Camera.Size!

Deprecated: Deprecated in Java.

Returns the dimensions for EXIF thumbnail in Jpeg picture.

Return
Camera.Size! a Size object with the height and width setting for the EXIF thumbnails

getMaxExposureCompensation

Added in API level 8
Deprecated in API level 21
open fun getMaxExposureCompensation(): Int

Deprecated: Deprecated in Java.

Gets the maximum exposure compensation index.

Return
Int maximum exposure compensation index (>=0). If both this method and getMinExposureCompensation return 0, exposure compensation is not supported.

getMaxNumDetectedFaces

Added in API level 14
Deprecated in API level 21
open fun getMaxNumDetectedFaces(): Int

Deprecated: Deprecated in Java.

Gets the maximum number of detected faces supported. This is the maximum length of the list returned from FaceDetectionListener. If the return value is 0, face detection of the specified type is not supported.

Return
Int the maximum number of detected face supported by the camera.

getMaxNumFocusAreas

Added in API level 14
Deprecated in API level 21
open fun getMaxNumFocusAreas(): Int

Deprecated: Deprecated in Java.

Gets the maximum number of focus areas supported. This is the maximum length of the list in setFocusAreas(java.util.List) and getFocusAreas().

Return
Int the maximum number of focus areas supported by the camera.

See Also

getMaxNumMeteringAreas

Added in API level 14
Deprecated in API level 21
open fun getMaxNumMeteringAreas(): Int

Deprecated: Deprecated in Java.

Gets the maximum number of metering areas supported. This is the maximum length of the list in setMeteringAreas(java.util.List) and getMeteringAreas().

Return
Int the maximum number of metering areas supported by the camera.

getMaxZoom

Added in API level 8
Deprecated in API level 21
open fun getMaxZoom(): Int

Deprecated: Deprecated in Java.

Gets the maximum zoom value allowed for snapshot. This is the maximum value that applications can set to setZoom(int). Applications should call isZoomSupported before using this method. This value may change in different preview size. Applications should call this again after setting preview size.

Return
Int the maximum zoom value supported by the camera.

getMeteringAreas

Added in API level 14
Deprecated in API level 21
open fun getMeteringAreas(): MutableList<Camera.Area!>!

Deprecated: Deprecated in Java.

Gets the current metering areas. Camera driver uses these areas to decide exposure.

Before using this API or setMeteringAreas(java.util.List), apps should call getMaxNumMeteringAreas() to know the maximum number of metering areas first. If the value is 0, metering area is not supported.

Each metering area is a rectangle with specified weight. The direction is relative to the sensor orientation, that is, what the sensor sees. The direction is not affected by the rotation or mirroring of setDisplayOrientation(int). Coordinates of the rectangle range from -1000 to 1000. (-1000, -1000) is the upper left point. (1000, 1000) is the lower right point. The width and height of metering areas cannot be 0 or negative.

The weight must range from 1 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 driver will add the weights in the overlap region.

A special case of a null metering area list means the driver is free to meter as it chooses. For example, the driver may use more signals to select metering areas and change them dynamically. Apps can set the metering area list to null if they want the driver to completely control metering.

Metering areas are relative to the current field of view (getZoom()). No matter what the zoom level is, (-1000,-1000) represents the top of the currently visible camera frame. The metering area cannot be set to be outside the current field of view, even when using zoom.

No matter what metering areas are, the final exposure are compensated by setExposureCompensation(int).

Return
MutableList<Camera.Area!>! a list of current metering areas

getMinExposureCompensation

Added in API level 8
Deprecated in API level 21
open fun getMinExposureCompensation(): Int

Deprecated: Deprecated in Java.

Gets the minimum exposure compensation index.

Return
Int minimum exposure compensation index (<=0). If both this method and getMaxExposureCompensation return 0, exposure compensation is not supported.

getPictureFormat

Added in API level 1
open fun getPictureFormat(): Int

Deprecated: Deprecated in Java.

Returns the image format for pictures.

Return
Int the picture format

getPictureSize

Added in API level 1
open fun getPictureSize(): Camera.Size!

Deprecated: Deprecated in Java.

Returns the dimension setting for pictures.

Return
Camera.Size! a Size object with the height and width setting for pictures

getPreferredPreviewSizeForVideo

Added in API level 11
Deprecated in API level 21
open fun getPreferredPreviewSizeForVideo(): Camera.Size!

Deprecated: Deprecated in Java.

Returns the preferred or recommended preview size (width and height) in pixels for video recording. Camcorder applications should set the preview size to a value that is not larger than the preferred preview size. In other words, the product of the width and height of the preview size should not be larger than that of the preferred preview size. In addition, we recommend to choose a preview size that has the same aspect ratio as the resolution of video to be recorded.

Return
Camera.Size! the preferred preview size (width and height) in pixels for video recording if getSupportedVideoSizes() does not return null; otherwise, null is returned.

getPreviewFormat

Added in API level 1
open fun getPreviewFormat(): Int

Deprecated: Deprecated in Java.

Returns the image format for preview frames got from PreviewCallback.

Return
Int the preview format.

getPreviewFpsRange

Added in API level 9
Deprecated in API level 21
open fun getPreviewFpsRange(range: IntArray!): Unit

Deprecated: Deprecated in Java.

Returns the current minimum and maximum preview fps. The values are one of the elements returned by getSupportedPreviewFpsRange.

Return
Unit range the minimum and maximum preview fps (scaled by 1000).

getPreviewFrameRate

Added in API level 1
Deprecated in API level 15
open fun getPreviewFrameRate(): Int

Deprecated: replaced by getPreviewFpsRange(int[])

Returns the setting for the rate at which preview frames are received. This is the target frame rate. The actual frame rate depends on the driver.

Return
Int the frame rate setting (frames per second)

getPreviewSize

Added in API level 1
open fun getPreviewSize(): Camera.Size!

Deprecated: Deprecated in Java.

Returns the dimensions setting for preview pictures.

Return
Camera.Size! a Size object with the width and height setting for the preview picture

getSceneMode

Added in API level 5
Deprecated in API level 21
open fun getSceneMode(): String!

Deprecated: Deprecated in Java.

Gets the current scene mode setting.

Return
String! one of SCENE_MODE_XXX string constant. null if scene mode setting is not supported.

getSupportedAntibanding

Added in API level 5
Deprecated in API level 21
open fun getSupportedAntibanding(): MutableList<String!>!

Deprecated: Deprecated in Java.

Gets the supported antibanding values.

Return
MutableList<String!>! a list of supported antibanding values. null if antibanding setting is not supported.

getSupportedColorEffects

Added in API level 5
Deprecated in API level 21
open fun getSupportedColorEffects(): MutableList<String!>!

Deprecated: Deprecated in Java.

Gets the supported color effects.

Return
MutableList<String!>! a list of supported color effects. null if color effect setting is not supported.

getSupportedFlashModes

Added in API level 5
Deprecated in API level 21
open fun getSupportedFlashModes(): MutableList<String!>!

Deprecated: Deprecated in Java.

Gets the supported flash modes.

Return
MutableList<String!>! a list of supported flash modes. null if flash mode setting is not supported.

See Also

getSupportedFocusModes

Added in API level 5
Deprecated in API level 21
open fun getSupportedFocusModes(): MutableList<String!>!

Deprecated: Deprecated in Java.

Gets the supported focus modes.

Return
MutableList<String!>! a list of supported focus modes. This method will always return a list with at least one element.

See Also

getSupportedJpegThumbnailSizes

Added in API level 8
Deprecated in API level 21
open fun getSupportedJpegThumbnailSizes(): MutableList<Camera.Size!>!

Deprecated: Deprecated in Java.

Gets the supported jpeg thumbnail sizes.

Return
MutableList<Camera.Size!>! a list of Size object. This method will always return a list with at least two elements. Size 0,0 (no thumbnail) is always supported.

getSupportedPictureFormats

Added in API level 5
Deprecated in API level 21
open fun getSupportedPictureFormats(): MutableList<Int!>!

Deprecated: Deprecated in Java.

Gets the supported picture formats.

Return
MutableList<Int!>! supported picture formats. This method will always return a list with at least one element.

getSupportedPictureSizes

Added in API level 5
Deprecated in API level 21
open fun getSupportedPictureSizes(): MutableList<Camera.Size!>!

Deprecated: Deprecated in Java.

Gets the supported picture sizes.

Return
MutableList<Camera.Size!>! a list of supported picture sizes. This method will always return a list with at least one element.

getSupportedPreviewFormats

Added in API level 5
Deprecated in API level 21
open fun getSupportedPreviewFormats(): MutableList<Int!>!

Deprecated: Deprecated in Java.

Gets the supported preview formats. android.graphics.ImageFormat#NV21 is always supported. android.graphics.ImageFormat#YV12 is always supported since API level 12.

Return
MutableList<Int!>! a list of supported preview formats. This method will always return a list with at least one element.

getSupportedPreviewFpsRange

Added in API level 9
Deprecated in API level 21
open fun getSupportedPreviewFpsRange(): MutableList<IntArray!>!

Deprecated: Deprecated in Java.

Gets the supported preview fps (frame-per-second) ranges. Each range contains a minimum fps and maximum fps. If minimum fps equals to maximum fps, the camera outputs frames in fixed frame rate. If not, the camera outputs frames in auto frame rate. The actual frame rate fluctuates between the minimum and the maximum. The values are multiplied by 1000 and represented in integers. For example, if frame rate is 26.623 frames per second, the value is 26623.

Return
MutableList<IntArray!>! a list of supported preview fps ranges. This method returns a list with at least one element. Every element is an int array of two values - minimum fps and maximum fps. The list is sorted from small to large (first by maximum fps and then minimum fps).

getSupportedPreviewFrameRates

Added in API level 5
Deprecated in API level 15
open fun getSupportedPreviewFrameRates(): MutableList<Int!>!

Deprecated: replaced by getSupportedPreviewFpsRange()

Gets the supported preview frame rates.

Return
MutableList<Int!>! a list of supported preview frame rates. null if preview frame rate setting is not supported.

getSupportedPreviewSizes

Added in API level 5
Deprecated in API level 21
open fun getSupportedPreviewSizes(): MutableList<Camera.Size!>!

Deprecated: Deprecated in Java.

Gets the supported preview sizes.

Return
MutableList<Camera.Size!>! a list of Size object. This method will always return a list with at least one element.

getSupportedSceneModes

Added in API level 5
Deprecated in API level 21
open fun getSupportedSceneModes(): MutableList<String!>!

Deprecated: Deprecated in Java.

Gets the supported scene modes.

Return
MutableList<String!>! a list of supported scene modes. null if scene mode setting is not supported.

See Also

getSupportedVideoSizes

Added in API level 11
Deprecated in API level 21
open fun getSupportedVideoSizes(): MutableList<Camera.Size!>!

Deprecated: Deprecated in Java.

Gets the supported video frame sizes that can be used by MediaRecorder.

If the returned list is not null, the returned list will contain at least one Size and one of the sizes in the returned list must be passed to MediaRecorder.setVideoSize() for camcorder application if camera is used as the video source. In this case, the size of the preview can be different from the resolution of the recorded video during video recording.

Exception on 176x144 (QCIF) resolution: Camera devices usually have a fixed capability for downscaling from larger resolution to smaller, and the QCIF resolution sometimes is not fully supported due to this limitation on devices with high-resolution image sensors. Therefore, trying to configure a QCIF video resolution with any preview or picture size larger than 1920x1080 (either width or height) might not be supported, and setParameters(android.hardware.Camera.Parameters) will throw a RuntimeException if it is not.

Return
MutableList<Camera.Size!>! a list of Size object if camera has separate preview and video output; otherwise, null is returned.

getSupportedWhiteBalance

Added in API level 5
Deprecated in API level 21
open fun getSupportedWhiteBalance(): MutableList<String!>!

Deprecated: Deprecated in Java.

Gets the supported white balance.

Return
MutableList<String!>! a list of supported white balance. null if white balance setting is not supported.

getVerticalViewAngle

Added in API level 8
Deprecated in API level 21
open fun getVerticalViewAngle(): Float

Deprecated: Deprecated in Java.

Gets the vertical angle of view in degrees.

Return
Float vertical angle of view. Returns -1.0 when the device doesn't report view angle information.

getVideoStabilization

Added in API level 15
Deprecated in API level 21
open fun getVideoStabilization(): Boolean

Deprecated: Deprecated in Java.

Get the current state of video stabilization. See setVideoStabilization for details of video stabilization.

Return
Boolean true if video stabilization is enabled

getWhiteBalance

Added in API level 5
Deprecated in API level 21
open fun getWhiteBalance(): String!

Deprecated: Deprecated in Java.

Gets the current white balance setting.

Return
String! current white balance. null if white balance setting is not supported.

getZoom

Added in API level 8
Deprecated in API level 21
open fun getZoom(): Int

Deprecated: Deprecated in Java.

Gets current zoom value. This also works when smooth zoom is in progress. Applications should check isZoomSupported before using this method.

Return
Int the current zoom value. The range is 0 to getMaxZoom. 0 means the camera is not zoomed.

getZoomRatios

Added in API level 8
Deprecated in API level 21
open fun getZoomRatios(): MutableList<Int!>!

Deprecated: Deprecated in Java.

Gets the zoom ratios of all zoom values. Applications should check isZoomSupported before using this method.

Return
MutableList<Int!>! the zoom ratios in 1/100 increments. Ex: a zoom of 3.2x is returned as 320. The number of elements is getMaxZoom + 1. The list is sorted from small to large. The first element is always 100. The last element is the zoom ratio of the maximum zoom value.

isAutoExposureLockSupported

Added in API level 14
Deprecated in API level 21
open fun isAutoExposureLockSupported(): Boolean

Deprecated: Deprecated in Java.

Returns true if auto-exposure locking is supported. Applications should call this before trying to lock auto-exposure. See setAutoExposureLock for details about the lock.

Return
Boolean true if auto-exposure lock is supported.

isAutoWhiteBalanceLockSupported

Added in API level 14
Deprecated in API level 21
open fun isAutoWhiteBalanceLockSupported(): Boolean

Deprecated: Deprecated in Java.

Returns true if auto-white balance locking is supported. Applications should call this before trying to lock auto-white balance. See setAutoWhiteBalanceLock for details about the lock.

Return
Boolean true if auto-white balance lock is supported.

isSmoothZoomSupported

Added in API level 8
Deprecated in API level 21
open fun isSmoothZoomSupported(): Boolean

Deprecated: Deprecated in Java.

Returns true if smooth zoom is supported. Applications should call this before using other smooth zoom methods.

Return
Boolean true if smooth zoom is supported.

isVideoSnapshotSupported

Added in API level 14
Deprecated in API level 21
open fun isVideoSnapshotSupported(): Boolean

Deprecated: Deprecated in Java.

Returns true if video snapshot is supported. That is, applications can call takePicture(android.hardware.Camera.ShutterCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback) during recording. Applications do not need to call startPreview() after taking a picture. The preview will be still active. Other than that, taking a picture during recording is identical to taking a picture normally. All settings and methods related to takePicture work identically. Ex: getPictureSize(), getSupportedPictureSizes(), setJpegQuality(int), setRotation(int), and etc. The picture will have an EXIF header. FLASH_MODE_AUTO and FLASH_MODE_ON also still work, but the video will record the flash.

Applications can set shutter callback as null to avoid the shutter sound. It is also recommended to set raw picture and post view callbacks to null to avoid the interrupt of preview display.

Field-of-view of the recorded video may be different from that of the captured pictures. The maximum size of a video snapshot may be smaller than that for regular still captures. If the current picture size is set higher than can be supported by video snapshot, the picture will be captured at the maximum supported size instead.

Return
Boolean true if video snapshot is supported.

isVideoStabilizationSupported

Added in API level 15
Deprecated in API level 21
open fun isVideoStabilizationSupported(): Boolean

Deprecated: Deprecated in Java.

Returns true if video stabilization is supported. See setVideoStabilization for details of video stabilization.

Return
Boolean true if video stabilization is supported

isZoomSupported

Added in API level 8
Deprecated in API level 21
open fun isZoomSupported(): Boolean

Deprecated: Deprecated in Java.

Returns true if zoom is supported. Applications should call this before using other zoom methods.

Return
Boolean true if zoom is supported.

remove

Added in API level 1
open fun remove(key: String!): Unit

Deprecated: Deprecated in Java.

removeGpsData

Added in API level 5
Deprecated in API level 21
open fun removeGpsData(): Unit

Deprecated: Deprecated in Java.

Removes GPS latitude, longitude, altitude, and timestamp from the parameters.

set

Added in API level 1
open fun set(
    key: String!, 
    value: String!
): Unit

Deprecated: Deprecated in Java.

Sets a String parameter.

Parameters
key String!: the key name for the parameter
value String!: the String value of the parameter

set

Added in API level 1
open fun set(
    key: String!, 
    value: Int
): Unit

Deprecated: Deprecated in Java.

Sets an integer parameter.

Parameters
key String!: the key name for the parameter
value Int: the int value of the parameter

setAntibanding

Added in API level 5
Deprecated in API level 21
open fun setAntibanding(antibanding: String!): Unit

Deprecated: Deprecated in Java.

Sets the antibanding.

Parameters
antibanding String!: new antibanding value.

setAutoExposureLock

Added in API level 14
Deprecated in API level 21
open fun setAutoExposureLock(toggle: Boolean): Unit

Deprecated: Deprecated in Java.

Sets the auto-exposure lock state. Applications should check isAutoExposureLockSupported before using this method.

If set to true, the camera auto-exposure routine will immediately pause until the lock is set to false. Exposure compensation settings changes will still take effect while auto-exposure is locked.

If auto-exposure is already locked, setting this to true again has no effect (the driver will not recalculate exposure values).

Stopping preview with stopPreview(), or triggering still image capture with takePicture(android.hardware.Camera.ShutterCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback), will not change the lock.

Exposure compensation, auto-exposure lock, and auto-white balance lock can be used to capture an exposure-bracketed burst of images, for example.

Auto-exposure state, including the lock state, will not be maintained after camera release() is called. Locking auto-exposure after open() but before the first call to startPreview() will not allow the auto-exposure routine to run at all, and may result in severely over- or under-exposed images.

Parameters
toggle Boolean: new state of the auto-exposure lock. True means that auto-exposure is locked, false means that the auto-exposure routine is free to run normally.

setAutoWhiteBalanceLock

Added in API level 14
Deprecated in API level 21
open fun setAutoWhiteBalanceLock(toggle: Boolean): Unit

Deprecated: Deprecated in Java.

Sets the auto-white balance lock state. Applications should check isAutoWhiteBalanceLockSupported before using this method.

If set to true, the camera auto-white balance routine will immediately pause until the lock is set to false.

If auto-white balance is already locked, setting this to true again has no effect (the driver will not recalculate white balance values).

Stopping preview with stopPreview(), or triggering still image capture with takePicture(android.hardware.Camera.ShutterCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback), will not change the the lock.

Changing the white balance mode with setWhiteBalance will release the auto-white balance lock if it is set.

Exposure compensation, AE lock, and AWB lock can be used to capture an exposure-bracketed burst of images, for example. Auto-white balance state, including the lock state, will not be maintained after camera release() is called. Locking auto-white balance after open() but before the first call to startPreview() will not allow the auto-white balance routine to run at all, and may result in severely incorrect color in captured images.

Parameters
toggle Boolean: new state of the auto-white balance lock. True means that auto-white balance is locked, false means that the auto-white balance routine is free to run normally.

setColorEffect

Added in API level 5
Deprecated in API level 21
open fun setColorEffect(value: String!): Unit

Deprecated: Deprecated in Java.

Sets the current color effect setting.

Parameters
value String!: new color effect.

setExposureCompensation

Added in API level 8
Deprecated in API level 21
open fun setExposureCompensation(value: Int): Unit

Deprecated: Deprecated in Java.

Sets the exposure compensation index.

Parameters
value Int: exposure compensation index. The valid value range is from getMinExposureCompensation (inclusive) to getMaxExposureCompensation (inclusive). 0 means exposure is not adjusted. Application should call getMinExposureCompensation and getMaxExposureCompensation to know if exposure compensation is supported.

setFlashMode

Added in API level 5
Deprecated in API level 21
open fun setFlashMode(value: String!): Unit

Deprecated: Deprecated in Java.

Sets the flash mode.

Parameters
value String!: flash mode.

See Also

setFocusAreas

Added in API level 14
Deprecated in API level 21
open fun setFocusAreas(focusAreas: MutableList<Camera.Area!>!): Unit

Deprecated: Deprecated in Java.

Sets focus areas. See getFocusAreas() for documentation.

Parameters
focusAreas MutableList<Camera.Area!>!: the focus areas

See Also

setFocusMode

Added in API level 5
Deprecated in API level 21
open fun setFocusMode(value: String!): Unit

Deprecated: Deprecated in Java.

Sets the focus mode.

Parameters
value String!: focus mode.

See Also

setGpsAltitude

Added in API level 5
Deprecated in API level 21
open fun setGpsAltitude(altitude: Double): Unit

Deprecated: Deprecated in Java.

Sets GPS altitude. This will be stored in JPEG EXIF header.

Parameters
altitude Double: GPS altitude in meters.

setGpsLatitude

Added in API level 5
Deprecated in API level 21
open fun setGpsLatitude(latitude: Double): Unit

Deprecated: Deprecated in Java.

Sets GPS latitude coordinate. This will be stored in JPEG EXIF header.

Parameters
latitude Double: GPS latitude coordinate.

setGpsLongitude

Added in API level 5
Deprecated in API level 21
open fun setGpsLongitude(longitude: Double): Unit

Deprecated: Deprecated in Java.

Sets GPS longitude coordinate. This will be stored in JPEG EXIF header.

Parameters
longitude Double: GPS longitude coordinate.

setGpsProcessingMethod

Added in API level 8
Deprecated in API level 21
open fun setGpsProcessingMethod(processing_method: String!): Unit

Deprecated: Deprecated in Java.

Sets GPS processing method. The method will be stored in a UTF-8 string up to 31 bytes long, in the JPEG EXIF header.

Parameters
processing_method String!: The processing method to get this location.

setGpsTimestamp

Added in API level 5
Deprecated in API level 21
open fun setGpsTimestamp(timestamp: Long): Unit

Deprecated: Deprecated in Java.

Sets GPS timestamp. This will be stored in JPEG EXIF header.

Parameters
timestamp Long: GPS timestamp (UTC in seconds since January 1, 1970).

setJpegQuality

Added in API level 5
Deprecated in API level 21
open fun setJpegQuality(quality: Int): Unit

Deprecated: Deprecated in Java.

Sets Jpeg quality of captured picture.

Parameters
quality Int: the JPEG quality of captured picture. The range is 1 to 100, with 100 being the best.

setJpegThumbnailQuality

Added in API level 5
Deprecated in API level 21
open fun setJpegThumbnailQuality(quality: Int): Unit

Deprecated: Deprecated in Java.

Sets the quality of the EXIF thumbnail in Jpeg picture.

Parameters
quality Int: the JPEG quality of the EXIF thumbnail. The range is 1 to 100, with 100 being the best.

setJpegThumbnailSize

Added in API level 5
Deprecated in API level 21
open fun setJpegThumbnailSize(
    width: Int, 
    height: Int
): Unit

Deprecated: Deprecated in Java.

Sets the dimensions for EXIF thumbnail in Jpeg picture. If applications set both width and height to 0, EXIF will not contain thumbnail.

Applications need to consider the display orientation. See setPreviewSize(int,int) for reference.

Parameters
width Int: the width of the thumbnail, in pixels
height Int: the height of the thumbnail, in pixels

setMeteringAreas

Added in API level 14
Deprecated in API level 21
open fun setMeteringAreas(meteringAreas: MutableList<Camera.Area!>!): Unit

Deprecated: Deprecated in Java.

Sets metering areas. See getMeteringAreas() for documentation.

Parameters
meteringAreas MutableList<Camera.Area!>!: the metering areas

setPictureFormat

Added in API level 1
open fun setPictureFormat(pixel_format: Int): Unit

Deprecated: Deprecated in Java.

Sets the image format for pictures.

Parameters
pixel_format Int: the desired picture format (ImageFormat.NV21, ImageFormat.RGB_565, or ImageFormat.JPEG)

setPictureSize

Added in API level 1
open fun setPictureSize(
    width: Int, 
    height: Int
): Unit

Deprecated: Deprecated in Java.

Sets the dimensions for pictures.

Applications need to consider the display orientation. See setPreviewSize(int,int) for reference.

Exception on 176x144 (QCIF) resolution: Camera devices usually have a fixed capability for downscaling from larger resolution to smaller, and the QCIF resolution sometimes is not fully supported due to this limitation on devices with high-resolution image sensors. Therefore, trying to configure a QCIF picture size with any preview or video size larger than 1920x1080 (either width or height) might not be supported, and setParameters(android.hardware.Camera.Parameters) might throw a RuntimeException if it is not.

Parameters
width Int: the width for pictures, in pixels
height Int: the height for pictures, in pixels

setPreviewFormat

Added in API level 1
open fun setPreviewFormat(pixel_format: Int): Unit

Deprecated: Deprecated in Java.

Sets the image format for preview pictures.

If this is never called, the default format will be android.graphics.ImageFormat#NV21, which uses the NV21 encoding format.

Use Parameters#getSupportedPreviewFormats to get a list of the available preview formats.

It is strongly recommended that either android.graphics.ImageFormat#NV21 or android.graphics.ImageFormat#YV12 is used, since they are supported by all camera devices.

For YV12, the image buffer that is received is not necessarily tightly packed, as there may be padding at the end of each row of pixel data, as described in android.graphics.ImageFormat#YV12. For camera callback data, it can be assumed that the stride of the Y and UV data is the smallest possible that meets the alignment requirements. That is, if the preview size is width x height, then the following equations describe the buffer index for the beginning of row y for the Y plane and row c for the U and V planes: 

<code>yStride   = (int) ceil(width / 16.0) * 16;
  uvStride  = (int) ceil( (yStride / 2) / 16.0) * 16;
  ySize     = yStride * height;
  uvSize    = uvStride * height / 2;
  yRowIndex = yStride * y;
  uRowIndex = ySize + uvSize + uvStride * c;
  vRowIndex = ySize + uvStride * c;
  size      = ySize + uvSize * 2;
  </code>
Parameters
pixel_format Int: the desired preview picture format, defined by one of the android.graphics.ImageFormat constants. (E.g., ImageFormat.NV21 (default), or ImageFormat.YV12)

setPreviewFpsRange

Added in API level 9
Deprecated in API level 21
open fun setPreviewFpsRange(
    min: Int, 
    max: Int
): Unit

Deprecated: Deprecated in Java.

Sets the minimum and maximum preview fps. This controls the rate of preview frames received in PreviewCallback. The minimum and maximum preview fps must be one of the elements from getSupportedPreviewFpsRange.

Parameters
min Int: the minimum preview fps (scaled by 1000).
max Int: the maximum preview fps (scaled by 1000).
Exceptions
java.lang.RuntimeException if fps range is invalid.

setPreviewFrameRate

Added in API level 1
Deprecated in API level 15
open fun setPreviewFrameRate(fps: Int): Unit

Deprecated: replaced by setPreviewFpsRange(int,int)

Sets the rate at which preview frames are received. This is the target frame rate. The actual frame rate depends on the driver.

Parameters
fps Int: the frame rate (frames per second)

setPreviewSize

Added in API level 1
open fun setPreviewSize(
    width: Int, 
    height: Int
): Unit

Deprecated: Deprecated in Java.

Sets the dimensions for preview pictures. If the preview has already started, applications should stop the preview first before changing preview size. The sides of width and height are based on camera orientation. That is, the preview size is the size before it is rotated by display orientation. So applications need to consider the display orientation while setting preview size. For example, suppose the camera supports both 480x320 and 320x480 preview sizes. The application wants a 3:2 preview ratio. If the display orientation is set to 0 or 180, preview size should be set to 480x320. If the display orientation is set to 90 or 270, preview size should be set to 320x480. The display orientation should also be considered while setting picture size and thumbnail size. Exception on 176x144 (QCIF) resolution: Camera devices usually have a fixed capability for downscaling from larger resolution to smaller, and the QCIF resolution sometimes is not fully supported due to this limitation on devices with high-resolution image sensors. Therefore, trying to configure a QCIF preview size with any picture or video size larger than 1920x1080 (either width or height) might not be supported, and setParameters(android.hardware.Camera.Parameters) might throw a RuntimeException if it is not.

Parameters
width Int: the width of the pictures, in pixels
height Int: the height of the pictures, in pixels

setRecordingHint

Added in API level 14
Deprecated in API level 21
open fun setRecordingHint(hint: Boolean): Unit

Deprecated: Deprecated in Java.

Sets recording mode hint. This tells the camera that the intent of the application is to record videos android.media.MediaRecorder#start(), not to take still pictures takePicture(android.hardware.Camera.ShutterCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback,android.hardware.Camera.PictureCallback). Using this hint can allow MediaRecorder.start() to start faster or with fewer glitches on output. This should be called before starting preview for the best result, but can be changed while the preview is active. The default value is false. The app can still call takePicture() when the hint is true or call MediaRecorder.start() when the hint is false. But the performance may be worse.

Parameters
hint Boolean: true if the apps intend to record videos using android.media.MediaRecorder.

setRotation

Added in API level 5
Deprecated in API level 21
open fun setRotation(rotation: Int): Unit

Deprecated: Deprecated in Java.

Sets the clockwise rotation angle in degrees relative to the orientation of the camera. This affects the pictures returned from JPEG PictureCallback. The camera driver may set orientation in the EXIF header without rotating the picture. Or the driver may rotate the picture and the EXIF thumbnail. If the Jpeg picture is rotated, the orientation in the EXIF header will be missing or 1 (row #0 is top and column #0 is left side).

If applications want to rotate the picture to match the orientation of what users see, apps should use android.view.OrientationEventListener and android.hardware.Camera.CameraInfo. The value from OrientationEventListener is relative to the natural orientation of the device. CameraInfo.orientation is the angle between camera orientation and natural device orientation. The sum of the two is the rotation angle for back-facing camera. The difference of the two is the rotation angle for front-facing camera. Note that the JPEG pictures of front-facing cameras are not mirrored as in preview display.

For example, suppose the natural orientation of the device is portrait. The device is rotated 270 degrees clockwise, so the device orientation is 270. Suppose a back-facing camera sensor is mounted in landscape and the top side of the camera sensor is aligned with the right edge of the display in natural orientation. So the camera orientation is 90. The rotation should be set to 0 (270 + 90).

The reference code is as follows. 

public void onOrientationChanged(int orientation) {
      if (orientation == ORIENTATION_UNKNOWN) return;
      android.hardware.Camera.CameraInfo info =
             new android.hardware.Camera.CameraInfo();
      android.hardware.Camera.getCameraInfo(cameraId, info);
      orientation = (orientation + 45) / 90 * 90;
      int rotation = 0;
      if (info.facing == CameraInfo.CAMERA_FACING_FRONT) {
          rotation = (info.orientation - orientation + 360) % 360;
      } else {  // back-facing camera
          rotation = (info.orientation + orientation) % 360;
      }
      mParameters.setRotation(rotation);
  }
Parameters
rotation Int: The rotation angle in degrees relative to the orientation of the camera. Rotation can only be 0, 90, 180 or 270.
Exceptions
java.lang.IllegalArgumentException if rotation value is invalid.

setSceneMode

Added in API level 5
Deprecated in API level 21
open fun setSceneMode(value: String!): Unit

Deprecated: Deprecated in Java.

Sets the scene mode. Changing scene mode may override other parameters (such as flash mode, focus mode, white balance). For example, suppose originally flash mode is on and supported flash modes are on/off. In night scene mode, both flash mode and supported flash mode may be changed to off. After setting scene mode, applications should call getParameters to know if some parameters are changed.

Parameters
value String!: scene mode.

See Also

setVideoStabilization

Added in API level 15
Deprecated in API level 21
open fun setVideoStabilization(toggle: Boolean): Unit

Deprecated: Deprecated in Java.

Enables and disables video stabilization. Use isVideoStabilizationSupported to determine if calling this method is valid.

Video stabilization reduces the shaking due to the motion of the camera in both the preview stream and in recorded videos, including data received from the preview callback. It does not reduce motion blur in images captured with android.hardware.Camera#takePicture.

Video stabilization can be enabled and disabled while preview or recording is active, but toggling it may cause a jump in the video stream that may be undesirable in a recorded video.

Parameters
toggle Boolean: Set to true to enable video stabilization, and false to disable video stabilization.

setWhiteBalance

Added in API level 5
Deprecated in API level 21
open fun setWhiteBalance(value: String!): Unit

Deprecated: Deprecated in Java.

Sets the white balance. Changing the setting will release the auto-white balance lock. It is recommended not to change white balance and AWB lock at the same time.

Parameters
value String!: new white balance.

setZoom

Added in API level 8
Deprecated in API level 21
open fun setZoom(value: Int): Unit

Deprecated: Deprecated in Java.

Sets current zoom value. If the camera is zoomed (value > 0), the actual picture size may be smaller than picture size setting. Applications can check the actual picture size after picture is returned from PictureCallback. The preview size remains the same in zoom. Applications should check isZoomSupported before using this method.

Parameters
value Int: zoom value. The valid range is 0 to getMaxZoom.

unflatten

Added in API level 1
open fun unflatten(flattened: String!): Unit

Deprecated: Deprecated in Java.

Takes a flattened string of parameters and adds each one to this Parameters object.

The flatten() method does the reverse.

Parameters
flattened String!: a String of parameters (key-value paired) that are semi-colon delimited