鸿蒙开发接口媒体：【@ohos.multimedia.camera (相机管理)】

jf_46214456 2024-05-31 1436

电子说

1.3w人已加入

描述

相机管理

说明：
开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import camera from '@ohos.multimedia.camera';

camera.getCameraManager

getCameraManager(context: Context, callback: AsyncCallback): void

获取相机管理器实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
contextContext是应用上下文。
callbackAsyncCallback<[CameraManager]>是回调函数，用于获取相机管理器实例。

示例：

camera.getCameraManager(context, (err, cameraManager) = > {
    if (err) {
        console.error('Failed to get the CameraManager instance ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraManager instance');
});

camera.getCameraManager

getCameraManager(context: Context): Promise

获取相机管理器实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
contextContext是应用上下文。

返回值：

类型说明
Promise<[CameraManager]>使用Promise的方式获取一个相机管理器实例。

示例：

camera.getCameraManager(context).then((cameraManager) = > {
    console.log('Promise returned with the CameraManager instance.');
})

CameraStatus

枚举，相机状态。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
CAMERA_STATUS_APPEAR0相机存在。
CAMERA_STATUS_DISAPPEAR1相机不存在。
CAMERA_STATUS_AVAILABLE2相机就绪。
CAMERA_STATUS_UNAVAILABLE3相机未就绪。

CameraPosition

枚举，相机方向。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
CAMERA_POSITION_UNSPECIFIED0未指定方向相机。
CAMERA_POSITION_BACK1后置相机。
CAMERA_POSITION_FRONT2前置相机。

CameraType

枚举，相机类型。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
CAMERA_TYPE_UNSPECIFIED0未指定相机类型。
CAMERA_TYPE_WIDE_ANGLE1广角相机。
CAMERA_TYPE_ULTRA_WIDE2超级广角相机。
CAMERA_TYPE_TELEPHOTO3长焦相机。
CAMERA_TYPE_TRUE_DEPTH4深度相机。

ConnectionType

枚举，相机连接类型。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
CAMERA_CONNECTION_BUILT_IN0内置相机。
CAMERA_CONNECTION_USB_PLUGIN1外置USB相机。
CAMERA_CONNECTION_REMOTE2分布式相机。

Size

用于表示相机预览、照片、视频支持的尺寸大小。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型可读可写说明
heightstring是是图像的高度。
widthnumber是是图像的宽度。

CameraManager

相机管理器类，使用前需要通过getCameraManager获取相机管理实例。

getCameras

getCameras(callback: AsyncCallback>): void

异步获取设备支持的相机列表，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback>是使用callback方式获取支持的相机列表。

示例：

cameraManager.getCameras((err, cameras) = > {
    if (err) {
        console.error('Failed to get the cameras. ${err.message}');
        return;
    }
    console.log('Callback returned with an array of supported cameras: ' + cameras.length);
})

getCameras

getCameras(): Promise>

异步获取设备支持的相机列表，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise>使用promise获取支持相机列表。

示例：

cameraManager.getCameras().then((cameraArray) = > {
    console.log('Promise returned with an array of supported cameras: ' + cameraArray.length);
})

createCameraInput

createCameraInput(cameraId: string, callback: AsyncCallback): void

使用相机ID异步创建CameraInput实例，通过注册回调函数获取结果。

需要权限： ohos.permission.CAMERA

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
cameraIdstring是指定相机ID。
callbackAsyncCallback<[CameraInput]>是回调函数，用于获取CameraInput实例。

示例：

cameraManager.createCameraInput(cameraId, (err, cameraInput) = > {
    if (err) {
        console.error('Failed to create the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraInput instance.');
})

createCameraInput

createCameraInput(cameraId: string): Promise

使用相机ID异步创建CameraInput实例，通过Promise获取结果。

需要权限： ohos.permission.CAMERA

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
cameraIdstring是指定相机ID。

返回值：

类型说明
Promise<[CameraInput]>使用Promise的方式获取CameraInput的实例。

示例：

cameraManager.createCameraInput(cameraId).then((cameraInput) = > {
    console.log('Promise returned with the CameraInput instance');
})

createCameraInput

createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCallback): void

使用相机位置和相机类型异步创建CameraInput实例，通过注册回调函数获取结果。

需要权限： ohos.permission.CAMERA

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
position[CameraPosition]是相机位置。
type[CameraType]是相机类型。
callbackAsyncCallback<[CameraInput]>是回调函数，用于获取CameraInput实例。

示例：

cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED, (err, cameraInput) = > {
    if (err) {
        console.error('Failed to create the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraInput instance');
})

createCameraInput

createCameraInput(position: CameraPosition, type: CameraType): Promise

使用相机位置和相机类型异步创建CameraInput实例，通过Promise获取结果。

需要权限： ohos.permission.CAMERA

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
position[CameraPosition]是相机位置。
type[CameraType]是相机类型。

返回值：

类型说明
Promise<[CameraInput]>使用Promise的方式获取CameraInput的实例。

示例：

cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED).then((cameraInput) = > {
    console.log('Promise returned with the CameraInput instance.');
})

