程序包 ohos.media.camera.device

接口 Camera

public interface Camera

Interface for using the camera.

A camera object can be obtained only in the following way:

Create a camera by calling CameraKit.createCamera(String, CameraStateCallback, EventHandler), and get camera running states by calling CameraStateCallback.

The recommended operation steps are as follows:

• Creating a camera: Call CameraKit.createCamera(String, CameraStateCallback, EventHandler). If the camera is successfully created, CameraStateCallback#onCreated(Camera) is called. Otherwise, CameraStateCallback#onCreateFailed(String, int) is called.
• Configuring the camera: Get a CameraConfig.Builder instance by calling Camera#getCameraConfigBuilder(), and then configure the camera by calling Camera#configure(CameraConfig). If the camera is successfully configured, CameraStateCallback#onConfigured(Camera) is called. Otherwise, CameraStateCallback#onConfigureFailed(Camera, int) is called.
• Starting looping-frame capture: After the configuration is complete, the camera is operable. Create a FrameConfig instance by FrameConfig.Builder, and then call Camera#triggerLoopingCapture(FrameConfig) to start looping-frame capture. Looping-frame capture is commonly used for preview or recording. Call Camera#triggerLoopingCapture(FrameConfig) to update configuration of looping-frame capture.
• Starting single-frame capture: Create a FrameConfig instance by FrameConfig.Builder, and then call Camera#triggerSingleCapture(FrameConfig) to start single-frame capture. Single-frame capture is commonly used for taking a picture.
• Stopping looping-frame capture: Call Camera#stopLoopingCapture().
• Releasing the camera: Call Camera#release().

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#CAMERA

嵌套类概要

嵌套类

限定符和类型	接口	说明
static interface	Camera.FrameConfigType	Provides frame configuration types.

字段概要

字段

限定符和类型	字段	说明
static int	CAPTURE_TRIGGER_ERROR_ID	Indicates an invalid capture trigger ID.

方法概要

限定符和类型	方法	说明
void	configure(CameraConfig config)	Configures the camera.
void	flushCaptures()	Immediately stops frame captures, including looping-frame, single-frame, and multi-frame captures.
CameraConfig.Builder	getCameraConfigBuilder()	Gets a CameraConfig.Builder instance.
String	getCameraId()	Gets the camera ID.
FrameConfig.Builder	getFrameConfigBuilder(int type)	Gets a specified type of FrameConfig.Builder instance.
void	release()	Releases the camera.
void	stopLoopingCapture()	Stops looping-frame capture.
int	triggerLoopingCapture(FrameConfig frameConfig)	Starts looping-frame capture.
int	triggerLoopingGroupCapture(List<FrameConfig> frameConfigs)	Starts looping-frame capture based on a group of configurations.
int	triggerMultiCapture(List<FrameConfig> frameConfigs)	Starts multi-frame capture.
int	triggerSingleCapture(FrameConfig frameConfig)	Starts single-frame capture.

字段详细资料

CAPTURE_TRIGGER_ERROR_ID

static final int CAPTURE_TRIGGER_ERROR_ID

Indicates an invalid capture trigger ID.

从以下版本开始:

1

另请参阅:

常量字段值

方法详细资料

getCameraId

String getCameraId()

Gets the camera ID.

返回:

Returns the camera ID.

从以下版本开始:

1

getCameraConfigBuilder

CameraConfig.Builder getCameraConfigBuilder()

Gets a CameraConfig.Builder instance.

返回:

Returns the CameraConfig.Builder instance.

从以下版本开始:

1

getFrameConfigBuilder

FrameConfig.Builder getFrameConfigBuilder(int type)

Gets a specified type of FrameConfig.Builder instance.

参数:

type - Indicates the frame configuration type.

返回:

Returns the specified type of FrameConfig.Builder instance.

抛出:

IllegalArgumentException - Throws this exception if the frame configuration type is not supported.

从以下版本开始:

1

另请参阅:

Camera.FrameConfigType

configure

void configure(CameraConfig config)

Configures the camera.

