Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
651e19e4
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
651e19e4
编写于
3月 19, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 19, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2194 媒体API修复
Merge pull request !2194 from zengyawen/master
上级
b7a9ac0b
0a580e44
变更
3
显示空白变更内容
内联
并排
Showing
3 changed file
with
614 addition
and
788 deletion
+614
-788
zh-cn/application-dev/reference/apis/js-apis-camera.md
zh-cn/application-dev/reference/apis/js-apis-camera.md
+432
-618
zh-cn/application-dev/reference/apis/js-apis-media.md
zh-cn/application-dev/reference/apis/js-apis-media.md
+65
-63
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
+117
-107
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-camera.md
浏览文件 @
651e19e4
...
@@ -24,7 +24,7 @@ getCameraManager(context: Context, callback: AsyncCallback<CameraManager\>): voi
...
@@ -24,7 +24,7 @@ getCameraManager(context: Context, callback: AsyncCallback<CameraManager\>): voi
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|-------------------------------|-----------|-----------------------------------------------------
|
|
-------- | ----------------------------------------------- | ---- | ----------------------------------
|
| context | Context | 是 | 应用上下文。 |
| context | Context | 是 | 应用上下文。 |
| callback | AsyncCallback<
[
CameraManager
](
#cameramanager
)
\>
| 是 | 回调函数,用于获取相机管理器实例。 |
| callback | AsyncCallback<
[
CameraManager
](
#cameramanager
)
\>
| 是 | 回调函数,用于获取相机管理器实例。 |
...
@@ -51,13 +51,13 @@ getCameraManager(context: Context): Promise<CameraManager\>
...
@@ -51,13 +51,13 @@ 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) => {
...
@@ -72,58 +72,54 @@ camera.getCameraManager(context).then((cameraManger) => {
枚举,相机状态。
枚举,相机状态。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
---------------------------|---------------|--------------------
|
|
------------------------- | ------ | ------------
|
| CAMERA_STATUS_APPEAR | 0
| 相机存在。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_STATUS_APPEAR | 0
| 相机存在。
|
| CAMERA_STATUS_DISAPPEAR | 1
| 相机不存在。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_STATUS_DISAPPEAR | 1
| 相机不存在。
|
| CAMERA_STATUS_AVAILABLE | 2
| 相机就绪。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_STATUS_AVAILABLE | 2
| 相机就绪。
|
| CAMERA_STATUS_UNAVAILABLE | 3
| 相机未就绪。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_STATUS_UNAVAILABLE | 3
| 相机未就绪。
|
## CameraPosition
## CameraPosition
枚举,相机方向。
枚举,相机方向。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
-----------------------------|---------------|-----------------------
|
|
--------------------------- | ------ | ----------------
|
| CAMERA_POSITION_UNSPECIFIED | 0
| 未指定方向相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_POSITION_UNSPECIFIED | 0
| 未指定方向相机。
|
| CAMERA_POSITION_BACK | 1
| 后置相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_POSITION_BACK | 1
| 后置相机。
|
| CAMERA_POSITION_FRONT | 2
| 前置相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_POSITION_FRONT | 2
| 前置相机。
|
## CameraType
## CameraType
枚举,相机类型。
枚举,相机类型。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
-------------------------|---------------|-------------------------
|
|
----------------------- | ------ | ----------------
|
| CAMERA_TYPE_UNSPECIFIED | 0
| 未指定相机类型。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_TYPE_UNSPECIFIED | 0
| 未指定相机类型。
|
| CAMERA_TYPE_WIDE_ANGLE | 1
| 广角相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_TYPE_WIDE_ANGLE | 1
| 广角相机。
|
| CAMERA_TYPE_ULTRA_WIDE | 2
| 超级广角相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_TYPE_ULTRA_WIDE | 2
| 超级广角相机。
|
| CAMERA_TYPE_TELEPHOTO | 3
| 长焦相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_TYPE_TELEPHOTO | 3
| 长焦相机。
|
| CAMERA_TYPE_TRUE_DEPTH | 4
| 深度相机。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| CAMERA_TYPE_TRUE_DEPTH | 4
| 深度相机。
|
## ConnectionType
## ConnectionType
枚举,相机连接类型。
枚举,相机连接类型。
| 名称 | 默认值 | 说明 |
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
|------------------------------|---------------|----------------------------|
| 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 |
## CameraFormat
枚举,照片格式。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|----------------------------|---------------|---------------------|
| ---------------------------- | ------ | ------------- |
| CAMERA_FORMAT_YCRCb_420_SP | 1003 | YCRCb格式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core |
| CAMERA_CONNECTION_BUILT_IN | 0 | 内置相机。 |
| CAMERA_FORMAT_JPEG | 2000 | JPEG格式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core |
| CAMERA_CONNECTION_USB_PLUGIN | 1 | 外置USB相机。 |
| CAMERA_FORMAT_AVC | 3000 | AVC格式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core |
| CAMERA_CONNECTION_REMOTE | 2 | 分布式相机。 |
| CAMERA_FORMAT_HEVC | 3001 | HEVC格式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core |
## CameraManager
## CameraManager
...
@@ -141,7 +137,7 @@ getCameras(callback: AsyncCallback<Array<Camera\>\>): void
...
@@ -141,7 +137,7 @@ getCameras(callback: AsyncCallback<Array<Camera\>\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|--------------------------------|-----------|---------------------------------------------------------
|
|
-------- | ----------------------------------------- | ---- | ------------------------------------
|
| callback | AsyncCallback<Array<
[
Camera
](
#camera
)
\>\>
| 是 | 使用callback方式获取支持的相机列表。 |
| callback | AsyncCallback<Array<
[
Camera
](
#camera
)
\>\>
| 是 | 使用callback方式获取支持的相机列表。 |
**示例:**
**示例:**
...
@@ -167,7 +163,7 @@ getCameras(): Promise<Array<Camera\>\>
...
@@ -167,7 +163,7 @@ getCameras(): Promise<Array<Camera\>\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
------------------------|--------------------------------------------------------
|
|
----------------------------------- | -----------------------------
|
| Promise<Array<
[
Camera
](
#camera
)
\>\>
| 使用promise获取支持相机列表。 |
| Promise<Array<
[
Camera
](
#camera
)
\>\>
| 使用promise获取支持相机列表。 |
...
@@ -190,7 +186,7 @@ createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput\>): void
...
@@ -190,7 +186,7 @@ createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput\>): void
**参数:**
**参数:**
| 名称 | 默认值 | 必填 | 说明 |
| 名称 | 默认值 | 必填 | 说明 |
|
----------|------------------------------|-----------|--------------------------------------------------
|
|
-------- | ------------------------------------------- | ---- | -----------------------------------
|
| cameraId | string | 是 | 指定相机ID。 |
| cameraId | string | 是 | 指定相机ID。 |
| callback | AsyncCallback<
[
CameraInput
](
#camerainput
)
\>
| 是 | 回调函数,用于获取CameraInput实例。 |
| callback | AsyncCallback<
[
CameraInput
](
#camerainput
)
\>
| 是 | 回调函数,用于获取CameraInput实例。 |
...
@@ -217,13 +213,13 @@ createCameraInput(cameraId: string): Promise<CameraInput\>
...
@@ -217,13 +213,13 @@ createCameraInput(cameraId: string): Promise<CameraInput\>
**参数:**
**参数:**
| 名称 | 默认值 | 必填 | 说明 |
| 名称 | 默认值 | 必填 | 说明 |
|
----------|-----------------------------|-----------|------------------------------------------
|
|
-------- | ------ | ---- | ------------
|
| cameraId | string | 是 | 指定相机ID。 |
| cameraId | string | 是 | 指定相机ID。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-------------------------|-------------------------------------------------
|
|
------------------------------------- | ----------------------------------------
|
| Promise<
[
CameraInput
](
#camerainput
)
\>
| 使用Promise的方式获取CameraInput的实例。 |
| Promise<
[
CameraInput
](
#camerainput
)
\>
| 使用Promise的方式获取CameraInput的实例。 |
**示例:**
**示例:**
...
@@ -245,7 +241,7 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal
...
@@ -245,7 +241,7 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------------|----------------------------|-----------|---------------------------------------------------
|
|
-------------- | ------------------------------------------- | ---- | -----------------------------------
|
| cameraPosition |
[
CameraPosition
](
#cameraposition
)
| 是 | 相机位置。 |
| cameraPosition |
[
CameraPosition
](
#cameraposition
)
| 是 | 相机位置。 |
| cameraType |
[
CameraType
](
#cameratype
)
| 是 | 相机类型。 |
| cameraType |
[
CameraType
](
#cameratype
)
| 是 | 相机类型。 |
| callback | AsyncCallback<
[
CameraInput
](
#camerainput
)
\>
| 是 | 回调函数,用于获取CameraInput实例。 |
| callback | AsyncCallback<
[
CameraInput
](
#camerainput
)
\>
| 是 | 回调函数,用于获取CameraInput实例。 |
...
@@ -273,14 +269,14 @@ createCameraInput(position: CameraPosition, type: CameraType): Promise<CameraInp
...
@@ -273,14 +269,14 @@ createCameraInput(position: CameraPosition, type: CameraType): Promise<CameraInp
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------------|----------------------------|-----------|----------------------------------------
|
|
-------------- | --------------------------------- | ---- | ----------
|
| cameraPosition |
[
CameraPosition
](
#cameraposition
)
| 是 | 相机位置。 |
| cameraPosition |
[
CameraPosition
](
#cameraposition
)
| 是 | 相机位置。 |
| cameraType |
[
CameraType
](
#cameratype
)
| 是 | 相机类型。 |
| cameraType |
[
CameraType
](
#cameratype
)
| 是 | 相机类型。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-------------------------|-------------------------------------------------
|
|
------------------------------------- | ----------------------------------------
|
| Promise<
[
CameraInput
](
#camerainput
)
\>
| 使用Promise的方式获取CameraInput的实例。 |
| Promise<
[
CameraInput
](
#camerainput
)
\>
| 使用Promise的方式获取CameraInput的实例。 |
**示例:**
**示例:**
...
@@ -302,7 +298,7 @@ on(type: 'cameraStatus', callback: AsyncCallback<CameraStatusInfo\>): void
...
@@ -302,7 +298,7 @@ on(type: 'cameraStatus', callback: AsyncCallback<CameraStatusInfo\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :----------------
----------------------------------- |
| :------- | :---------------------
------------------------------- | :--- | :
----------------------------------- |
| type | string | 是 | 监听事件。 |
| type | string | 是 | 监听事件。 |
| callback | AsyncCallback<
[
CameraStatusInfo
](
#camerastatusinfo
)
\>
| 是 | 回调函数,用于获取相机状态变化信息。 |
| callback | AsyncCallback<
[
CameraStatusInfo
](
#camerastatusinfo
)
\>
| 是 | 回调函数,用于获取相机状态变化信息。 |
...
@@ -319,12 +315,14 @@ cameraManager.on('cameraStatus', (cameraStatusInfo) => {
...
@@ -319,12 +315,14 @@ cameraManager.on('cameraStatus', (cameraStatusInfo) => {
相机实例。
相机实例。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 只读 | 说明 |
| 名称 | 类型 | 只读 | 说明 |
|
----------------|----------------|----------|------------------------
|
|
-------------- | --------------------------------- | ---- | --------------
|
| cameraId | string
| 是 | 相机ID。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| cameraId | string
| 是 | 相机ID。
|
| cameraPosition |
[
CameraPosition
](
#cameraposition
)
| 是
| 相机位置。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| cameraPosition |
[
CameraPosition
](
#cameraposition
)
| 是
| 相机位置。
|
| cameraType |
[
CameraType
](
#cameratype
)
| 是 | 相机类型。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| cameraType |
[
CameraType
](
#cameratype
)
| 是 | 相机类型。
|
| connectionType |
[
ConnectionType
](
#connectiontype
)
| 是
| 相机连接类型。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| connectionType |
[
ConnectionType
](
#connectiontype
)
| 是
| 相机连接类型。
|
**示例:**
**示例:**
...
@@ -343,10 +341,12 @@ var cameraId = cameraObj.connectionType;
...
@@ -343,10 +341,12 @@ var cameraId = cameraObj.connectionType;
相机状态信息。
相机状态信息。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 说明 |
| 名称 | 类型 | 说明 |
|
----------------|----------------|------------------
|
|
------ | ----------------------------- | ----------
|
| camera
|
[
Camera
](
#camera
)
| 相机信息。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| camera
|
[
Camera
](
#camera
)
| 相机信息。
|
| status
|
[
CameraStatus
](
#camerastatus
)
| 相机状态。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| status
|
[
CameraStatus
](
#camerastatus
)
| 相机状态。
|
## CameraInput
## CameraInput
...
@@ -364,7 +364,7 @@ getCameraId(callback: AsyncCallback<string\>\): void
...
@@ -364,7 +364,7 @@ getCameraId(callback: AsyncCallback<string\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|------------------------|-----------|---------------------------------------
|
|
-------- | ---------------------- | ---- | --------------------------
|
| callback | AsyncCallback<string
\>
| 是 | 回调函数,用于获取相机ID。 |
| callback | AsyncCallback<string
\>
| 是 | 回调函数,用于获取相机ID。 |
**示例:**
**示例:**
...
@@ -390,7 +390,7 @@ getCameraId(): Promise<string\>
...
@@ -390,7 +390,7 @@ getCameraId(): Promise<string\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
------------------------|--------------------------------------
|
|
---------------- | -----------------------------
|
| Promise<string
\>
| 使用Promise的方式获取相机ID。 |
| Promise<string
\>
| 使用Promise的方式获取相机ID。 |
**示例:**
**示例:**
...
@@ -401,204 +401,6 @@ cameraInput.getCameraId().then((cameraId) => {
...
@@ -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
### hasFlash
...
@@ -611,7 +413,7 @@ hasFlash(callback: AsyncCallback<boolean\>): void
...
@@ -611,7 +413,7 @@ hasFlash(callback: AsyncCallback<boolean\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|-------------------------|-----------|----------------------------------------------------
|
|
-------- | ----------------------- | ---- | --------------------------------------
|
| callback | AsyncCallback<boolean
\>
| 是 | 回调函数,返回true表示设备支持闪光灯。 |
| callback | AsyncCallback<boolean
\>
| 是 | 回调函数,返回true表示设备支持闪光灯。 |
**示例:**
**示例:**
...
@@ -637,7 +439,7 @@ hasFlash(): Promise<boolean\>
...
@@ -637,7 +439,7 @@ hasFlash(): Promise<boolean\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|--------------------------------------------------------
|
|
----------------- | -------------------------------------------------------
|
| Promise<boolean
\>
| 使用Promise的方式获取结果,返回true表示设备支持闪光灯。 |
| Promise<boolean
\>
| 使用Promise的方式获取结果,返回true表示设备支持闪光灯。 |
**示例:**
**示例:**
...
@@ -659,7 +461,7 @@ isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean\>): v
...
@@ -659,7 +461,7 @@ isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean\>): v
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|----------------------------------------------------
|
|
--------- | ----------------------- | ---- | ----------------------------------------
|
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
| callback | AsyncCallback<boolean
\>
| 是 | 回调函数,返回true表示支持该闪光灯模式。 |
| callback | AsyncCallback<boolean
\>
| 是 | 回调函数,返回true表示支持该闪光灯模式。 |
...
@@ -686,13 +488,13 @@ isFlashModeSupported(flashMode: FlashMode): Promise<boolean\>
...
@@ -686,13 +488,13 @@ isFlashModeSupported(flashMode: FlashMode): Promise<boolean\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|----------------------------------------------------
|
|
--------- | ----------------------- | ---- | ----------------
|
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|---------------------------------------------------
|
|
----------------- | ------------------------------------------------------------
|
| Promise<boolean
\>
| 使用Promise的方式获取结果,返回true表示设备支持该闪光灯模式。 |
| Promise<boolean
\>
| 使用Promise的方式获取结果,返回true表示设备支持该闪光灯模式。 |
**示例:**
**示例:**
...
@@ -719,7 +521,7 @@ setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void\>): void
...
@@ -719,7 +521,7 @@ setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|----------------------------------------------------
|
|
--------- | ----------------------- | ---- | ------------------------
|
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -751,13 +553,13 @@ setFlashMode(flashMode: FlashMode): Promise<void\>
...
@@ -751,13 +553,13 @@ setFlashMode(flashMode: FlashMode): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|----------------------------------------------------
|
|
--------- | ----------------------- | ---- | ----------------
|
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
| flashMode |
[
FlashMode
](
#flashmode
)
| 是 | 指定闪光灯模式。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|-----------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -779,7 +581,7 @@ getFlashMode(callback: AsyncCallback<FlashMode\>): void
...
@@ -779,7 +581,7 @@ getFlashMode(callback: AsyncCallback<FlashMode\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|---------------------------|-----------|------------------------------------------------
|
|
-------- | --------------------------------------- | ---- | ----------------------------------------
|
| callback | AsyncCallback<
[
FlashMode
](
#flashmode
)
\>
| 是 | 回调函数,用于获取当前设备的闪光灯模式。 |
| callback | AsyncCallback<
[
FlashMode
](
#flashmode
)
\>
| 是 | 回调函数,用于获取当前设备的闪光灯模式。 |
**示例:**
**示例:**
...
@@ -805,7 +607,7 @@ getFlashMode(): Promise<FlashMode\>
...
@@ -805,7 +607,7 @@ getFlashMode(): Promise<FlashMode\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|---------------------------------------------------
|
|
--------------------------------- | ---------------------------------------
|
| Promise<
[
FlashMode
](
#flashmode
)
\>
| 使用Promise的方式获取当前的闪光灯模式。 |
| Promise<
[
FlashMode
](
#flashmode
)
\>
| 使用Promise的方式获取当前的闪光灯模式。 |
**示例:**
**示例:**
...
@@ -827,7 +629,7 @@ isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean\>): void
...
@@ -827,7 +629,7 @@ isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|----------------------------------------------------
|
|
-------- | ----------------------- | ---- | --------------------------------------
|
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
| callback | AsyncCallback<boolean
\>
| 是 | 回调函数,返回true表示支持该焦距模式。 |
| callback | AsyncCallback<boolean
\>
| 是 | 回调函数,返回true表示支持该焦距模式。 |
...
@@ -854,13 +656,13 @@ isFocusModeSupported(afMode: FocusMode): Promise<boolean\>
...
@@ -854,13 +656,13 @@ isFocusModeSupported(afMode: FocusMode): Promise<boolean\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|----------------------------------------|-----------|-------------
|
|
------ | ----------------------- | ---- | ----------------
|
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|---------------------------------------------------
|
|
----------------- | -----------------------------------------------------------
|
| Promise<boolean
\>
| 使用Promise的方式获取结果,返回true表示设备支持该焦距模式。 |
| Promise<boolean
\>
| 使用Promise的方式获取结果,返回true表示设备支持该焦距模式。 |
**示例:**
**示例:**
...
@@ -884,7 +686,7 @@ setFocusMode(afMode: FocusMode, callback: AsyncCallback<void\>): void
...
@@ -884,7 +686,7 @@ setFocusMode(afMode: FocusMode, callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|------------------------------------
|
|
-------- | ----------------------- | ---- | ------------------------
|
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -913,13 +715,13 @@ setFocusMode(afMode: FocusMode): Promise<void\>
...
@@ -913,13 +715,13 @@ setFocusMode(afMode: FocusMode): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|-----------------------------------------|-----------|-------------
|
|
------ | ----------------------- | ---- | ----------------
|
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
| afMode |
[
FocusMode
](
#focusmode
)
| 是 | 指定的焦距模式。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|-----------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -941,7 +743,7 @@ getFocusMode(callback: AsyncCallback<FocusMode\>): void
...
@@ -941,7 +743,7 @@ getFocusMode(callback: AsyncCallback<FocusMode\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|---------------------------|-----------|------------------------------------------------
|
|
-------- | --------------------------------------- | ---- | --------------------------------------
|
| callback | AsyncCallback<
[
FocusMode
](
#focusmode
)
\>
| 是 | 回调函数,用于获取当前设备的焦距模式。 |
| callback | AsyncCallback<
[
FocusMode
](
#focusmode
)
\>
| 是 | 回调函数,用于获取当前设备的焦距模式。 |
**示例:**
**示例:**
...
@@ -989,7 +791,7 @@ getZoomRatioRange\(callback: AsyncCallback<Array<number\>\>\): void
...
@@ -989,7 +791,7 @@ getZoomRatioRange\(callback: AsyncCallback<Array<number\>\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|--------------------------------|-----------|-------------------------------------------------
|
|
-------- | ------------------------------ | ---- | ------------------------
|
| callback | AsyncCallback<Array<number
\>\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<Array<number
\>\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1015,7 +817,7 @@ getZoomRatioRange\(\): Promise<Array<number\>\>
...
@@ -1015,7 +817,7 @@ getZoomRatioRange\(\): Promise<Array<number\>\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
------------------------|---------------------------------------------
|
|
------------------------ | -------------------------------------------
|
| Promise<Array<number
\>\>
| 使用Promise的方式获取当前的可变焦距比范围。 |
| Promise<Array<number
\>\>
| 使用Promise的方式获取当前的可变焦距比范围。 |
**示例:**
**示例:**
...
@@ -1037,7 +839,7 @@ setZoomRatio(zoomRatio: number, callback: AsyncCallback<void\>): void
...
@@ -1037,7 +839,7 @@ setZoomRatio(zoomRatio: number, callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|------------------------|-----------|------------------------------------
|
|
--------- | -------------------- | ---- | ------------------------
|
| zoomRatio | number | 是 | 可变焦距比。 |
| zoomRatio | number | 是 | 可变焦距比。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1064,13 +866,13 @@ setZoomRatio(zoomRatio: number): Promise<void\>
...
@@ -1064,13 +866,13 @@ setZoomRatio(zoomRatio: number): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|----------|-----------|-------------
|
|
--------- | ------ | ---- | ------------
|
| zoomRatio | number | 是 | 可变焦距比。 |
| zoomRatio | number | 是 | 可变焦距比。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-----------------------|-----------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1092,7 +894,7 @@ getZoomRatio(callback: AsyncCallback<number\>): void
...
@@ -1092,7 +894,7 @@ getZoomRatio(callback: AsyncCallback<number\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-----------|---------------------------|-----------|------------------------------------------------------
|
|
-------- | ---------------------- | ---- | ------------------------
|
| callback | AsyncCallback<number
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<number
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1140,7 +942,7 @@ release\(callback: AsyncCallback<void\>\): void
...
@@ -1140,7 +942,7 @@ release\(callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1166,7 +968,7 @@ release(): Promise<void\>
...
@@ -1166,7 +968,7 @@ release(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1188,7 +990,7 @@ on(type: 'focusStateChange', callback: AsyncCallback<FocusState\>): void
...
@@ -1188,7 +990,7 @@ on(type: 'focusStateChange', callback: AsyncCallback<FocusState\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
------------------- | :--- | :-------------------------------------------------------
|
| type | string | 是 | 监听事件,固定为'focusStateChange',即焦距状态变化事件。 |
| type | string | 是 | 监听事件,固定为'focusStateChange',即焦距状态变化事件。 |
| callback | AsyncCallback<
[
FocusState
](
#focusstate
)
\>
| 是 | 回调函数,用于获取焦距状态。 |
| callback | AsyncCallback<
[
FocusState
](
#focusstate
)
\>
| 是 | 回调函数,用于获取焦距状态。 |
...
@@ -1211,7 +1013,7 @@ on('error', callback: ErrorCallback<CameraInputError\>): void
...
@@ -1211,7 +1013,7 @@ on('error', callback: ErrorCallback<CameraInputError\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
---------- | :--- | :------------------------
|
| type | string | 是 | 监听事件,固定为'error'。 |
| type | string | 是 | 监听事件,固定为'error'。 |
| callback | ErrorCallback<CameraInputError
\>
| 是 | 回调函数,用于获取结果。 |
| callback | ErrorCallback<CameraInputError
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1228,33 +1030,39 @@ cameraInput.on('error', (cameraInputError) => {
...
@@ -1228,33 +1030,39 @@ cameraInput.on('error', (cameraInputError) => {
枚举,闪光灯模式。
枚举,闪光灯模式。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
------------------------|---------------|------------------------
|
|
---------------------- | ------ | ------------
|
| FLASH_MODE_CLOSE | 0
| 闪光灯关闭。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FLASH_MODE_CLOSE | 0
| 闪光灯关闭。
|
| FLASH_MODE_OPEN | 1
| 闪光灯开启。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FLASH_MODE_OPEN | 1
| 闪光灯开启。
|
| FLASH_MODE_AUTO | 2
| 自动闪光灯。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FLASH_MODE_AUTO | 2
| 自动闪光灯。
|
| FLASH_MODE_ALWAYS_OPEN | 3
| 闪光灯常亮。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FLASH_MODE_ALWAYS_OPEN | 3
| 闪光灯常亮。
|
## FocusMode
## FocusMode
枚举,焦距模式。
枚举,焦距模式。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
----------------------------|---------------|----------------------------
|
|
-------------------------- | ------ | ------------------
|
| FOCUS_MODE_MANUAL | 0
| 手动变焦模式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FOCUS_MODE_MANUAL | 0
| 手动变焦模式。
|
| FOCUS_MODE_CONTINUOUS_AUTO | 1
| 连续自动变焦模式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FOCUS_MODE_CONTINUOUS_AUTO | 1
| 连续自动变焦模式。
|
| FOCUS_MODE_AUTO | 2
| 自动变焦模式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FOCUS_MODE_AUTO | 2
| 自动变焦模式。
|
| FOCUS_MODE_LOCKED | 3
| 定焦模式。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| FOCUS_MODE_LOCKED | 3
| 定焦模式。
|
## FocusState
## FocusState
枚举,焦距状态。
枚举,焦距状态。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
| --------------------- | ------ | ------------
------------------------------------------------
|
| --------------------- | ------ | ------------ |
| FOCUS_STATE_SCAN | 0 | 扫描状态。
<br/>
系统能力 : SystemCapability.Multimedia.Camera.Core
|
| FOCUS_STATE_SCAN | 0 | 扫描状态。
|
| FOCUS_STATE_FOCUSED | 1 | 相机已对焦。
<br/>
系统能力 : SystemCapability.Multimedia.Camera.Core
|
| FOCUS_STATE_FOCUSED | 1 | 相机已对焦。 |
| FOCUS_STATE_UNFOCUSED | 2 | 相机未对焦。
<br/>
系统能力 : SystemCapability.Multimedia.Camera.Core
|
| FOCUS_STATE_UNFOCUSED | 2 | 相机未对焦。 |
## camera.createCaptureSession
## camera.createCaptureSession
...
@@ -1267,7 +1075,7 @@ createCaptureSession\(context: Context, callback: AsyncCallback<CaptureSession\>
...
@@ -1267,7 +1075,7 @@ createCaptureSession\(context: Context, callback: AsyncCallback<CaptureSession\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|--------------------------------|-----------|-----------------------------------------------------
|
|
-------- | ------------------------------------------------- | ---- | --------------------------------------
|
| context | Context | 是 | 应用上下文。 |
| context | Context | 是 | 应用上下文。 |
| callback | AsyncCallback<
[
CaptureSession
](
#capturesession
)
\>
| 是 | 回调函数,用于获取CaptureSession实例。 |
| callback | AsyncCallback<
[
CaptureSession
](
#capturesession
)
\>
| 是 | 回调函数,用于获取CaptureSession实例。 |
...
@@ -1294,13 +1102,13 @@ createCaptureSession(context: Context\): Promise<CaptureSession\>;
...
@@ -1294,13 +1102,13 @@ createCaptureSession(context: Context\): Promise<CaptureSession\>;
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|-------------------------------|-----------|-----------------------------------------------------
|
|
------- | ------- | ---- | ------------
|
| context | Context | 是 | 应用上下文。 |
| context | Context | 是 | 应用上下文。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
---------------------------|---------------------------------------------------
|
|
------------------------------------------- | -----------------------------------------
|
| Promise<
[
CaptureSession
](
#capturesession
)
\>
| 使用Promise的方式获取CaptureSession实例。 |
| Promise<
[
CaptureSession
](
#capturesession
)
\>
| 使用Promise的方式获取CaptureSession实例。 |
**示例:**
**示例:**
...
@@ -1326,7 +1134,7 @@ beginConfig\(callback: AsyncCallback<void\>\): void
...
@@ -1326,7 +1134,7 @@ beginConfig\(callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1352,7 +1160,7 @@ beginConfig\(\): Promise<void\>
...
@@ -1352,7 +1160,7 @@ beginConfig\(\): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
---------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -1375,7 +1183,7 @@ commitConfig\(callback: AsyncCallback<void\>\): void
...
@@ -1375,7 +1183,7 @@ commitConfig\(callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|---------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1401,7 +1209,7 @@ commitConfig\(\): Promise<void\>
...
@@ -1401,7 +1209,7 @@ commitConfig\(\): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
---------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1423,7 +1231,7 @@ addInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void
...
@@ -1423,7 +1231,7 @@ addInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-------------|----------------------|-----------|---------------------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要添加的CameraInput实例。 |
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要添加的CameraInput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1450,13 +1258,13 @@ addInput\(cameraInput: CameraInput\): Promise<void\>
...
@@ -1450,13 +1258,13 @@ addInput\(cameraInput: CameraInput\): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-------------|---------------------|-----------|-------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要添加的CameraInput实例。 |
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要添加的CameraInput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1478,7 +1286,7 @@ addOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): void
...
@@ -1478,7 +1286,7 @@ addOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|----------------------|-----------|-------------------------------------
|
|
------------- | ------------------------------- | ---- | -----------------------------
|
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要添加的PreviewOutput实例。 |
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要添加的PreviewOutput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1505,13 +1313,13 @@ addOutput\(previewOutput: PreviewOutput\): Promise<void\>
...
@@ -1505,13 +1313,13 @@ addOutput\(previewOutput: PreviewOutput\): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|--------------------------------
|
|
------------- | ------------------------------- | ---- | -----------------------------
|
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要添加的PreviewOutput实例。 |
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要添加的PreviewOutput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|-----------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1533,7 +1341,7 @@ addOutput\(photoOutput: PhotoOutput, callback: AsyncCallback<void\>\): void
...
@@ -1533,7 +1341,7 @@ addOutput\(photoOutput: PhotoOutput, callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|-------------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1560,13 +1368,13 @@ addOutput\(photoOutput: PhotoOutput\): Promise<void\>
...
@@ -1560,13 +1368,13 @@ addOutput\(photoOutput: PhotoOutput\): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|--------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
---------------|-----------------------------------
|
|
-------------- | ---------------------------
|
| Promise
\<
void> | 使用Promise的方式获取结果。 |
| Promise
\<
void> | 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1588,7 +1396,7 @@ addOutput\(videoOutput: VideoOutput, callback: AsyncCallback<void\>\): void
...
@@ -1588,7 +1396,7 @@ addOutput\(videoOutput: VideoOutput, callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|-------------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| videoOutput |
[
VideoOutput
](
#videooutput
)
| 是 | 需要添加的VideoOutput实例。 |
| videoOutput |
[
VideoOutput
](
#videooutput
)
| 是 | 需要添加的VideoOutput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1643,7 +1451,7 @@ removeInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void
...
@@ -1643,7 +1451,7 @@ removeInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-------------|----------------------|-----------|------------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要移除的CameraInput实例。 |
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要移除的CameraInput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1670,13 +1478,13 @@ removeInput\(cameraInput: CameraInput\): Promise<void\>
...
@@ -1670,13 +1478,13 @@ removeInput\(cameraInput: CameraInput\): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
-------------|---------------------|-----------|---------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要移除的CameraInput实例。 |
| cameraInput |
[
CameraInput
](
#camerainput
)
| 是 | 需要移除的CameraInput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|-----------------------------------
|
|
-------------- | ---------------------------
|
| Promise
\<
void> | 使用Promise的方式获取结果。 |
| Promise
\<
void> | 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1698,7 +1506,7 @@ removeOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): vo
...
@@ -1698,7 +1506,7 @@ removeOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): vo
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|----------------------|-----------|------------------------------------
|
|
------------- | ------------------------------- | ---- | -----------------------------
|
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要移除的PreviewOutput实例。 |
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要移除的PreviewOutput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1725,14 +1533,14 @@ removeOutput(previewOutput: PreviewOutput): Promise<void\>
...
@@ -1725,14 +1533,14 @@ removeOutput(previewOutput: PreviewOutput): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|-----------------------------------
|
|
------------- | ------------------------------- | ---- | -----------------------------
|
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要移除的PreviewOutput实例。 |
| previewOutput |
[
PreviewOutput
](
#previewoutput
)
| 是 | 需要移除的PreviewOutput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
---------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -1755,7 +1563,7 @@ removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void\>): void
...
@@ -1755,7 +1563,7 @@ removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|----------------------|-----------|------------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1782,14 +1590,14 @@ removeOutput(photoOutput: PhotoOutput): Promise<void\>
...
@@ -1782,14 +1590,14 @@ removeOutput(photoOutput: PhotoOutput): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|---------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
| photoOutput |
[
PhotoOutput
](
#photooutput
)
| 是 | 需要添加的PhotoOutput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
---------------|------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -1812,7 +1620,7 @@ removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void\>): void
...
@@ -1812,7 +1620,7 @@ removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|----------------------|-----------|------------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| videoOutput |
[
VideoOutput
](
#videooutput
)
| 是 | 需要添加的VideoOutput实例。 |
| videoOutput |
[
VideoOutput
](
#videooutput
)
| 是 | 需要添加的VideoOutput实例。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -1839,14 +1647,14 @@ removeOutput(videoOutput: VideoOutput): Promise<void\>
...
@@ -1839,14 +1647,14 @@ removeOutput(videoOutput: VideoOutput): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
---------------|---------------------|-----------|---------------------------------
|
|
----------- | --------------------------- | ---- | ---------------------------
|
| videoOutput |
[
VideoOutput
](
#videooutput
)
| 是 | 需要添加的VideoOutput实例。 |
| videoOutput |
[
VideoOutput
](
#videooutput
)
| 是 | 需要添加的VideoOutput实例。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -1869,7 +1677,7 @@ start\(callback: AsyncCallback<void\>\): void
...
@@ -1869,7 +1677,7 @@ start\(callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1895,7 +1703,7 @@ start\(\): Promise<void\>
...
@@ -1895,7 +1703,7 @@ start\(\): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|-----------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1918,7 +1726,7 @@ stop\(callback: AsyncCallback<void\>\): void
...
@@ -1918,7 +1726,7 @@ stop\(callback: AsyncCallback<void\>\): void
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1944,7 +1752,7 @@ stop(): Promise<void\>
...
@@ -1944,7 +1752,7 @@ stop(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|-----------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -1966,7 +1774,7 @@ release\(callback: AsyncCallback<void\>\): void
...
@@ -1966,7 +1774,7 @@ release\(callback: AsyncCallback<void\>\): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -1992,7 +1800,7 @@ release(): Promise<void\>
...
@@ -1992,7 +1800,7 @@ release(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -2014,7 +1822,7 @@ on(type: 'error', callback: ErrorCallback<CaptureSessionError\>): void
...
@@ -2014,7 +1822,7 @@ on(type: 'error', callback: ErrorCallback<CaptureSessionError\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
------------- | :--- | :---------------------------
|
| type | string | 是 | 监听事件,固定为'error'。 |
| type | string | 是 | 监听事件,固定为'error'。 |
| callback | ErrorCallback<CaptureSessionError
\>
| 是 | 回调函数,用于获取错误信息。 |
| callback | ErrorCallback<CaptureSessionError
\>
| 是 | 回调函数,用于获取错误信息。 |
...
@@ -2037,7 +1845,7 @@ createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput\>):
...
@@ -2037,7 +1845,7 @@ createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput\>):
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
------------|-------------------------------|-----------|----------------------------------------------------
|
|
--------- | ----------------------------------------------- | ---- | -------------------------------------
|
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
| callback | AsyncCallback<
[
PreviewOutput
](
#previewoutput
)
\>
| 是 | 回调函数,用于获取PreviewOutput实例。 |
| callback | AsyncCallback<
[
PreviewOutput
](
#previewoutput
)
\>
| 是 | 回调函数,用于获取PreviewOutput实例。 |
...
@@ -2064,13 +1872,13 @@ createPreviewOutput(surfaceId: string): Promise\<PreviewOutput>
...
@@ -2064,13 +1872,13 @@ createPreviewOutput(surfaceId: string): Promise\<PreviewOutput>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
------------|-----------------|-----------|----------------------------------------------------
|
|
--------- | ------ | ---- | ----------------------------------
|
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
| surfaceId | string | 是 | 从XComponent组件获取的Surface ID。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
-------------------------|---------------------------------------------------
|
|
----------------------------------------- | ---------------------------
|
| Promise<
[
PreviewOutput
](
#previewoutput
)
\>
| 使用Promise的方式获取结果。 |
| Promise<
[
PreviewOutput
](
#previewoutput
)
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -2096,7 +1904,7 @@ release(callback: AsyncCallback<void\>): void
...
@@ -2096,7 +1904,7 @@ release(callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -2122,7 +1930,7 @@ release(): Promise<void\>
...
@@ -2122,7 +1930,7 @@ release(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|-----------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -2145,7 +1953,7 @@ on(type: 'frameStart', callback: AsyncCallback<void\>): void
...
@@ -2145,7 +1953,7 @@ on(type: 'frameStart', callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :----------------
| :-------- | :----------------------------------
|
| :------- | :----------------
--- | :--- | :-------------------------------------------
|
| type | string | 是 | 监听事件,固定为'frameStart',即帧启动事件。 |
| type | string | 是 | 监听事件,固定为'frameStart',即帧启动事件。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -2168,7 +1976,7 @@ on(type: 'frameEnd', callback: AsyncCallback<void\>): void
...
@@ -2168,7 +1976,7 @@ on(type: 'frameEnd', callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :----------------
| :-------- | :----------------------------------
|
| :------- | :----------------
--- | :--- | :-----------------------------------------
|
| type | string | 是 | 监听事件,固定为'frameEnd',即帧结束事件。 |
| type | string | 是 | 监听事件,固定为'frameEnd',即帧结束事件。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -2191,7 +1999,7 @@ on(type: 'error', callback: ErrorCallback<PreviewOutputError\>): void
...
@@ -2191,7 +1999,7 @@ on(type: 'error', callback: ErrorCallback<PreviewOutputError\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
------------ | :--- | :---------------------------
|
| type | string | 是 | 监听事件,固定为'error'。 |
| type | string | 是 | 监听事件,固定为'error'。 |
| callback | ErrorCallback<PreviewOutputError
\>
| 是 | 回调函数,用于获取错误信息。 |
| callback | ErrorCallback<PreviewOutputError
\>
| 是 | 回调函数,用于获取错误信息。 |
...
@@ -2214,7 +2022,7 @@ createPhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput\>): voi
...
@@ -2214,7 +2022,7 @@ createPhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput\>): voi
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
------------|-------------------------------|-----------|----------------------------------------------------
|
|
--------- | ------------------------------------------- | ---- | -----------------------------------
|
| surfaceId | string | 是 | 从ImageReceiver获取的Surface ID。 |
| surfaceId | string | 是 | 从ImageReceiver获取的Surface ID。 |
| callback | AsyncCallback<
[
PhotoOutput
](
#photooutput
)
\>
| 是 | 回调函数,用于获取PhotoOutput实例。 |
| callback | AsyncCallback<
[
PhotoOutput
](
#photooutput
)
\>
| 是 | 回调函数,用于获取PhotoOutput实例。 |
...
@@ -2241,13 +2049,13 @@ createPhotoOutput(surfaceId: string): Promise<PhotoOutput\>
...
@@ -2241,13 +2049,13 @@ 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) => {
...
@@ -2261,32 +2069,38 @@ camera.createPhotoOutput(surfaceId).then((photoOutput) => {
枚举,图片旋转角度。
枚举,图片旋转角度。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
--------------|---------------|----------------------------------------
|
|
------------ | ------ | ---------------
|
| ROTATION_0 | 0
| 图片旋转0度。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| ROTATION_0 | 0
| 图片旋转0度。
|
| ROTATION_90 | 90
| 图片旋转90度。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| ROTATION_90 | 90
| 图片旋转90度。
|
| ROTATION_180 | 180
| 图片旋转180度。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| ROTATION_180 | 180
| 图片旋转180度。
|
| ROTATION_270 | 270
| 图片旋转270度。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| ROTATION_270 | 270
| 图片旋转270度。
|
## QualityLevel
## QualityLevel
枚举,图片质量。
枚举,图片质量。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 默认值 | 说明 |
| 名称 | 默认值 | 说明 |
|
----------------------|---------------|----------------------
|
|
-------------------- | ------ | --------------
|
| QUALITY_LEVEL_HIGH | 0
| 图片质量高。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| QUALITY_LEVEL_HIGH | 0
| 图片质量高。
|
| QUALITY_LEVEL_MEDIUM | 1
| 图片质量中等。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| QUALITY_LEVEL_MEDIUM | 1
| 图片质量中等。
|
| QUALITY_LEVEL_LOW | 2
| 图片质量差。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| QUALITY_LEVEL_LOW | 2
| 图片质量差。
|
## PhotoCaptureSetting
## PhotoCaptureSetting
拍摄照片的设置。
拍摄照片的设置。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|---------------|-----------|---------------------
|
|
-------- | ------------------------------- | ---- | --------------
|
| quality |
[
QualityLevel
](
#qualitylevel
)
| 否 | 图片质量。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| quality |
[
QualityLevel
](
#qualitylevel
)
| 否 | 图片质量。
|
| rotation |
[
ImageRotation
](
#imagerotation
)
| 否
| 图片旋转角度。
<br/>
**系统能力:**
SystemCapability.Multimedia.Camera.Core
|
| rotation |
[
ImageRotation
](
#imagerotation
)
| 否
| 图片旋转角度。
|
## PhotoOutput
## PhotoOutput
...
@@ -2304,7 +2118,7 @@ capture(callback: AsyncCallback<void\>): void
...
@@ -2304,7 +2118,7 @@ capture(callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|---------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -2330,7 +2144,7 @@ capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void\>): void
...
@@ -2330,7 +2144,7 @@ capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | ------------------------------------------- | ---- | ------------------------
|
| setting |
[
PhotoCaptureSetting
](
#photocapturesetting
)
| 是 | 拍照设置。 |
| setting |
[
PhotoCaptureSetting
](
#photocapturesetting
)
| 是 | 拍照设置。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -2357,13 +2171,13 @@ capture(setting?: PhotoCaptureSetting): Promise<void\>
...
@@ -2357,13 +2171,13 @@ capture(setting?: PhotoCaptureSetting): Promise<void\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|---------------------|-----------|----------------------------------------------
|
|
------- | ------------------------------------------- | ---- | ----------
|
| setting |
[
PhotoCaptureSetting
](
#photocapturesetting
)
| 否 | 拍照设置。 |
| setting |
[
PhotoCaptureSetting
](
#photocapturesetting
)
| 否 | 拍照设置。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -2386,7 +2200,7 @@ release(callback: AsyncCallback<void\>): void
...
@@ -2386,7 +2200,7 @@ release(callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -2412,7 +2226,7 @@ release(): Promise<void\>
...
@@ -2412,7 +2226,7 @@ release(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -2435,7 +2249,7 @@ on(type: 'captureStart', callback: AsyncCallback<number\>): void
...
@@ -2435,7 +2249,7 @@ on(type: 'captureStart', callback: AsyncCallback<number\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :--------------------- | :---
----- | :-----------------------------------------------
|
| :------- | :--------------------- | :---
| :-----------------------------------------------
|
| type | string | 是 | 监听事件,固定为'captureStart',即拍照启动事件。 |
| type | string | 是 | 监听事件,固定为'captureStart',即拍照启动事件。 |
| callback | AsyncCallback<number
\>
| 是 | 使用callback的方式获取Capture ID。 |
| callback | AsyncCallback<number
\>
| 是 | 使用callback的方式获取Capture ID。 |
...
@@ -2458,7 +2272,7 @@ on(type: 'frameShutter', callback: AsyncCallback<FrameShutterInfo\>): void
...
@@ -2458,7 +2272,7 @@ on(type: 'frameShutter', callback: AsyncCallback<FrameShutterInfo\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
---------- | :--- | :---------------------------------------------
|
| type | string | 是 | 监听事件,固定为'frameShutter',即帧刷新事件。 |
| type | string | 是 | 监听事件,固定为'frameShutter',即帧刷新事件。 |
| callback | AsyncCallback<FrameShutterInfo
\>
| 是 | 回调函数,用于获取相关信息。 |
| callback | AsyncCallback<FrameShutterInfo
\>
| 是 | 回调函数,用于获取相关信息。 |
...
@@ -2482,7 +2296,7 @@ on(type: 'captureEnd', callback: AsyncCallback<CaptureEndInfo\>): void
...
@@ -2482,7 +2296,7 @@ on(type: 'captureEnd', callback: AsyncCallback<CaptureEndInfo\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
-------- | :--- | :---------------------------------------------
|
| type | string | 是 | 监听事件,固定为'captureEnd',即拍照停止事件。 |
| type | string | 是 | 监听事件,固定为'captureEnd',即拍照停止事件。 |
| callback | AsyncCallback<CaptureEndInfo
\>
| 是 | 回调函数,用于获取相关信息。 |
| callback | AsyncCallback<CaptureEndInfo
\>
| 是 | 回调函数,用于获取相关信息。 |
...
@@ -2506,7 +2320,7 @@ on(type: 'error', callback: ErrorCallback<PhotoOutputError\>): void
...
@@ -2506,7 +2320,7 @@ on(type: 'error', callback: ErrorCallback<PhotoOutputError\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
---------- | :--- | :---------------------------
|
| type | string | 是 | 监听事件,固定为'error'。 |
| type | string | 是 | 监听事件,固定为'error'。 |
| callback | ErrorCallback<PhotoOutputError
\>
| 是 | 回调函数,用于获取错误信息。 |
| callback | ErrorCallback<PhotoOutputError
\>
| 是 | 回调函数,用于获取错误信息。 |
...
@@ -2529,7 +2343,7 @@ createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput\>): voi
...
@@ -2529,7 +2343,7 @@ createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput\>): voi
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
------------|-------------------------------|-----------|----------------------------------------------------
|
|
--------- | ------------------------------------------- | ---- | -----------------------------------
|
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
| callback | AsyncCallback<
[
VideoOutput
](
#videooutput
)
\>
| 是 | 回调函数,用于获取VideoOutput实例。 |
| callback | AsyncCallback<
[
VideoOutput
](
#videooutput
)
\>
| 是 | 回调函数,用于获取VideoOutput实例。 |
...
@@ -2556,7 +2370,7 @@ createVideoOutput(surfaceId: string): Promise<VideoOutput\>
...
@@ -2556,7 +2370,7 @@ createVideoOutput(surfaceId: string): Promise<VideoOutput\>
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
------------|-----------------|-----------|----------------------------------------------------
|
|
--------- | ------ | ---- | ---------------------------------
|
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
| surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 |
**返回值:**
**返回值:**
...
@@ -2588,7 +2402,7 @@ start(callback: AsyncCallback<void\>): void
...
@@ -2588,7 +2402,7 @@ start(callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -2614,7 +2428,7 @@ start(): Promise<void\>
...
@@ -2614,7 +2428,7 @@ start(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -2637,7 +2451,7 @@ stop(callback: AsyncCallback<void\>): void
...
@@ -2637,7 +2451,7 @@ stop(callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -2663,7 +2477,7 @@ stop(): Promise<void\>
...
@@ -2663,7 +2477,7 @@ stop(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
**示例:**
**示例:**
...
@@ -2685,7 +2499,7 @@ release(callback: AsyncCallback<void\>): void
...
@@ -2685,7 +2499,7 @@ release(callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
|
----------|----------------------|-----------|----------------------------------------------
|
|
-------- | -------------------- | ---- | ------------------------
|
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
**示例:**
**示例:**
...
@@ -2711,7 +2525,7 @@ release(): Promise<void\>
...
@@ -2711,7 +2525,7 @@ release(): Promise<void\>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
|
----------------|---------------------------------------------
|
|
-------------- | ---------------------------
|
| Promise<void
\>
| 使用Promise的方式获取结果。 |
| Promise<void
\>
| 使用Promise的方式获取结果。 |
...
@@ -2734,7 +2548,7 @@ on(type: 'frameStart', callback: AsyncCallback<void\>): void
...
@@ -2734,7 +2548,7 @@ on(type: 'frameStart', callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :----------------
| :-------- | :----------------------------------
|
| :------- | :----------------
--- | :--- | :-----------------------------------------------
|
| type | string | 是 | 监听事件,固定为'frameStart',即视频帧开启事件。 |
| type | string | 是 | 监听事件,固定为'frameStart',即视频帧开启事件。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -2757,7 +2571,7 @@ on(type: 'frameEnd', callback: AsyncCallback<void\>): void
...
@@ -2757,7 +2571,7 @@ on(type: 'frameEnd', callback: AsyncCallback<void\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :----------------
| :-------- | :----------------------------------
|
| :------- | :----------------
--- | :--- | :---------------------------------------------
|
| type | string | 是 | 监听事件,固定为'frameEnd',即视频帧结束事件。 |
| type | string | 是 | 监听事件,固定为'frameEnd',即视频帧结束事件。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
| callback | AsyncCallback<void
\>
| 是 | 回调函数,用于获取结果。 |
...
@@ -2780,7 +2594,7 @@ on(type: 'error', callback: ErrorCallback<VideoOutputError\>): void
...
@@ -2780,7 +2594,7 @@ on(type: 'error', callback: ErrorCallback<VideoOutputError\>): void
**参数:**
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| :------- | :---------------------
| :-------- | :-----------------------------------------------
|
| :------- | :---------------------
----- | :--- | :---------------------------
|
| type | string | 是 | 监听事件,固定为'error'。 |
| type | string | 是 | 监听事件,固定为'error'。 |
| callback | Callback<VideoOutputError
\>
| 是 | 回调函数,用于获取错误信息。 |
| callback | Callback<VideoOutputError
\>
| 是 | 回调函数,用于获取错误信息。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @
651e19e4
...
@@ -10,7 +10,7 @@
...
@@ -10,7 +10,7 @@
-
音频播放(
[
AudioPlayer
](
#audioplayer
)
)
-
音频播放(
[
AudioPlayer
](
#audioplayer
)
)
-
视频播放(
[
VideoPlayer
](
#videoplayer8
)
)
-
视频播放(
[
VideoPlayer
](
#videoplayer8
)
)
-
音频录制(
[
AudioRecorder
](
#audiorecorder
)
)
-
音频录制(
[
AudioRecorder
](
#audiorecorder
)
)
-
视频录制(
[
VideoRecorder
](
#
VideoRecorder
<sup>
8+
</sup>
))
-
视频录制(
[
VideoRecorder
](
#
videoRecorder8
)
)
后续将提供以下功能:DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
后续将提供以下功能:DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
...
@@ -229,8 +229,8 @@ Codec MIME类型枚举。
...
@@ -229,8 +229,8 @@ Codec MIME类型枚举。
**系统能力:**
以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。
**系统能力:**
以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------ | --------------------- | ------------------------
------------------------------------
|
| ------------ | --------------------- | ------------------------ |
| VIDEO_H263 | 'video/h263' | 表示视频/h263类型。|
| VIDEO_H263 | 'video/h263' | 表示视频/h263类型。
|
| VIDEO_AVC | 'video/avc' | 表示视频/avc类型。 |
| VIDEO_AVC | 'video/avc' | 表示视频/avc类型。 |
| VIDEO_MPEG2 | 'video/mpeg2' | 表示视频/mpeg2类型。 |
| VIDEO_MPEG2 | 'video/mpeg2' | 表示视频/mpeg2类型。 |
| VIDEO_MPEG4 | 'video/mp4v-es' | 表示视频/mpeg4类型。 |
| VIDEO_MPEG4 | 'video/mp4v-es' | 表示视频/mpeg4类型。 |
...
@@ -283,7 +283,7 @@ Codec MIME类型枚举。
...
@@ -283,7 +283,7 @@ Codec MIME类型枚举。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| src | string | 是 | 是 | 音频媒体URI,支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。
<br>
**支持路径示例**
:
<br>
1、fd类型播放:fd://xx
<br>

<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>

<br>
2、http网络播放: http://xx
<br>
3、hls网络播放路径:开发中
<br>
**注意事项**
:
<br>
使用媒体素材需要获取读权限,否则无法正常播放。 |
| loop | boolean | 是 | 是 | 音频循环播放属性,设置为'true'表示循环播放。 |
| loop | boolean | 是 | 是 | 音频循环播放属性,设置为'true'表示循环播放。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置。 |
| duration | number | 是 | 否 | 音频时长。 |
| duration | number | 是 | 否 | 音频时长。 |
...
@@ -293,7 +293,7 @@ Codec MIME类型枚举。
...
@@ -293,7 +293,7 @@ Codec MIME类型枚举。
play(): void
play(): void
开始播放音频资源,需在
[
dataLoad
](
#
on('play'
| 'pause' | 'stop' | 'reset' | 'dataload' | 'finish' | 'volumechange')
)事件成功触发后,才能调用play方法。
开始播放音频资源,需在
[
dataLoad
](
#
audioplayer_on
)
事件成功触发后,才能调用play方法。
**系统能力:**
SystemCapability.Multimedia.Media.AudioPlayer
**系统能力:**
SystemCapability.Multimedia.Media.AudioPlayer
...
@@ -424,7 +424,7 @@ audioPlayer = undefined;
...
@@ -424,7 +424,7 @@ audioPlayer = undefined;
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription1></a>
### 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) => {
...
@@ -460,7 +460,7 @@ audioPlayer.getTrackDescription((error, arrlist) => {
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription2></a>
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription2></a>
getTrackDescription(): Promise
<Array
<[
MediaDescription
](
#mediadescription8
)
>
>
getTrackDescription(): Promise
<Array
\<
MediaDescription
>
>
通过Promise方式获取音频轨道信息。
通过Promise方式获取音频轨道信息。
...
@@ -512,9 +512,9 @@ on(type: 'bufferingUpdate', callback: (infoType: [BufferingInfoType](#bufferingi
...
@@ -512,9 +512,9 @@ on(type: 'bufferingUpdate', callback: (infoType: [BufferingInfoType](#bufferingi
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------
----------------------------------------------------
| ---- | ------------------------------------------------------------ |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 音频缓存事件回调类型,支持的事件:'bufferingUpdate'。 |
| type | string | 是 | 音频缓存事件回调类型,支持的事件:'bufferingUpdate'。 |
| callback |
(infoType:
[
BufferingInfoType
](
#bufferinginfotype8
)
, value: number) => void
| 是 | 音频缓存事件回调方法。
<br>
[
BufferingInfoType
](
#bufferinginfotype8
)
为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。 |
| callback |
function
| 是 | 音频缓存事件回调方法。
<br>
[
BufferingInfoType
](
#bufferinginfotype8
)
为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。 |
**示例:**
**示例:**
...
@@ -525,7 +525,7 @@ audioPlayer.on('bufferingUpdate', (infoType, value) => {
...
@@ -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
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
...
@@ -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 | 是 | 播放事件回调方法。 |
| callback | () => void | 是 | 播放事件回调方法。 |
**示例:**
**示例:**
...
@@ -609,7 +609,7 @@ on(type: 'timeUpdate', callback: Callback\<number>): 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的时间。 |
| callback | Callback
\<
number> | 是 | 播放事件回调方法。回调方法入参为成功seek的时间。 |
**示例:**
**示例:**
...
@@ -667,7 +667,7 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
...
@@ -667,7 +667,7 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
## VideoPlayer<sup>8+</sup>
## VideoPlayer<sup>8+</sup>
视频播放管理类,用于管理和播放视频媒体。在调用VideoPlayer的方法前,需要先通过
[
createVideoPlayer()
](
#media
.
createvideoplayer8
)
构建一个
[
VideoPlayer
](
#videoplayer8
)
实例。
视频播放管理类,用于管理和播放视频媒体。在调用VideoPlayer的方法前,需要先通过
[
createVideoPlayer()
](
#mediacreatevideoplayer8
)
构建一个
[
VideoPlayer
](
#videoplayer8
)
实例。
视频播放demo可参考:
[
视频播放开发指导
](
../../media/video-playback.md
)
视频播放demo可参考:
[
视频播放开发指导
](
../../media/video-playback.md
)
...
@@ -677,7 +677,7 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
...
@@ -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>

<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>

<br>
2、http网络播放: http://xx
<br/>
3、hls网络播放路径:开发中
<br/>
**注意事项**
:
<br>
使用媒体素材需要获取读权限,否则无法正常播放。 |
| loop
<sup>
8+
</sup>
| boolean | 是 | 是 | 视频循环播放属性,设置为'true'表示循环播放。 |
| loop
<sup>
8+
</sup>
| boolean | 是 | 是 | 视频循环播放属性,设置为'true'表示循环播放。 |
| currentTime
<sup>
8+
</sup>
| number | 是 | 否 | 视频的当前播放位置。 |
| currentTime
<sup>
8+
</sup>
| number | 是 | 否 | 视频的当前播放位置。 |
| duration
<sup>
8+
</sup>
| number | 是 | 否 | 视频时长,返回-1表示直播模式。 |
| duration
<sup>
8+
</sup>
| number | 是 | 否 | 视频时长,返回-1表示直播模式。 |
...
@@ -1054,9 +1054,9 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
...
@@ -1054,9 +1054,9 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------
| ---- | ----------
------------------------------ |
| -------- | --------
-------------- | ---- |
------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点,单位毫秒。 |
| timeMs | number | 是 | 指定的跳转时间节点,单位毫秒。 |
| mode |
SeekMode | 是 | 跳转模式,具体见
[
SeekMode
](
#seekmode8
)
。
|
| mode |
[
SeekMode
](
#seekmode8
)
| 是 | 跳转模式。
|
| callback | function | 是 | 跳转到指定播放位置的回调方法。 |
| callback | function | 是 | 跳转到指定播放位置的回调方法。 |
**示例:**
**示例:**
...
@@ -1082,9 +1082,9 @@ seek(timeMs: number, mode?:SeekMode): Promise\<number>
...
@@ -1082,9 +1082,9 @@ seek(timeMs: number, mode?:SeekMode): Promise\<number>
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------
| ---- | --------
------------------------------ |
| ------ | --------
-------------- | ---- |
------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点,单位毫秒。 |
| timeMs | number | 是 | 指定的跳转时间节点,单位毫秒。 |
| mode |
SeekMode | 否 | 跳转模式,具体见
[
SeekMode
](
#seekmode8
)
|
| mode |
[
SeekMode
](
#seekmode8
)
| 否 | 跳转模式。
|
**返回值:**
**返回值:**
...
@@ -1227,7 +1227,7 @@ await videoPlayer.release().then() => {
...
@@ -1227,7 +1227,7 @@ await videoPlayer.release().then() => {
### getTrackDescription<sup>8+</sup>
### getTrackDescription<sup>8+</sup>
getTrackDescription(callback: AsyncCallback
<Array
<[
MediaDescription
](
#mediadescription8
)
>
>): void
getTrackDescription(callback: AsyncCallback
<Array
\<
MediaDescription
>
>): void
通过回调方式获取视频轨道信息。
通过回调方式获取视频轨道信息。
...
@@ -1236,8 +1236,8 @@ getTrackDescription(callback: AsyncCallback<Array<[MediaDescription](#mediadescr
...
@@ -1236,8 +1236,8 @@ getTrackDescription(callback: AsyncCallback<Array<[MediaDescription](#mediadescr
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | -------------------------- |
| -------- | --------
----------------------------------------------------
| ---- | -------------------------- |
| callback |
function
| 是 | 获取视频轨道信息回调方法。 |
| callback |
AsyncCallback
<Array
<[
MediaDescription
](
#mediadescription8
)
>
>
| 是 | 获取视频轨道信息回调方法。 |
**示例:**
**示例:**
...
@@ -1263,7 +1263,7 @@ videoPlayer.getTrackDescription((error, arrlist) => {
...
@@ -1263,7 +1263,7 @@ videoPlayer.getTrackDescription((error, arrlist) => {
### getTrackDescription<sup>8+</sup>
### getTrackDescription<sup>8+</sup>
getTrackDescription(): Promise
<Array
<[
MediaDescription
](
#mediadescription8
)
>
>
getTrackDescription(): Promise
<Array
\<
MediaDescription
>
>
通过Promise方式获取视频轨道信息。
通过Promise方式获取视频轨道信息。
...
@@ -1418,9 +1418,9 @@ on(type: 'startRenderFrame', callback: Callback\<void>): void
...
@@ -1418,9 +1418,9 @@ on(type: 'startRenderFrame', callback: Callback\<void>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| -------- | --------
-------
| ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放首帧送显上报事件回调类型,支持的事件:'startRenderFrame'。 |
| type | string | 是 | 视频播放首帧送显上报事件回调类型,支持的事件:'startRenderFrame'。 |
| callback |
function
| 是 | 视频播放首帧送显上报事件回调方法。 |
| callback |
Callback
\<
void>
| 是 | 视频播放首帧送显上报事件回调方法。 |
**示例:**
**示例:**
...
@@ -1465,9 +1465,9 @@ on(type: 'error', callback: ErrorCallback): void
...
@@ -1465,9 +1465,9 @@ on(type: 'error', callback: ErrorCallback): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| -------- | --------
-----
| ---- | ------------------------------------------------------------ |
| type | string | 是 | 播放错误事件回调类型,支持的事件包括:'error'。
<br>
- 'error':视频播放中发生错误,触发该事件。 |
| type | string | 是 | 播放错误事件回调类型,支持的事件包括:'error'。
<br>
- 'error':视频播放中发生错误,触发该事件。 |
| callback |
function
| 是 | 播放错误事件回调方法。 |
| callback |
ErrorCallback
| 是 | 播放错误事件回调方法。 |
**示例:**
**示例:**
...
@@ -1555,7 +1555,7 @@ audioPlayer.getTrackDescription((error, arrlist) => {
...
@@ -1555,7 +1555,7 @@ audioPlayer.getTrackDescription((error, arrlist) => {
## AudioRecorder
## AudioRecorder
音频录制管理类,用于录制音频媒体。在调用AudioRecorder的方法前,需要先通过
[
createAudioRecorder()
](
#media
.
createaudiorecorder
)
构建一个
[
AudioRecorder
](
#audiorecorder
)
实例。
音频录制管理类,用于录制音频媒体。在调用AudioRecorder的方法前,需要先通过
[
createAudioRecorder()
](
#mediacreateaudiorecorder
)
构建一个
[
AudioRecorder
](
#audiorecorder
)
实例。
音频录制demo可参考:
[
音频录制开发指导
](
../../media/audio-recorder.md
)
音频录制demo可参考:
[
音频录制开发指导
](
../../media/audio-recorder.md
)
...
@@ -1798,7 +1798,7 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
...
@@ -1798,7 +1798,7 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
| format |
[
AudioOutputFormat
](
#audiooutputformat
)
| 否 | 音量输出封装格式,默认设置为MPEG_4。 |
| format |
[
AudioOutputFormat
](
#audiooutputformat
)
| 否 | 音量输出封装格式,默认设置为MPEG_4。 |
| location
<sup>
8+
</sup>
|
[
Location
](
#location8
)
| 否 | 音频采集的地理位置。 |
| location
<sup>
8+
</sup>
|
[
Location
](
#location8
)
| 否 | 音频采集的地理位置。 |
| uri | string | 是 | 视频输出URI:fd://xx
(fd
number)
<br/>

<br/>
文件需要由调用者创建,并赋予适当的权限。 |
| uri | string | 是 | 视频输出URI:fd://xx
(fd
number)
<br/>

<br/>
文件需要由调用者创建,并赋予适当的权限。 |
| audioEncoderMime |
[
CodecMimeType
](
#
CodecMimeType8
)
| 否 | 音频编码格式。
|
| audioEncoderMime |
[
CodecMimeType
](
#
codecmimetype8
)
| 否 | 音频编码格式。
|
## AudioEncoder
## AudioEncoder
...
@@ -1832,15 +1832,17 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
...
@@ -1832,15 +1832,17 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
## VideoRecorder<sup>8+</sup>
## VideoRecorder<sup>8+</sup>
视频录制管理类,用于录制视频媒体。在调用VideoRecorder的方法前,需要先通过
[
createVideoRecorder()
](
#media
.
createvideorecorder8
)
构建一个
[
VideoRecorder
](
#videorecorder8
)
实例。
视频录制管理类,用于录制视频媒体。在调用VideoRecorder的方法前,需要先通过
[
createVideoRecorder()
](
#mediacreatevideorecorder8
)
构建一个
[
VideoRecorder
](
#videorecorder8
)
实例。
视频录制demo可参考:
[
视频录制开发指导
](
../../media/video-recorder.md
)
视频录制demo可参考:
[
视频录制开发指导
](
../../media/video-recorder.md
)
### 属性
### 属性
**系统能力:**
以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | ------------------------------------- | ---- | ---- | ---------------- |
| ------------------ | -------------------------------------
-
| ---- | ---- | ---------------- |
| state
<sup>
8+
</sup>
|
[
VideoRecordState
](
#videorecordstate
)
| 是 | 否 | 视频录制的状态。 |
| state
<sup>
8+
</sup>
|
[
VideoRecordState
](
#videorecordstate
8
)
| 是 | 否 | 视频录制的状态。 |
### prepare<sup>8+</sup><a name=videorecorder_prepare1></a>
### prepare<sup>8+</sup><a name=videorecorder_prepare1></a>
...
@@ -1848,7 +1850,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
...
@@ -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
**系统能力:**
SystemCapability.Multimedia.Media.VideoRecorder
...
@@ -1916,7 +1918,7 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
...
@@ -1916,7 +1918,7 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
异步方式进行视频录制的参数设置。通过Promise获取返回值。
异步方式进行视频录制的参数设置。通过Promise获取返回值。
**需要权限:**
ohos.permission.MICROPHONE
ohos.permission.CAMERA
**需要权限:**
ohos.permission.MICROPHONE
,
ohos.permission.CAMERA
**系统能力:**
SystemCapability.Multimedia.Media.VideoRecorder
**系统能力:**
SystemCapability.Multimedia.Media.VideoRecorder
...
@@ -2435,13 +2437,13 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
...
@@ -2435,13 +2437,13 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
**系统能力:**
以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。
**系统能力:**
以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。
| 名称 | 参数类型 | 必填 | 说明 |
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ----------------------------------------------
------------
| ---- | ------------------------------------------------------------ |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType |
[
AudioSourceType
](
#audiosourcetype
<sup>
8+
</sup>
) | 是 | 视频录制的音频源类型。 |
| audioSourceType |
[
AudioSourceType
](
#audiosourcetype
8
)
| 是 | 视频录制的音频源类型。 |
| videoSourceType |
[
VideoSourceType
](
#videosourcetype
<sup>
8+
</sup>
) | 是 | 视频录制的视频源类型。 |
| videoSourceType |
[
VideoSourceType
](
#videosourcetype
8
)
| 是 | 视频录制的视频源类型。 |
| profile |
[
VideoRecorderProfile
](
#videorecorderprofile8
)
| 是 | 视频录制的profile。 |
| profile |
[
VideoRecorderProfile
](
#videorecorderprofile8
)
| 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| location |
[
Location
](
#location8
)
| 否 | 录制视频的地理位置。 |
| location |
[
Location
](
#location8
)
| 否 | 录制视频的地理位置。 |
| url | string
| 是 | 视频输出URL:fd://xx
(fd
number)
<br/>

<br/>
文件需要由调用者创建,并赋予适当的权限。 |
| url | string
| 是 | 视频输出URL:fd://xx
(fd
number)
<br/>

<br/>
文件需要由调用者创建,并赋予适当的权限。 |
## AudioSourceType<sup>8+</sup>
## AudioSourceType<sup>8+</sup>
...
@@ -2475,10 +2477,10 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
...
@@ -2475,10 +2477,10 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| ---------------- | -------------------------------------------- | ---- | ---------------- |
| ---------------- | -------------------------------------------- | ---- | ---------------- |
| audioBitrate | number | 是 | 音频编码比特率。 |
| audioBitrate | number | 是 | 音频编码比特率。 |
| audioChannels | number | 是 | 音频采集声道数。 |
| audioChannels | number | 是 | 音频采集声道数。 |
| audioCodec |
[
CodecMimeType
](
#
CodecMimeT
ype8
)
| 是 | 音频编码格式。 |
| audioCodec |
[
CodecMimeType
](
#
codecmimet
ype8
)
| 是 | 音频编码格式。 |
| audioSampleRate | number | 是 | 音频采样率。 |
| audioSampleRate | number | 是 | 音频采样率。 |
| fileFormat |
[
ContainerFormatType
](
#containerformattype8
)
| 是 | 文件的容器格式。 |
| fileFormat |
[
ContainerFormatType
](
#containerformattype8
)
| 是 | 文件的容器格式。 |
| videoCodec |
[
CodecMimeType
](
#
CodecMimeT
ype8
)
| 是 | 视频编码格式。 |
| videoCodec |
[
CodecMimeType
](
#
codecmimet
ype8
)
| 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @
651e19e4
媒体库管理
#
媒体库管理
==========
>  **说明:**
>  **说明:**
> 该组件从API Version 6开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 6开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
导入模块
## 导入模块
---------
```
```
import mediaLibrary from '@ohos.multimedia.medialibrary';
import mediaLibrary from '@ohos.multimedia.medialibrary';
```
```
...
@@ -21,13 +19,13 @@ getMediaLibrary(context: Context): MediaLibrary
...
@@ -21,13 +19,13 @@ getMediaLibrary(context: Context): MediaLibrary
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------- |
| ------- | ------- | ---- | --------------------
----------------------------------------
|
| context | Context | 是 | API7以下接口可不传此参数,API 8以上接口此参数是必填参数,传入Ability实例的context,获取媒体库 |
| context | Context | 是 | API7以下接口可不传此参数,API 8以上接口此参数是必填参数,传入Ability实例的context,获取媒体库 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------
| :
----- |
| ------------
----------------- | :----
----- |
|
[
MediaLibrary
](
#medialibrary
)
| 媒体库实例 |
|
[
MediaLibrary
](
#medialibrary
)
| 媒体库实例 |
**示例:**
**示例:**
...
@@ -97,7 +95,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>
...
@@ -97,7 +95,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>
**返回值**
**返回值**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------------------- | -------------- |
| -----------------------------
-------
| -------------- |
|
[
FetchFileResult
](
#fetchfileresult8
)
| 文件数据结果集 |
|
[
FetchFileResult
](
#fetchfileresult8
)
| 文件数据结果集 |
**示例:**
**示例:**
...
@@ -127,7 +125,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|
...
@@ -127,7 +125,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------
| ---- |
------------------- |
| -------- | ----------------
---- | ---- | -----------------------------------------
------------------- |
| type | string | 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| type | string | 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| callback | callback
<
void
>
| 是 | 回调返回空 |
| callback | callback
<
void
>
| 是 | 回调返回空 |
...
@@ -149,7 +147,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'
...
@@ -149,7 +147,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------
| ---- |
------------------- |
| -------- | ----------------
---- | ---- | -----------------------------------------
------------------- |
| type | string | 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| type | string | 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| callback | callback
<
void
>
| 否 | 回调返回空 |
| callback | callback
<
void
>
| 否 | 回调返回空 |
...
@@ -249,9 +247,9 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>):
...
@@ -249,9 +247,9 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>):
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------
| ------------------------------- | ---- |
------------ |
| ------
-- | ------------------------------- | ---- | -------------
------------ |
| type |
[
DirectoryType
](
#directorytype
)
| 是 | 公共目录类型 |
| type |
[
DirectoryType
](
#directorytype
)
| 是 | 公共目录类型 |
| callback
|AsyncCallback
<
string
>
| 是 | callback 返回公共目录路径 |
| callback
| AsyncCallback
<
string
>
| 是 | callback 返回公共目录路径 |
**示例:**
**示例:**
...
@@ -383,7 +381,7 @@ release(callback: AsyncCallback<void>): void
...
@@ -383,7 +381,7 @@ release(callback: AsyncCallback<void>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------
| ---- | --
-------------------- |
| -------- | -------------------
------ | ---- |
-------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调表示成功还是失败 |
| callback | AsyncCallback
<
void
>
| 是 | 回调表示成功还是失败 |
**示例:**
**示例:**
...
@@ -407,7 +405,7 @@ release(): Promise<void>
...
@@ -407,7 +405,7 @@ release(): Promise<void>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| --
--------------------------------- |
| -------------
------ |
--------------------------------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果 |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果 |
**示例:**
**示例:**
...
@@ -690,7 +688,9 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
...
@@ -690,7 +688,9 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
提供封装文件属性的方法。
提供封装文件属性的方法。
### **属性**
### 属性
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ----------------------- | ---- | ---- | ------------------------------------------------------ |
| ------------ | ----------------------- | ---- | ---- | ------------------------------------------------------ |
...
@@ -730,7 +730,7 @@ isDirectory(callback: AsyncCallback<boolean>): void
...
@@ -730,7 +730,7 @@ isDirectory(callback: AsyncCallback<boolean>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ----------------------------- |
| -------- | ----------------------
------
| ---- | ----------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 当前FileAsset是否是目录的回调 |
| callback | AsyncCallback
<
boolean
>
| 是 | 当前FileAsset是否是目录的回调 |
**示例:**
**示例:**
...
@@ -765,7 +765,7 @@ isDirectory():Promise<boolean>
...
@@ -765,7 +765,7 @@ isDirectory():Promise<boolean>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------
| --
---------------------------------------- |
| ----------------
------ |
---------------------------------------- |
| Promise
<
boolean
>
| Promise实例,返回当前FileAsset是否是目录 |
| Promise
<
boolean
>
| Promise实例,返回当前FileAsset是否是目录 |
**示例:**
**示例:**
...
@@ -802,7 +802,7 @@ commitModify(callback: AsyncCallback<void>): void
...
@@ -802,7 +802,7 @@ commitModify(callback: AsyncCallback<void>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- | ----------
---------- |
| -------- | ----------------------
--- | ---- |
---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
**示例:**
**示例:**
...
@@ -838,7 +838,7 @@ commitModify(): Promise<void>
...
@@ -838,7 +838,7 @@ commitModify(): Promise<void>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| ----------------
------------- |
| -------------
------ |
------------- |
| Promise
<
void
>
| Promise返回空 |
| Promise
<
void
>
| Promise返回空 |
**示例:**
**示例:**
...
@@ -872,7 +872,7 @@ open(mode: string, callback: AsyncCallback<number>): void
...
@@ -872,7 +872,7 @@ open(mode: string, callback: AsyncCallback<number>): void
**参数**
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- |
-------------------- |
| -------- | ----------------------
----- | ---- | ------------------------------------
-------------------- |
| mode | string | 是 | 打开文件方式,如:'r'(只读), 'w'(只写), 'rw'(读写) |
| mode | string | 是 | 打开文件方式,如:'r'(只读), 'w'(只写), 'rw'(读写) |
| callback | AsyncCallback
<
number
>
| 是 | 回调返回文件句柄 |
| callback | AsyncCallback
<
number
>
| 是 | 回调返回文件句柄 |
...
@@ -913,7 +913,7 @@ open(mode: string): Promise<number>
...
@@ -913,7 +913,7 @@ open(mode: string): Promise<number>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| ----------
------------------- |
| -------------
-------- |
------------------- |
| Promise
<
number
>
| Promise返回文件句柄 |
| Promise
<
number
>
| Promise返回文件句柄 |
**示例:**
**示例:**
...
@@ -947,7 +947,7 @@ close(fd: number, callback: AsyncCallback<void>): void
...
@@ -947,7 +947,7 @@ close(fd: number, callback: AsyncCallback<void>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- | ----------
---------- |
| -------- | ----------------------
--- | ---- |
---------- |
| fd | number | 是 | 文件描述符 |
| fd | number | 是 | 文件描述符 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
...
@@ -994,7 +994,7 @@ close(fd: number): Promise<void>
...
@@ -994,7 +994,7 @@ close(fd: number): Promise<void>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| ----------------
------------- |
| -------------
------ |
------------- |
| Promise
<
void
>
| Promise返回空 |
| Promise
<
void
>
| Promise返回空 |
**示例:**
**示例:**
...
@@ -1035,7 +1035,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void
...
@@ -1035,7 +1035,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- |
-------------------- |
| -------- | ----------------------
------------- | ---- | ----
-------------------- |
| callback | AsyncCallback
<
image.PixelMap
>
| 是 | 回调返回缩略图的PixelMap |
| callback | AsyncCallback
<
image.PixelMap
>
| 是 | 回调返回缩略图的PixelMap |
**示例:**
**示例:**
...
@@ -1070,7 +1070,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void
...
@@ -1070,7 +1070,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- |
-------------------- |
| -------- | ----------------------
------------- | ---- | ----
-------------------- |
| size |
[
Size
](
#size8
)
| 是 | 缩略图尺寸 |
| size |
[
Size
](
#size8
)
| 是 | 缩略图尺寸 |
| callback | AsyncCallback
<
image.PixelMap
>
| 是 | 回调返回缩略图的PixelMap |
| callback | AsyncCallback
<
image.PixelMap
>
| 是 | 回调返回缩略图的PixelMap |
...
@@ -1112,7 +1112,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>
...
@@ -1112,7 +1112,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| --
--------------------------- |
| -------------
---------------- |
--------------------------- |
| Promise
<
image.PixelMap
>
| Promise返回缩略图的PixelMap |
| Promise
<
image.PixelMap
>
| Promise返回缩略图的PixelMap |
**示例:**
**示例:**
...
@@ -1147,7 +1147,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void
...
@@ -1147,7 +1147,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------
| ---- |
-------------- |
| ---------- | -------------------
------ | ---- | --------------------------------------------
-------------- |
| isFavorite | boolean | 是 | 是否设置为收藏文件, true:设置为收藏文件,false:取消收藏 |
| isFavorite | boolean | 是 | 是否设置为收藏文件, true:设置为收藏文件,false:取消收藏 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
...
@@ -1189,7 +1189,7 @@ favorite(isFavorite: boolean): Promise<void>
...
@@ -1189,7 +1189,7 @@ favorite(isFavorite: boolean): Promise<void>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| ----------------
------------- |
| -------------
------ |
------------- |
| Promise
<
void
>
| Promise返回空 |
| Promise
<
void
>
| Promise返回空 |
**示例:**
**示例:**
...
@@ -1226,7 +1226,7 @@ isFavorite(callback: AsyncCallback<boolean>): void
...
@@ -1226,7 +1226,7 @@ isFavorite(callback: AsyncCallback<boolean>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------- |
| -------- | ----------------------
------
| ---- | ---------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调表示是否为收藏文件 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调表示是否为收藏文件 |
**示例:**
**示例:**
...
@@ -1265,7 +1265,7 @@ isFavorite():Promise<boolean>
...
@@ -1265,7 +1265,7 @@ isFavorite():Promise<boolean>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------- | ----------------------------- |
| -------------
---------
| ----------------------------- |
| Promise
<
boolean
>
| Promise回调表示是否是收藏文件 |
| Promise
<
boolean
>
| Promise回调表示是否是收藏文件 |
**示例:**
**示例:**
...
@@ -1304,7 +1304,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void>): void
...
@@ -1304,7 +1304,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- | --
------------------ |
| -------- | ----------------------
--- | ---- |
------------------ |
| isTrash | boolean | 是 | 是否设置为垃圾文件 |
| isTrash | boolean | 是 | 是否设置为垃圾文件 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
...
@@ -1349,7 +1349,7 @@ trash(isTrash: boolean): Promise<void>
...
@@ -1349,7 +1349,7 @@ trash(isTrash: boolean): Promise<void>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| ----------------
------------- |
| -------------
------ |
------------- |
| Promise
<
void
>
| Promise返回空 |
| Promise
<
void
>
| Promise返回空 |
**示例:**
**示例:**
...
@@ -1386,7 +1386,7 @@ isTrash(callback: AsyncCallback<boolean>): void
...
@@ -1386,7 +1386,7 @@ isTrash(callback: AsyncCallback<boolean>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------
| ---- |
-------------------- |
| -------- | ----------------------
------ | ---- | ----------
-------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调返回表示文件是否为垃圾文件 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调返回表示文件是否为垃圾文件 |
**示例:**
**示例:**
...
@@ -1430,7 +1430,7 @@ isTrash():Promise<boolean>
...
@@ -1430,7 +1430,7 @@ isTrash():Promise<boolean>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
|
----------------------------- |
| -------------
------ | ----
----------------------------- |
| Promise
<
void
>
| Promise回调表示文件是否为垃圾文件 |
| Promise
<
void
>
| Promise回调表示文件是否为垃圾文件 |
**示例:**
**示例:**
...
@@ -1601,7 +1601,7 @@ getFirstObject(): Promise<FileAsset>
...
@@ -1601,7 +1601,7 @@ getFirstObject(): Promise<FileAsset>
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------
| --------------
------------------------ |
| ------------------
--------------------- |
------------------------ |
| Promise
<
[FileAsset](#fileasset8)
>
| Promise方式返回FileAsset |
| Promise
<
[FileAsset](#fileasset8)
>
| Promise方式返回FileAsset |
**示例**
:
**示例**
:
...
@@ -1675,7 +1675,7 @@ async function example() {
...
@@ -1675,7 +1675,7 @@ async function example() {
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------
| --
----------------- |
| --------------------------------
------- |
----------------- |
| Promise
<
[FileAsset](#fileasset8)
>
| 返回FileAsset对象 |
| Promise
<
[FileAsset](#fileasset8)
>
| 返回FileAsset对象 |
**示例**
:
**示例**
:
...
@@ -1743,7 +1743,7 @@ getLastObject(): Promise<FileAsset>
...
@@ -1743,7 +1743,7 @@ getLastObject(): Promise<FileAsset>
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------
| --
----------------- |
| --------------------------------
------- |
----------------- |
| Promise
<
[FileAsset](#fileasset8)
>
| 返回FileAsset对象 |
| Promise
<
[FileAsset](#fileasset8)
>
| 返回FileAsset对象 |
**示例**
:
**示例**
:
...
@@ -1812,13 +1812,13 @@ getPositionObject(index: number): Promise<FileAsset>
...
@@ -1812,13 +1812,13 @@ getPositionObject(index: number): Promise<FileAsset>
**参数**
:
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | -------------------- |
| ----- | ------ | ---- | --------------------
-------
|
| index | number | 是 | 要获取的文件的索引,从0开始 |
| index | number | 是 | 要获取的文件的索引,从0开始 |
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------
| --
----------------- |
| --------------------------------
------- |
----------------- |
| Promise
<
[FileAsset](#fileasset8)
>
| 返回FileAsset对象 |
| Promise
<
[FileAsset](#fileasset8)
>
| 返回FileAsset对象 |
**示例**
:
**示例**
:
...
@@ -1917,6 +1917,8 @@ async function example() {
...
@@ -1917,6 +1917,8 @@ async function example() {
### **属性**
### **属性**
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 参数型 | 可读 | 可写 | 说明 |
| 名称 | 参数型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | -------------- |
| ------------ | ------ | ---- | ---- | -------------- |
| albumId | number | 是 | 否 | 相册编号 |
| albumId | number | 是 | 否 | 相册编号 |
...
@@ -1940,7 +1942,7 @@ commitModify(callback: AsyncCallback<void>): void
...
@@ -1940,7 +1942,7 @@ commitModify(callback: AsyncCallback<void>): void
**参数**
:
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------
| ---- | -------------------
---------- |
| -------- | -------------------
------ | ---- |
---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
| callback | AsyncCallback
<
void
>
| 是 | 回调返回空 |
**示例**
:
**示例**
:
...
@@ -1977,7 +1979,7 @@ commitModify(): Promise<void>
...
@@ -1977,7 +1979,7 @@ commitModify(): Promise<void>
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| -------------
| -----------------------------------
----------------- |
| -------------
------ |
----------------- |
| Promise
<
void
>
| Promise调用返回空 |
| Promise
<
void
>
| Promise调用返回空 |
**示例**
:
**示例**
:
...
@@ -2012,7 +2014,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe
...
@@ -2012,7 +2014,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe
**参数**
:
**参数**
:
| 参数 | 类型 | 必填 | 说明 |
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | --------------------------------- |
| -------- | --------------------------------------------
-------
| ---- | --------------------------------- |
| options |
[
MediaFetchOptions
](
#mediafetchoptions8
)
| 是 | 媒体检索选项 |
| options |
[
MediaFetchOptions
](
#mediafetchoptions8
)
| 是 | 媒体检索选项 |
| callback | AsyncCallback
<
[
FetchFileResult
](
#fetchfileresult8
)
>
| 是 | 异步返回FetchFileResult之后的回调 |
| callback | AsyncCallback
<
[
FetchFileResult
](
#fetchfileresult8
)
>
| 是 | 异步返回FetchFileResult之后的回调 |
...
@@ -2077,6 +2079,8 @@ async function example() {
...
@@ -2077,6 +2079,8 @@ async function example() {
注册设备的信息。
注册设备的信息。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | ---------- | ---- | ---- | ---------------- |
| ---------- | ---------- | ---- | ---- | ---------------- |
| deviceName | string | 是 | 否 | 注册设备的名称 |
| deviceName | string | 是 | 否 | 注册设备的名称 |
...
@@ -2091,6 +2095,8 @@ MediaType
...
@@ -2091,6 +2095,8 @@ MediaType
枚举,媒体类型。
枚举,媒体类型。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| 名称 | 默认值 | 描述 |
| ----- | ------ | ---- |
| ----- | ------ | ---- |
| FILE | 0 | 文件 |
| FILE | 0 | 文件 |
...
@@ -2103,6 +2109,8 @@ FileKey
...
@@ -2103,6 +2109,8 @@ FileKey
枚举,文件关键信息。
枚举,文件关键信息。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| 名称 | 默认值 | 描述 |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ID | file_id | 文件编号 |
| ID | file_id | 文件编号 |
...
@@ -2130,6 +2138,8 @@ DirectoryType
...
@@ -2130,6 +2138,8 @@ DirectoryType
枚举,目录类型。
枚举,目录类型。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| 名称 | 默认值 | 描述 |
| ------------- | ------ | ------------------ |
| ------------- | ------ | ------------------ |
| DIR_CAMERA | 0 | 表示Camera文件路径 |
| DIR_CAMERA | 0 | 表示Camera文件路径 |
...
@@ -2144,6 +2154,8 @@ DeviceType
...
@@ -2144,6 +2154,8 @@ DeviceType
枚举,设备类型。
枚举,设备类型。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 默认值 | 描述 |
| 名称 | 默认值 | 描述 |
| ------------ | ------ | ---------- |
| ------------ | ------ | ---------- |
| TYPE_UNKNOWN | 0 | 未识别设备 |
| TYPE_UNKNOWN | 0 | 未识别设备 |
...
@@ -2158,14 +2170,16 @@ DeviceType
...
@@ -2158,14 +2170,16 @@ DeviceType
检索条件。
检索条件。
| 名称 | 类型 | 可读 | 可写 | 必填 |说明 |
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| ------------- | ------------- | ---- | ---- | ---- |---------------- |
| selections | string | 是 | 是 |是 | 检索条件,使用
[
FileKey
](
#filekey
)
中的枚举值作为检索条件的列名。示例:
<br
/>
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, |
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| selectionArgs | Array
<
string
>
| 是 | 是 |是 | 检索条件的值,对应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" |
| selections | string | 是 | 是 | 是 | 检索条件,使用
[
FileKey
](
#filekey
)
中的枚举值作为检索条件的列名。示例:
<br
/>
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, |
| uri | string | 是 | 是 | 否 |文件URI |
| selectionArgs | Array
<
string
>
| 是 | 是 | 是 | 检索条件的值,对应selections中检索条件列的值。
<br
/>
示例:
<br
/>
selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| networkId | string | 是 | 是 | 否 |注册设备网络ID |
| order | string | 是 | 是 | 否 | 检索结果排序方式,使用
[
FileKey
](
#filekey
)
中的枚举值作为检索结果排序的列,可以用升序或降序排列。示例:
<br
/>
升序排列:order: mediaLibrary.FileKey.DATE_ADDED + " AESC"
<br
/>
降序排列:order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
| extendArgs | string | 是 | 是 | 否 |扩展的检索参数,目前没有扩展检索参数 |
| uri | string | 是 | 是 | 否 | 文件URI |
| networkId | string | 是 | 是 | 否 | 注册设备网络ID |
| extendArgs | string | 是 | 是 | 否 | 扩展的检索参数,目前没有扩展检索参数 |
## Size<sup>8+</sup>
## Size<sup>8+</sup>
...
@@ -2199,11 +2213,7 @@ DeviceType
...
@@ -2199,11 +2213,7 @@ DeviceType
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
### 属性
| 名称 | 类型 | 必填 | 描述 |
| 名称 | 类型 | 必填 | 描述 |
| ----- | ------ | ---- | ------------------------------ |
| ----- | ------ | ---- | ------------------------------ |
| type | string | 是 | 媒体类型,包括:image,video。 |
| 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录