程序包 ohos.media.camera

类 CameraKit

java.lang.Object

ohos.media.camera.CameraKit

public final class CameraKit
extends Object

Provides the entry for using camera functions.

In general, the camera workflow is as follows:

• [Mandatory] Call CameraKit#getInstance(Context) to obtain a CameraKit instance.
• [Optional] Register a callback to monitor camera usage states using CameraKit#registerCameraDeviceCallback(CameraDeviceCallback, EventHandler) and unregister the callback by CameraKit#unregisterCameraDeviceCallback(CameraDeviceCallback).
• [Mandatory] Get all the supported logical cameras by calling CameraKit#getCameraIds().
• [Optional] Get more information about a physical camera by calling CameraKit#getCameraInfo(String). The information includes the camera facing direction, physical cameras that belong to the logical camera, and connection types of physical cameras.
• [Optional] Get static abilities of a logical or physical camera by calling CameraKit#getCameraAbility(String) and query the supported abilities and their configuration ranges through a specific ability querying method. For example, you can query the support for the zoom function by using CameraAbility#getSupportedZoom().
• [Mandatory] Create a logical or physical camera by calling CameraKit#createCamera(String, CameraStateCallback, EventHandler).
• [Mandatory] Start running the camera by calling methods provided in Camera.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#CAMERA

方法概要

限定符和类型	方法	说明
void	createCamera(String cameraId, CameraStateCallback callback, EventHandler handler)	Creates a camera object.
CameraAbility	getCameraAbility(String cameraId)	Gets the static ability of a specified logical or physical camera.
String[]	getCameraIds()	Gets current logical camera IDs.
CameraInfo	getCameraInfo(String cameraId)	Gets a CameraInfo object about a specified logical camera.
static CameraKit	getInstance(Context context)	Gets a CameraKit instance.
void	registerCameraDeviceCallback(CameraDeviceCallback callback, EventHandler handler)	Registers a callback for camera usage states.
void	setFlashlight(String cameraId, boolean isEnable)	Enables or disables the flashlight.
void	unregisterCameraDeviceCallback(CameraDeviceCallback callback)	Unregisters a callback for camera usage states.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

getInstance

public static CameraKit getInstance(Context context)

Gets a CameraKit instance.

This method provides the only CameraKit object accessed by all applications.

参数:

context - Indicates the application context.

返回:

Returns a CameraKit instance if the input parameter is valid; returns null otherwise.

从以下版本开始:

1

getCameraIds

public String[] getCameraIds()

Gets current logical camera IDs.

返回:

Returns the IDs if obtained; returns a list with the length of 0 if no camera is available.

抛出:

IllegalStateException - Throws this exception if camera service is not initialized.

从以下版本开始:

3

getCameraInfo

public CameraInfo getCameraInfo(String cameraId)

Gets a CameraInfo object about a specified logical camera.

The logical camera ID can be obtained by CameraKit#getCameraIds().

参数:

cameraId - Indicates the ID of the logical camera.

返回:

Returns the camera information if obtained; returns null if the ID is invalid or the query fails.

抛出:

IllegalStateException - Throws this exception if camera service is not initialized.

从以下版本开始:

1

getCameraAbility

public CameraAbility getCameraAbility(String cameraId)

Gets the static ability of a specified logical or physical camera.

Use the methods provided in CameraAbility to use the ability.

参数:

cameraId - Indicates the ID of a logical or physical camera.

A logical camera ID can be obtained by CameraKit#getCameraIds().

A physical camera ID can be obtained by CameraInfo#getPhysicalIdList().

返回:

Returns the static ability if obtained; returns null if the ID is invalid or the query fails.

抛出:

IllegalStateException - Throws this exception if camera service is not initialized.

从以下版本开始:

1

createCamera

public void createCamera(String cameraId,
                         CameraStateCallback callback,
                         EventHandler handler)

Creates a camera object.

All parameters must not be null.

After the camera is created, CameraStateCallback#onCreated(Camera) is called.

参数:

cameraId - Indicates the ID of a logical or physical camera.

A logical camera ID can be obtained by CameraKit#getCameraIds().

A physical camera ID can be obtained by CameraInfo#getPhysicalIdList().

callback - Indicates the callback for camera creation and running states. If the callback is null, an exception will be thrown.

handler - Indicates a handler of the callback for internal camera operations. If the handler is null, an exception will be thrown.

The handler should be valid throughout the camera lifecycle. If the handler is released earlier than excepted, an error may occur, or an exception can be thrown.

抛出:

NullPointerException - Throws this exception if an input parameter is null.

IllegalStateException - Throws this exception if camera service is not initialized.

从以下版本开始:

1

setFlashlight

public void setFlashlight(String cameraId,
                          boolean isEnable)

Enables or disables the flashlight.

When the flashlight is enabled or disabled successfully, CameraDeviceCallback#onFlashlightStatus(String, int) is called.

When the flashlight is unavailable, for example, when the camera is being occupied by another application, CameraDeviceCallback#onFlashlightStatus(String, int) is called.

参数:

cameraId - Indicates the camera ID.

isEnable - Indicates whether the flashlight is enabled. true indicates that the flashlight is enabled; false indicates that the flashlight is disabled.

initial

registerCameraDeviceCallback

public void registerCameraDeviceCallback(CameraDeviceCallback callback,
                                         EventHandler handler)

Registers a callback for camera usage states.

This method can be used to monitor camera states.

This method can be called multiple times. If the same callback is passed repeatedly, only the callback passed for the first time is valid.

参数:

callback - Indicates a callback for camera usage states.

handler - Indicates a handler of the callback. The handler must not be null, and the callback will be invoked in the handler.

The handler must be valid throughout the camera lifecycle. If the handler is released before expected, an exception may be thrown.

抛出:

NullPointerException - Throws this exception if an input parameter is null.

IllegalStateException - Throws this exception if camera service is not initialized.

从以下版本开始:

1

unregisterCameraDeviceCallback

public void unregisterCameraDeviceCallback(CameraDeviceCallback callback)

Unregisters a callback for camera usage states.

If the same callback is passed repeatedly, only the callback passed for the first time is valid. After a callback is unregistered, camera usage states will not be received. An invalid callback or one passed repeatedly will be ignored.

参数:

callback - Indicates a callback for camera usage states.

抛出:

NullPointerException - Throws this exception if an input parameter is null.

IllegalStateException - Throws this exception if camera service is not initialized.

从以下版本开始:

1