Before using this method, call Camera#getCameraConfigBuilder() to obtain a CameraConfig.Builder instance. This method is mainly used to set a surface for preview, taking pictures, or recording. The preview surface must be configured, and the other two surfaces are optional.

If the camera is successfully configured, CameraStateCallback#onConfigured(Camera) will be called. In this case, the camera becomes operable.

参数:

config - Indicates camera configuration parameters.

抛出:

NullPointerException - Throws this exception if camera configuration is null.

IllegalArgumentException - Throws this exception if a parameter value is invalid. For example, the camera configuration is null, or the surface is null.

IllegalStateException - Throws this exception if the camera is released or if an error occurs.

从以下版本开始:

1

release

void release()

Releases the camera.

AAfter the camera is released, it will become unavilable for operations. Any operation on it will cause an unexpected result or exception.

从以下版本开始:

1

triggerLoopingCapture

int triggerLoopingCapture(FrameConfig frameConfig)

Starts looping-frame capture.

Looping-frame capture is commonly used for preview or recording. Ensure the following conditions are met when calling this method:

• The camera has been configured, and CameraStateCallback#onConfigured(Camera) has been called.
• A surface for looping-frame capture has been added by calling CameraConfig.Builder#addSurface(Surface).

参数:

frameConfig - Indicates the looping-frame capture configuration.

返回:

Returns the trigger ID for this capture.

抛出:

IllegalArgumentException - Throws this exception if configuration of the camera or surface is null.

IllegalStateException - Throws this exception if the camera is not in the configured state.

从以下版本开始:

3

triggerLoopingGroupCapture

int triggerLoopingGroupCapture(List<FrameConfig> frameConfigs)

Starts looping-frame capture based on a group of configurations.

You can use this method for differentiated frame rate control when there are multiple concurrent streams. Ensure the following conditions are met when calling this method:

• The camera has been configured, and CameraStateCallback#onConfigured(Camera) has been called.
• A surface for looping-frame capture has been added by calling CameraConfig.Builder#addSurface(Surface).

参数:

frameConfigs - Indicates a group of frame configurations.

返回:

Returns the trigger ID for this capture.

抛出:

IllegalArgumentException - Throws this exception if the camera or the surface is not configured.

IllegalStateException - Throws this exception if the camera is not in the configured state.

从以下版本开始:

3

stopLoopingCapture

void stopLoopingCapture()

Stops looping-frame capture.

抛出:

IllegalStateException - Throws this exception if the camera is not in the configured state.

从以下版本开始:

1

triggerSingleCapture

int triggerSingleCapture(FrameConfig frameConfig)

Starts single-frame capture.

This method is commonly used for taking a picture.

Before taking a picture, the camera must start looping-frame capture. The configuration of this capture will be inserted into the looping capture queue. Surfaces in the looping-frame capture configuration should also be included in this single-frame capture to obtain continuous preview or video images.

参数:

frameConfig - Indicates single-frame capture configuration.

返回:

Returns the trigger ID for this capture.

抛出:

IllegalArgumentException - Throws this exception if the camera or the surface is not configured.

IllegalStateException - Throws this exception if the camera is not in the configured state.

从以下版本开始:

3

triggerMultiCapture

int triggerMultiCapture(List<FrameConfig> frameConfigs)

Starts multi-frame capture.

Before taking a picture, looping-frame capture must be started. The configuration of those shoots will be inserted into the looping capture queue. Surfaces in the looping-frame capture configuration should also be included in this multi-frame capture to obtain continuous preview or video images.

参数:

frameConfigs - Indicates multi-frame capture configuration.

返回:

Returns the trigger ID for this capture.

抛出:

IllegalArgumentException - Throws this exception if the camera or the surface is not configured.

IllegalStateException - Throws this exception if the camera is not in the configured state.

从以下版本开始:

3

flushCaptures

void flushCaptures()

Immediately stops frame captures, including looping-frame, single-frame, and multi-frame captures.

Some in-flight captures may call FrameStateCallback#onFrameError(Camera, FrameConfig, int, FrameResult).

抛出:

IllegalStateException - Throws this exception if the camera is not in the configured state.

从以下版本开始:

1