Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 8b1ab8b8 编写于 作者: M mali
浏览文件
操作

Document sample modification-03 

Signed-off-by: Nmali <mali81@huawei.com>
上级 0eb4188b
隐藏空白更改
内联 并排
Showing with 307 addition and 211 deletion
zh-cn/application-dev/reference/apis/js-apis-camera.md
浏览文件 @ 8b1ab8b8
...@@ -1346,7 +1346,7 @@ captureSession.removeInput(cameraInput).then(() => { ...@@ -1346,7 +1346,7 @@ captureSession.removeInput(cameraInput).then(() => {
### addOutput ### addOutput
addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback<void\>\): void addOutput\(previewOutput: CameraOutput, callback: AsyncCallback<void\>\): void
把[CameraOutput](#cameraoutput)加入到会话，通过注册回调函数获取结果。 把[CameraOutput](#cameraoutput)加入到会话，通过注册回调函数获取结果。
...@@ -1356,13 +1356,13 @@ addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback<void\>\): void ...@@ -1356,13 +1356,13 @@ addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback<void\>\): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ------------------------ | | ------------- | ------------------------------- | ---- | ------------------------ |
| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | | previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的previewoutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
captureSession.addOutput(cameraOutput, (err) => { captureSession.addOutput(previewOutput, (err) => {
if (err) { if (err) {
console.error(`Failed to add output. ${err.message}`); console.error(`Failed to add output. ${err.message}`);
return; return;
...@@ -1373,7 +1373,7 @@ captureSession.addOutput(cameraOutput, (err) => { ...@@ -1373,7 +1373,7 @@ captureSession.addOutput(cameraOutput, (err) => {
### addOutput ### addOutput
addOutput\(cameraOutput: CameraOutput\): Promise<void\> addOutput\(previewOutput: CameraOutput\): Promise<void\>
把[CameraOutput](#cameraoutput)加入到会话，通过Promise获取结果。 把[CameraOutput](#cameraoutput)加入到会话，通过Promise获取结果。
...@@ -1383,7 +1383,7 @@ addOutput\(cameraOutput: CameraOutput\): Promise<void\> ...@@ -1383,7 +1383,7 @@ addOutput\(cameraOutput: CameraOutput\): Promise<void\>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ------------------------- | | ------------- | ------------------------------- | ---- | ------------------------- |
| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | | previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的previewOutput实例。 |
**返回值：** **返回值：**
...@@ -1394,14 +1394,14 @@ addOutput\(cameraOutput: CameraOutput\): Promise<void\> ...@@ -1394,14 +1394,14 @@ addOutput\(cameraOutput: CameraOutput\): Promise<void\>
**示例：** **示例：**
```js ```js
captureSession.addOutput(cameraOutput).then(() => { captureSession.addOutput(previewOutput).then(() => {
console.log('Promise returned with cameraOutput added.'); console.log('Promise returned with cameraOutput added.');
}) })
``` ```
### removeOutput ### removeOutput
removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback<void\>\): void removeOutput\(previewOutput: CameraOutput, callback: AsyncCallback<void\>\): void
从会话中移除[CameraOutput](#cameraoutput)，通过注册回调函数获取结果。 从会话中移除[CameraOutput](#cameraoutput)，通过注册回调函数获取结果。
...@@ -1411,13 +1411,13 @@ removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback<void\>\): void ...@@ -1411,13 +1411,13 @@ removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback<void\>\): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ------------------------ | | ------------- | ------------------------------- | ---- | ------------------------ |
| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | | previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的previewoutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
captureSession.removeOutput(cameraOutput, (err) => { captureSession.removeOutput(previewOutput, (err) => {
if (err) { if (err) {
console.error(`Failed to remove the CameraOutput instance. ${err.message}`); console.error(`Failed to remove the CameraOutput instance. ${err.message}`);
return; return;
...@@ -1428,7 +1428,7 @@ captureSession.removeOutput(cameraOutput, (err) => { ...@@ -1428,7 +1428,7 @@ captureSession.removeOutput(cameraOutput, (err) => {
### removeOutput ### removeOutput
removeOutput(cameraOutput: CameraOutput): Promise<void\> removeOutput(previewOutput: CameraOutput): Promise<void\>
从会话中移除[CameraOutput](#cameraoutput)，通过Promise获取结果。 从会话中移除[CameraOutput](#cameraoutput)，通过Promise获取结果。
...@@ -1438,7 +1438,7 @@ removeOutput(cameraOutput: CameraOutput): Promise<void\> ...@@ -1438,7 +1438,7 @@ removeOutput(cameraOutput: CameraOutput): Promise<void\>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ------------------------- | | ------------- | ------------------------------- | ---- | ------------------------- |
| cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | | previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的previewoutput实例。 |
**返回值：** **返回值：**
...@@ -1451,7 +1451,7 @@ removeOutput(cameraOutput: CameraOutput): Promise<void\> ...@@ -1451,7 +1451,7 @@ removeOutput(cameraOutput: CameraOutput): Promise<void\>
**示例：** **示例：**
```js ```js
captureSession.removeOutput(cameraOutput).then(() => { captureSession.removeOutput(previewOutput).then(() => {
console.log('Promise returned to indicate that the CameraOutput instance is removed.'); console.log('Promise returned to indicate that the CameraOutput instance is removed.');
}) })
``` ```
...@@ -2926,37 +2926,41 @@ captureSession.on('error', (captureSessionError) => { ...@@ -2926,37 +2926,41 @@ captureSession.on('error', (captureSessionError) => {
会话中[CaptureSession](#capturesession)使用的输出信息，output的基类。 会话中[CaptureSession](#capturesession)使用的输出信息，output的基类。
### release ## PreviewOutput
release(callback: AsyncCallback<void\>): void 预览输出类。继承[CameraOutput](#cameraoutput)
释放输出资源，通过注册回调函数获取结果。 ### start
start(callback: AsyncCallback<void\>): void
开始输出预览流，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------- | | -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
cameraOutput.release((err) => { previewOutput.start((err) => {
if (err) { if (err) {
console.error(`Failed to release the PreviewOutput instance ${err.message}`); console.error(`Failed to start the previewOutput. ${err.message}`);
return; 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<void\> start(): Promise<void\>
释放输出资源，通过Promise获取结果。 开始输出预览流，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
...@@ -2969,20 +2973,16 @@ release(): Promise<void\> ...@@ -2969,20 +2973,16 @@ release(): Promise<void\>
**示例：** **示例：**
```js ```js
cameraOutput.release().then(() => { previewOutput.start().then(() => {
console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); console.log('Promise returned with previewOutput started.');
}) })
``` ```
## PreviewOutput ### stop
预览输出类。继承[CameraOutput](#cameraoutput)
### start
start(callback: AsyncCallback<void\>): void stop(callback: AsyncCallback<void\>): void
开始输出预览流，通过注册回调函数获取结果。 停止输出预览流，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
...@@ -2995,82 +2995,82 @@ start(callback: AsyncCallback<void\>): void ...@@ -2995,82 +2995,82 @@ start(callback: AsyncCallback<void\>): void
**示例：** **示例：**
```js ```js
previewOutput.start((err) => { previewOutput.stop((err) => {
if (err) { if (err) {
console.error(`Failed to start the previewOutput. ${err.message}`); console.error(`Failed to stop the previewOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with previewOutput started.'); console.log('Callback returned with previewOutput stopped.');
}) })
``` ```
### start ### stop
start(): Promise<void\> stop(): Promise<void\>
开始输出预览流，通过Promise获取结果。 停止输出预览流，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ----------------------- | | -------------- | ------------------------ |
| Promise<void\> | 使用Promise的方式获取结果。 | | Promise<void\> | 使用Promise的方式获取结果。 |
**示例：** **示例：**
```js ```js
previewOutput.start().then(() => { previewOutput.stop().then(() => {
console.log('Promise returned with previewOutput started.'); console.log('Callback returned with previewOutput stopped.');
}) })
``` ```
### stop ### release
stop(callback: AsyncCallback<void\>): void release(callback: AsyncCallback<void\>): void
停止输出预览流，通过注册回调函数获取结果。 释放输出资源，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------- | | -------- | -------------------- | ---- | ------------------- |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
previewOutput.stop((err) => { previewOutput.release((err) => {
if (err) { if (err) {
console.error(`Failed to stop the previewOutput. ${err.message}`); console.error(`Failed to release the PreviewOutput instance ${err.message}`);
return; 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<void\> release(): Promise<void\>
停止输出预览流，通过Promise获取结果。 释放输出资源，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------ | | -------------- | ----------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 | | Promise<void\> | 使用Promise的方式获取结果。 |
**示例：** **示例：**
```js ```js
previewOutput.stop().then(() => { previewOutput.release().then(() => {
console.log('Callback returned with previewOutput stopped.'); console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
}) })
``` ```
...@@ -3330,6 +3330,54 @@ photoOutput.isMirrorSupported((err, isSupported) => { ...@@ -3330,6 +3330,54 @@ photoOutput.isMirrorSupported((err, isSupported) => {
}) })
``` ```
### release
release(callback: AsyncCallback<void\>): void
释放输出资源，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------- |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
```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<void\>
释放输出资源，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
```js
photoOutput.release().then(() => {
console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
})
```
### isMirrorSupported ### isMirrorSupported
isMirrorSupported(): Promise<boolean\> isMirrorSupported(): Promise<boolean\>
...@@ -3592,6 +3640,54 @@ videoOutput.stop().then(() => { ...@@ -3592,6 +3640,54 @@ videoOutput.stop().then(() => {
}) })
``` ```
### release
release(callback: AsyncCallback<void\>): void
释放输出资源，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------- |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
```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<void\>
释放输出资源，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
```js
videoOutput.release().then(() => {
console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
})
```
### on('frameStart') ### on('frameStart')
on(type: 'frameStart', callback: AsyncCallback<void\>): void on(type: 'frameStart', callback: AsyncCallback<void\>): void
...@@ -3682,344 +3778,344 @@ videoOutput.on('error', (VideoOutputError) => { ...@@ -3682,344 +3778,344 @@ videoOutput.on('error', (VideoOutputError) => {
| ---- | ------------------------------------- | ----------------- | ----------------------- | | ---- | ------------------------------------- | ----------------- | ----------------------- |
| code | [PhotoOutputErrorCode](#photooutputerrorcode) | 是 | VideoOutput中的错误码。 | | code | [PhotoOutputErrorCode](#photooutputerrorcode) | 是 | VideoOutput中的错误码。 |
## MetadataObjectType ## MetadataOutput
枚举，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)相机信息中的数据来源。 metadata流。继承[CameraOutput](#cameraoutput)
### getType ### start
getType(callback: AsyncCallback<MetadataObjectType\>): void start(callback: AsyncCallback<void\>): void
查询metadata对象类型，通过注册回调函数获取结果。 开始输出metadata，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | --- | -------------------- | | -------- | ----------------------------------------------------------- | ---- | ------------------- |
| callback | AsyncCallback<[MetadataObjectType](#metadataobjecttype)\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
metadataObject.getType((err, metadataObjectType) => { metadataOutput.start((err) => {
if (err) { if (err) {
console.error(`Failed to get type. ${err.message}`); console.error(`Failed to start metadataOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with an array of metadataObjectType.'); console.log('Callback returned with metadataOutput started.');
}) })
``` ```
### getType ### start
getType(): Promise<MetadataObjectType\> start(): Promise<void\>
查询metadata对象类型，通过Promise获取结果。 开始输出metadata，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------------------- | --------------------------- | | ---------------------- | ------------------------ |
| Promise<[MetadataObjectType](#metadataobjecttype)\> | 使用Promise的方式获取结果。 | | Promise<void\> | 使用Promise的方式获取结果。 |
**示例：** **示例：**
```js ```js
metadataObject.getType().then((metadataObjectType) => { metadataOutput.start().then(() => {
console.log('Callback returned with an array of metadataObjectType.'); console.log('Callback returned with metadataOutput started.');
}) })
``` ```
### getTimestamp ### stop
getTimestamp(callback: AsyncCallback<number\>): void stop(callback: AsyncCallback<void\>): void
查询metadata时间戳，通过注册回调函数获取结果。 停止输出metadata，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------ | | -------- | -------------------------- | ---- | ------------------- |
| callback | AsyncCallback<number\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
metadataObject.getTimestamp((err,timestamp) => { metadataOutput.stop((err) => {
if (err) { if (err) {
console.error(`Failed to get timestamp. ${err.message}`); console.error(`Failed to stop the metadataOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with timestamp getted timestamp : ${timestamp}'); console.log('Callback returned with metadataOutput stopped.');
}) })
``` ```
### getTimestamp ### stop
getTimestamp(): Promise<number\> stop(): Promise<void\>
查询metadata时间戳，通过Promise获取结果。 停止输出metadata，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | --------------------------- | | ---------------------- | --------------------------- |
| Promise<number)\> | 使用Promise的方式获取结果。 | | Promise<void\> | 使用Promise的方式获取结果。 |
**示例：** **示例：**
```js ```js
metadataObject.getTimestamp().then((timestamp) => { metadataOutput.stop().then(() => {
console.log('Callback returned with timestamp getted timestamp : ${timestamp}'); console.log('Callback returned with metadataOutput stopped.');
}) })
``` ```
### getBoundingBox ### on('metadataObjectsAvailable')
getBoundingBox(callback: AsyncCallback<Rect\>): void on(type: 'metadataObjectsAvailable', callback: AsyncCallback<Array<MetadataObject\>\>): void
查询metadata的边界框，通过注册回调函数获取结果。 监听检测到的metadata对象，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------ | | -------- | ------------------------------------------------ | ---- | ------------------------------------ |
| callback | AsyncCallback<[Rect](#rect)\> | 是 | 回调函数，用于获取结果。 | | type | string | 是 | 监听事件，固定为'metadataObjectsAvailable'，即metadata对象。 |
| callback | Callback<Array<[MetadataObject](#metadataobject)\>\> | 是 | 回调函数，用于获取错误信息。 |
**示例：** **示例：**
```js ```js
metadataObject.getBoundingBox((err, rect) => { metadataOutput.on('metadataObjectsAvailable', (metadataObject) => {
if (err) { console.log(`metadata output error code: ${metadataObject.code}`);
console.error(`Failed to get boundingBox. ${err.message}`);
return;
}
console.log('Callback returned with boundingBox getted.');
}) })
``` ```
### getBoundingBox ### on('error')
getBoundingBox(): Promise<Rect\> on(type: 'error', callback: ErrorCallback<MetadataOutputError\>): void
查询metadata的边界框，通过Promise获取结果。 监听metadata流的错误，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **参数：**
| 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------------- | --------------------------- | | -------- | ------------------------------------------------ | ---- | --------------------------------------- |
| Promise<[Rect](#rect)\> | 使用Promise的方式获取结果。 | | type | string | 是 | 监听事件，固定为'error'，即metadata流的错误。 |
| callback | Callback<[MetadataOutputError](#metadataoutputerror)\> | 是 | 回调函数，用于获取错误信息。 |
**示例：** **示例：**
```js ```js
metadataObject.getBoundingBox().then((rect) => { metadataOutput.on('error', (metadataOutputError) => {
console.log('Callback returned with boundingBox getted.'); 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\>): 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<MetadataObjectType\>): void
查询metadata对象类型，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------- | | -------- | --------------------------------------------------------- | --- | -------------------- |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<[MetadataObjectType](#metadataobjecttype)\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
metadataOutput.start((err) => { metadataObject.getType((err, metadataObjectType) => {
if (err) { if (err) {
console.error(`Failed to start metadataOutput. ${err.message}`); console.error(`Failed to get type. ${err.message}`);
return; return;
} }
console.log('Callback returned with metadataOutput started.'); console.log('Callback returned with an array of metadataObjectType.');
}) })
``` ```
### start ### getType
start(): Promise<void\> getType(): Promise<MetadataObjectType\>
开始输出metadata，通过Promise获取结果。 查询metadata对象类型，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ------------------------ | | --------------------------------------------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 | | Promise<[MetadataObjectType](#metadataobjecttype)\> | 使用Promise的方式获取结果。 |
**示例：** **示例：**
```js ```js
metadataOutput.start().then(() => { metadataObject.getType().then((metadataObjectType) => {
console.log('Callback returned with metadataOutput started.'); console.log('Callback returned with an array of metadataObjectType.');
}) })
``` ```
### stop ### getTimestamp
stop(callback: AsyncCallback<void\>): void getTimestamp(callback: AsyncCallback<number\>): void
停止输出metadata，通过注册回调函数获取结果。 查询metadata时间戳，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- | | -------- | ----------------------------------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 | | callback | AsyncCallback<number\> | 是 | 回调函数，用于获取结果。 |
**示例：** **示例：**
```js ```js
metadataOutput.stop((err) => { metadataObject.getTimestamp((err,timestamp) => {
if (err) { if (err) {
console.error(`Failed to stop the metadataOutput. ${err.message}`); console.error(`Failed to get timestamp. ${err.message}`);
return; return;
} }
console.log('Callback returned with metadataOutput stopped.'); console.log('Callback returned with timestamp getted timestamp : ${timestamp}');
}) })
``` ```
### stop ### getTimestamp
stop(): Promise<void\> getTimestamp(): Promise<number\>
停止输出metadata，通过Promise获取结果。 查询metadata时间戳，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------------- | | ---------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 | | Promise<number)\> | 使用Promise的方式获取结果。 |
**示例：** **示例：**
```js ```js
metadataOutput.stop().then(() => { metadataObject.getTimestamp().then((timestamp) => {
console.log('Callback returned with metadataOutput stopped.'); console.log('Callback returned with timestamp getted timestamp : ${timestamp}');
}) })
``` ```
### on('metadataObjectsAvailable') ### getBoundingBox
on(type: 'metadataObjectsAvailable', callback: AsyncCallback<Array<MetadataObject\>\>): void getBoundingBox(callback: AsyncCallback<Rect\>): void
监听检测到的metadata对象，通过注册回调函数获取结果。 查询metadata的边界框，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ------------------------------------ | | -------- | ----------------------------------------------------------- | ---- | ------------------------ |
| type | string | 是 | 监听事件，固定为'metadataObjectsAvailable'，即metadata对象。 | | callback | AsyncCallback<[Rect](#rect)\> | 是 | 回调函数，用于获取结果。 |
| callback | Callback<Array<[MetadataObject](#metadataobject)\>\> | 是 | 回调函数，用于获取错误信息。 |
**示例：** **示例：**
```js ```js
metadataOutput.on('metadataObjectsAvailable', (metadataObject) => { metadataObject.getBoundingBox((err, rect) => {
console.log(`metadata output error code: ${metadataObject.code}`); 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<MetadataOutputError\>): void getBoundingBox(): Promise<Rect\>
监听metadata流的错误，通过注册回调函数获取结果。 查询metadata的边界框，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core **系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| -------- | ------------------------------------------------ | ---- | --------------------------------------- | | ---------------------- | --------------------------- |
| type | string | 是 | 监听事件，固定为'error'，即metadata流的错误。 | | Promise<[Rect](#rect)\> | 使用Promise的方式获取结果。 |
| callback | Callback<[MetadataOutputError](#metadataoutputerror)\> | 是 | 回调函数，用于获取错误信息。 |
**示例：** **示例：**
```js ```js
metadataOutput.on('error', (metadataOutputError) => { metadataObject.getBoundingBox().then((rect) => {
console.log(`Metadata output error code: ${metadataOutputError.code}`); console.log('Callback returned with boundingBox getted.');
}) })
``` ```
## MetadataOutputErrorCode ## MetadataFaceObject
枚举，metadata输出错误类型。
**系统能力：** SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
| ------------------------------- | ---- | -------- |
| ERROR_UNKNOWN | -1 | 未知错误。 |
| ERROR_INSUFFICIENT_RESOURCES | 0 | 资源不足。 |
## MetadataOutputError
metadata输出错误码。
**系统能力：** SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 | metadata的人脸对象。继承[MetadataObject](#metadataobject)
| ---- | ------------------------------------- | ----------------- | ----------------------- | \ No newline at end of file
| code | [MetadataOutputErrorCode](#metadataoutputerrorcode) | 是 | MetadataOutput中的错误码。 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或