From 8b1ab8b81b2aad64d74c25275e21464afa7670ff Mon Sep 17 00:00:00 2001 From: mali Date: Wed, 7 Dec 2022 15:12:15 +0800 Subject: [PATCH] Document sample modification-03 Signed-off-by: mali --- .../reference/apis/js-apis-camera.md | 518 +++++++++++------- 1 file changed, 307 insertions(+), 211 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 21cbd72142..72580f26b8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-camera.md +++ b/zh-cn/application-dev/reference/apis/js-apis-camera.md @@ -1346,7 +1346,7 @@ captureSession.removeInput(cameraInput).then(() => { ### addOutput -addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void +addOutput\(previewOutput: CameraOutput, callback: AsyncCallback\): void 把[CameraOutput](#cameraoutput)加入到会话，通过注册回调函数获取结果。 @@ -1356,13 +1356,13 @@ addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------ | -| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | +| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的previewoutput实例。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -captureSession.addOutput(cameraOutput, (err) => { +captureSession.addOutput(previewOutput, (err) => { if (err) { console.error(`Failed to add output. ${err.message}`); return; @@ -1373,7 +1373,7 @@ captureSession.addOutput(cameraOutput, (err) => { ### addOutput -addOutput\(cameraOutput: CameraOutput\): Promise +addOutput\(previewOutput: CameraOutput\): Promise 把[CameraOutput](#cameraoutput)加入到会话，通过Promise获取结果。 @@ -1383,7 +1383,7 @@ addOutput\(cameraOutput: CameraOutput\): Promise | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------- | -| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | +| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的previewOutput实例。 | **返回值：** @@ -1394,14 +1394,14 @@ addOutput\(cameraOutput: CameraOutput\): Promise **示例：** ```js -captureSession.addOutput(cameraOutput).then(() => { +captureSession.addOutput(previewOutput).then(() => { console.log('Promise returned with cameraOutput added.'); }) ``` ### removeOutput -removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void +removeOutput\(previewOutput: CameraOutput, callback: AsyncCallback\): void 从会话中移除[CameraOutput](#cameraoutput)，通过注册回调函数获取结果。 @@ -1411,13 +1411,13 @@ removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------ | -| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | +| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的previewoutput实例。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -captureSession.removeOutput(cameraOutput, (err) => { +captureSession.removeOutput(previewOutput, (err) => { if (err) { console.error(`Failed to remove the CameraOutput instance. ${err.message}`); return; @@ -1428,7 +1428,7 @@ captureSession.removeOutput(cameraOutput, (err) => { ### removeOutput -removeOutput(cameraOutput: CameraOutput): Promise +removeOutput(previewOutput: CameraOutput): Promise 从会话中移除[CameraOutput](#cameraoutput)，通过Promise获取结果。 @@ -1438,7 +1438,7 @@ removeOutput(cameraOutput: CameraOutput): Promise | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------- | -| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | +| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的previewoutput实例。 | **返回值：** @@ -1451,7 +1451,7 @@ removeOutput(cameraOutput: CameraOutput): Promise **示例：** ```js -captureSession.removeOutput(cameraOutput).then(() => { +captureSession.removeOutput(previewOutput).then(() => { console.log('Promise returned to indicate that the CameraOutput instance is removed.'); }) ``` @@ -2926,37 +2926,41 @@ captureSession.on('error', (captureSessionError) => { 会话中[CaptureSession](#capturesession)使用的输出信息，output的基类。 -### release +## PreviewOutput -release(callback: AsyncCallback): void +预览输出类。继承[CameraOutput](#cameraoutput) -释放输出资源，通过注册回调函数获取结果。 +### start + +start(callback: AsyncCallback): void + +开始输出预览流，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** | 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------- | +| -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -cameraOutput.release((err) => { +previewOutput.start((err) => { if (err) { - console.error(`Failed to release the PreviewOutput instance ${err.message}`); + console.error(`Failed to start the previewOutput. ${err.message}`); return; } - console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.'); -}); + console.log('Callback returned with previewOutput started.'); +}) ``` -### release +### start -release(): Promise +start(): Promise -释放输出资源，通过Promise获取结果。 +开始输出预览流，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core @@ -2969,20 +2973,16 @@ release(): Promise **示例：** ```js -cameraOutput.release().then(() => { - console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); +previewOutput.start().then(() => { + console.log('Promise returned with previewOutput started.'); }) ``` -## PreviewOutput - -预览输出类。继承[CameraOutput](#cameraoutput) - -### start +### stop -start(callback: AsyncCallback): void +stop(callback: AsyncCallback): void -开始输出预览流，通过注册回调函数获取结果。 +停止输出预览流，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core @@ -2995,82 +2995,82 @@ start(callback: AsyncCallback): void **示例：** ```js -previewOutput.start((err) => { +previewOutput.stop((err) => { if (err) { - console.error(`Failed to start the previewOutput. ${err.message}`); + console.error(`Failed to stop the previewOutput. ${err.message}`); return; } - console.log('Callback returned with previewOutput started.'); + console.log('Callback returned with previewOutput stopped.'); }) ``` -### start +### stop -start(): Promise +stop(): Promise -开始输出预览流，通过Promise获取结果。 +停止输出预览流，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **返回值：** | 类型 | 说明 | -| -------------- | ----------------------- | +| -------------- | ------------------------ | | Promise | 使用Promise的方式获取结果。 | **示例：** ```js -previewOutput.start().then(() => { - console.log('Promise returned with previewOutput started.'); +previewOutput.stop().then(() => { + console.log('Callback returned with previewOutput stopped.'); }) ``` -### stop +### release -stop(callback: AsyncCallback): void +release(callback: AsyncCallback): void -停止输出预览流，通过注册回调函数获取结果。 +释放输出资源，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** | 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | +| -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -previewOutput.stop((err) => { +previewOutput.release((err) => { if (err) { - console.error(`Failed to stop the previewOutput. ${err.message}`); + console.error(`Failed to release the PreviewOutput instance ${err.message}`); return; } - console.log('Callback returned with previewOutput stopped.'); -}) + console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.'); +}); ``` -### stop +### release -stop(): Promise +release(): Promise -停止输出预览流，通过Promise获取结果。 +释放输出资源，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **返回值：** | 类型 | 说明 | -| -------------- | ------------------------ | +| -------------- | ----------------------- | | Promise | 使用Promise的方式获取结果。 | **示例：** ```js -previewOutput.stop().then(() => { - console.log('Callback returned with previewOutput stopped.'); +previewOutput.release().then(() => { + console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); }) ``` @@ -3330,6 +3330,54 @@ photoOutput.isMirrorSupported((err, isSupported) => { }) ``` +### release + +release(callback: AsyncCallback): void + +释放输出资源，通过注册回调函数获取结果。 + +**系统能力：** SystemCapability.Multimedia.Camera.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------- | +| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | + +**示例：** + +```js +photoOutput.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 + +释放输出资源，通过Promise获取结果。 + +**系统能力：** SystemCapability.Multimedia.Camera.Core + +**返回值：** + +| 类型 | 说明 | +| -------------- | ----------------------- | +| Promise | 使用Promise的方式获取结果。 | + +**示例：** + +```js +photoOutput.release().then(() => { + console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); +}) +``` + ### isMirrorSupported isMirrorSupported(): Promise @@ -3592,6 +3640,54 @@ videoOutput.stop().then(() => { }) ``` +### release + +release(callback: AsyncCallback): void + +释放输出资源，通过注册回调函数获取结果。 + +**系统能力：** SystemCapability.Multimedia.Camera.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------- | +| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | + +**示例：** + +```js +videoOutput.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 + +释放输出资源，通过Promise获取结果。 + +**系统能力：** SystemCapability.Multimedia.Camera.Core + +**返回值：** + +| 类型 | 说明 | +| -------------- | ----------------------- | +| Promise | 使用Promise的方式获取结果。 | + +**示例：** + +```js +videoOutput.release().then(() => { + console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); +}) +``` + ### on('frameStart') on(type: 'frameStart', callback: AsyncCallback): void @@ -3682,344 +3778,344 @@ videoOutput.on('error', (VideoOutputError) => { | ---- | ------------------------------------- | ----------------- | ----------------------- | | code | [PhotoOutputErrorCode](#photooutputerrorcode) | 是 | VideoOutput中的错误码。 | -## MetadataObjectType - -枚举，metadata流。 - -**系统能力：** SystemCapability.Multimedia.Camera.Core - -| 名称 | 值 | 说明 | -| ------------------------- | ---- | ----------------- | -| FACE_DETECTION | 0 | metadata对象类型。 | - -## Rect - -矩形定义。 - -**系统能力：** SystemCapability.Multimedia.Camera.Core - -| 名称 | 类型 | 必填 | 说明 | -| -------- | ------ | --------------- | -------------------- | -| topLeftX | number | 是 | 矩形区域左上角x坐标。 | -| topLeftY | number | 是 | 矩形区域左上角y坐标。 | -| width | number | 是 | 矩形宽。 | -| height | number | 是 |矩形高。 | - -## MetadataObject +## MetadataOutput -相机元能力信息，[CameraInput](#camerainput)相机信息中的数据来源。 +metadata流。继承[CameraOutput](#cameraoutput) -### getType +### start -getType(callback: AsyncCallback): void +start(callback: AsyncCallback): void -查询metadata对象类型，通过注册回调函数获取结果。 +开始输出metadata，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------------------- | --- | -------------------- | -| callback | AsyncCallback<[MetadataObjectType](#metadataobjecttype)\> | 是 | 回调函数，用于获取结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ------------------- | +| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -metadataObject.getType((err, metadataObjectType) => { +metadataOutput.start((err) => { if (err) { - console.error(`Failed to get type. ${err.message}`); + console.error(`Failed to start metadataOutput. ${err.message}`); return; } - console.log('Callback returned with an array of metadataObjectType.'); + console.log('Callback returned with metadataOutput started.'); }) ``` -### getType +### start -getType(): Promise +start(): Promise -查询metadata对象类型，通过Promise获取结果。 +开始输出metadata，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **返回值：** -| 类型 | 说明 | -| --------------------------------------------------- | --------------------------- | -| Promise<[MetadataObjectType](#metadataobjecttype)\> | 使用Promise的方式获取结果。 | +| 类型 | 说明 | +| ---------------------- | ------------------------ | +| Promise | 使用Promise的方式获取结果。 | **示例：** ```js -metadataObject.getType().then((metadataObjectType) => { - console.log('Callback returned with an array of metadataObjectType.'); +metadataOutput.start().then(() => { + console.log('Callback returned with metadataOutput started.'); }) ``` -### getTimestamp +### stop -getTimestamp(callback: AsyncCallback): void +stop(callback: AsyncCallback): void -查询metadata时间戳，通过注册回调函数获取结果。 +停止输出metadata，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------- | ---- | ------------------- | +| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -metadataObject.getTimestamp((err,timestamp) => { +metadataOutput.stop((err) => { if (err) { - console.error(`Failed to get timestamp. ${err.message}`); + console.error(`Failed to stop the metadataOutput. ${err.message}`); return; } - console.log('Callback returned with timestamp getted timestamp : ${timestamp}'); + console.log('Callback returned with metadataOutput stopped.'); }) ``` -### getTimestamp +### stop -getTimestamp(): Promise +stop(): Promise -查询metadata时间戳，通过Promise获取结果。 +停止输出metadata，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **返回值：** -| 类型 | 说明 | -| ---------------- | --------------------------- | -| Promise | 使用Promise的方式获取结果。 | +| 类型 | 说明 | +| ---------------------- | --------------------------- | +| Promise | 使用Promise的方式获取结果。 | **示例：** ```js -metadataObject.getTimestamp().then((timestamp) => { - console.log('Callback returned with timestamp getted timestamp : ${timestamp}'); +metadataOutput.stop().then(() => { + console.log('Callback returned with metadataOutput stopped.'); }) ``` -### getBoundingBox +### on('metadataObjectsAvailable') -getBoundingBox(callback: AsyncCallback): void +on(type: 'metadataObjectsAvailable', callback: AsyncCallback\>): void -查询metadata的边界框，通过注册回调函数获取结果。 +监听检测到的metadata对象，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback<[Rect](#rect)\> | 是 | 回调函数，用于获取结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------ | ---- | ------------------------------------ | +| type | string | 是 | 监听事件，固定为'metadataObjectsAvailable'，即metadata对象。 | +| callback | Callback\> | 是 | 回调函数，用于获取错误信息。 | **示例：** ```js -metadataObject.getBoundingBox((err, rect) => { - if (err) { - console.error(`Failed to get boundingBox. ${err.message}`); - return; - } - console.log('Callback returned with boundingBox getted.'); +metadataOutput.on('metadataObjectsAvailable', (metadataObject) => { + console.log(`metadata output error code: ${metadataObject.code}`); }) ``` -### getBoundingBox +### on('error') -getBoundingBox(): Promise +on(type: 'error', callback: ErrorCallback): void -查询metadata的边界框，通过Promise获取结果。 +监听metadata流的错误，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core -**返回值：** +**参数：** -| 类型 | 说明 | -| ---------------------- | --------------------------- | -| Promise<[Rect](#rect)\> | 使用Promise的方式获取结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------ | ---- | --------------------------------------- | +| type | string | 是 | 监听事件，固定为'error'，即metadata流的错误。 | +| callback | Callback<[MetadataOutputError](#metadataoutputerror)\> | 是 | 回调函数，用于获取错误信息。 | **示例：** ```js -metadataObject.getBoundingBox().then((rect) => { - console.log('Callback returned with boundingBox getted.'); +metadataOutput.on('error', (metadataOutputError) => { + console.log(`Metadata output error code: ${metadataOutputError.code}`); }) ``` -## MetadataFaceObject +## MetadataOutputErrorCode -metadata的人脸对象。继承[MetadataObject](#metadataobject) +枚举，metadata输出错误类型。 -## MetadataOutput +**系统能力：** SystemCapability.Multimedia.Camera.Core -metadata流。继承[CameraOutput](#cameraoutput) +| 名称 | 值 | 说明 | +| ------------------------------- | ---- | -------- | +| ERROR_UNKNOWN | -1 | 未知错误。 | +| ERROR_INSUFFICIENT_RESOURCES | 0 | 资源不足。 | -### start +## MetadataOutputError -start(callback: AsyncCallback): void +metadata输出错误码。 -开始输出metadata，通过注册回调函数获取结果。 +**系统能力：** SystemCapability.Multimedia.Camera.Core + +| 名称 | 类型 | 必填 | 说明 | +| ---- | ------------------------------------- | ----------------- | ----------------------- | +| code | [MetadataOutputErrorCode](#metadataoutputerrorcode) | 是 | MetadataOutput中的错误码。 | + +## MetadataObjectType + +枚举，metadata流。 + +**系统能力：** SystemCapability.Multimedia.Camera.Core + +| 名称 | 值 | 说明 | +| ------------------------- | ---- | ----------------- | +| FACE_DETECTION | 0 | metadata对象类型。 | + +## Rect + +矩形定义。 + +**系统能力：** SystemCapability.Multimedia.Camera.Core + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------ | --------------- | -------------------- | +| topLeftX | number | 是 | 矩形区域左上角x坐标。 | +| topLeftY | number | 是 | 矩形区域左上角y坐标。 | +| width | number | 是 | 矩形宽。 | +| height | number | 是 |矩形高。 | + +## MetadataObject + +相机元能力信息，[CameraInput](#camerainput)相机信息中的数据来源。 + +### getType + +getType(callback: AsyncCallback): void + +查询metadata对象类型，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------------- | --- | -------------------- | +| callback | AsyncCallback<[MetadataObjectType](#metadataobjecttype)\> | 是 | 回调函数，用于获取结果。 | **示例：** ```js -metadataOutput.start((err) => { +metadataObject.getType((err, metadataObjectType) => { if (err) { - console.error(`Failed to start metadataOutput. ${err.message}`); + console.error(`Failed to get type. ${err.message}`); return; } - console.log('Callback returned with metadataOutput started.'); + console.log('Callback returned with an array of metadataObjectType.'); }) ``` -### start +### getType -start(): Promise +getType(): Promise -开始输出metadata，通过Promise获取结果。 +查询metadata对象类型，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **返回值：** -| 类型 | 说明 | -| ---------------------- | ------------------------ | -| Promise | 使用Promise的方式获取结果。 | +| 类型 | 说明 | +| --------------------------------------------------- | --------------------------- | +| Promise<[MetadataObjectType](#metadataobjecttype)\> | 使用Promise的方式获取结果。 | **示例：** ```js -metadataOutput.start().then(() => { - console.log('Callback returned with metadataOutput started.'); +metadataObject.getType().then((metadataObjectType) => { + console.log('Callback returned with an array of metadataObjectType.'); }) ``` -### stop +### getTimestamp -stop(callback: AsyncCallback): void +getTimestamp(callback: AsyncCallback): void -停止输出metadata，通过注册回调函数获取结果。 +查询metadata时间戳，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------- | ---- | ------------------- | -| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ------------------------ | +| callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | **示例：** ```js -metadataOutput.stop((err) => { +metadataObject.getTimestamp((err,timestamp) => { if (err) { - console.error(`Failed to stop the metadataOutput. ${err.message}`); + console.error(`Failed to get timestamp. ${err.message}`); return; } - console.log('Callback returned with metadataOutput stopped.'); + console.log('Callback returned with timestamp getted timestamp : ${timestamp}'); }) ``` -### stop +### getTimestamp -stop(): Promise +getTimestamp(): Promise -停止输出metadata，通过Promise获取结果。 +查询metadata时间戳，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **返回值：** -| 类型 | 说明 | -| ---------------------- | --------------------------- | -| Promise | 使用Promise的方式获取结果。 | +| 类型 | 说明 | +| ---------------- | --------------------------- | +| Promise | 使用Promise的方式获取结果。 | **示例：** ```js -metadataOutput.stop().then(() => { - console.log('Callback returned with metadataOutput stopped.'); +metadataObject.getTimestamp().then((timestamp) => { + console.log('Callback returned with timestamp getted timestamp : ${timestamp}'); }) ``` -### on('metadataObjectsAvailable') +### getBoundingBox -on(type: 'metadataObjectsAvailable', callback: AsyncCallback\>): void +getBoundingBox(callback: AsyncCallback): void -监听检测到的metadata对象，通过注册回调函数获取结果。 +查询metadata的边界框，通过注册回调函数获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------ | ---- | ------------------------------------ | -| type | string | 是 | 监听事件，固定为'metadataObjectsAvailable'，即metadata对象。 | -| callback | Callback\> | 是 | 回调函数，用于获取错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ------------------------ | +| callback | AsyncCallback<[Rect](#rect)\> | 是 | 回调函数，用于获取结果。 | **示例：** ```js -metadataOutput.on('metadataObjectsAvailable', (metadataObject) => { - console.log(`metadata output error code: ${metadataObject.code}`); +metadataObject.getBoundingBox((err, rect) => { + if (err) { + console.error(`Failed to get boundingBox. ${err.message}`); + return; + } + console.log('Callback returned with boundingBox getted.'); }) ``` -### on('error') +### getBoundingBox -on(type: 'error', callback: ErrorCallback): void +getBoundingBox(): Promise -监听metadata流的错误，通过注册回调函数获取结果。 +查询metadata的边界框，通过Promise获取结果。 **系统能力：** SystemCapability.Multimedia.Camera.Core -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------ | ---- | --------------------------------------- | -| type | string | 是 | 监听事件，固定为'error'，即metadata流的错误。 | -| callback | Callback<[MetadataOutputError](#metadataoutputerror)\> | 是 | 回调函数，用于获取错误信息。 | +| 类型 | 说明 | +| ---------------------- | --------------------------- | +| Promise<[Rect](#rect)\> | 使用Promise的方式获取结果。 | **示例：** ```js -metadataOutput.on('error', (metadataOutputError) => { - console.log(`Metadata output error code: ${metadataOutputError.code}`); +metadataObject.getBoundingBox().then((rect) => { + console.log('Callback returned with boundingBox getted.'); }) ``` -## MetadataOutputErrorCode - -枚举，metadata输出错误类型。 - -**系统能力：** SystemCapability.Multimedia.Camera.Core - -| 名称 | 值 | 说明 | -| ------------------------------- | ---- | -------- | -| ERROR_UNKNOWN | -1 | 未知错误。 | -| ERROR_INSUFFICIENT_RESOURCES | 0 | 资源不足。 | - -## MetadataOutputError - -metadata输出错误码。 - -**系统能力：** SystemCapability.Multimedia.Camera.Core +## MetadataFaceObject -| 名称 | 类型 | 必填 | 说明 | -| ---- | ------------------------------------- | ----------------- | ----------------------- | -| code | [MetadataOutputErrorCode](#metadataoutputerrorcode) | 是 | MetadataOutput中的错误码。 | \ No newline at end of file +metadata的人脸对象。继承[MetadataObject](#metadataobject) \ No newline at end of file -- GitLab