程序包 ohos.media.camera.device

接口 CameraAbility

public interface CameraAbility

Queries static abilities of the camera.

Obtain a CameraAbility object by calling CameraKit.getCameraAbility(String). The CameraAbility object is used to describe static abilities of a logical or physical camera.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#CAMERA

嵌套类概要

嵌套类

限定符和类型	接口	说明
static interface	CameraAbility.CameraRunningMode	Describes camera running mode types.

方法概要

限定符和类型	方法	说明
long	getMinCaptureDuration(int format, Size size)	Obtains the minimum capture interval for streams with a specified image format and resolution.
<T> long	getMinCaptureDuration(Class<T> clazz, Size size)	Obtains the minimum capture interval for streams with a given resolution based on a specified Class object.
<T> List<T>	getParameterRange(ParameterKey.Key<T> parameter)	Gets the value range of a specified parameter.
<T> T	getPropertyValue(PropertyKey.Key<T> property)	Gets the value of a specified property.
int[]	getSupportedAeMode()	Gets auto exposure (AE) modes supported by the camera.
int[]	getSupportedAfMode()	Gets autofocus (AF) modes supported by the camera.
int[]	getSupportedAwbMode()	Gets the auto white balance (AWB) modes supported by this camera.
int[]	getSupportedFaceDetection()	Gets the supported face detection types.
int[]	getSupportedFlashMode()	Gets the supported flash modes.
List<Integer>	getSupportedFormats()	Obtains the list of supported output image formats.
List<Scope<Integer>>	getSupportedHighFrameRate(int format, Size size)	Obtains the range of high frame rates supported by a specified image format and resolution.
<T> List<Scope<Integer>>	getSupportedHighFrameRate(Class<T> clazz, Size size)	Obtains the range of high frame rates supported by a specified Class object and resolution.
List<Size>	getSupportedHighSizes(int format)	Obtains the list of high resolutions at frame rates of less than 30 fps.
List<ParameterKey.Key<?>>	getSupportedParameters()	Gets parameters supported by the camera.
List<PropertyKey.Key<?>>	getSupportedProperties()	Gets camera properties.
List<ResultKey.Key<?>>	getSupportedResults()	Gets the keys of returnable results related to the parameter settings supported by the camera.
int[]	getSupportedRunningModes()	Obtains the running modes supported by the camera.
List<Size>	getSupportedSizes(int format)	Gets supported output image sizes based on a specified format.
<T> List<Size>	getSupportedSizes(Class<T> clazz)	Gets supported output image sizes based on a specified class type.
float[]	getSupportedZoom()	Gets the zoom range supported by the camera.
boolean	isFormatSupported(int format)	Checks whether a specified format is supported for image output.
<T> boolean	isSurfaceClassSupported(Class<T> clazz)	Checks whether the surface class is supported.

方法详细资料

getSupportedFormats

List<Integer> getSupportedFormats()

Obtains the list of supported output image formats.

返回:

Returns the list if any supported format is obtained; returns an empty list otherwise.

从以下版本开始:

3

getSupportedSizes

List<Size> getSupportedSizes(int format)

Gets supported output image sizes based on a specified format.

参数:

format - Indicates an output image format, which is defined by ImageFormat.

Note that not all the defined formats are supported.

返回:

Returns the supported sizes matching the specified output image format; returns an empty list if the specified format is not supported.

从以下版本开始:

3

另请参阅:

ImageFormat

getSupportedSizes

<T> List<Size> getSupportedSizes(Class<T> clazz)

Gets supported output image sizes based on a specified class type.

类型参数:

T - Indicates a class type.

参数:

clazz - Indicates a referenced Class object that is not null.

Only SurfaceOps and Recorder are supported.

返回:

Returns the resolution matching the specified class; returns an empty list if the specified class is not supported.

抛出:

NullPointerException - Throws this exception if clazz is null.

从以下版本开始:

3

getSupportedAfMode

int[] getSupportedAfMode()

