Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 0a580e44 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 b7a9ac0b
隐藏空白更改
内联 并排
Showing with 614 addition and 788 deletion
zh-cn/application-dev/reference/apis/js-apis-camera.md
浏览文件 @ 0a580e44
......@@ -23,10 +23,10 @@ getCameraManager(context: Context, callback: AsyncCallback<CameraManager\>): voi
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|-------------------------------|-----------|-----------------------------------------------------|
| context | Context | 是 | 应用上下文。 |
| callback | AsyncCallback<[CameraManager](#cameramanager)\> | 是 | 回调函数，用于获取相机管理器实例。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ---------------------------------- |
| context | Context | 是 | 应用上下文。 |
| callback | AsyncCallback<[CameraManager](#cameramanager)\> | 是 | 回调函数，用于获取相机管理器实例。 |
**示例：**
......@@ -50,15 +50,15 @@ getCameraManager(context: Context): Promise<CameraManager\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------|
| context | Context | 是 | 应用上下文。 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------ |
| context | Context | 是 | 应用上下文。 |
**返回值：**
| 类型 | 说明 |
|-------------------------|--------------------------------------------------------|
| Promise<[CameraManager](#cameramanager)\> | 使用Promise的方式获取一个相机管理器实例。 |
| 类型 | 说明 |
| ----------------------------------------- | ----------------------------------------- |
| Promise<[CameraManager](#cameramanager)\> | 使用Promise的方式获取一个相机管理器实例。 |
**示例：**
......@@ -72,58 +72,54 @@ camera.getCameraManager(context).then((cameraManger) => {
枚举，相机状态。
| 名称 | 默认值 | 说明 |
|---------------------------|---------------|--------------------|
| CAMERA_STATUS_APPEAR | 0 | 相机存在。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_STATUS_DISAPPEAR | 1 | 相机不存在。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_STATUS_AVAILABLE | 2 | 相机就绪。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_STATUS_UNAVAILABLE | 3 | 相机未就绪。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| ------------------------- | ------ | ------------ |
| CAMERA_STATUS_APPEAR | 0 | 相机存在。 |
| CAMERA_STATUS_DISAPPEAR | 1 | 相机不存在。 |
| CAMERA_STATUS_AVAILABLE | 2 | 相机就绪。 |
| CAMERA_STATUS_UNAVAILABLE | 3 | 相机未就绪。 |
## CameraPosition
枚举，相机方向。
| 名称 | 默认值 | 说明 |
|-----------------------------|---------------|-----------------------|
| CAMERA_POSITION_UNSPECIFIED | 0 | 未指定方向相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_POSITION_BACK | 1 | 后置相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_POSITION_FRONT | 2 | 前置相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| --------------------------- | ------ | ---------------- |
| CAMERA_POSITION_UNSPECIFIED | 0 | 未指定方向相机。 |
| CAMERA_POSITION_BACK | 1 | 后置相机。 |
| CAMERA_POSITION_FRONT | 2 | 前置相机。 |
## CameraType
枚举，相机类型。
| 名称 | 默认值 | 说明 |
|-------------------------|---------------|-------------------------|
| CAMERA_TYPE_UNSPECIFIED | 0 | 未指定相机类型。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_TYPE_WIDE_ANGLE | 1 | 广角相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_TYPE_ULTRA_WIDE | 2 | 超级广角相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_TYPE_TELEPHOTO | 3 | 长焦相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_TYPE_TRUE_DEPTH | 4 | 深度相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| ----------------------- | ------ | ---------------- |
| CAMERA_TYPE_UNSPECIFIED | 0 | 未指定相机类型。 |
| CAMERA_TYPE_WIDE_ANGLE | 1 | 广角相机。 |
| CAMERA_TYPE_ULTRA_WIDE | 2 | 超级广角相机。 |
| CAMERA_TYPE_TELEPHOTO | 3 | 长焦相机。 |
| CAMERA_TYPE_TRUE_DEPTH | 4 | 深度相机。 |
## ConnectionType
枚举，相机连接类型。
| 名称 | 默认值 | 说明 |
|------------------------------|---------------|----------------------------|
| CAMERA_CONNECTION_BUILT_IN | 0 | 内置相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_CONNECTION_USB_PLUGIN | 1 | 外置USB相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_CONNECTION_REMOTE | 2 | 分布式相机。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
## CameraFormat
枚举，照片格式。
| 名称 | 默认值 | 说明 |
|----------------------------|---------------|---------------------|
| CAMERA_FORMAT_YCRCb_420_SP | 1003 | YCRCb格式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_FORMAT_JPEG | 2000 | JPEG格式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_FORMAT_AVC | 3000 | AVC格式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| CAMERA_FORMAT_HEVC | 3001 | HEVC格式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| 名称 | 默认值 | 说明 |
| ---------------------------- | ------ | ------------- |
| CAMERA_CONNECTION_BUILT_IN | 0 | 内置相机。 |
| CAMERA_CONNECTION_USB_PLUGIN | 1 | 外置USB相机。 |
| CAMERA_CONNECTION_REMOTE | 2 | 分布式相机。 |
## CameraManager
......@@ -140,9 +136,9 @@ getCameras(callback: AsyncCallback<Array<Camera\>\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|--------------------------------|-----------|---------------------------------------------------------|
| callback | AsyncCallback<Array<[Camera](#camera)\>\> | 是 | 使用callback方式获取支持的相机列表。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback<Array<[Camera](#camera)\>\> | 是 | 使用callback方式获取支持的相机列表。 |
**示例：**
......@@ -166,9 +162,9 @@ getCameras(): Promise<Array<Camera\>\>
**返回值：**
| 类型 | 说明 |
|------------------------|--------------------------------------------------------|
| Promise<Array<[Camera](#camera)\>\> | 使用promise获取支持相机列表。 |
| 类型 | 说明 |
| ----------------------------------- | ----------------------------- |
| Promise<Array<[Camera](#camera)\>\> | 使用promise获取支持相机列表。 |
**示例：**
......@@ -189,10 +185,10 @@ createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput\>): void
**参数：**
| 名称 | 默认值 | 必填 | 说明 |
|----------|------------------------------|-----------|--------------------------------------------------|
| cameraId | string | 是 | 指定相机ID。 |
| callback | AsyncCallback<[CameraInput](#camerainput)\> | 是 | 回调函数，用于获取CameraInput实例。 |
| 名称 | 默认值 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ----------------------------------- |
| cameraId | string | 是 | 指定相机ID。 |
| callback | AsyncCallback<[CameraInput](#camerainput)\> | 是 | 回调函数，用于获取CameraInput实例。 |
**示例：**
......@@ -216,15 +212,15 @@ createCameraInput(cameraId: string): Promise<CameraInput\>
**参数：**
| 名称 | 默认值 | 必填 | 说明 |
|----------|-----------------------------|-----------|------------------------------------------|
| cameraId | string | 是 | 指定相机ID。 |
| 名称 | 默认值 | 必填 | 说明 |
| -------- | ------ | ---- | ------------ |
| cameraId | string | 是 | 指定相机ID。 |
**返回值：**
| 类型 | 说明 |
|-------------------------|-------------------------------------------------|
| Promise<[CameraInput](#camerainput)\> | 使用Promise的方式获取CameraInput的实例。 |
| 类型 | 说明 |
| ------------------------------------- | ---------------------------------------- |
| Promise<[CameraInput](#camerainput)\> | 使用Promise的方式获取CameraInput的实例。 |
**示例：**
......@@ -244,10 +240,10 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------------|----------------------------|-----------|---------------------------------------------------|
| cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。 |
| cameraType | [CameraType](#cameratype) | 是 | 相机类型。 |
| 名称 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------------- | ---- | ----------------------------------- |
| cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。 |
| cameraType | [CameraType](#cameratype) | 是 | 相机类型。 |
| callback | AsyncCallback<[CameraInput](#camerainput)\> | 是 | 回调函数，用于获取CameraInput实例。 |
**示例：**
......@@ -272,15 +268,15 @@ createCameraInput(position: CameraPosition, type: CameraType): Promise<CameraInp
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------------|----------------------------|-----------|----------------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------- | ---- | ---------- |
| cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。 |
| cameraType | [CameraType](#cameratype) | 是 | 相机类型。 |
**返回值：**
| 类型 | 说明 |
|-------------------------|-------------------------------------------------|
| 类型 | 说明 |
| ------------------------------------- | ---------------------------------------- |
| Promise<[CameraInput](#camerainput)\> | 使用Promise的方式获取CameraInput的实例。 |
**示例：**
......@@ -301,10 +297,10 @@ on(type: 'cameraStatus', callback: AsyncCallback<CameraStatusInfo\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :--------------------------------------------------- |
| type | string | 是 | 监听事件。 |
| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取相机状态变化信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------------------------------------- | :--- | :----------------------------------- |
| type | string | 是 | 监听事件。 |
| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取相机状态变化信息。 |
**示例：**
......@@ -319,12 +315,14 @@ cameraManager.on('cameraStatus', (cameraStatusInfo) => {
相机实例。
| 名称 | 类型 | 只读 | 说明 |
|----------------|----------------|----------|------------------------|
| cameraId | string | 是 | 相机ID。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core|
| cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| cameraType | [CameraType](#cameratype) | 是 | 相机类型。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| connectionType | [ConnectionType](#connectiontype) | 是 | 相机连接类型。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 只读 | 说明 |
| -------------- | --------------------------------- | ---- | -------------- |
| cameraId | string | 是 | 相机ID。 |
| cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。 |
| cameraType | [CameraType](#cameratype) | 是 | 相机类型。 |
| connectionType | [ConnectionType](#connectiontype) | 是 | 相机连接类型。 |
**示例：**
......@@ -343,10 +341,12 @@ var cameraId = cameraObj.connectionType;
相机状态信息。
| 名称 | 类型 | 说明 |
|----------------|----------------|------------------|
| camera | [Camera](#camera) | 相机信息。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| status | [CameraStatus](#camerastatus) | 相机状态。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 说明 |
| ------ | ----------------------------- | ---------- |
| camera | [Camera](#camera) | 相机信息。 |
| status | [CameraStatus](#camerastatus) | 相机状态。 |
## CameraInput
......@@ -363,9 +363,9 @@ getCameraId(callback: AsyncCallback<string\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|------------------------|-----------|---------------------------------------|
| callback | AsyncCallback<string\> | 是 | 回调函数，用于获取相机ID。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------------- |
| callback | AsyncCallback<string\> | 是 | 回调函数，用于获取相机ID。 |
**示例：**
......@@ -389,9 +389,9 @@ getCameraId(): Promise<string\>
**返回值：**
| 类型 | 说明 |
|------------------------|--------------------------------------|
| Promise<string\> | 使用Promise的方式获取相机ID。 |
| 类型 | 说明 |
| ---------------- | ----------------------------- |
| Promise<string\> | 使用Promise的方式获取相机ID。 |
**示例：**
......@@ -401,204 +401,6 @@ cameraInput.getCameraId().then((cameraId) => {
})
```
### getSupportedSizes
getSupportedSizes\(format: CameraFormat, callback: AsyncCallback<Array<Size\>\>\): void
根据指定格式，获取相机支持的分辨率，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|------------------------------|-----------|---------------------------------------------|
| format | [CameraFormat](#cameraformat) | 是 | 指定照片格式。 |
| callback | AsyncCallback<Array<[Size](js-apis-image.md#Size)\>\> | 是 | 回调函数，用于获取相机支持分辨率。 |
**示例：**
```
cameraInput.getSupportedSizes(format, (err, sizes) => {
if (err) {
console.error('Failed to get the supported sizes. ${err.message}');
return;
}
console.log('Callback returned with the supported sizes:' + sizes);
})
```
### getSupportedSizes
getSupportedSizes\(format: CameraFormat\): Promise<Array<Size\>\>
根据指定格式，获取相机支持的分辨率，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | -------------- |
| format | [CameraFormat](#cameraformat) | 是 | 指定照片格式。 |
**返回值：**
| 类型 | 说明 |
|------------------------|---------------------------------------------|
| Promise<Array<[Size](js-apis-image.md#Size)\>\> | 使用Promise的方式获取相机支持的分辨率。 |
**示例：**
```
cameraInput.getSupportedSizes(format).then((sizes) => {
console.log('Promise returned with supported sizes: ' + sizes);
})
```
### getSupportedPreviewFormats
getSupportedPreviewFormats\(callback: AsyncCallback<Array<CameraFormat\>\>\): void
获取相机预览图片的支持格式，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback<Array<[CameraFormat](#cameraformat)\>\> | 是 | 回调函数，用于获取预览图片的支持格式。 |
**示例：**
```
cameraInput.getSupportedPreviewFormats((err, previewFormats) => {
if (err) {
console.error('Failed to get the supported preview formats. ${err.message}');
return;
}
console.log('Callback returned with supported preview formats: ' + previewFormats.length);
})
```
### getSupportedPreviewFormats
getSupportedPreviewFormats\(\): Promise<Array<CameraFormat\>\>
获取相机预览图片的支持格式，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：**
| 类型 | 说明 |
|--------------------------------|-------------------------------------------------------|
| Promise<Array<[CameraFormat](#cameraformat)\>\> | 使用Promise的方式获取预览图片的支持格式。 |
**示例：**
```
cameraInput.getSupportedPreviewFormats().then((previewFormats) => {
console.log('Promise returned with supported preview formats.' + previewFormats.length);
})
```
### getSupportedPhotoFormats
getSupportedPhotoFormats\(callback: AsyncCallback<Array<CameraFormat\>\>\): void
获取照片的支持格式，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|--------------------------------------|-----------|-------------------------------------------------|
| callback | AsyncCallback<Array<[CameraFormat](#cameraformat)\>\> | 是 | 回调函数，用于获取支持的照片格式。 |
**示例：**
```
cameraInput.getSupportedPhotoFormats((err, photoFormats) => {
if (err) {
console.error('Failed to get the supported photo formats. ${err.message}');
return;
}
console.log('Callback returned with supported photo formats');
})
```
### getSupportedPhotoFormats
getSupportedPhotoFormats\(\): Promise<Array<CameraFormat\>\>
获取照片的支持格式，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：**
| 类型 | 说明 |
|--------------------------------|---------------------------------------------------|
| Promise<Array<[CameraFormat](#cameraformat)\>\> | 使用Promise的方式获取支持的照片格式。 |
**示例：**
```
cameraInput.getSupportedPhotoFormats().then((photoFormats) => {
console.log('Promise returned with supported photo formats.' + photoFormats.length);
})
```
### getSupportedVideoFormats
getSupportedVideoFormats\(callback: AsyncCallback<Array<CameraFormat\>\>\): void
获取录制视频的支持格式，通过注册回调函数获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|--------------------------------------|-----------|-------------------------------------------------|
| callback | AsyncCallback<Array<[CameraFormat](#cameraformat)\>\> | 是 | 回调函数，用于获取支持的视频格式。 |
**示例：**
```
cameraInput.getSupportedVideoFormats((err, videoFormats) => {
if (err) {
console.error('Failed to get the supported video formats. ${err.message}');
return;
}
console.log('Callback returned with supported video formats : ' + videoFormats.length);
})
```
### getSupportedVideoFormats
getSupportedVideoFormats\(\): Promise<Array<CameraFormat\>\>
获取录制视频的支持格式，通过Promise获取结果。
**系统能力：** SystemCapability.Multimedia.Camera.Core
**返回值：**
| 类型 | 说明 |
|--------------------------------|---------------------------------------------------|
| Promise<Array<[CameraFormat](#cameraformat)\>\> | 使用Promise的方式获取支持的视频格式。 |
**示例：**
```
cameraInput.getSupportedVideoFormats().then((videoFormats) => {
console.log('Promise returned with supported video formats.' + videoFormats.length);
})
```
### hasFlash
......@@ -610,9 +412,9 @@ hasFlash(callback: AsyncCallback<boolean\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|-------------------------|-----------|----------------------------------------------------|
| callback | AsyncCallback<boolean\> | 是 | 回调函数，返回true表示设备支持闪光灯。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback<boolean\> | 是 | 回调函数，返回true表示设备支持闪光灯。 |
**示例：**
......@@ -636,9 +438,9 @@ hasFlash(): Promise<boolean\>
**返回值：**
| 类型 | 说明 |
|-----------------------|--------------------------------------------------------|
| Promise<boolean\> | 使用Promise的方式获取结果，返回true表示设备支持闪光灯。 |
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------- |
| Promise<boolean\> | 使用Promise的方式获取结果，返回true表示设备支持闪光灯。 |
**示例：**
......@@ -658,10 +460,10 @@ isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean\>): v
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|----------------------------------------------------|
| flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 |
| callback | AsyncCallback<boolean\> | 是 | 回调函数，返回true表示支持该闪光灯模式。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | ---------------------------------------- |
| flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 |
| callback | AsyncCallback<boolean\> | 是 | 回调函数，返回true表示支持该闪光灯模式。 |
**示例：**
......@@ -685,15 +487,15 @@ isFlashModeSupported(flashMode: FlashMode): Promise<boolean\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|----------------------------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | ---------------- |
| flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 |
**返回值：**
| 类型 | 说明 |
|-----------------------|---------------------------------------------------|
| Promise<boolean\> | 使用Promise的方式获取结果，返回true表示设备支持该闪光灯模式。 |
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------------ |
| Promise<boolean\> | 使用Promise的方式获取结果，返回true表示设备支持该闪光灯模式。 |
**示例：**
......@@ -718,10 +520,10 @@ setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|----------------------------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | ------------------------ |
| flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -750,15 +552,15 @@ setFlashMode(flashMode: FlashMode): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|----------------------------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | ---------------- |
| flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 |
**返回值：**
| 类型 | 说明 |
|-----------------------|-----------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -778,9 +580,9 @@ getFlashMode(callback: AsyncCallback<FlashMode\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|---------------------------|-----------|------------------------------------------------|
| callback | AsyncCallback<[FlashMode](#flashmode)\> | 是 | 回调函数，用于获取当前设备的闪光灯模式。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback<[FlashMode](#flashmode)\> | 是 | 回调函数，用于获取当前设备的闪光灯模式。 |
**示例：**
......@@ -804,9 +606,9 @@ getFlashMode(): Promise<FlashMode\>
**返回值：**
| 类型 | 说明 |
|-----------------------|---------------------------------------------------|
| Promise<[FlashMode](#flashmode)\> | 使用Promise的方式获取当前的闪光灯模式。 |
| 类型 | 说明 |
| --------------------------------- | --------------------------------------- |
| Promise<[FlashMode](#flashmode)\> | 使用Promise的方式获取当前的闪光灯模式。 |
**示例：**
......@@ -826,10 +628,10 @@ isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|----------------------------------------------------|
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
| callback | AsyncCallback<boolean\> | 是 | 回调函数，返回true表示支持该焦距模式。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
| callback | AsyncCallback<boolean\> | 是 | 回调函数，返回true表示支持该焦距模式。 |
**示例：**
......@@ -853,15 +655,15 @@ isFocusModeSupported(afMode: FocusMode): Promise<boolean\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|----------------------------------------|-----------|-------------|
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------- |
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
**返回值：**
| 类型 | 说明 |
|-----------------------|---------------------------------------------------|
| Promise<boolean\> | 使用Promise的方式获取结果，返回true表示设备支持该焦距模式。 |
| 类型 | 说明 |
| ----------------- | ----------------------------------------------------------- |
| Promise<boolean\> | 使用Promise的方式获取结果，返回true表示设备支持该焦距模式。 |
**示例：**
......@@ -883,10 +685,10 @@ setFocusMode(afMode: FocusMode, callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|------------------------------------|
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------ |
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -912,15 +714,15 @@ setFocusMode(afMode: FocusMode): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|-----------------------------------------|-----------|-------------|
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------- | ---- | ---------------- |
| afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 |
**返回值：**
| 类型 | 说明 |
|-----------------------|-----------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -940,9 +742,9 @@ getFocusMode(callback: AsyncCallback<FocusMode\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|---------------------------|-----------|------------------------------------------------|
| callback | AsyncCallback<[FocusMode](#focusmode)\> | 是 | 回调函数，用于获取当前设备的焦距模式。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback<[FocusMode](#focusmode)\> | 是 | 回调函数，用于获取当前设备的焦距模式。 |
**示例：**
......@@ -988,9 +790,9 @@ getZoomRatioRange\(callback: AsyncCallback<Array<number\>\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|--------------------------------|-----------|-------------------------------------------------|
| callback | AsyncCallback<Array<number\>\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------ | ---- | ------------------------ |
| callback | AsyncCallback<Array<number\>\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1014,8 +816,8 @@ getZoomRatioRange\(\): Promise<Array<number\>\>
**返回值：**
| 类型 | 说明 |
|------------------------|---------------------------------------------|
| 类型 | 说明 |
| ------------------------ | ------------------------------------------- |
| Promise<Array<number\>\> | 使用Promise的方式获取当前的可变焦距比范围。 |
**示例：**
......@@ -1036,10 +838,10 @@ setZoomRatio(zoomRatio: number, callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|------------------------|-----------|------------------------------------|
| zoomRatio | number | 是 | 可变焦距比。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | -------------------- | ---- | ------------------------ |
| zoomRatio | number | 是 | 可变焦距比。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1063,15 +865,15 @@ setZoomRatio(zoomRatio: number): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|----------|-----------|-------------|
| zoomRatio | number | 是 | 可变焦距比。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------ |
| zoomRatio | number | 是 | 可变焦距比。 |
**返回值：**
| 类型 | 说明 |
|-----------------------|-----------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1091,9 +893,9 @@ getZoomRatio(callback: AsyncCallback<number\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-----------|---------------------------|-----------|------------------------------------------------------|
| callback | AsyncCallback<number\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------ |
| callback | AsyncCallback<number\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1139,9 +941,9 @@ release\(callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1165,9 +967,9 @@ release(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1187,10 +989,10 @@ on(type: 'focusStateChange', callback: AsyncCallback<FocusState\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'focusStateChange'，即焦距状态变化事件。 |
| callback | AsyncCallback<[FocusState](#focusstate)\> | 是 | 回调函数，用于获取焦距状态。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------------------------- | :--- | :------------------------------------------------------- |
| type | string | 是 | 监听事件，固定为'focusStateChange'，即焦距状态变化事件。 |
| callback | AsyncCallback<[FocusState](#focusstate)\> | 是 | 回调函数，用于获取焦距状态。 |
**示例：**
......@@ -1210,10 +1012,10 @@ on('error', callback: ErrorCallback<CameraInputError\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<CameraInputError\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------------------- | :--- | :------------------------ |
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<CameraInputError\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1228,33 +1030,39 @@ cameraInput.on('error', (cameraInputError) => {
枚举，闪光灯模式。
| 名称 | 默认值 | 说明 |
|------------------------|---------------|------------------------|
| FLASH_MODE_CLOSE | 0 | 闪光灯关闭。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| FLASH_MODE_OPEN | 1 | 闪光灯开启。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| FLASH_MODE_AUTO | 2 | 自动闪光灯。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| FLASH_MODE_ALWAYS_OPEN | 3 | 闪光灯常亮。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| ---------------------- | ------ | ------------ |
| FLASH_MODE_CLOSE | 0 | 闪光灯关闭。 |
| FLASH_MODE_OPEN | 1 | 闪光灯开启。 |
| FLASH_MODE_AUTO | 2 | 自动闪光灯。 |
| FLASH_MODE_ALWAYS_OPEN | 3 | 闪光灯常亮。 |
## FocusMode
枚举，焦距模式。
| 名称 | 默认值 | 说明 |
|----------------------------|---------------|----------------------------|
| FOCUS_MODE_MANUAL | 0 | 手动变焦模式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| FOCUS_MODE_CONTINUOUS_AUTO | 1 | 连续自动变焦模式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| FOCUS_MODE_AUTO | 2 | 自动变焦模式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| FOCUS_MODE_LOCKED | 3 | 定焦模式。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| -------------------------- | ------ | ------------------ |
| FOCUS_MODE_MANUAL | 0 | 手动变焦模式。 |
| FOCUS_MODE_CONTINUOUS_AUTO | 1 | 连续自动变焦模式。 |
| FOCUS_MODE_AUTO | 2 | 自动变焦模式。 |
| FOCUS_MODE_LOCKED | 3 | 定焦模式。 |
## FocusState
枚举，焦距状态。
| 名称 | 默认值 | 说明 |
| --------------------- | ------ | ------------------------------------------------------------ |
| FOCUS_STATE_SCAN | 0 | 扫描状态。<br/> 系统能力 : SystemCapability.Multimedia.Camera.Core |
| FOCUS_STATE_FOCUSED | 1 | 相机已对焦。<br/> 系统能力 : SystemCapability.Multimedia.Camera.Core |
| FOCUS_STATE_UNFOCUSED | 2 | 相机未对焦。<br/> 系统能力 : SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| --------------------- | ------ | ------------ |
| FOCUS_STATE_SCAN | 0 | 扫描状态。 |
| FOCUS_STATE_FOCUSED | 1 | 相机已对焦。 |
| FOCUS_STATE_UNFOCUSED | 2 | 相机未对焦。 |
## camera.createCaptureSession
......@@ -1266,10 +1074,10 @@ createCaptureSession\(context: Context, callback: AsyncCallback<CaptureSession\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|--------------------------------|-----------|-----------------------------------------------------|
| context | Context | 是 | 应用上下文。 |
| callback | AsyncCallback<[CaptureSession](#capturesession)\> | 是 | 回调函数，用于获取CaptureSession实例。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | -------------------------------------- |
| context | Context | 是 | 应用上下文。 |
| callback | AsyncCallback<[CaptureSession](#capturesession)\> | 是 | 回调函数，用于获取CaptureSession实例。 |
**示例：**
......@@ -1293,14 +1101,14 @@ createCaptureSession(context: Context\): Promise<CaptureSession\>;
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|-------------------------------|-----------|-----------------------------------------------------|
| context | Context | 是 | 应用上下文。 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------ |
| context | Context | 是 | 应用上下文。 |
**返回值：**
| 类型 | 说明 |
|---------------------------|---------------------------------------------------|
| 类型 | 说明 |
| ------------------------------------------- | ----------------------------------------- |
| Promise<[CaptureSession](#capturesession)\> | 使用Promise的方式获取CaptureSession实例。 |
**示例：**
......@@ -1325,9 +1133,9 @@ beginConfig\(callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1351,9 +1159,9 @@ beginConfig\(\): Promise<void\>
**返回值：**
| 类型 | 说明 |
|---------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1374,9 +1182,9 @@ commitConfig\(callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|---------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1400,9 +1208,9 @@ commitConfig\(\): Promise<void\>
**返回值：**
| 类型 | 说明 |
|---------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1422,10 +1230,10 @@ addInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-------------|----------------------|-----------|---------------------------------------------|
| cameraInput | [CameraInput](#camerainput) | 是 | 需要添加的CameraInput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| cameraInput | [CameraInput](#camerainput) | 是 | 需要添加的CameraInput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1449,14 +1257,14 @@ addInput\(cameraInput: CameraInput\): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-------------|---------------------|-----------|-------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| cameraInput | [CameraInput](#camerainput) | 是 | 需要添加的CameraInput实例。 |
**返回值：**
| 类型 | 说明 |
|----------------|------------------------------------|
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1477,10 +1285,10 @@ addOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|----------------------|-----------|-------------------------------------|
| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的PreviewOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----------------------------- |
| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的PreviewOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1504,14 +1312,14 @@ addOutput\(previewOutput: PreviewOutput\): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|--------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----------------------------- |
| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要添加的PreviewOutput实例。 |
**返回值：**
| 类型 | 说明 |
|----------------|-----------------------------------|
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1532,10 +1340,10 @@ addOutput\(photoOutput: PhotoOutput, callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|-------------------------------------|
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1559,14 +1367,14 @@ addOutput\(photoOutput: PhotoOutput\): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|--------------------------------|
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
**返回值：**
| 类型 | 说明 |
|---------------|-----------------------------------|
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise\<void> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1587,9 +1395,9 @@ addOutput\(videoOutput: VideoOutput, callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|-------------------------------------|
| videoOutput | [VideoOutput](#videooutput) | 是 | 需要添加的VideoOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| videoOutput | [VideoOutput](#videooutput) | 是 | 需要添加的VideoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1642,10 +1450,10 @@ removeInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-------------|----------------------|-----------|------------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| cameraInput | [CameraInput](#camerainput) | 是 | 需要移除的CameraInput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1669,14 +1477,14 @@ removeInput\(cameraInput: CameraInput\): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|-------------|---------------------|-----------|---------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| cameraInput | [CameraInput](#camerainput) | 是 | 需要移除的CameraInput实例。 |
**返回值：**
| 类型 | 说明 |
|----------------|-----------------------------------|
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise\<void> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1697,10 +1505,10 @@ removeOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): vo
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|----------------------|-----------|------------------------------------|
| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的PreviewOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----------------------------- |
| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的PreviewOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1724,15 +1532,15 @@ removeOutput(previewOutput: PreviewOutput): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|-----------------------------------|
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----------------------------- |
| previewOutput | [PreviewOutput](#previewoutput) | 是 | 需要移除的PreviewOutput实例。 |
**返回值：**
| 类型 | 说明 |
|---------------|---------------------------------------------|
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
......@@ -1754,10 +1562,10 @@ removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|----------------------|-----------|------------------------------------|
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1781,16 +1589,16 @@ removeOutput(photoOutput: PhotoOutput): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|---------------------------------|
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| photoOutput | [PhotoOutput](#photooutput) | 是 | 需要添加的PhotoOutput实例。 |
**返回值：**
| 类型 | 说明 |
|---------------|------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1811,10 +1619,10 @@ removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|----------------------|-----------|------------------------------------|
| videoOutput | [VideoOutput](#videooutput) | 是 | 需要添加的VideoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| videoOutput | [VideoOutput](#videooutput) | 是 | 需要添加的VideoOutput实例。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1838,16 +1646,16 @@ removeOutput(videoOutput: VideoOutput): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|---------------|---------------------|-----------|---------------------------------|
| videoOutput | [VideoOutput](#videooutput) | 是 | 需要添加的VideoOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | --------------------------- |
| videoOutput | [VideoOutput](#videooutput) | 是 | 需要添加的VideoOutput实例。 |
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1868,9 +1676,9 @@ start\(callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1894,9 +1702,9 @@ start\(\): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|-----------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1917,9 +1725,9 @@ stop\(callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1943,9 +1751,9 @@ stop(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|-----------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -1965,9 +1773,9 @@ release\(callback: AsyncCallback<void\>\): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -1991,9 +1799,9 @@ release(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2013,10 +1821,10 @@ on(type: 'error', callback: ErrorCallback<CaptureSessionError\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<CaptureSessionError\> | 是 | 回调函数，用于获取错误信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------------------- | :--- | :--------------------------- |
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<CaptureSessionError\> | 是 | 回调函数，用于获取错误信息。 |
**示例：**
......@@ -2036,10 +1844,10 @@ createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput\>):
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|------------|-------------------------------|-----------|----------------------------------------------------|
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
| callback | AsyncCallback<[PreviewOutput](#previewoutput)\> | 是 | 回调函数，用于获取PreviewOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ------------------------------------- |
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
| callback | AsyncCallback<[PreviewOutput](#previewoutput)\> | 是 | 回调函数，用于获取PreviewOutput实例。 |
**示例：**
......@@ -2063,15 +1871,15 @@ createPreviewOutput(surfaceId: string): Promise\<PreviewOutput>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|------------|-----------------|-----------|----------------------------------------------------|
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------------------------- |
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
**返回值：**
| 类型 | 说明 |
|-------------------------|---------------------------------------------------|
| Promise<[PreviewOutput](#previewoutput)\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| ----------------------------------------- | --------------------------- |
| Promise<[PreviewOutput](#previewoutput)\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2095,9 +1903,9 @@ release(callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2121,9 +1929,9 @@ release(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|-----------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2144,10 +1952,10 @@ on(type: 'frameStart', callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------- | :-------- | :----------------------------------|
| type | string | 是 | 监听事件，固定为'frameStart'，即帧启动事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------- | :--- | :------------------------------------------- |
| type | string | 是 | 监听事件，固定为'frameStart'，即帧启动事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2167,10 +1975,10 @@ on(type: 'frameEnd', callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------- | :-------- | :----------------------------------|
| type | string | 是 | 监听事件，固定为'frameEnd'，即帧结束事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 监听事件，固定为'frameEnd'，即帧结束事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2190,10 +1998,10 @@ on(type: 'error', callback: ErrorCallback<PreviewOutputError\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<PreviewOutputError\> | 是 | 回调函数，用于获取错误信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------------------- | :--- | :--------------------------- |
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<PreviewOutputError\> | 是 | 回调函数，用于获取错误信息。 |
**示例：**
......@@ -2213,10 +2021,10 @@ createPhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput\>): voi
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|------------|-------------------------------|-----------|----------------------------------------------------|
| surfaceId | string | 是 | 从ImageReceiver获取的Surface ID。 |
| callback | AsyncCallback<[PhotoOutput](#photooutput)\> | 是 | 回调函数，用于获取PhotoOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------------- | ---- | ----------------------------------- |
| surfaceId | string | 是 | 从ImageReceiver获取的Surface ID。 |
| callback | AsyncCallback<[PhotoOutput](#photooutput)\> | 是 | 回调函数，用于获取PhotoOutput实例。 |
**示例：**
......@@ -2240,15 +2048,15 @@ createPhotoOutput(surfaceId: string): Promise<PhotoOutput\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|------------|-----------------|-----------|----------------------------------------------------|
| surfaceId | string | 是 | 从ImageReceiver获取的Surface ID。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | --------------------------------- |
| surfaceId | string | 是 | 从ImageReceiver获取的Surface ID。 |
**返回值：**
| 类型 | 说明 |
|-------------------------|--------------------------------------------------|
| Promise<[PhotoOutput](#photooutput)\> | 使用Promise的方式获取PhotoOutput实例。 |
| 类型 | 说明 |
| ------------------------------------- | -------------------------------------- |
| Promise<[PhotoOutput](#photooutput)\> | 使用Promise的方式获取PhotoOutput实例。 |
**示例：**
......@@ -2261,32 +2069,38 @@ camera.createPhotoOutput(surfaceId).then((photoOutput) => {
枚举，图片旋转角度。
| 名称 | 默认值 | 说明 |
|--------------|---------------|----------------------------------------|
| ROTATION_0 | 0 | 图片旋转0度。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| ROTATION_90 | 90 | 图片旋转90度。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| ROTATION_180 | 180 | 图片旋转180度。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| ROTATION_270 | 270 | 图片旋转270度。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| ------------ | ------ | --------------- |
| ROTATION_0 | 0 | 图片旋转0度。 |
| ROTATION_90 | 90 | 图片旋转90度。 |
| ROTATION_180 | 180 | 图片旋转180度。 |
| ROTATION_270 | 270 | 图片旋转270度。 |
## QualityLevel
枚举，图片质量。
| 名称 | 默认值 | 说明 |
|----------------------|---------------|----------------------|
| QUALITY_LEVEL_HIGH | 0 | 图片质量高。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| QUALITY_LEVEL_MEDIUM | 1 | 图片质量中等。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| QUALITY_LEVEL_LOW | 2 | 图片质量差。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| -------------------- | ------ | -------------- |
| QUALITY_LEVEL_HIGH | 0 | 图片质量高。 |
| QUALITY_LEVEL_MEDIUM | 1 | 图片质量中等。 |
| QUALITY_LEVEL_LOW | 2 | 图片质量差。 |
## PhotoCaptureSetting
拍摄照片的设置。
| 名称 | 类型 | 必填 | 说明 |
|----------|---------------|-----------|---------------------|
| quality | [QualityLevel](#qualitylevel) | 否 | 图片质量。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
| rotation | [ImageRotation](#imagerotation) | 否 | 图片旋转角度。<br/>**系统能力：** SystemCapability.Multimedia.Camera.Core |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | -------------- |
| quality | [QualityLevel](#qualitylevel) | 否 | 图片质量。 |
| rotation | [ImageRotation](#imagerotation) | 否 | 图片旋转角度。 |
## PhotoOutput
......@@ -2303,9 +2117,9 @@ capture(callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|---------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2329,10 +2143,10 @@ capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| setting | [PhotoCaptureSetting](#photocapturesetting) | 是 | 拍照设置。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ------------------------ |
| setting | [PhotoCaptureSetting](#photocapturesetting) | 是 | 拍照设置。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2356,15 +2170,15 @@ capture(setting?: PhotoCaptureSetting): Promise<void\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|---------------------|-----------|----------------------------------------------|
| setting | [PhotoCaptureSetting](#photocapturesetting) | 否 | 拍照设置。 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------- | ---- | ---------- |
| setting | [PhotoCaptureSetting](#photocapturesetting) | 否 | 拍照设置。 |
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2385,9 +2199,9 @@ release(callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2411,9 +2225,9 @@ release(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2434,10 +2248,10 @@ on(type: 'captureStart', callback: AsyncCallback<number\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'captureStart'，即拍照启动事件。 |
| callback | AsyncCallback<number\> | 是 | 使用callback的方式获取Capture ID。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :--- | :----------------------------------------------- |
| type | string | 是 | 监听事件，固定为'captureStart'，即拍照启动事件。 |
| callback | AsyncCallback<number\> | 是 | 使用callback的方式获取Capture ID。 |
**示例：**
......@@ -2457,10 +2271,10 @@ on(type: 'frameShutter', callback: AsyncCallback<FrameShutterInfo\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'frameShutter'，即帧刷新事件。 |
| callback | AsyncCallback<FrameShutterInfo\> | 是 | 回调函数，用于获取相关信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------------------- | :--- | :--------------------------------------------- |
| type | string | 是 | 监听事件，固定为'frameShutter'，即帧刷新事件。 |
| callback | AsyncCallback<FrameShutterInfo\> | 是 | 回调函数，用于获取相关信息。 |
**示例：**
......@@ -2481,10 +2295,10 @@ on(type: 'captureEnd', callback: AsyncCallback<CaptureEndInfo\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'captureEnd'，即拍照停止事件。 |
| callback | AsyncCallback<CaptureEndInfo\> | 是 | 回调函数，用于获取相关信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :----------------------------- | :--- | :--------------------------------------------- |
| type | string | 是 | 监听事件，固定为'captureEnd'，即拍照停止事件。 |
| callback | AsyncCallback<CaptureEndInfo\> | 是 | 回调函数，用于获取相关信息。 |
**示例：**
......@@ -2505,10 +2319,10 @@ on(type: 'error', callback: ErrorCallback<PhotoOutputError\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<PhotoOutputError\> | 是 | 回调函数，用于获取错误信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------------------- | :--- | :--------------------------- |
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | ErrorCallback<PhotoOutputError\> | 是 | 回调函数，用于获取错误信息。 |
**示例：**
......@@ -2528,10 +2342,10 @@ createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput\>): voi
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|------------|-------------------------------|-----------|----------------------------------------------------|
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
| callback | AsyncCallback<[VideoOutput](#videooutput)\> | 是 | 回调函数，用于获取VideoOutput实例。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------------- | ---- | ----------------------------------- |
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
| callback | AsyncCallback<[VideoOutput](#videooutput)\> | 是 | 回调函数，用于获取VideoOutput实例。 |
**示例：**
......@@ -2555,9 +2369,9 @@ createVideoOutput(surfaceId: string): Promise<VideoOutput\>
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|------------|-----------------|-----------|----------------------------------------------------|
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | --------------------------------- |
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
**返回值：**
......@@ -2587,9 +2401,9 @@ start(callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2613,9 +2427,9 @@ start(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2636,9 +2450,9 @@ stop(callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2662,9 +2476,9 @@ stop(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2684,9 +2498,9 @@ release(callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2710,9 +2524,9 @@ release(): Promise<void\>
**返回值：**
| 类型 | 说明 |
|----------------|---------------------------------------------|
| Promise<void\> | 使用Promise的方式获取结果。 |
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise<void\> | 使用Promise的方式获取结果。 |
**示例：**
......@@ -2733,10 +2547,10 @@ on(type: 'frameStart', callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------- | :-------- | :----------------------------------|
| type | string | 是 | 监听事件，固定为'frameStart'，即视频帧开启事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------- | :--- | :----------------------------------------------- |
| type | string | 是 | 监听事件，固定为'frameStart'，即视频帧开启事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2756,10 +2570,10 @@ on(type: 'frameEnd', callback: AsyncCallback<void\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------- | :-------- | :----------------------------------|
| type | string | 是 | 监听事件，固定为'frameEnd'，即视频帧结束事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :------------------- | :--- | :--------------------------------------------- |
| type | string | 是 | 监听事件，固定为'frameEnd'，即视频帧结束事件。 |
| callback | AsyncCallback<void\> | 是 | 回调函数，用于获取结果。 |
**示例：**
......@@ -2779,10 +2593,10 @@ on(type: 'error', callback: ErrorCallback<VideoOutputError\>): void
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | Callback<VideoOutputError\> | 是 | 回调函数，用于获取错误信息。 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :-------------------------- | :--- | :--------------------------- |
| type | string | 是 | 监听事件，固定为'error'。 |
| callback | Callback<VideoOutputError\> | 是 | 回调函数，用于获取错误信息。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 0a580e44
......@@ -10,7 +10,7 @@
- 音频播放（[AudioPlayer](#audioplayer)）
- 视频播放（[VideoPlayer](#videoplayer8)）
- 音频录制（[AudioRecorder](#audiorecorder)）
- 视频录制（[VideoRecorder](#VideoRecorder<sup>8+</sup>)）
- 视频录制（[VideoRecorder](#videoRecorder8)）
后续将提供以下功能：DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
......@@ -228,16 +228,16 @@ Codec MIME类型枚举。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。
| 名称 | 值 | 说明 |
| ------------ | --------------------- | ------------------------------------------------------------ |
| VIDEO_H263 | 'video/h263' | 表示视频/h263类型。|
| VIDEO_AVC | 'video/avc' | 表示视频/avc类型。 |
| VIDEO_MPEG2 | 'video/mpeg2' | 表示视频/mpeg2类型。 |
| VIDEO_MPEG4 | 'video/mp4v-es' | 表示视频/mpeg4类型。 |
| VIDEO_VP8 | 'video/x-vnd.on2.vp8' | 表示视频/vp8类型。 |
| 名称 | 值 | 说明 |
| ------------ | --------------------- | ------------------------ |
| VIDEO_H263 | 'video/h263' | 表示视频/h263类型。 |
| VIDEO_AVC | 'video/avc' | 表示视频/avc类型。 |
| VIDEO_MPEG2 | 'video/mpeg2' | 表示视频/mpeg2类型。 |
| VIDEO_MPEG4 | 'video/mp4v-es' | 表示视频/mpeg4类型。 |
| VIDEO_VP8 | 'video/x-vnd.on2.vp8' | 表示视频/vp8类型。 |
| AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 |
| AUDIO_VORBIS | 'audio/vorbis' | 表示音频/vorbis类型。 |
| AUDIO_FLAC | 'audio/flac' | 表示音频/flac类型。 |
| AUDIO_VORBIS | 'audio/vorbis' | 表示音频/vorbis类型。 |
| AUDIO_FLAC | 'audio/flac' | 表示音频/flac类型。 |
## MediaDescriptionKey<sup>8+</sup>
......@@ -283,7 +283,7 @@ Codec MIME类型枚举。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。<br>**支持路径示例**：<br>1、fd类型播放：fd://xx<br>![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png)<br>2、http网络播放: http://xx<br>3、hls网络播放路径：开发中<br>**注意事项**：<br>使用媒体素材需要获取读权限，否则无法正常播放。 |
| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。<br>**支持路径示例**：<br>1、fd类型播放：fd://xx<br>![](figures/zh-cn_image_url.png)<br>2、http网络播放: http://xx<br>3、hls网络播放路径：开发中<br>**注意事项**：<br>使用媒体素材需要获取读权限，否则无法正常播放。 |
| loop | boolean | 是 | 是 | 音频循环播放属性，设置为'true'表示循环播放。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置。 |
| duration | number | 是 | 否 | 音频时长。 |
......@@ -293,7 +293,7 @@ Codec MIME类型枚举。
play(): void
开始播放音频资源，需在[dataLoad](#on('play' | 'pause' | 'stop' | 'reset' | 'dataload' | 'finish' | 'volumechange'))事件成功触发后，才能调用play方法。
开始播放音频资源，需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用play方法。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
......@@ -424,7 +424,7 @@ audioPlayer = undefined;
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription1></a>
getTrackDescription(callback: AsyncCallback<Array<[MediaDescription](#mediadescription8)>>): void
getTrackDescription(callback: AsyncCallback<Array\<MediaDescription>>): void
通过回调方式获取音频轨道信息。
......@@ -460,7 +460,7 @@ audioPlayer.getTrackDescription((error, arrlist) => {
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription2></a>
getTrackDescription(): Promise<Array<[MediaDescription](#mediadescription8)>>
getTrackDescription(): Promise<Array\<MediaDescription>>
通过Promise方式获取音频轨道信息。
......@@ -511,10 +511,10 @@ on(type: 'bufferingUpdate', callback: (infoType: [BufferingInfoType](#bufferingi
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 音频缓存事件回调类型，支持的事件：'bufferingUpdate'。 |
| callback | (infoType: [BufferingInfoType](#bufferinginfotype8), value: number) => void | 是 | 音频缓存事件回调方法。<br>[BufferingInfoType](#bufferinginfotype8)为BUFFERING_PERCENT或CACHED_DURATION时，value值有效，否则固定为0。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 音频缓存事件回调类型，支持的事件：'bufferingUpdate'。 |
| callback | function | 是 | 音频缓存事件回调方法。<br>[BufferingInfoType](#bufferinginfotype8)为BUFFERING_PERCENT或CACHED_DURATION时，value值有效，否则固定为0。 |
**示例：**
......@@ -525,7 +525,7 @@ audioPlayer.on('bufferingUpdate', (infoType, value) => {
});
```
### on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')
### on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')<a name = audioplayer_on></a>
on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void
......@@ -537,7 +537,7 @@ on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeCh
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'play' \| 'pause' \| 'stop' \| 'reset' \| 'dataLoad' \| 'finish' \| 'volumeChange'。<br>- 'play'：完成[play()](#play)调用，音频开始播放，触发该事件。<br>- 'pause'：完成[pause()](#pause)调用，音频暂停播放，触发该事件。<br>- 'stop'：完成[stop()](#stop)调用，音频停止播放，触发该事件。<br>- 'reset'：完成[reset()](#reset7)调用，播放器重置，触发该事件。<br>- 'dataLoad'：完成音频数据加载后触发该事件，即src属性设置完成后触发该事件。<br>- 'finish'：完成音频播放后触发该事件。<br>- 'volumeChange'：完成[setVolume()](#setvolume)调用，播放音量改变后触发该事件。 |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'play' \| 'pause' \| 'stop' \| 'reset' \| 'dataLoad' \| 'finish' \| 'volumeChange'。<br>- 'play'：完成[play()](#audioplayer_play)调用，音频开始播放，触发该事件。<br>- 'pause'：完成[pause()](#audioplayer_pause)调用，音频暂停播放，触发该事件。<br>- 'stop'：完成[stop()](#audioplayer_stop)调用，音频停止播放，触发该事件。<br>- 'reset'：完成[reset()](#audioplayer_reset)调用，播放器重置，触发该事件。<br>- 'dataLoad'：完成音频数据加载后触发该事件，即src属性设置完成后触发该事件。<br>- 'finish'：完成音频播放后触发该事件。<br>- 'volumeChange'：完成[setVolume()](#audioplayer_setvolume)调用，播放音量改变后触发该事件。 |
| callback | () => void | 是 | 播放事件回调方法。 |
**示例：**
......@@ -609,7 +609,7 @@ on(type: 'timeUpdate', callback: Callback\<number>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'timeUpdate'。<br>- 'timeUpdate'：[seek()](#seek)调用完成，触发该事件。 |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'timeUpdate'。<br>- 'timeUpdate'：[seek()](#audioplayer_seek)调用完成，触发该事件。 |
| callback | Callback\<number> | 是 | 播放事件回调方法。回调方法入参为成功seek的时间。 |
**示例：**
......@@ -667,7 +667,7 @@ audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件
## VideoPlayer<sup>8+</sup>
视频播放管理类，用于管理和播放视频媒体。在调用VideoPlayer的方法前，需要先通过[createVideoPlayer()](#media.createvideoplayer8)构建一个[VideoPlayer](#videoplayer8)实例。
视频播放管理类，用于管理和播放视频媒体。在调用VideoPlayer的方法前，需要先通过[createVideoPlayer()](#mediacreatevideoplayer8)构建一个[VideoPlayer](#videoplayer8)实例。
视频播放demo可参考：[视频播放开发指导](../../media/video-playback.md)
......@@ -677,7 +677,7 @@ audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| url<sup>8+</sup> | string | 是 | 是 | 视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。<br>**支持路径示例**：<br>1. fd类型播放：fd://xx<br>![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png)<br>2、http网络播放: http://xx<br/>3、hls网络播放路径：开发中<br/>**注意事项**：<br>使用媒体素材需要获取读权限，否则无法正常播放。 |
| url<sup>8+</sup> | string | 是 | 是 | 视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。<br>**支持路径示例**：<br>1. fd类型播放：fd://xx<br>![](figures/zh-cn_image_url.png)<br>2、http网络播放: http://xx<br/>3、hls网络播放路径：开发中<br/>**注意事项**：<br>使用媒体素材需要获取读权限，否则无法正常播放。 |
| loop<sup>8+</sup> | boolean | 是 | 是 | 视频循环播放属性，设置为'true'表示循环播放。 |
| currentTime<sup>8+</sup> | number | 是 | 否 | 视频的当前播放位置。 |
| duration<sup>8+</sup> | number | 是 | 否 | 视频时长，返回-1表示直播模式。 |
......@@ -1053,11 +1053,11 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ---------------------------------------- |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 |
| mode | SeekMode | 是 | 跳转模式，具体见[SeekMode](#seekmode8)。 |
| callback | function | 是 | 跳转到指定播放位置的回调方法。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 |
| mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 |
| callback | function | 是 | 跳转到指定播放位置的回调方法。 |
**示例：**
......@@ -1081,10 +1081,10 @@ seek(timeMs: number, mode?:SeekMode): Promise\<number>
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | -------------------------------------- |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 |
| mode | SeekMode | 否 | 跳转模式，具体见[SeekMode](#seekmode8) |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------- | ---- | ------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 |
| mode | [SeekMode](#seekmode8) | 否 | 跳转模式。 |
**返回值：**
......@@ -1227,7 +1227,7 @@ await videoPlayer.release().then() => {
### getTrackDescription<sup>8+</sup>
getTrackDescription(callback: AsyncCallback<Array<[MediaDescription](#mediadescription8)>>): void
getTrackDescription(callback: AsyncCallback<Array\<MediaDescription>>): void
通过回调方式获取视频轨道信息。
......@@ -1235,9 +1235,9 @@ getTrackDescription(callback: AsyncCallback<Array<[MediaDescription](#mediadescr
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | -------------------------- |
| callback | function | 是 | 获取视频轨道信息回调方法。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback<Array<[MediaDescription](#mediadescription8)>> | 是 | 获取视频轨道信息回调方法。 |
**示例：**
......@@ -1263,7 +1263,7 @@ videoPlayer.getTrackDescription((error, arrlist) => {
### getTrackDescription<sup>8+</sup>
getTrackDescription(): Promise<Array<[MediaDescription](#mediadescription8)>>
getTrackDescription(): Promise<Array\<MediaDescription>>
通过Promise方式获取视频轨道信息。
......@@ -1417,10 +1417,10 @@ on(type: 'startRenderFrame', callback: Callback\<void>): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放首帧送显上报事件回调类型，支持的事件：'startRenderFrame'。 |
| callback | function | 是 | 视频播放首帧送显上报事件回调方法。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放首帧送显上报事件回调类型，支持的事件：'startRenderFrame'。 |
| callback | Callback\<void> | 是 | 视频播放首帧送显上报事件回调方法。 |
**示例：**
......@@ -1464,10 +1464,10 @@ on(type: 'error', callback: ErrorCallback): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。<br>- 'error'：视频播放中发生错误，触发该事件。 |
| callback | function | 是 | 播放错误事件回调方法。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。<br>- 'error'：视频播放中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
**示例：**
......@@ -1555,7 +1555,7 @@ audioPlayer.getTrackDescription((error, arrlist) => {
## AudioRecorder
音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#media.createaudiorecorder) 构建一个[AudioRecorder](#audiorecorder)实例。
音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#mediacreateaudiorecorder) 构建一个[AudioRecorder](#audiorecorder)实例。
音频录制demo可参考：[音频录制开发指导](../../media/audio-recorder.md)
......@@ -1798,7 +1798,7 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error'
| format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 |
| location<sup>8+</sup> | [Location](#location8) | 否 | 音频采集的地理位置。 |
| uri | string | 是 | 视频输出URI：fd://xx&nbsp;(fd&nbsp;number)<br/>![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
| audioEncoderMime | [CodecMimeType](#CodecMimeType8) | 否 | 音频编码格式。 |
| audioEncoderMime | [CodecMimeType](#codecmimetype8) | 否 | 音频编码格式。 |
## AudioEncoder
......@@ -1832,15 +1832,17 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error'
## VideoRecorder<sup>8+</sup>
视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#media.createvideorecorder8)构建一个[VideoRecorder](#videorecorder8)实例。
视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder8)构建一个[VideoRecorder](#videorecorder8)实例。
视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md)
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | ------------------------------------- | ---- | ---- | ---------------- |
| state<sup>8+</sup> | [VideoRecordState](#videorecordstate) | 是 | 否 | 视频录制的状态。 |
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | -------------------------------------- | ---- | ---- | ---------------- |
| state<sup>8+</sup> | [VideoRecordState](#videorecordstate8) | 是 | 否 | 视频录制的状态。 |
### prepare<sup>8+</sup><a name=videorecorder_prepare1></a>
......@@ -1848,7 +1850,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
异步方式进行视频录制的参数设置。通过注册回调函数获取返回值。
**需要权限：** ohos.permission.MICROPHONE ohos.permission.CAMERA
**需要权限：** ohos.permission.MICROPHONE，ohos.permission.CAMERA
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
......@@ -1916,7 +1918,7 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
异步方式进行视频录制的参数设置。通过Promise获取返回值。
**需要权限：** ohos.permission.MICROPHONE ohos.permission.CAMERA
**需要权限：** ohos.permission.MICROPHONE，ohos.permission.CAMERA
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
......@@ -2434,14 +2436,14 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype<sup>8+</sup>) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype<sup>8+</sup>) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile8) | 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location8) | 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL：fd://xx&nbsp;(fd&nbsp;number)<br/>![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype8) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype8) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile8) | 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location8) | 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
## AudioSourceType<sup>8+</sup>
......@@ -2475,10 +2477,10 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| ---------------- | -------------------------------------------- | ---- | ---------------- |
| audioBitrate | number | 是 | 音频编码比特率。 |
| audioChannels | number | 是 | 音频采集声道数。 |
| audioCodec | [CodecMimeType](#CodecMimeType8) | 是 | 音频编码格式。 |
| audioCodec | [CodecMimeType](#codecmimetype8) | 是 | 音频编码格式。 |
| audioSampleRate | number | 是 | 音频采样率。 |
| fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 |
| videoCodec | [CodecMimeType](#CodecMimeType8) | 是 | 视频编码格式。 |
| videoCodec | [CodecMimeType](#codecmimetype8) | 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
......
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ 0a580e44
媒体库管理
==========
# 媒体库管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
导入模块
---------
## 导入模块
```
import mediaLibrary from '@ohos.multimedia.medialibrary';
```
......@@ -20,14 +18,14 @@ getMediaLibrary(context: Context): MediaLibrary
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------- |
| context | Context | 是 | API7以下接口可不传此参数，API 8以上接口此参数是必填参数，传入Ability实例的context，获取媒体库 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | API7以下接口可不传此参数，API 8以上接口此参数是必填参数，传入Ability实例的context，获取媒体库 |
**返回值：**
| 类型 | 说明 |
| ------------ | :----- |
| 类型 | 说明 |
| ----------------------------- | :--------- |
| [MediaLibrary](#medialibrary) | 媒体库实例 |
**示例：**
......@@ -96,8 +94,8 @@ getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt;
**返回值**
| 类型 | 说明 |
| ----------------------------- | -------------- |
| 类型 | 说明 |
| ------------------------------------ | -------------- |
| [FetchFileResult](#fetchfileresult8) | 文件数据结果集 |
**示例：**
......@@ -126,10 +124,10 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------- |
| type | string | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更 |
| callback | callback&lt;void&gt; | 是 | 回调返回空 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更 |
| callback | callback&lt;void&gt; | 是 | 回调返回空 |
**示例：**
......@@ -148,10 +146,10 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------- |
| type | string | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更 |
| callback | callback&lt;void&gt; | 否 | 回调返回空 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更 |
| callback | callback&lt;void&gt; | 否 | 回调返回空 |
**示例：**
......@@ -248,10 +246,10 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;):
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | ------------ |
| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 |
| callback |AsyncCallback&lt;string&gt; | 是 | callback 返回公共目录路径 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------- |
| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 |
| callback | AsyncCallback&lt;string&gt; | 是 | callback 返回公共目录路径 |
**示例：**
......@@ -382,8 +380,8 @@ release(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ---------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调表示成功还是失败 |
**示例：**
......@@ -406,8 +404,8 @@ release(): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------------- |
| 类型 | 说明 |
| ------------------- | --------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果 |
**示例：**
......@@ -690,7 +688,9 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
提供封装文件属性的方法。
### **属性**
### 属性
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ----------------------- | ---- | ---- | ------------------------------------------------------ |
......@@ -729,8 +729,8 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ----------------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 当前FileAsset是否是目录的回调 |
**示例：**
......@@ -764,8 +764,8 @@ isDirectory():Promise&lt;boolean&gt;
**返回值：**
| 类型 | 说明 |
| ---------------- | ------------------------------------------ |
| 类型 | 说明 |
| ---------------------- | ---------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，返回当前FileAsset是否是目录 |
**示例：**
......@@ -801,8 +801,8 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
**示例：**
......@@ -837,8 +837,8 @@ commitModify(): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise&lt;void&gt; | Promise返回空 |
**示例：**
......@@ -871,10 +871,10 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写） |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调返回文件句柄 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------------------------------------- |
| mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写） |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调返回文件句柄 |
**示例：**
......@@ -912,8 +912,8 @@ open(mode: string): Promise&lt;number&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| --------------------- | ------------------- |
| Promise&lt;number&gt; | Promise返回文件句柄 |
**示例：**
......@@ -946,9 +946,9 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| fd | number | 是 | 文件描述符 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| fd | number | 是 | 文件描述符 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
**示例：**
......@@ -993,8 +993,8 @@ close(fd: number): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise&lt;void&gt; | Promise返回空 |
**示例：**
......@@ -1034,8 +1034,8 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | 回调返回缩略图的PixelMap |
**示例：**
......@@ -1069,9 +1069,9 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| size | [Size](#size8) | 是 | 缩略图尺寸 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------ |
| size | [Size](#size8) | 是 | 缩略图尺寸 |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | 回调返回缩略图的PixelMap |
**示例：**
......@@ -1111,8 +1111,8 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ----------------------------- | --------------------------- |
| Promise&lt;image.PixelMap&gt; | Promise返回缩略图的PixelMap |
**示例：**
......@@ -1146,10 +1146,10 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------- | ---- | -------------- |
| isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------------------------------------------------- |
| isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
**示例：**
......@@ -1188,8 +1188,8 @@ favorite(isFavorite: boolean): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise&lt;void&gt; | Promise返回空 |
**示例：**
......@@ -1225,8 +1225,8 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调表示是否为收藏文件 |
**示例：**
......@@ -1264,8 +1264,8 @@ isFavorite():Promise&lt;boolean&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ---------------------- | ----------------------------- |
| Promise&lt;boolean&gt; | Promise回调表示是否是收藏文件 |
**示例：**
......@@ -1303,10 +1303,10 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| isTrash | boolean | 是 | 是否设置为垃圾文件 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------ |
| isTrash | boolean | 是 | 是否设置为垃圾文件 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
**示例：**
......@@ -1348,8 +1348,8 @@ trash(isTrash: boolean): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise&lt;void&gt; | Promise返回空 |
**示例：**
......@@ -1385,8 +1385,8 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调返回表示文件是否为垃圾文件 |
**示例：**
......@@ -1429,8 +1429,8 @@ isTrash():Promise&lt;boolean&gt;
**返回值：**
| 类型 | 说明 |
| ------------- | ----------------------------- |
| 类型 | 说明 |
| ------------------- | --------------------------------- |
| Promise&lt;void&gt; | Promise回调表示文件是否为垃圾文件 |
**示例：**
......@@ -1600,9 +1600,9 @@ getFirstObject(): Promise&lt;FileAsset&gt;
**返回值**：
| 类型 | 说明 |
| ------------------ | -------------------------------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | Promise方式返回FileAsset |
| 类型 | 说明 |
| --------------------------------------- | ------------------------ |
| Promise&lt;[FileAsset](#fileasset8)&gt; | Promise方式返回FileAsset |
**示例**：
......@@ -1674,8 +1674,8 @@ async function example() {
**返回值**：
| 类型 | 说明 |
| -------------------------------- | ------------------- |
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | 返回FileAsset对象 |
**示例**：
......@@ -1742,8 +1742,8 @@ getLastObject(): Promise&lt;FileAsset&gt;
**返回值**：
| 类型 | 说明 |
| -------------------------------- | ------------------- |
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | 返回FileAsset对象 |
**示例**：
......@@ -1811,14 +1811,14 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt;
**参数**：
| 参数 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | -------------------- |
| 参数 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | --------------------------- |
| index | number | 是 | 要获取的文件的索引，从0开始 |
**返回值**：
| 类型 | 说明 |
| -------------------------------- | ------------------- |
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | 返回FileAsset对象 |
**示例**：
......@@ -1917,6 +1917,8 @@ async function example() {
### **属性**
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 参数型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | -------------- |
| albumId | number | 是 | 否 | 相册编号 |
......@@ -1939,9 +1941,9 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
**参数**：
| 参数 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ----------------------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
| 参数 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 |
**示例**：
......@@ -1976,8 +1978,8 @@ commitModify(): Promise&lt;void&gt;
**返回值**：
| 类型 | 说明 |
| ------------- | ---------------------------------------------------- |
| 类型 | 说明 |
| ------------------- | ----------------- |
| Promise&lt;void&gt; | Promise调用返回空 |
**示例**：
......@@ -2011,9 +2013,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
**参数**：
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | --------------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项 |
| 参数 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | --------------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项 |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步返回FetchFileResult之后的回调 |
**示例**：
......@@ -2077,6 +2079,8 @@ async function example() {
注册设备的信息。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | ---------- | ---- | ---- | ---------------- |
| deviceName | string | 是 | 否 | 注册设备的名称 |
......@@ -2091,6 +2095,8 @@ MediaType
枚举，媒体类型。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| ----- | ------ | ---- |
| FILE | 0 | 文件 |
......@@ -2103,6 +2109,8 @@ FileKey
枚举，文件关键信息。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ID | file_id | 文件编号 |
......@@ -2130,6 +2138,8 @@ DirectoryType
枚举，目录类型。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| ------------- | ------ | ------------------ |
| DIR_CAMERA | 0 | 表示Camera文件路径 |
......@@ -2144,6 +2154,8 @@ DeviceType
枚举，设备类型。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| ------------ | ------ | ---------- |
| TYPE_UNKNOWN | 0 | 未识别设备 |
......@@ -2158,14 +2170,16 @@ DeviceType
检索条件。
| 名称 | 类型 | 可读 | 可写 | 必填 |说明 |
| ------------- | ------------- | ---- | ---- | ---- |---------------- |
| selections | string | 是 | 是 |是 | 检索条件，使用[FileKey](#filekey)中的枚举值作为检索条件的列名。示例：<br />selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, |
| selectionArgs | Array&lt;string&gt; | 是 | 是 |是 | 检索条件的值，对应selections中检索条件列的值。<br />示例：<br />selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| order | string | 是 | 是 | 否 |检索结果排序方式，使用[FileKey](#filekey)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：<br />升序排列：order: mediaLibrary.FileKey.DATE_ADDED + " AESC"<br />降序排列：order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
| uri | string | 是 | 是 | 否 |文件URI |
| networkId | string | 是 | 是 | 否 |注册设备网络ID |
| extendArgs | string | 是 | 是 | 否 |扩展的检索参数，目前没有扩展检索参数 |
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| ------------- | ------------------- | ---- | ---- | ---- | ------------------------------------------------------------ |
| selections | string | 是 | 是 | 是 | 检索条件，使用[FileKey](#filekey)中的枚举值作为检索条件的列名。示例：<br />selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, |
| selectionArgs | Array&lt;string&gt; | 是 | 是 | 是 | 检索条件的值，对应selections中检索条件列的值。<br />示例：<br />selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| order | string | 是 | 是 | 否 | 检索结果排序方式，使用[FileKey](#filekey)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：<br />升序排列：order: mediaLibrary.FileKey.DATE_ADDED + " AESC"<br />降序排列：order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
| uri | string | 是 | 是 | 否 | 文件URI |
| networkId | string | 是 | 是 | 否 | 注册设备网络ID |
| extendArgs | string | 是 | 是 | 否 | 扩展的检索参数，目前没有扩展检索参数 |
## Size<sup>8+</sup>
......@@ -2199,11 +2213,7 @@ DeviceType
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
### 属性
| 名称 | 类型 | 必填 | 描述 |
| ----- | ------ | ---- | ------------------------------ |
| type | string | 是 | 媒体类型，包括：image，video。 |
| count | number | 是 | 媒体选择最大数量。 |
| count | number | 是 | 媒体选择最大数量。 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或