on('cameraStatus')

on(type: 'cameraStatus', callback: AsyncCallback): void

监听相机的状态变化，通过注册回调函数获取相机的状态变化。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'cameraStatus'，即相机状态变化事件。
callbackAsyncCallback<[CameraStatusInfo]>是回调函数，用于获取相机状态变化信息。

示例：

cameraManager.on('cameraStatus', (err, cameraStatusInfo) = > {
    if (err) {
        console.error('Failed to get cameraStatus callback. ${err.message}');
        return;
    }
    console.log('camera : ' + cameraStatusInfo.camera.cameraId);
    console.log('status: ' + cameraStatusInfo.status);
})

Camera

调用[camera.getCameraManager]后，将返回Camera实例，包括相机ID、位置、类型、连接类型等相机相关的元数据。

系统能力： SystemCapability.Multimedia.Camera.Core。

名称类型只读说明
cameraIdstring是相机ID。
cameraPosition[CameraPosition]是相机位置。
cameraType[CameraType]是相机类型。
connectionType[ConnectionType]是相机连接类型。

示例：

async function getCameraInfo("cameraId") {
    var cameraManager = await camera.getCameraManager();
    var cameras = await cameraManager.getCameras();
    var cameraObj = cameras[0];
    var cameraId = cameraObj.cameraId;
    var cameraPosition = cameraObj.cameraPosition;
    var cameraType = cameraObj.cameraType;
    var connectionType = cameraObj.connectionType;
}

CameraStatusInfo

相机管理器回调返回的接口实例，表示相机状态信息。

系统能力： SystemCapability.Multimedia.Camera.Core。

名称类型说明
camera[Camera]相机信息。
status[CameraStatus]相机状态。

CameraInput

相机输入类。在使用该类的方法前，需要先构建一个CameraInput实例。

getCameraId

getCameraId(callback: AsyncCallback): void

异步获取该CameraInput实例的相机ID，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取相机ID。

示例：

cameraInput.getCameraId((err, cameraId) = > {
    if (err) {
        console.error('Failed to get the camera ID. ${err.message}');
        return;
    }
    console.log('Callback returned with the camera ID: ' + cameraId);
})

getCameraId

getCameraId(): Promise

异步获取该CameraInput实例的相机ID，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取相机ID。

示例：

cameraInput.getCameraId().then((cameraId) = > {
    console.log('Promise returned with the camera ID:' + cameraId);
})

hasFlash

hasFlash(callback: AsyncCallback): void

判断设备是否支持闪光灯，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，返回true表示设备支持闪光灯。

示例：

cameraInput.hasFlash((err, status) = > {
    if (err) {
        console.error('Failed to check whether the device has flash light. ${err.message}');
        return;
    }
    console.log('Callback returned with flash light support status: ' + status);
})

hasFlash

hasFlash(): Promise

判断设备是否支持闪光灯，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果，返回true表示设备支持闪光灯。

示例：

cameraInput.hasFlash().then((status) = > {
    console.log('Promise returned with the flash light support status:' + status);
})

isFlashModeSupported

isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback): void

判断设备是否支持指定闪光灯模式，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
flashMode[FlashMode]是指定闪光灯模式。
callbackAsyncCallback是回调函数，返回true表示支持该闪光灯模式。

示例：

cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO, (err, status) = > {
    if (err) {
        console.error('Failed to check whether the flash mode is supported. ${err.message}');
        return;
    }
    console.log('Callback returned with the flash mode support status: ' + status);
})

isFlashModeSupported

isFlashModeSupported(flashMode: FlashMode): Promise

判断设备是否支持指定闪光灯模式，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
flashMode[FlashMode]是指定闪光灯模式。

返回值：

类型说明
Promise使用Promise的方式获取结果，返回true表示设备支持该闪光灯模式。

示例：

cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO).then((status) = > {
    console.log('Promise returned with flash mode support status.' + status);
})

setFlashMode

setFlashMode(flashMode: FlashMode, callback: AsyncCallback): void