Gets autofocus (AF) modes supported by the camera.

Check supported AF modes before setting an AF mode by calling FrameConfig.Builder#setAfMode(int, Rect).

返回:

Returns supported AF modes; returns an empty array if AF is not supported.

从以下版本开始:

1

另请参阅:

Metadata.AfMode, FrameConfig.Builder.setAfMode(int, Rect)

getSupportedAeMode

int[] getSupportedAeMode()

Gets auto exposure (AE) modes supported by the camera.

Check supported AE modes before setting an AE mode by calling FrameConfig.Builder#setAeMode(int, Rect)

返回:

Returns AE modes supported by the camera; returns an empty array if AE is not supported.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setAeMode(int, Rect)

getSupportedAwbMode

int[] getSupportedAwbMode()

Gets the auto white balance (AWB) modes supported by this camera.

You should call this method before setting an AWB mode via FrameConfig.Builder#setAwbMode(int, Rect).

返回:

Returns the supported AWB modes if any; returns an empty array otherwise.

从以下版本开始:

5

另请参阅:

FrameConfig.Builder.setAwbMode(int, Rect)

getSupportedZoom

float[] getSupportedZoom()

Gets the zoom range supported by the camera.

Check the supported zoom range before setting a zoom value by calling FrameConfig.Builder#setZoom(float).

If the camera supports zoom, the return value is array [minZoom, maxZoom], indicating the supported zoom range. The array length is fixed at 2. If the camera does not support zoom, [1.0f, 1.0f] is returned.

The zoom value can be any floating-point number in the range. The larger the zoom value is, the higher times an image is zoomed.

If the camera supports long-focus zoom and the zoom value exceeds a certain threshold, such as 3.0f or 5.0f, the camera automatically switch to the long-focus lens.

返回:

Returns the supported zoom range.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setZoom(float)

getSupportedFlashMode

int[] getSupportedFlashMode()

Gets the supported flash modes.

Check supported flash modes before setting a flash mode by calling FrameConfig.Builder#setFlashMode(int).

The returned values indicate supported flash modes, {FLASH_OPEN, FLASH_CLOSE, FLASH_ALWAYS_OPEN}.

返回:

Returns the supported flash modes; returns an empty array if no flash mode is not supported.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setFlashMode(int), Metadata.FlashMode

getSupportedFaceDetection

int[] getSupportedFaceDetection()

Gets the supported face detection types.

Check the supported face detection types before setting the function by calling FrameConfig.Builder#setFaceDetection(int, boolean).

The return value indicates supported face detection types. The array length is the number of supported types, for example, {FACE_DETECTION, FACE_SMILE_DETECTION}.

返回:

Returns the supported face detection types; returns an empty array if face detection is not supported.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setFaceDetection(int, boolean), Metadata.FaceDetectionType

getSupportedParameters

List<ParameterKey.Key<?>> getSupportedParameters()

Gets parameters supported by the camera.

Check supported parameters are before setting them by calling FrameConfig.Builder#setParameter(ParameterKey.Key, Object).

返回:

Returns the supported parameters; returns an empty list if the camera does not support parameter settings.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setParameter(ParameterKey.Key, Object)

getParameterRange

<T> List<T> getParameterRange(ParameterKey.Key<T> parameter)

Gets the value range of a specified parameter.

Check valid values of the parameters before setting them by calling FrameConfig.Builder#setParameter(ParameterKey.Key, Object).

类型参数:

T - Indicates a value type of the parameters.

参数:

parameter - Indicates the parameters supported by the camera.

返回:

Returns value ranges of the supported parameters.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setParameter(ParameterKey.Key, Object)

getSupportedResults

List<ResultKey.Key<?>> getSupportedResults()

Gets the keys of returnable results related to the parameter settings supported by the camera.

返回:

Returns keys of returnable results related to the parameter settings supported by the camera; returns an empty list if no key is obtained.

从以下版本开始:

1

getSupportedProperties

