From 50e148ad8048a3e71ffab8ec922bfb179691e656 Mon Sep 17 00:00:00 2001 From: cold_yixiu Date: Sat, 25 Mar 2023 10:12:15 +0800 Subject: [PATCH] fix camera apis description Signed-off-by: cold_yixiu --- .../reference/apis/js-apis-camera.md | 240 +++++++++--------- 1 file changed, 121 insertions(+), 119 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-camera.md b/zh-cn/application-dev/reference/apis/js-apis-camera.md index 3c17b40889..38166decdc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-camera.md +++ b/zh-cn/application-dev/reference/apis/js-apis-camera.md @@ -99,10 +99,10 @@ let cameraManager = camera.getCameraManager(context); | 名称 | 类型 | 必填 | 说明 | | ----------------------------- | -------------------------------------------------- | --- |------------------- | -| previewProfiles | Array<[Profile](#profile)\> | 是 | 支持的预览配置信息。 | -| photoProfiles | Array<[Profile](#profile)\> | 是 | 支持的拍照配置信息。 | -| videoProfiles | Array<[VideoProfile](#videoprofile)\> | 是 | 支持的录像配置信息。 | -| supportedMetadataObjectTypes | Array<[MetadataObjectType](#metadataobjecttype)\> | 是 | 支持的metadata流类型信息。| +| previewProfiles | Array\<[Profile](#profile)\> | 是 | 支持的预览配置信息。 | +| photoProfiles | Array\<[Profile](#profile)\> | 是 | 支持的拍照配置信息。 | +| videoProfiles | Array\<[VideoProfile](#videoprofile)\> | 是 | 支持的录像配置信息。 | +| supportedMetadataObjectTypes | Array\<[MetadataObjectType](#metadataobjecttype)\> | 是 | 支持的metadata流类型信息。| ## CameraErrorCode @@ -128,7 +128,7 @@ let cameraManager = camera.getCameraManager(context); ### getSupportedCameras -getSupportedCameras(): Array +getSupportedCameras(): Array\ 获取支持指定的相机设备对象，同步返回结果。 @@ -138,7 +138,7 @@ getSupportedCameras(): Array | 类型 | 说明 | | ----------------------------------------------- | ---------------------------- | -| Array<[CameraDevice](#cameradevice)> | 相机设备列表。 | +| Array\<[CameraDevice](#cameradevice)> | 相机设备列表。 | **示例：** @@ -149,7 +149,7 @@ let cameras = cameraManager.getSupportedCameras(); ### getSupportedOutputCapability -getSupportedOutputCapability(cameraDevice:CameraDevice): CameraOutputCapability +getSupportedOutputCapability(camera:CameraDevice): CameraOutputCapability 查询相机设备在模式下支持的输出能力，同步返回结果。 @@ -459,7 +459,7 @@ try { ### createMetadataOutput -createMetadataOutput(metadataObjectTypes:Array): MetadataOutput +createMetadataOutput(metadataObjectTypes:Array\): MetadataOutput 创建metadata流输出对象，同步返回结果。 @@ -469,7 +469,7 @@ createMetadataOutput(metadataObjectTypes:Array): MetadataOu | 参数名 | 类型 | 必填 | 说明 | | -------------------- | -------------------------------------------------- | --- | ---------------------------- | -| metadataObjectTypes | Array<[MetadataObjectType](#metadataobjecttype)\> | 是 | metadata流类型信息，通过getSupportedOutputCapability接口获取。 | +| metadataObjectTypes | Array\<[MetadataObjectType](#metadataobjecttype)\> | 是 | metadata流类型信息，通过getSupportedOutputCapability接口获取。 | **返回值：** @@ -534,7 +534,7 @@ try { ### on('cameraStatus') -on(type: 'cameraStatus', callback: AsyncCallback): void +on(type: 'cameraStatus', callback: AsyncCallback\): void 相机设备状态回调，通过注册回调函数获取相机的状态变化。 @@ -545,7 +545,7 @@ on(type: 'cameraStatus', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -----------------| ---- | --------- | | type | string | 是 | 监听事件，固定为'cameraStatus'。cameraManager对象获取成功后可监听。目前只支持对设备打开或者关闭会触发该事件并返回对应信息 | -| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取镜头状态变化信息。 | | +| callback | AsyncCallback\<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取镜头状态变化信息。 | | **示例：** @@ -558,7 +558,7 @@ cameraManager.on('cameraStatus', (cameraStatusInfo) => { ### on('cameraMute') -on(type: 'cameraMute', callback: AsyncCallback): void +on(type: 'cameraMute', callback: AsyncCallback\): void 禁用回调，通过注册回调函数获取相机禁用状态变化。 @@ -683,7 +683,7 @@ cameraManager.on('cameraMute', (curMuetd) => { ### open -open\(callback: AsyncCallback\): void +open\(callback: AsyncCallback\\): void 打开相机，通过注册回调函数获取状态。 @@ -693,7 +693,7 @@ open\(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -719,7 +719,7 @@ cameraInput.open((err) => { ### open -open(): Promise +open(): Promise\ 打开相机，通过Promise获取相机的状态。 @@ -729,7 +729,7 @@ open(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -753,7 +753,7 @@ cameraInput.open().then(() => { ### close -close\(callback: AsyncCallback\): void +close\(callback: AsyncCallback\\): void 关闭相机，通过注册回调函数获取状态。 @@ -763,7 +763,7 @@ close\(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -787,7 +787,7 @@ cameraInput.close((err) => { ### close -close(): Promise +close(): Promise\ 关闭相机，通过Promise获取状态。 @@ -797,7 +797,7 @@ close(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。 | +| Promise\ | 使用Promise的方式获取结果。 | **错误码：** @@ -819,7 +819,7 @@ cameraInput.close().then(() => { ### on('error') -on(type: 'error', cameraDevice:CameraDevice, callback: ErrorCallback): void +on(type: 'error', camera:CameraDevice, callback: ErrorCallback\): void 监听CameraInput的错误事件，通过注册回调函数获取结果。 @@ -831,7 +831,7 @@ on(type: 'error', cameraDevice:CameraDevice, callback: ErrorCallback | 是 | 回调函数，用于获取结果。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | ErrorCallback\ | 是 | 回调函数，用于获取结果。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **示例：** @@ -945,7 +945,7 @@ try { ### commitConfig -commitConfig(callback: AsyncCallback): void +commitConfig(callback: AsyncCallback\): void 提交配置信息，通过注册回调函数获取结果。 @@ -955,7 +955,7 @@ commitConfig(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -980,7 +980,7 @@ captureSession.commitConfig((err) => { ### commitConfig -commitConfig(): Promise +commitConfig(): Promise\ 提交配置信息，通过Promise获取结果。 @@ -990,7 +990,7 @@ commitConfig(): Promise | 类型 | 说明 | | -------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -1094,7 +1094,7 @@ try { ### addOutput -addOutput(previewOutput: CameraOutput): void +addOutput(cameraOutput: CameraOutput): void 把[CameraOutput](#cameraoutput)加入到会话。 @@ -1104,7 +1104,7 @@ addOutput(previewOutput: CameraOutput): void | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------ | -| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的previewoutput实例。 | +| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | **返回值：** @@ -1125,7 +1125,7 @@ addOutput(previewOutput: CameraOutput): void ```js try { - captureSession.addOutput(previewOutput); + captureSession.addOutput(cameraOutput); } catch (error) { // 失败返回错误码error.code并处理 console.log(error.code); @@ -1134,7 +1134,7 @@ try { ### removeOutput -removeOutput(previewOutput: CameraOutput): void +removeOutput(cameraOutput: CameraOutput): void 从会话中移除[CameraOutput](#cameraoutput)。 @@ -1144,7 +1144,7 @@ removeOutput(previewOutput: CameraOutput): void | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------ | -| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的previewoutput实例。 | +| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | **返回值：** @@ -1174,7 +1174,7 @@ try { ### start -start\(callback: AsyncCallback\): void +start\(callback: AsyncCallback\\): void 开始会话工作，通过注册回调函数获取结果。 @@ -1184,7 +1184,7 @@ start\(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -1209,7 +1209,7 @@ captureSession.start((err) => { ### start -start\(\): Promise +start\(\): Promise\ 开始会话工作，通过Promise获取结果。 @@ -1219,7 +1219,7 @@ start\(\): Promise | 类型 | 说明 | | -------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。 | +| Promise\ | 使用Promise的方式获取结果。 | **错误码：** @@ -1242,7 +1242,7 @@ captureSession.start().then(() => { ### stop -stop\(callback: AsyncCallback\): void +stop\(callback: AsyncCallback\\): void 停止会话工作，通过注册回调函数获取结果。 @@ -1252,7 +1252,7 @@ stop\(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -1276,7 +1276,7 @@ captureSession.stop((err) => { ### stop -stop(): Promise +stop(): Promise\ 停止会话工作，通过Promise获取结果。 @@ -1286,7 +1286,7 @@ stop(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -1308,7 +1308,7 @@ captureSession.stop().then(() => { ### release -release\(callback: AsyncCallback\): void +release\(callback: AsyncCallback\\): void 释放会话资源，通过注册回调函数获取结果。 @@ -1318,7 +1318,7 @@ release\(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -1342,7 +1342,7 @@ captureSession.release((err) => { ### release -release(): Promise +release(): Promise\ 释放会话资源，通过Promise获取结果。 @@ -1352,7 +1352,7 @@ release(): Promise | 类型 | 说明 | | -------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -1710,7 +1710,7 @@ try { ### getExposureBiasRange -getExposureBiasRange(): Array +getExposureBiasRange(): Array\ 查询曝光补偿范围。 @@ -1720,7 +1720,7 @@ getExposureBiasRange(): Array | 类型 | 说明 | | ---------- | ----------------------------- | -| Array | 获取补偿范围的数组。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Array\ | 获取补偿范围的数组。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2034,7 +2034,7 @@ try { ### getZoomRatioRange -getZoomRatioRange(): Array +getZoomRatioRange(): Array\ 获取支持的变焦范围。 @@ -2044,7 +2044,7 @@ getZoomRatioRange(): Array | 类型 | 说明 | | ---------- | ----------------------------- | -| Array | 用于获取可变焦距比范围，返回的数组包括其最小值和最大值。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Array\ | 用于获取可变焦距比范围，返回的数组包括其最小值和最大值。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2251,7 +2251,7 @@ try { ### on('focusStateChange') -on(type: 'focusStateChange', callback: AsyncCallback): void +on(type: 'focusStateChange', callback: AsyncCallback\): void 监听相机聚焦的状态变化，通过注册回调函数获取结果。 @@ -2262,7 +2262,7 @@ on(type: 'focusStateChange', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------- | ---- | ------------------------ | | type | string | 是 | 监听事件，固定为'focusStateChange'，session 创建成功可监听。仅当自动对焦模式时,且相机对焦状态发生改变时可触发该事件 | -| callback | AsyncCallback<[FocusState](#focusstate)\> | 是 | 回调函数，用于获取当前对焦状态。 | +| callback | AsyncCallback\<[FocusState](#focusstate)\> | 是 | 回调函数，用于获取当前对焦状态。 | **示例：** @@ -2274,7 +2274,7 @@ captureSession.on('focusStateChange', (focusState) => { ### on('error') -on(type: 'error', callback: ErrorCallback): void +on(type: 'error', callback: ErrorCallback\): void 监听拍照会话的错误事件，通过注册回调函数获取结果。 @@ -2285,7 +2285,7 @@ on(type: 'error', callback: ErrorCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 监听事件，固定为'error'，session创建成功之后可监听该接口。session调用相关接口出现错误时会触发该事件，比如调用（beginConfig()，commitConfig()，addInput）等接口发生错误时返回错误信息。 | -| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | ErrorCallback\ | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **示例：** @@ -2305,7 +2305,7 @@ captureSession.on('error', (error) => { ### start -start(callback: AsyncCallback): void +start(callback: AsyncCallback\): void 开始输出预览流，通过注册回调函数获取结果。 @@ -2315,7 +2315,7 @@ start(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2339,7 +2339,7 @@ previewOutput.start((err) => { ### start -start(): Promise +start(): Promise\ 开始输出预览流，通过Promise获取结果。 @@ -2349,7 +2349,7 @@ start(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode)| +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode)| **错误码：** @@ -2371,7 +2371,7 @@ previewOutput.start().then(() => { ### stop -stop(callback: AsyncCallback): void +stop(callback: AsyncCallback\): void 停止输出预览流，通过注册回调函数获取结果。 @@ -2381,7 +2381,7 @@ stop(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。 | **示例：** @@ -2397,7 +2397,7 @@ previewOutput.stop((err) => { ### stop -stop(): Promise +stop(): Promise\ 停止输出预览流，通过Promise获取结果。 @@ -2407,7 +2407,7 @@ stop(): Promise | 类型 | 说明 | | -------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。 | +| Promise\ | 使用Promise的方式获取结果。 | **示例：** @@ -2421,7 +2421,7 @@ previewOutput.stop().then(() => { ### release -release(callback: AsyncCallback): void +release(callback: AsyncCallback\): void 释放输出资源，通过注册回调函数获取结果。 @@ -2431,7 +2431,7 @@ release(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2455,7 +2455,7 @@ previewOutput.release((err) => { ### release -release(): Promise +release(): Promise\ 释放输出资源，通过Promise获取结果。 @@ -2465,7 +2465,7 @@ release(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2487,7 +2487,7 @@ previewOutput.release().then(() => { ### on('frameStart') -on(type: 'frameStart', callback: AsyncCallback): void +on(type: 'frameStart', callback: AsyncCallback\): void 监听预览帧启动，通过注册回调函数获取结果。 @@ -2498,7 +2498,7 @@ on(type: 'frameStart', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | --------------------------------------- | | type | string | 是 | 监听事件，固定为'frameStart'，previewOutput创建成功可监听。底层第一次开始曝光时触发该事件并返回 | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。只要有该事件返回就证明预览开始 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。只要有该事件返回就证明预览开始 | **示例：** @@ -2510,7 +2510,7 @@ previewOutput.on('frameStart', () => { ### on('frameEnd') -on(type: 'frameEnd', callback: AsyncCallback): void +on(type: 'frameEnd', callback: AsyncCallback\): void 监听预览帧结束，通过注册回调函数获取结果。 @@ -2521,7 +2521,7 @@ on(type: 'frameEnd', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------- | | type | string | 是 | 监听事件，固定为'frameEnd'，previewOutput创建成功可监听。预览完全结束最后一帧时触发该事件并返回， | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。只要有该事件返回就证明预览结束 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。只要有该事件返回就证明预览结束 | **示例：** @@ -2533,7 +2533,7 @@ previewOutput.on('frameEnd', () => { ### on('error') -on(type: 'error', callback: ErrorCallback): void +on(type: 'error', callback: ErrorCallback\): void 监听预览输出的错误事件，通过注册回调函数获取结果。 @@ -2544,7 +2544,7 @@ on(type: 'error', callback: ErrorCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------| ---- | ------------------------ | | type | string | 是 | 监听事件，固定为'error'，previewOutput创建成功可监听。预览接口使用错误时触发该事件，比如调用（start（），release（））等接口发生错误时返回对应错误信息。| -| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | ErrorCallback\ | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **示例：** @@ -2611,7 +2611,7 @@ previewOutput.on('error', (previewOutputError) => { ### capture -capture(callback: AsyncCallback): void +capture(callback: AsyncCallback\): void 以默认设置触发一次拍照，通过注册回调函数获取结果。 @@ -2621,7 +2621,7 @@ capture(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2646,7 +2646,7 @@ photoOutput.capture((err) => { ### capture -capture(): Promise +capture(): Promise\ 以默认设置触发一次拍照，通过Promise获取结果。 @@ -2656,7 +2656,7 @@ capture(): Promise | 类型 | 说明 | | -------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2679,7 +2679,7 @@ photoOutput.capture().then(() => { ### capture -capture(setting: PhotoCaptureSetting, callback: AsyncCallback): void +capture(setting: PhotoCaptureSetting, callback: AsyncCallback\): void 以指定参数触发一次拍照，通过注册回调函数获取结果。 @@ -2690,7 +2690,7 @@ capture(setting: PhotoCaptureSetting, callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | -------------------- | | setting | [PhotoCaptureSetting](#photocapturesetting) | 是 | 拍照设置。 | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2727,7 +2727,7 @@ photoOutput.capture(settings, (err) => { ### capture -capture(setting?: PhotoCaptureSetting): Promise +capture(setting?: PhotoCaptureSetting): Promise\ 以指定参数触发一次拍照，通过Promise获取结果。 @@ -2743,7 +2743,7 @@ capture(setting?: PhotoCaptureSetting): Promise | 类型 | 说明 | | -------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2787,7 +2787,7 @@ let isSupported = photoOutput.isMirrorSupported(); ### release -release(callback: AsyncCallback): void +release(callback: AsyncCallback\): void 释放输出资源，通过注册回调函数获取结果。 @@ -2797,7 +2797,7 @@ release(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2821,7 +2821,7 @@ photoOutput.release((err) => { ### release -release(): Promise +release(): Promise\ 释放输出资源，通过Promise获取结果。 @@ -2831,7 +2831,7 @@ release(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -2853,7 +2853,7 @@ photoOutput.release().then(() => { ### on('captureStart') -on(type: 'captureStart', callback: AsyncCallback): void +on(type: 'captureStart', callback: AsyncCallback\): void 监听拍照开始，通过注册回调函数获取Capture ID。 @@ -2864,7 +2864,7 @@ on(type: 'captureStart', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------ | | type | string | 是 | 监听事件，固定为'captureStart'，photoOutput创建成功后可监听。每次拍照，底层开始曝光时触发该事件并返回。 | -| callback | AsyncCallback | 是 | 使用callback的方式获取Capture ID。 | +| callback | AsyncCallback\ | 是 | 使用callback的方式获取Capture ID。 | **示例：** @@ -2876,7 +2876,7 @@ photoOutput.on('captureStart', (captureId) => { ### on('frameShutter') -on(type: 'frameShutter', callback: AsyncCallback): void +on(type: 'frameShutter', callback: AsyncCallback\): void 监听拍照帧输出捕获，通过注册回调函数获取结果。 @@ -2887,7 +2887,7 @@ on(type: 'frameShutter', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------- | --- | ------------------------------------ | | type | string | 是 | 监听事件，固定为'frameShutter'，photoOutput创建成功后可监听。 | -| callback | AsyncCallback<[FrameShutterInfo](#frameshutterinfo)\> | 是 | 回调函数，用于获取相关信息。该回调返回意味着可以再次下发拍照请求。 | +| callback | AsyncCallback\<[FrameShutterInfo](#frameshutterinfo)\> | 是 | 回调函数，用于获取相关信息。该回调返回意味着可以再次下发拍照请求。 | **示例：** @@ -2900,7 +2900,7 @@ photoOutput.on('frameShutter', (frameShutterInfo) => { ### on('captureEnd') -on(type: 'captureEnd', callback: AsyncCallback): void +on(type: 'captureEnd', callback: AsyncCallback\): void 监听拍照结束，通过注册回调函数获取结果。 @@ -2911,7 +2911,7 @@ on(type: 'captureEnd', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------- | ---- | ---------------------------------------- | | type | string | 是 | 监听事件，固定为'captureEnd'，photoOutput创建成功后可监听。拍照完全结束可触发该事件发生并返回相应信息。 | -| callback | AsyncCallback<[CaptureEndInfo](#captureendinfo)\> | 是 | 回调函数，用于获取相关信息。 | +| callback | AsyncCallback\<[CaptureEndInfo](#captureendinfo)\> | 是 | 回调函数，用于获取相关信息。 | **示例：** @@ -2924,7 +2924,7 @@ photoOutput.on('captureEnd', (captureEndInfo) => { ### on('error') -on(type: 'error', callback: ErrorCallback): void +on(type: 'error', callback: ErrorCallback\): void 监听拍照输出发生错误，通过注册回调函数获取结果。 @@ -2935,7 +2935,7 @@ on(type: 'error', callback: ErrorCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------- | ---- | ----------------------------------- | | type | string | 是 | 监听事件，固定为'error'，photoOutput创建成功后可监听。拍照接口调用时出现错误触发该事件并返回错误信息。 | -| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | ErrorCallback\ | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **示例：** @@ -2973,7 +2973,7 @@ photoOutput.on('error', (error) => { ### start -start(callback: AsyncCallback): void +start(callback: AsyncCallback\): void 启动录制，通过注册回调函数获取结果。 @@ -2983,7 +2983,7 @@ start(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -3008,7 +3008,7 @@ videoOutput.start((err) => { ### start -start(): Promise +start(): Promise\ 启动录制，通过Promise获取结果。 @@ -3018,7 +3018,7 @@ start(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -3041,7 +3041,7 @@ videoOutput.start().then(() => { ### stop -stop(callback: AsyncCallback): void +stop(callback: AsyncCallback\): void 结束录制，通过注册回调函数获取结果。 @@ -3051,7 +3051,7 @@ stop(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------ | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。 | **示例：** @@ -3067,7 +3067,7 @@ videoOutput.stop((err) => { ### stop -stop(): Promise +stop(): Promise\ 结束录制，通过Promise获取结果。 @@ -3077,7 +3077,7 @@ stop(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。 | +| Promise\ | 使用Promise的方式获取结果。 | **示例：** @@ -3091,7 +3091,7 @@ videoOutput.stop().then(() => { ### release -release(callback: AsyncCallback): void +release(callback: AsyncCallback\): void 释放输出资源，通过注册回调函数获取结果。 @@ -3101,7 +3101,7 @@ release(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -3125,7 +3125,7 @@ videoOutput.release((err) => { ### release -release(): Promise +release(): Promise\ 释放输出资源，通过Promise获取结果。 @@ -3135,7 +3135,7 @@ release(): Promise | 类型 | 说明 | | -------------- | ----------------------- | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -3157,7 +3157,7 @@ videoOutput.release().then(() => { ### on('frameStart') -on(type: 'frameStart', callback: AsyncCallback): void +on(type: 'frameStart', callback: AsyncCallback\): void 监听录像开始，通过注册回调函数获取结果。 @@ -3168,7 +3168,7 @@ on(type: 'frameStart', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ----------------------------------------- | | type | string | 是 | 监听事件，固定为'frameStart'，videoOutput创建成功后可监听。底层第一次曝光时触发该事件并返回。 | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 只要有该事件返回就证明录像开始 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。 只要有该事件返回就证明录像开始 | **示例：** @@ -3180,7 +3180,7 @@ videoOutput.on('frameStart', () => { ### on('frameEnd') -on(type: 'frameEnd', callback: AsyncCallback): void +on(type: 'frameEnd', callback: AsyncCallback\): void 监听录像结束，通过注册回调函数获取结果。 @@ -3191,7 +3191,7 @@ on(type: 'frameEnd', callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------------ | | type | string | 是 | 监听事件，固定为'frameEnd'，videoOutput创建成功后可监听。录像完全结束最后一帧时触发该事件并返回 。 | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 只要有该事件返回就证明录像结束 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。 只要有该事件返回就证明录像结束 | **示例：** @@ -3203,7 +3203,7 @@ videoOutput.on('frameEnd', () => { ### on('error') -on(type: 'error', callback: ErrorCallback): void +on(type: 'error', callback: ErrorCallback\): void 监听录像输出发生错误，通过注册回调函数获取结果。 @@ -3214,7 +3214,7 @@ on(type: 'error', callback: ErrorCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------- | ---- | -------------------------------------- | | type | string | 是 | 监听事件，固定为'error'，videoOutput创建成功后可监听。录像接口调用出现错误时触发该事件并返回对应错误码,比如调用（start(),release()）接口时出现错误返回对应错误信息。 | -| callback | Callback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | Callback\ | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **示例：** @@ -3230,7 +3230,7 @@ metadata流。继承[CameraOutput](#cameraoutput) ### start -start(callback: AsyncCallback): void +start(callback: AsyncCallback\): void 开始输出metadata，通过注册回调函数获取结果。 @@ -3240,7 +3240,7 @@ start(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -3265,7 +3265,7 @@ metadataOutput.start((err) => { ### start -start(): Promise +start(): Promise\ 开始输出metadata，通过Promise获取结果。 @@ -3275,7 +3275,7 @@ start(): Promise | 类型 | 说明 | | ---------------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| Promise\ | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **错误码：** @@ -3298,7 +3298,7 @@ metadataOutput.start().then(() => { ### stop -stop(callback: AsyncCallback): void +stop(callback: AsyncCallback\): void 停止输出metadata，通过注册回调函数获取结果。 @@ -3308,7 +3308,7 @@ stop(callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | +| callback | AsyncCallback\ | 是 | 回调函数，用于获取结果。 | **示例：** @@ -3324,7 +3324,7 @@ metadataOutput.stop((err) => { ### stop -stop(): Promise +stop(): Promise\ 停止输出metadata，通过Promise获取结果。 @@ -3334,7 +3334,7 @@ stop(): Promise | 类型 | 说明 | | ---------------------- | --------------------------- | -| Promise | 使用Promise的方式获取结果。 | +| Promise\ | 使用Promise的方式获取结果。 | **示例：** @@ -3348,7 +3348,7 @@ metadataOutput.stop().then(() => { ### on('metadataObjectsAvailable') -on(type: 'metadataObjectsAvailable', callback: AsyncCallback\>): void +on(type: 'metadataObjectsAvailable', callback: AsyncCallback\\>): void 监听检测到的metadata对象，通过注册回调函数获取结果。 @@ -3359,7 +3359,7 @@ on(type: 'metadataObjectsAvailable', callback: AsyncCallback\> | 是 | 回调函数，用于获取metadata数据。 | +| callback | Callback\\> | 是 | 回调函数，用于获取metadata数据。 | **示例：** @@ -3371,7 +3371,7 @@ metadataOutput.on('metadataObjectsAvailable', (metadataObjectArr) => { ### on('error') -on(type: 'error', callback: ErrorCallback): void +on(type: 'error', callback: ErrorCallback\): void 监听metadata流的错误，通过注册回调函数获取结果。 @@ -3382,7 +3382,7 @@ on(type: 'error', callback: ErrorCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------- | ---- | --------------------------------------- | | type | string | 是 | 监听事件，固定为'error'，metadataOutput创建成功后可监听。metadata接口使用错误时触发该事件并返回对应错误码，比如调用（start（），release（））接口时发生错误返回对应错误信息。 | -| callback | Callback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | +| callback | Callback\ | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型[CameraErrorCode](#cameraerrorcode) | **示例：** @@ -3419,6 +3419,8 @@ metadataOutput.on('error', (metadataOutputError) => { 相机元能力信息，[CameraInput](#camerainput)相机信息中的数据来源，通过metadataOutput.on('metadataObjectsAvailable')接口获取 +**系统能力：** SystemCapability.Multimedia.Camera.Core + | 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | -----------------| | type | [MetadataObjectType](#metadataobjecttype) | 否 | metadata 类型，目前只有人脸识别。 | -- GitLab