设置闪光灯模式，通过注册回调函数获取结果。

进行设置之前，需要先检查：

  1. 设备是否支持闪光灯，可使用方法[hasFlash]。
  2. 设备是否支持指定的闪光灯模式，可使用方法[isFlashModeSupported]。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
flashMode[FlashMode]是指定闪光灯模式。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO, (err) = > {
    if (err) {
        console.error('Failed to set the flash mode  ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setFlashMode.');
})

setFlashMode

setFlashMode(flashMode: FlashMode): Promise

设置闪光灯模式，通过Promise获取结果。

进行设置之前，需要先检查：

  1. 设备是否支持闪光灯，可使用方法[hasFlash]。
  2. 设备是否支持指定的闪光灯模式。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
flashMode[FlashMode]是指定闪光灯模式。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO).then(() = > {
    console.log('Promise returned with the successful execution of setFlashMode.');
})

getFlashMode

getFlashMode(callback: AsyncCallback): void

获取当前设备的闪光灯模式，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback<[FlashMode]>是回调函数，用于获取当前设备的闪光灯模式。

示例：

cameraInput.getFlashMode((err, flashMode) = > {
    if (err) {
        console.error('Failed to get the flash mode  ${err.message}');
        return;
    }
    console.log('Callback returned with current flash mode: ' + flashMode);
})

getFlashMode

getFlashMode(): Promise

获取当前设备的闪光灯模式，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise<[FlashMode]>使用Promise的方式获取当前的闪光灯模式。

示例：

cameraInput.getFlashMode().then((flashMode) = > {
    console.log('Promise returned with current flash mode : ' + flashMode);
})

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback): void

判断设备是否支持指定的焦距模式，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
afMode[FocusMode]是指定的焦距模式。
callbackAsyncCallback是回调函数，返回true表示支持该焦距模式。

示例：

cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO, (err, status) = > {
    if (err) {
        console.error('Failed to check whether the focus mode is supported. ${err.message}');
        return;
    }
    console.log('Callback returned with the focus mode support status: ' + status);
})

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode): Promise

判断设备是否支持指定的焦距模式，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
afMode[FocusMode]是指定的焦距模式。

返回值：

类型说明
Promise使用Promise的方式获取结果，返回true表示设备支持该焦距模式。

示例：

cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO).then((status) = > {
    console.log('Promise returned with focus mode support status.' + status);
})

setFocusMode

setFocusMode(afMode: FocusMode, callback: AsyncCallback): void

设置焦距模式，通过注册回调函数获取结果。

进行设置之前，需要先检查设备是否支持指定的焦距模式。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
afMode[FocusMode]是指定的焦距模式。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO, (err) = > {
    if (err) {
        console.error('Failed to set the focus mode  ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setFocusMode.');
})

setFocusMode

setFocusMode(afMode: FocusMode): Promise

设置焦距模式，通过Promise获取结果。

进行设置之前，需要先检查设备是否支持指定的焦距模式，可使用方法[isFocusModeSupported]。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
afMode[FocusMode]是指定的焦距模式。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO).then(() = > {
    console.log('Promise returned with the successful execution of setFocusMode.');
})

getFocusMode

getFocusMode(callback: AsyncCallback): void

获取当前设备的焦距模式，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback<[FocusMode]>是回调函数，用于获取当前设备的焦距模式。

示例：

cameraInput.getFocusMode((err, afMode) = > {
    if (err) {
        console.error('Failed to get the focus mode  ${err.message}');
        return;
    }
    console.log('Callback returned with current focus mode: ' + afMode);
})

getFocusMode

getFocusMode(): Promise

获取当前设备的焦距模式，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取当前的焦距模式。

示例：

cameraInput.getFocusMode().then((afMode) = > {
    console.log('Promise returned with current focus mode : ' + afMode);
})

getZoomRatioRange

getZoomRatioRange(callback: AsyncCallback>): void

获取可变焦距比范围，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback>是回调函数，用于获取结果。

示例：

cameraInput.getZoomRatioRange((err, zoomRatioRange) = > {
    if (err) {
        console.error('Failed to get the zoom ratio range. ${err.message}');
        return;
    }
    console.log('Callback returned with zoom ratio range: ' + zoomRatioRange.length);
})

getZoomRatioRange

getZoomRatioRange(): Promise>

获取可变焦距比范围，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise>使用Promise的方式获取当前的可变焦距比范围。

示例：

cameraInput.getZoomRatioRange().then((zoomRatioRange) = > {
    console.log('Promise returned with zoom ratio range: ' + zoomRatioRange.length);
})

setZoomRatio