List<PropertyKey.Key<?>> getSupportedProperties()

Gets camera properties.

The properties are used to describe camera's inherent information, instead of controlling the camera, for example, PropertyKey#SENSOR_ORIENTATION.

返回:

Returns the camera properties; returns an empty list if the camera does not have property information.

从以下版本开始:

1

getPropertyValue

<T> T getPropertyValue(PropertyKey.Key<T> property)

Gets the value of a specified property.

Check supported properties by calling CameraAbility#getSupportedProperties() before this method.

类型参数:

T - Indicates the data type of the property.

参数:

property - Indicates properties supported by the camera.

返回:

Returns the value of the static property.

抛出:

NullPointerException - Throws this exception if property is null.

从以下版本开始:

1

getSupportedRunningModes

int[] getSupportedRunningModes()

Obtains the running modes supported by the camera.

You should obtain the supported running modes before setting any mode via CameraConfig.Builder#setRunningMode(int).

返回:

Returns the supported running modes if any; returns an empty array otherwise.

从以下版本开始:

3

另请参阅:

CameraConfig.Builder.setRunningMode(int)

getSupportedHighFrameRate

List<Scope<Integer>> getSupportedHighFrameRate(int format,
                                               Size size)

Obtains the range of high frame rates supported by a specified image format and resolution.

High frame rates refer to the frame rates greater than 30 fps. The range of them can be discontinuous.

参数:

format - Indicates the output image format, which is defined by ImageFormat.

size - Indicates the image resolution.

返回:

Returns the range in a Scope list if there is any high frame rate supported; returns an empty list if format or size is not supported.

从以下版本开始:

3

getSupportedHighFrameRate

<T> List<Scope<Integer>> getSupportedHighFrameRate(Class<T> clazz,
                                                   Size size)

Obtains the range of high frame rates supported by a specified Class object and resolution.

High frame rates refer to the frame rates greater than 30 fps. The range of them can be discontinuous.

类型参数:

T - Indicates a class type.

参数:

clazz - Indicates a referenced Class object that is not null.

返回:

Returns the range in a Scope list if there is any high frame rate supported; returns an empty list if clazz or size is not supported.

从以下版本开始:

3

getSupportedHighSizes

List<Size> getSupportedHighSizes(int format)

Obtains the list of high resolutions at frame rates of less than 30 fps.

参数:

format - Indicates the output image format, which is defined by ImageFormat.

返回:

Returns the list if there is any high resolution supported at frame rates of less than 30 fps; returns an empty list otherwise.

从以下版本开始:

3

getMinCaptureDuration

long getMinCaptureDuration(int format,
                           Size size)

Obtains the minimum capture interval for streams with a specified image format and resolution.

参数:

format - Indicates the output image format, which is defined by ImageFormat.

size - Indicates the image resolution.

返回:

Returns the minimum capture interval.

从以下版本开始:

3

getMinCaptureDuration

<T> long getMinCaptureDuration(Class<T> clazz,
                               Size size)

Obtains the minimum capture interval for streams with a given resolution based on a specified Class object.

类型参数:

T - Indicates a class type.

参数:

clazz - Indicates a referenced Class object that is not null.

size - Indicates the image resolution.

返回:

Returns the minimum capture interval.

从以下版本开始:

3

isFormatSupported

boolean isFormatSupported(int format)

Checks whether a specified format is supported for image output.

Not all formats defined in ImageFormat are supported.

参数:

format - Indicates an output image format, which is defined in ImageFormat.

返回:

Returns true if the format is supported; returns false otherwise.

从以下版本开始:

5

另请参阅:

ImageFormat

isSurfaceClassSupported

<T> boolean isSurfaceClassSupported(Class<T> clazz)

Checks whether the surface class is supported.

类型参数:

T - Indicates a generic type of the surface class.

参数:

clazz - Indicates the class of the surface.

返回:

Returns true if the surface class is supported; returns false otherwise.

从以下版本开始:

5