setZoomRatio(zoomRatio: number, callback: AsyncCallback): void

设置可变焦距比，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
zoomRationumber是可变焦距比。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

cameraInput.setZoomRatio(1, (err) = > {
    if (err) {
        console.error('Failed to set the zoom ratio value ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setZoomRatio.');
})

setZoomRatio

setZoomRatio(zoomRatio: number): Promise

设置可变焦距比，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
zoomRationumber是可变焦距比。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

cameraInput.setZoomRatio(1).then(() = > {
    console.log('Promise returned with the successful execution of setZoomRatio.');
})

getZoomRatio

getZoomRatio(callback: AsyncCallback): void

获取当前的可变焦距比，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

cameraInput.getZoomRatio((err, zoomRatio) = > {
    if (err) {
        console.error('Failed to get the zoom ratio ${err.message}');
        return;
    }
    console.log('Callback returned with current zoom ratio: ' + zoomRatio);
})

getZoomRatio

getZoomRatio(): Promise

获取当前的可变焦距比，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

cameraInput.getZoomRatio().then((zoomRatio) = > {
    console.log('Promise returned with current zoom ratio : ' + zoomRatio);
})

release

release(callback: AsyncCallback): void

释放相机实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

cameraInput.release((err) = > {
    if (err) {
        console.error('Failed to release the CameraInput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CameraInput instance is released successfully.');
});

release

release(): Promise

释放相机实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

cameraInput.release().then(() = > {
    console.log('Promise returned to indicate that the CameraInput instance is released successfully.');
})

on('focusStateChange')

on(type: 'focusStateChange', callback: AsyncCallback): void

监听焦距的状态变化，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'focusStateChange'，即焦距状态变化事件。
callbackAsyncCallback<[FocusState]>是回调函数，用于获取焦距状态。

示例：

cameraInput.on('focusStateChange', (focusState) = > {
    console.log('Focus state  : ' + focusState);
})

on('error')

on(type: 'error', callback: ErrorCallback): void

监听CameraInput的错误事件，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'error'，即CameraInput错误事件。
callbackErrorCallback<[CameraInputError]>是回调函数，用于获取结果。

示例：

cameraInput.on('error', (cameraInputError) = > {
    console.log('Camera input error code: ' + cameraInputError.code);
})

CameraInputErrorCode

枚举，CameraInput的错误码。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
ERROR_UNKNOWN-1未知错误。

CameraInputError

CameraInput错误对象。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型说明
code[CameraInputErrorCode]CameraInput中的错误码。

FlashMode

枚举，闪光灯模式。

系统能力： SystemCapability.Multimedia.Camera.Core。

名称值说明
FLASH_MODE_CLOSE0闪光灯关闭。
FLASH_MODE_OPEN1闪光灯开启。
FLASH_MODE_AUTO2自动闪光灯。
FLASH_MODE_ALWAYS_OPEN3闪光灯常亮。

FocusMode

枚举，焦距模式。

系统能力： SystemCapability.Multimedia.Camera.Core。

名称值说明
FOCUS_MODE_MANUAL0手动变焦模式。
FOCUS_MODE_CONTINUOUS_AUTO1连续自动变焦模式。
FOCUS_MODE_AUTO2自动变焦模式。
FOCUS_MODE_LOCKED3定焦模式。

FocusState

枚举，焦距状态。

系统能力： SystemCapability.Multimedia.Camera.Core。

名称值说明
FOCUS_STATE_SCAN0扫描状态。
FOCUS_STATE_FOCUSED1相机已对焦。
FOCUS_STATE_UNFOCUSED2相机未对焦。

camera.createCaptureSession

createCaptureSession(context: Context, callback: AsyncCallback): void

获取CaptureSession实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
contextContext是应用上下文。
callbackAsyncCallback<[CaptureSession]>是回调函数，用于获取CaptureSession实例。

示例：

camera.createCaptureSession((context), (err, captureSession) = > {
    if (err) {
        console.error('Failed to create the CaptureSession instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CaptureSession instance.' + captureSession);
});

camera.createCaptureSession

createCaptureSession(context: Context): Promise;

获取CaptureSession实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
contextContext是应用上下文。

返回值：

类型说明
Promise<[CaptureSession]>使用Promise的方式获取CaptureSession实例。

示例：

camera.createCaptureSession(context).then((captureSession) = > {
    console.log('Promise returned with the CaptureSession instance');
})

CaptureSession

拍照会话类。

beginConfig

beginConfig(callback: AsyncCallback): void

开始配置会话，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.beginConfig((err) = > {
    if (err) {
        console.error('Failed to start the configuration. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the begin config success.');
});

beginConfig

beginConfig(): Promise

开始配置会话，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.beginConfig().then(() = > {
    console.log('Promise returned to indicate the begin config success.');
})

commitConfig

commitConfig(callback: AsyncCallback): void

提交会话配置，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.commitConfig((err) = > {
    if (err) {
        console.error('Failed to commit the configuration. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the commit config success.');
});

commitConfig

commitConfig(): Promise

提交会话配置，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.commitConfig().then(() = > {
    console.log('Promise returned to indicate the commit config success.');
})

addInput

addInput(cameraInput: CameraInput, callback: AsyncCallback): void

在当前会话中，添加一个CameraInput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
cameraInput[CameraInput]是需要添加的CameraInput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.addInput(cameraInput, (err) = > {
    if (err) {
        console.error('Failed to add the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CameraInput instance is added.');
});

addInput

addInput(cameraInput: CameraInput): Promise

在当前会话中，添加一个CameraInput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
cameraInput[CameraInput]是需要添加的CameraInput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.addInput(cameraInput).then(() = > {
    console.log('Promise used to indicate that the CameraInput instance is added.');
})

addOutput

addOutput(previewOutput: PreviewOutput, callback: AsyncCallback): void

在当前会话中，添加一个PreviewOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
previewOutput[PreviewOutput]是需要添加的PreviewOutput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.addOutput(previewOutput, (err) = > {
    if (err) {
        console.error('Failed to add the PreviewOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is added.');
});

addOutput

addOutput(previewOutput: PreviewOutput): Promise

在当前会话中，添加一个PreviewOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
previewOutput[PreviewOutput]是需要添加的PreviewOutput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.addOutput(previewOutput).then(() = > {
    console.log('Promise used to indicate that the PreviewOutput instance is added.');
})

addOutput

addOutput(photoOutput: PhotoOutput, callback: AsyncCallback): void

在当前会话中，添加一个PhotoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
photoOutput[PhotoOutput]是需要添加的PhotoOutput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.addOutput(photoOutput, (err) = > {
    if (err) {
        console.error('Failed to add the PhotoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is added.');
});

addOutput

addOutput(photoOutput: PhotoOutput): Promise

在当前会话中，添加一个PhotoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
photoOutput[PhotoOutput]是需要添加的PhotoOutput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.addOutput(photoOutput).then(() = > {
    console.log('Promise used to indicate that the PhotoOutput instance is added.');
})

addOutput

addOutput(videoOutput: VideoOutput, callback: AsyncCallback): void

在当前会话中，添加一个VideoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
videoOutput[VideoOutput]是需要添加的VideoOutput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.addOutput(videoOutput, (err) = > {
    if (err) {
        console.error('Failed to add the VideoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is added.');
});

addOutput

addOutput(videoOutput: VideoOutput): Promise

在当前会话中，添加一个VideoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
videoOutput[VideoOutput]是需要添加的VideoOutput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.addOutput(videoOutput).then(() = > {
    console.log('Promise used to indicate that the VideoOutput instance is added.');
})

removeInput

removeInput(cameraInput: CameraInput, callback: AsyncCallback): void

在当前会话中，移除一个CameraInput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
cameraInput[CameraInput]是需要移除的CameraInput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.removeInput(cameraInput, (err) = > {
    if (err) {
        console.error('Failed to remove the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the cameraInput instance is removed.');
});

removeInput

removeInput(cameraInput: CameraInput): Promise

在当前会话中，移除一个CameraInput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
cameraInput[CameraInput]是需要移除的CameraInput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.removeInput(cameraInput).then(() = > {
    console.log('Promise returned to indicate that the cameraInput instance is removed.');
})

removeOutput

removeOutput(previewOutput: PreviewOutput, callback: AsyncCallback): void

在当前会话中，移除一个PreviewOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
previewOutput[PreviewOutput]是需要移除的PreviewOutput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.removeOutput(previewOutput, (err) = > {
    if (err) {
        console.error('Failed to remove the PreviewOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is removed.');
});

removeOutput

removeOutput(previewOutput: PreviewOutput): Promise

在当前会话中，移除一个PreviewOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
previewOutput[PreviewOutput]是需要移除的PreviewOutput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.removeOutput(previewOutput).then(() = > {
    console.log('Promise returned to indicate that the PreviewOutput instance is removed.');
})

removeOutput

removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback): void

在当前会话中，移除一个PhotoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
photoOutput[PhotoOutput]是需要移除的PhotoOutput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.removeOutput(photoOutput, (err) = > {
    if (err) {
        console.error('Failed to remove the PhotoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is removed.');
});

removeOutput

removeOutput(photoOutput: PhotoOutput): Promise

在当前会话中，移除一个PhotoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
photoOutput[PhotoOutput]是需要移除的PhotoOutput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.removeOutput(photoOutput).then(() = > {
    console.log('Promise returned to indicate that the PhotoOutput instance is removed.');
})

removeOutput

removeOutput(videoOutput: VideoOutput, callback: AsyncCallback): void

在当前会话中，移除一个VideoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
videoOutput[VideoOutput]是需要移除的VideoOutput实例。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.removeOutput(videoOutput, (err) = > {
    if (err) {
        console.error('Failed to remove the VideoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is removed.');
});

removeOutput

removeOutput(videoOutput: VideoOutput): Promise

在当前会话中，移除一个VideoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
videoOutput[VideoOutput]是需要移除的VideoOutput实例。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.removeOutput(videoOutput).then(() = > {
    console.log('Promise returned to indicate that the VideoOutput instance is removed.');
})

start

start(callback: AsyncCallback): void

启动拍照会话，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.start((err) = > {
    if (err) {
        console.error('Failed to start the session ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the session start success.');
});

start

start(): Promise

启动拍照会话，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.start().then(() = > {
    console.log('Promise returned to indicate the session start success.');
})

stop

stop(callback: AsyncCallback): void

停止拍照会话，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.stop((err) = > {
    if (err) {
        console.error('Failed to stop the session ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the session stop success.');
});

stop

stop(): Promise

停止拍照会话，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.stop().then(() = > {
    console.log('Promise returned to indicate the session stop success.');
})

release

release(callback: AsyncCallback): void

释放CaptureSession实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

captureSession.release((err) = > {
    if (err) {
        console.error('Failed to release the CaptureSession instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CaptureSession instance is released successfully.');
});

release

release(): Promise

释放CaptureSession实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

captureSession.release().then(() = > {
    console.log('Promise returned to indicate that the CaptureSession instance is released successfully.');
})

on('error')

on(type: 'error', callback: ErrorCallback): void

监听拍照会话的错误事件，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'error'，即拍照会话错误事件。
callbackErrorCallback<[CaptureSessionError]>是回调函数，用于获取错误信息。

示例：

captureSession.on('error', (captureSessionError) = > {
    console.log('Capture session error code: ' + captureSessionError.code);
})

CaptureSessionErrorCode

枚举，拍照会话的错误码。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
ERROR_UNKNOWN-1未知错误。

CaptureSessionError

拍照会话错误对象。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型说明
code[CaptureSessionError]CaptureSession中的错误码。

camera.createPreviewOutput

createPreviewOutput(surfaceId: string, callback: AsyncCallback): void

获取PreviewOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
surfaceIdstring是从XComponent组件获取的Surface ID。
callbackAsyncCallback<[PreviewOutput]>是回调函数，用于获取PreviewOutput实例。

示例：

camera.createPreviewOutput(("surfaceId"), (err, previewOutput) = > {
    if (err) {
        console.error('Failed to create the PreviewOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with previewOutput instance');
});

camera.createPreviewOutput

createPreviewOutput(surfaceId: string): Promise

获取PreviewOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
surfaceIdstring是从XComponent组件获取的Surface ID。

返回值：

类型说明
Promise<[PreviewOutput]>使用Promise的方式获取结果。

示例：

camera.createPreviewOutput("surfaceId").then((previewOutput) = > {
    console.log('Promise returned with the PreviewOutput instance');
})

PreviewOutput

预览输出类。

release

release(callback: AsyncCallback): void

释放PreviewOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

previewOutput.release((err) = > {
    if (err) {
        console.error('Failed to release the PreviewOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.');
});

release

release(): Promise

释放PreviewOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

previewOutput.release().then(() = > {
    console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
})

on('frameStart')

on(type: 'frameStart', callback: AsyncCallback): void

监听预览帧启动，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'frameStart'，即帧启动事件。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

previewOutput.on('frameStart', () = > {
    console.log('Preview frame started');
})

on('frameEnd')

on(type: 'frameEnd', callback: AsyncCallback): void

监听预览帧结束，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'frameEnd'，即帧结束事件。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

previewOutput.on('frameEnd', () = > {
    console.log('Preview frame ended');
})

on('error')

on(type: 'error', callback: ErrorCallback): void

监听预览输出的错误事件，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'error'，即预览输出错误事件。
callbackErrorCallback<[PreviewOutputErrorCode]>是回调函数，用于获取错误信息。

示例：

previewOutput.on('error', (previewOutputError) = > {
    console.log('Preview output error code: ' + previewOutputError.code);
})

PreviewOutputErrorCode

枚举，预览输出的错误码。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
ERROR_UNKNOWN-1未知错误。

PreviewOutputError

预览输出错误对象。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型说明
code[PreviewOutputErrorCode]PreviewOutput中的错误码。

camera.createPhotoOutput

createPhotoOutput(surfaceId: string, callback: AsyncCallback): void

获取PhotoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
surfaceIdstring是从[ImageReceiver]获取的Surface ID。
callbackAsyncCallback<[PhotoOutput]>是回调函数，用于获取PhotoOutput实例。

示例：

camera.createPhotoOutput(("surfaceId"), (err, photoOutput) = > {
    if (err) {
        console.error('Failed to create the PhotoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the PhotoOutput instance.');
});

camera.createPhotoOutput

createPhotoOutput(surfaceId: string): Promise

获取PhotoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
surfaceIdstring是从[ImageReceiver]获取的Surface ID。

返回值：

类型说明
Promise<[PhotoOutput]>使用Promise的方式获取PhotoOutput实例。

示例：

camera.createPhotoOutput("surfaceId").then((photoOutput) = > {
    console.log('Promise returned with PhotoOutput instance');
})

ImageRotation

枚举，图片旋转角度。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
ROTATION_00图片旋转0度。
ROTATION_9090图片旋转90度。
ROTATION_180180图片旋转180度。
ROTATION_270270图片旋转270度。

QualityLevel

枚举，图片质量。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
QUALITY_LEVEL_HIGH0图片质量高。
QUALITY_LEVEL_MEDIUM1图片质量中等。
QUALITY_LEVEL_LOW2图片质量差。

PhotoCaptureSetting

拍摄照片的设置。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型必填说明
quality[QualityLevel]否图片质量。
rotation[ImageRotation]否图片旋转角度。

PhotoOutput

照片输出类。

capture

capture(callback: AsyncCallback): void

拍照，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

photoOutput.capture((err) = > {
    if (err) {
        console.error('Failed to capture the photo ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the photo capture request success.');
});

capture

capture(setting: PhotoCaptureSetting, callback: AsyncCallback): void

根据拍照设置拍照，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
setting[PhotoCaptureSetting]是拍照设置。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

photoOutput.capture(settings, (err) = > {
    if (err) {
        console.error('Failed to capture the photo ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the photo capture request success.');
});

capture

capture(setting?: PhotoCaptureSetting): Promise

根据拍照设置拍照，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
setting[PhotoCaptureSetting]否拍照设置。

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

photoOutput.capture().then(() = > {
    console.log('Promise returned to indicate that photo capture request success.');
})

release

release(callback: AsyncCallback): void

释放PhotoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

photoOutput.release((err) = > {
    if (err) {
        console.error('Failed to release the PhotoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is released successfully.');
});

release

release(): Promise

释放PhotoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

photoOutput.release().then(() = > {
    console.log('Promise returned to indicate that the PhotoOutput instance is released successfully.');
})

on('captureStart')

on(type: 'captureStart', callback: AsyncCallback): void

监听拍照启动，通过注册回调函数获取Capture ID。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'captureStart'，即拍照启动事件。
callbackAsyncCallback是使用callback的方式获取Capture ID。

示例：

photoOutput.on('captureStart', (err, captureId) = > {
    console.log('photo capture stated, captureId : ' + captureId);
})

on('frameShutter')

on(type: 'frameShutter', callback: AsyncCallback): void

监听快门，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'frameShutter'，即帧刷新事件。
callbackAsyncCallback<[FrameShutterInfo]>是回调函数，用于获取相关信息。

示例：

photoOutput.on('frameShutter', (frameShutterInfo) = > {
    console.log('photo capture end, captureId : ' + frameShutterInfo.captureId);
    console.log('Timestamp for frame : ' + frameShutterInfo.timestamp);
})

on('captureEnd')

on(type: 'captureEnd', callback: AsyncCallback): void

监听拍照停止，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'captureEnd'，即拍照停止事件。
callbackAsyncCallback<[CaptureEndInfo]>是回调函数，用于获取相关信息。

示例：

photoOutput.on('captureEnd', (captureEndInfo) = > {
    console.log('photo capture end, captureId : ' + captureEndInfo.captureId);
    console.log('frameCount : ' + captureEndInfo.frameCount);
})

on('error')

on(type: 'error', callback: ErrorCallback): void

监听拍照的错误事件，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'error'，即拍照错误事件。
callbackErrorCallback<[PhotoOutputError]>是回调函数，用于获取错误信息。

示例：

photoOutput.on('error', (photoOutputError) = > {
    console.log('Photo output error code: ' + photoOutputError.code);
})

FrameShutterInfo

快门事件信息。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型必填说明
captureIdnumber是CaptureId，本次拍摄动作的ID。
timestampnumber是时间戳。

CaptureEndInfo

拍照停止信息。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型必填说明
captureIdnumber是CaptureId，本次拍摄动作的ID。
frameCountnumber是帧计数。

PhotoOutputErrorCode

枚举，拍照输出的错误码。

系统能力： SystemCapability.Multimedia.Camera.Core

名称值说明
ERROR_UNKNOWN-1未知错误。

PhotoOutputError

拍照输出错误对象。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型说明
code[PhotoOutputError]PhotoOutput中的错误码。

camera.createVideoOutput

createVideoOutput(surfaceId: string, callback: AsyncCallback): void

获取VideoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
surfaceIdstring是从VideoRecorder获取的Surface ID。
callbackAsyncCallback<[VideoOutput]>是回调函数，用于获取VideoOutput实例。

示例：

camera.createVideoOutput(("surfaceId"), (err, videoOutput) = > {
    if (err) {
        console.error('Failed to create the VideoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the VideoOutput instance');
});

camera.createVideoOutput

createVideoOutput(surfaceId: string): Promise

获取VideoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
surfaceIdstring是从VideoRecorder获取的Surface ID。

返回值：

类型说明
Promise<[VideoOutput]>使用Promise的方式获取VideoOutput实例。

示例：

camera.createVideoOutput("surfaceId"
).then((videoOutput) = > {
    console.log('Promise returned with the VideoOutput instance');
})

VideoOutput

视频输出类。

start

start(callback: AsyncCallback): void

开始拍摄视频，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

videoOutput.start((err) = > {
    if (err) {
        console.error('Failed to start the video output ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the video output start success.');
});

start

start(): Promise

开始拍摄视频，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

videoOutput.start().then(() = > {
    console.log('Promise returned to indicate that start method execution success.');
})

stop

stop(callback: AsyncCallback): void

停止拍摄视频，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

videoOutput.stop((err) = > {
    if (err) {
        console.error('Failed to stop the video output ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the video output stop success.');
});

stop

stop(): Promise

停止拍摄视频，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

videoOutput.start().then(() = > {
    console.log('Promise returned to indicate that stop method execution success.');
})

release

release(callback: AsyncCallback): void

释放VideoOutput实例，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
callbackAsyncCallback是回调函数，用于获取结果。

示例：

videoOutput.release((err) = > {
    if (err) {
        console.error('Failed to release the VideoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is released successfully.');
});

release

release(): Promise

释放VideoOutput实例，通过Promise获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

返回值：

类型说明
Promise使用Promise的方式获取结果。

示例：

videoOutput.release().then(() = > {
    console.log('Promise returned to indicate that the VideoOutput instance is released successfully.');
})

on('frameStart')

on(type: 'frameStart', callback: AsyncCallback): void

监听视频帧开启，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'frameStart'，即视频帧开启事件。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

videoOutput.on('frameStart', () = > {
    console.log('Video frame started');
})

on('frameEnd')

on(type: 'frameEnd', callback: AsyncCallback): void

监听视频帧结束，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'frameEnd'，即视频帧结束事件。
callbackAsyncCallback是回调函数，用于获取结果。

示例：

videoOutput.on('frameEnd', () = > {
    console.log('Video frame ended');
})

on('error')

on(type: 'error', callback: ErrorCallback): void

监听视频输出的错误事件，通过注册回调函数获取结果。

系统能力： SystemCapability.Multimedia.Camera.Core

参数：

名称类型必填说明
typestring是监听事件，固定为'error'，即视频输出错误事件。
callbackCallback<[VideoOutputError]>是回调函数，用于获取错误信息。

示例：

videoOutput.on('error', (VideoOutputError) = > {
    console.log('Video output error code: ' + VideoOutputError.code);
})

VideoOutputErrorCode

枚举，视频输出的错误码。

系统能力： SystemCapability.Multimedia.Camera.Core

名称HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿值说明
ERROR_UNKNOWN-1未知错误。

接口

VideoOutputError

视频输出错误对象。

系统能力： SystemCapability.Multimedia.Camera.Core

名称类型说明
code[PhotoOutputError]VideoOutput中的错误码。

审核编辑 黄宇

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分