Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 3c8292d5 编写于 作者: X x30034819
浏览文件
操作

avplayer avrecorder Signed-off-by: x30034819 <xieyijun3@huawei.com> 

Signed-off-by: Nx30034819 <xieyijun3@huawei.com>
Change-Id: Iec608d2446222c40150949da40a6154d46e23b25
上级 218d65ef
隐藏空白更改
内联 并排
Showing with 1553 addition and 1568 deletion
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 3c8292d5
...@@ -174,6 +174,88 @@ media.createAVRecorder().then((recorder) => { ...@@ -174,6 +174,88 @@ media.createAVRecorder().then((recorder) => {
}); });
``` ```
## media.createVideoRecorder<sup>9+</sup>
createVideoRecorder(callback: AsyncCallback\<VideoRecorder>): void
异步方式创建视频录制实例。通过注册回调函数获取返回值。
一台设备只允许创建一个录制实例。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------ |
| 5400101 | No memory. Return by callback. |
**示例：**
```js
let videoRecorder
media.createVideoRecorder((error, video) => {
if (video != null) {
videoRecorder = video;
console.info('video createVideoRecorder success');
} else {
console.info(`video createVideoRecorder fail, error:${error}`);
}
});
```
## media.createVideoRecorder<sup>9+</sup>
createVideoRecorder(): Promise\<VideoRecorder>
异步方式创建视频录制实例。通过Promise获取返回值。
一台设备只允许创建一个录制实例。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**返回值：**
| 类型 | 说明 |
| ----------------------------------------- | ------------------------------------------------------------ |
| Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------- |
| 5400101 | No memory. Return by promise. |
**示例：**
```js
let videoRecorder
media.createVideoRecorder().then((video) => {
if (video != null) {
videoRecorder = video;
console.info('video createVideoRecorder success');
} else {
console.info('video createVideoRecorder fail');
}
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
```
## AVErrorCode<sup>9+</sup><a name=averrorcode></a> ## AVErrorCode<sup>9+</sup><a name=averrorcode></a>
[媒体错误码](../errorcodes/errorcode-media.md)类型枚举 [媒体错误码](../errorcodes/errorcode-media.md)类型枚举
...@@ -2465,128 +2547,97 @@ AVRecorder.off('error'); ...@@ -2465,128 +2547,97 @@ AVRecorder.off('error');
| latitude | number | 是 | 地理位置的纬度。 | | latitude | number | 是 | 地理位置的纬度。 |
| longitude | number | 是 | 地理位置的经度。 | | longitude | number | 是 | 地理位置的经度。 |
## media.createAudioPlayer<sup>(deprecated)</sup><a name=createaudioplayer></a> ## VideoRecorder<sup>9+</sup>
createAudioPlayer(): AudioPlayer
同步方式创建音频播放实例。
> **说明：** > **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[createAVPlayer](#mediacreateavplayer9)替代。 > AVRecorder<sup>9+</sup>发布后停止维护，建议使用[AVRecorder](#avrecorder9)替代。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**返回值：**
| 类型 | 说明 |
| --------------------------- | ------------------------------------------------------------ |
| [AudioPlayer](#audioplayerdeprecated) | 返回AudioPlayer类实例，失败时返回null。可用于音频播放、暂停、停止等操作。 |
**示例：**
```js 视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder9)构建一个[VideoRecorder](#videorecorder9)实例。
let audioPlayer = media.createAudioPlayer();
```
## media.createVideoPlayer<sup>(deprecated)</sup><a name=createvideoplayer></a>
createVideoPlayer(callback: AsyncCallback\<VideoPlayer>): void 视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md)
异步方式创建视频播放实例，通过注册回调函数获取返回值。 ### 属性
> **说明：** **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
> 从API version 8开始支持，从API version 9开始废弃，建议使用[createAVPlayer](#mediacreateavplayer9)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统接口：** 该接口为系统接口
**参数：** | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | -------------------------------------- | ---- | ---- | ---------------- |
| state<sup>9+</sup> | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 |
| 参数名 | 类型 | 必填 | 说明 | ### prepare<sup>9+</sup><a name=videorecorder_prepare1></a>
| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<[VideoPlayer](#videoplayerdeprecated)> | 是 | 回调函数。异步返回VideoPlayer实例，失败时返回null。可用于管理和播放视频媒体。 |
**示例：** prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
```js 异步方式进行视频录制的参数设置。通过注册回调函数获取返回值。
let videoPlayer
media.createVideoPlayer((error, video) => { **需要权限：** ohos.permission.MICROPHONE
if (video != null) {
videoPlayer = video;
console.info('video createVideoPlayer success');
} else {
console.info(`video createVideoPlayer fail, error:${error}`);
}
});
```
## media.createVideoPlayer<sup>(deprecated)</sup> **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
createVideoPlayer(): Promise\<VideoPlayer> **系统接口：** 该接口为系统接口
异步方式创建视频播放实例，通过Promise获取返回值。 **参数：**
> **说明：** | 参数名 | 类型 | 必填 | 说明 |
> 从API version 8开始支持，从API version 9开始废弃，建议使用[createAVPlayer](#mediacreateavplayer9-1)替代。 | -------- | -------------------------------------------- | ---- | ----------------------------------- |
| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
| callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 |
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **错误码：**
**返回值：** 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------------------------------------ | ------------------------------------------------------------ | | -------- | ------------------------------------------ |
| Promise<[VideoPlayer](#videoplayerdeprecated)> | Promise对象。异步返回VideoPlayer实例，失败时返回null。可用于管理和播放视频媒体。 | | 201 | Permission denied. Return by callback. |
| 401 | Parameter error. Return by callback. |
| 5400102 | Operation not allowed. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
let videoPlayer let videoProfile = {
audioBitrate : 48000,
media.createVideoPlayer().then((video) => { audioChannels : 2,
if (video != null) { audioCodec : 'audio/mp4a-latm',
videoPlayer = video; audioSampleRate : 48000,
console.info('video createVideoPlayer success'); fileFormat : 'mp4',
} else { videoBitrate : 48000,
console.info('video createVideoPlayer fail'); videoCodec : 'video/mp4v-es',
} videoFrameWidth : 640,
}).catch((error) => { videoFrameHeight : 480,
console.info(`video catchCallback, error:${error}`); videoFrameRate : 30
}); }
```
## media.createAudioRecorder<sup>(deprecated)</sup><a name=createaudiorecorder></a>
createAudioRecorder(): AudioRecorder
创建音频录制的实例来控制音频的录制。
一台设备只允许创建一个录制实例。
> **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[createAVRecorder](#mediacreateavrecorder9)替代。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**返回值:**
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| [AudioRecorder](#audiorecorderdeprecated) | 返回AudioRecorder类实例，失败时返回null。可用于录制音频媒体。 |
**示例：** let videoConfig = {
audioSourceType : 1,
videoSourceType : 0,
profile : videoProfile,
url : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
```js // asyncallback
let audioRecorder = media.createAudioRecorder(); videoRecorder.prepare(videoConfig, (err) => {
if (err == null) {
console.info('prepare success');
} else {
console.info('prepare failed and error is ' + err.message);
}
})
``` ```
## media.createVideoRecorder<sup>(deprecated)</sup><a name=mediacreatevideorecorder9></a> ### prepare<sup>9+</sup><a name=videorecorder_prepare2></a>
createVideoRecorder(callback: AsyncCallback\<VideoRecorder>): void prepare(config: VideoRecorderConfig): Promise\<void>;
> **说明：** 异步方式进行视频录制的参数设置。通过Promise获取返回值。
> 从API version 9开始支持，从API version 9开始废弃，建议使用[createAVRecorder](#mediacreateavrecorder9)替代。
异步方式创建视频录制实例。通过注册回调函数获取返回值。 **需要权限：** ohos.permission.MICROPHONE
一台设备只允许创建一个录制实例。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
...@@ -2594,967 +2645,960 @@ createVideoRecorder(callback: AsyncCallback\<VideoRecorder>): void ...@@ -2594,967 +2645,960 @@ createVideoRecorder(callback: AsyncCallback\<VideoRecorder>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | -------------------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 | | config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
**返回值：**
| 类型 | 说明 |
| -------------- | ---------------------------------------- |
| Promise\<void> | 异步视频录制prepare方法的Promise返回值。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ------------------------------ | | -------- | ----------------------------------------- |
| 5400101 | No memory. Return by callback. | | 201 | Permission denied. Return by promise. |
| 401 | Parameter error. Return by promise. |
| 5400102 | Operation not allowed. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
let videoRecorder let videoProfile = {
audioBitrate : 48000,
media.createVideoRecorder((error, video) => { audioChannels : 2,
if (video != null) { audioCodec : 'audio/mp4a-latm',
videoRecorder = video; audioSampleRate : 48000,
console.info('video createVideoRecorder success'); fileFormat : 'mp4',
} else { videoBitrate : 48000,
console.info(`video createVideoRecorder fail, error:${error}`); videoCodec : 'video/mp4v-es',
} videoFrameWidth : 640,
videoFrameHeight : 480,
videoFrameRate : 30
}
let videoConfig = {
audioSourceType : 1,
videoSourceType : 0,
profile : videoProfile,
url : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
// promise
videoRecorder.prepare(videoConfig).then(() => {
console.info('prepare success');
}).catch((err) => {
console.info('prepare failed and catch error is ' + err.message);
}); });
``` ```
## media.createVideoRecorder<sup>(deprecated)</sup> ### getInputSurface<sup>9+</sup>
createVideoRecorder(): Promise\<VideoRecorder> getInputSurface(callback: AsyncCallback\<string>): void;
> **说明：** 异步方式获得录制需要的surface。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。
> 从API version 9开始支持，从API version 9开始废弃，建议使用[createAVRecorder](#mediacreateavrecorder9)替代。
异步方式创建视频录制实例。通过Promise获取返回值。 应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。
一台设备只允许创建一个录制实例。
只能在[prepare()](#videorecorder_prepare1)接口调用后调用。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口 **系统接口：** 该接口为系统接口
**返回值：** **参数：**
| 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------------------------------- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | --------------------------- |
| Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 | | callback | AsyncCallback\<string> | 是 | 异步获得surface的回调方法。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ----------------------------- | | -------- | ------------------------------------------ |
| 5400101 | No memory. Return by promise. | | 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
let videoRecorder // asyncallback
let surfaceID = null; // 传递给外界的surfaceID
media.createVideoRecorder().then((video) => { videoRecorder.getInputSurface((err, surfaceId) => {
if (video != null) { if (err == null) {
videoRecorder = video; console.info('getInputSurface success');
console.info('video createVideoRecorder success'); surfaceID = surfaceId;
} else { } else {
console.info('video createVideoRecorder fail'); console.info('getInputSurface failed and error is ' + err.message);
} }
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
}); });
``` ```
## MediaErrorCode<sup>(deprecated)</sup><a name=mediaerrorcode></a> ### getInputSurface<sup>9+</sup>
媒体服务错误类型枚举。
> **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[媒体错误码](../errorcodes/errorcode-media.md)替代。
**系统能力：** SystemCapability.Multimedia.Media.Core
| 名称 | 值 | 说明 | getInputSurface(): Promise\<string>;
| -------------------------- | ---- | -------------------------------------- |
| MSERR_OK | 0 | 表示操作成功。 |
| MSERR_NO_MEMORY | 1 | 表示申请内存失败，系统可能无可用内存。 |
| MSERR_OPERATION_NOT_PERMIT | 2 | 表示无权限执行此操作。 |
| MSERR_INVALID_VAL | 3 | 表示传入入参无效。 |
| MSERR_IO | 4 | 表示发生IO错误。 |
| MSERR_TIMEOUT | 5 | 表示操作超时。 |
| MSERR_UNKNOWN | 6 | 表示未知错误。 |
| MSERR_SERVICE_DIED | 7 | 表示服务端失效。 |
| MSERR_INVALID_STATE | 8 | 表示在当前状态下，不允许执行此操作。 |
| MSERR_UNSUPPORTED | 9 | 表示在当前版本下，不支持此操作。 |
## AudioPlayer<sup>(deprecated)</sup> 异步方式获得录制需要的surface。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。
> **说明：** 应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVPlayer](#avplayer9)替代。
音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过[createAudioPlayer()](#mediacreateaudioplayerdeprecated)构建一个AudioPlayer实例。 只能在[prepare()](#videorecorder_prepare1)接口调用后调用。
### 属性<a name=audioplayer_属性></a> **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer **系统接口：** 该接口为系统接口
| 名称 | 类型 | 可读 | 可写 | 说明 | **返回值：**
| ------------------------------- | ------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(m4a、aac、mp3、ogg、wav)。<br>**支持路径示例**：<br>1. fd类型播放：fd://xx<br>![](figures/zh-cn_image_url.png)<br>2. http网络播放: http://xx<br/>3. https网络播放: https://xx<br/>4. hls网络播放路径：http://xx或者https://xx<br/>**需要权限：** ohos.permission.READ_MEDIA 或 ohos.permission.INTERNET。 |
| fdSrc<sup>9+</sup> | [AVFileDescriptor](#avfiledescriptor9) | 是 | 是 | 音频媒体文件描述，使用场景：应用中的音频资源被连续存储在同一个文件中。<br/>**使用示例**：<br/>假设一个连续存储的音乐文件: <br/>音乐1(地址偏移:0，字节长度:100)<br/>音乐2(地址偏移:101，字节长度:50)<br/>音乐3(地址偏移:151，字节长度:150)<br/>1. 播放音乐1：AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; }<br/>2. 播放音乐2：AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; }<br/>3. 播放音乐3：AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; }<br/>假设是一个独立的音乐文件: 请使用src=fd://xx <br/> |
| loop | boolean | 是 | 是 | 音频循环播放属性，设置为'true'表示循环播放。 |
| audioInterruptMode<sup>9+</sup> | [audio.InterruptMode](js-apis-audio.md#interruptmode9) | 是 | 是 | 音频焦点模型。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置，单位为毫秒（ms）。 |
| duration | number | 是 | 否 | 音频时长，单位为毫秒（ms）。 |
| state | [AudioState](#audiostate) | 是 | 否 | 可以查询音频播放的状态，该状态不可作为调用play/pause/stop等状态切换的触发条件。 |
### play<a name=audioplayer_play></a> | 类型 | 说明 |
| ---------------- | -------------------------------- |
| Promise\<string> | 异步获得surface的Promise返回值。 |
play(): void **错误码：**
开始播放音频资源，需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用。 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer | 错误码ID | 错误信息 |
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
audioPlayer.on('play', () => { //设置'play'事件回调 // promise
console.log('audio play success'); let surfaceID = null; // 传递给外界的surfaceID
videoRecorder.getInputSurface().then((surfaceId) => {
console.info('getInputSurface success');
surfaceID = surfaceId;
}).catch((err) => {
console.info('getInputSurface failed and catch error is ' + err.message);
}); });
audioPlayer.play();
``` ```
### pause<a name=audioplayer_pause></a> ### start<sup>9+</sup><a name=videorecorder_start1></a>
pause(): void start(callback: AsyncCallback\<void>): void;
暂停播放音频资源。 异步方式开始视频录制。通过注册回调函数获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer 在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)后调用，需要依赖数据源先给surface传递数据。
**示例：** **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
```js **系统接口：** 该接口为系统接口
audioPlayer.on('pause', () => { //设置'pause'事件回调
console.log('audio pause success');
});
audioPlayer.pause();
```
### stop<a name=audioplayer_stop></a> **参数：**
stop(): void | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步开始视频录制的回调方法。 |
停止播放音频资源。 **错误码：**
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
audioPlayer.on('stop', () => { //设置'stop'事件回调 // asyncallback
console.log('audio stop success'); videoRecorder.start((err) => {
if (err == null) {
console.info('start videorecorder success');
} else {
console.info('start videorecorder failed and error is ' + err.message);
}
}); });
audioPlayer.stop();
``` ```
### reset<sup>7+</sup><a name=audioplayer_reset></a> ### start<sup>9+</sup><a name=videorecorder_start2></a>
reset(): void
重置播放音频资源。 start(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer 异步方式开始视频录制。通过Promise获取返回值。
**示例：** 在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)后调用，需要依赖数据源先给surface传递数据。
```js **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
audioPlayer.on('reset', () => { //设置'reset'事件回调
console.log('audio reset success');
});
audioPlayer.reset();
```
### seek<a name=audioplayer_seek></a> **系统接口：** 该接口为系统接口
seek(timeMs: number): void **返回值：**
跳转到指定播放位置。 | 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步开始视频录制方法的Promise返回值。 |
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer **错误码：**
**参数：** 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 参数名 | 类型 | 必填 | 说明 | | 错误码ID | 错误信息 |
| ------ | ------ | ---- | ----------------------------------------------------------- | | -------- | ----------------------------------------- |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围[0, duration]。 | | 5400102 | Operation not allowed. Return by promise. |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调 // promise
if (seekDoneTime == null) { videoRecorder.start().then(() => {
console.info('audio seek fail'); console.info('start videorecorder success');
return; }).catch((err) => {
} console.info('start videorecorder failed and catch error is ' + err.message);
console.log('audio seek success. seekDoneTime: ' + seekDoneTime);
}); });
audioPlayer.seek(30000); //seek到30000ms的位置
``` ```
### setVolume<a name=audioplayer_setvolume></a> ### pause<sup>9+</sup><a name=videorecorder_pause1></a>
setVolume(vol: number): void pause(callback: AsyncCallback\<void>): void;
设置音量。 异步方式暂停视频录制。通过注册回调函数获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer 在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | -------- | -------------------- | ---- | ---------------------------- |
| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 | | callback | AsyncCallback\<void> | 是 | 异步暂停视频录制的回调方法。 |
**示例：** **错误码：**
```js 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调
console.log('audio volumeChange success'); | 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：**
```js
// asyncallback
videoRecorder.pause((err) => {
if (err == null) {
console.info('pause videorecorder success');
} else {
console.info('pause videorecorder failed and error is ' + err.message);
}
}); });
audioPlayer.setVolume(1); //设置音量到100%
``` ```
### release<a name=audioplayer_release></a> ### pause<sup>9+</sup><a name=videorecorder_pause2></a>
release(): void pause(): Promise\<void>;
释放音频资源。 异步方式暂停视频录制。通过Promise获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer 在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步暂停视频录制方法的Promise返回值。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
audioPlayer.release(); // promise
audioPlayer = undefined; videoRecorder.pause().then(() => {
console.info('pause videorecorder success');
}).catch((err) => {
console.info('pause videorecorder failed and catch error is ' + err.message);
});
``` ```
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription1></a> ### resume<sup>9+</sup><a name=videorecorder_resume1></a>
getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void resume(callback: AsyncCallback\<void>): void;
通过回调方式获取音频轨道信息。需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用。 异步方式恢复视频录制。通过注册回调函数获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------ | | -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<Array\<[MediaDescription](#mediadescription8)>> | 是 | 音频轨道信息MediaDescription数组回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步恢复视频录制的回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
function printfDescription(obj) { // asyncallback
for (let item in obj) { videoRecorder.resume((err) => {
let property = obj[item]; if (err == null) {
console.info('audio key is ' + item); console.info('resume videorecorder success');
console.info('audio value is ' + property);
}
}
audioPlayer.getTrackDescription((error, arrList) => {
if (arrList != null) {
for (let i = 0; i < arrList.length; i++) {
printfDescription(arrList[i]);
}
} else { } else {
console.log(`audio getTrackDescription fail, error:${error}`); console.info('resume videorecorder failed and error is ' + err.message);
} }
}); });
``` ```
### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription2></a> ### resume<sup>9+</sup><a name=videorecorder_resume2></a>
getTrackDescription(): Promise\<Array\<MediaDescription>> resume(): Promise\<void>;
通过Promise方式获取音频轨道信息。需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用 异步方式恢复视频录制。通过Promise获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------ | ----------------------------------------------- | | -------------- | ------------------------------------- |
| Promise<Array<[MediaDescription](#mediadescription8)>> | 音频轨道信息MediaDescription数组Promise返回值。 | | Promise\<void> | 异步恢复视频录制方法的Promise返回值。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
function printfDescription(obj) { // promise
for (let item in obj) { videoRecorder.resume().then(() => {
let property = obj[item]; console.info('resume videorecorder success');
console.info('audio key is ' + item); }).catch((err) => {
console.info('audio value is ' + property); console.info('resume videorecorder failed and catch error is ' + err.message);
} });
} ```
let arrayDescription = null
audioPlayer.getTrackDescription().then((arrList) => { ### stop<sup>9+</sup><a name=videorecorder_stop1></a>
if (arrList != null) {
arrayDescription = arrList; stop(callback: AsyncCallback\<void>): void;
异步方式停止视频录制。通过注册回调函数获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步停止视频录制的回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：**
```js
// asyncallback
videoRecorder.stop((err) => {
if (err == null) {
console.info('stop videorecorder success');
} else { } else {
console.log('audio getTrackDescription fail'); console.info('stop videorecorder failed and error is ' + err.message);
} }
}).catch((error) => {
console.info(`audio catchCallback, error:${error}`);
}); });
for (let i = 0; i < arrayDescription.length; i++) {
printfDescription(arrayDescription[i]);
}
``` ```
### on('bufferingUpdate')<sup>8+</sup> ### stop<sup>9+</sup><a name=videorecorder_stop2></a>
on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void stop(): Promise\<void>;
开始订阅音频缓存更新事件。仅网络播放支持该订阅事件。 异步方式停止视频录制。通过Promise获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。
**参数：** **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
| 参数名 | 类型 | 必填 | 说明 | **系统接口：** 该接口为系统接口
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 音频缓存事件回调类型，支持的事件：'bufferingUpdate'。 | **返回值：**
| callback | function | 是 | 音频缓存事件回调方法。<br>[BufferingInfoType](#bufferinginfotype8)为BUFFERING_PERCENT或CACHED_DURATION时，value值有效，否则固定为0。 |
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步停止视频录制方法的Promise返回值。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
audioPlayer.on('bufferingUpdate', (infoType, value) => { // promise
console.log('audio bufferingInfo type: ' + infoType); videoRecorder.stop().then(() => {
console.log('audio bufferingInfo value: ' + value); console.info('stop videorecorder success');
}).catch((err) => {
console.info('stop videorecorder failed and catch error is ' + err.message);
}); });
``` ```
### on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')<a name = audioplayer_on></a> ### release<sup>9+</sup><a name=videorecorder_release1></a>
on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void release(callback: AsyncCallback\<void>): void;
开始订阅音频播放事件。 异步方式释放视频录制资源。通过注册回调函数获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------- | ---- | ------------------------------------------------------------ | | -------- | -------------------- | ---- | -------------------------------- |
| 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 | AsyncCallback\<void> | 是 | 异步释放视频录制资源的回调方法。 |
| callback | () => void | 是 | 播放事件回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------- |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
import fileio from '@ohos.fileio' // asyncallback
videoRecorder.release((err) => {
let audioPlayer = media.createAudioPlayer(); //创建一个音频播放实例 if (err == null) {
audioPlayer.on('dataLoad', () => { //设置'dataLoad'事件回调，src属性设置成功后，触发此回调 console.info('release videorecorder success');
console.info('audio set source success'); } else {
audioPlayer.play(); //开始播放，并触发'play'事件回调 console.info('release videorecorder failed and error is ' + err.message);
});
audioPlayer.on('play', () => { //设置'play'事件回调
console.info('audio play success');
audioPlayer.seek(30000); //调用seek方法，并触发'timeUpdate'事件回调
});
audioPlayer.on('pause', () => { //设置'pause'事件回调
console.info('audio pause success');
audioPlayer.stop(); //停止播放，并触发'stop'事件回调
});
audioPlayer.on('reset', () => { //设置'reset'事件回调
console.info('audio reset success');
audioPlayer.release(); //释放播放实例资源
audioPlayer = undefined;
});
audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调
if (seekDoneTime == null) {
console.info('audio seek fail');
return;
} }
console.info('audio seek success, and seek time is ' + seekDoneTime);
audioPlayer.setVolume(0.5); //设置音量为50%，并触发'volumeChange'事件回调
});
audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调
console.info('audio volumeChange success');
audioPlayer.pause(); //暂停播放，并触发'pause'事件回调
});
audioPlayer.on('finish', () => { //设置'finish'事件回调
console.info('audio play finish');
audioPlayer.stop(); //停止播放，并触发'stop'事件回调
});
audioPlayer.on('error', (error) => { //设置'error'事件回调
console.info(`audio error called, error: ${error}`);
});
// 用户选择视频设置fd(本地播放)
let fdPath = 'fd://';
// path路径的码流可通过"hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" 命令，将其推送到设备上
let path = '/data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
fileio.open(path).then((fdValue) => {
fdPath = fdPath + '' + fdValue;
console.info('open fd success fd is' + fdPath);
}, (err) => {
console.info('open fd failed err is' + err);
}).catch((err) => {
console.info('open fd failed err is' + err);
}); });
audioPlayer.src = fdPath; //设置src属性，并触发'dataLoad'事件回调
``` ```
### on('timeUpdate') ### release<sup>9+</sup><a name=videorecorder_release2></a>
on(type: 'timeUpdate', callback: Callback\<number>): void
开始订阅音频播放时间更新事件。处于播放状态时，每隔1s上报一次该事件。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 | release(): Promise\<void>;
| -------- | ----------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'timeUpdate'。<br>- 'timeUpdate'：音频播放时间戳更新，开始播放后自动触发该事件。 |
| callback | Callback\<number> | 是 | 播放事件回调方法。回调方法入参为更新后的时间戳。 |
**示例：** 异步方式释放视频录制资源。通过Promise获取返回值。
```js **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
audioPlayer.on('timeUpdate', (newTime) => { //设置'timeUpdate'事件回调
if (newTime == null) {
console.info('audio timeUpadate fail');
return;
}
console.log('audio timeUpadate success. seekDoneTime: ' + newTime);
});
audioPlayer.play(); //开始播放后，自动触发时间戳更新事件
```
### on('error') **系统接口：** 该接口为系统接口
on(type: 'error', callback: ErrorCallback): void **返回值：**
开始订阅音频播放错误事件，当上报error错误事件后，用户需处理error事件，退出播放操作。 | 类型 | 说明 |
| -------------- | ----------------------------------------- |
| Promise\<void> | 异步释放视频录制资源方法的Promise返回值。 |
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer **错误码：**
**参数：** 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 参数名 | 类型 | 必填 | 说明 | | 错误码ID | 错误信息 |
| -------- | ------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------- |
| type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。<br>- 'error'：音频播放中发生错误，触发该事件。 | | 5400105 | Service died. Return by callback. |
| callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
**示例：** **示例：**
```js ```js
audioPlayer.on('error', (error) => { //设置'error'事件回调 // promise
console.info(`audio error called, error: ${error}`); videoRecorder.release().then(() => {
console.info('release videorecorder success');
}).catch((err) => {
console.info('release videorecorder failed and catch error is ' + err.message);
}); });
audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件
``` ```
## AudioState<sup>(deprecated)</sup> ### reset<sup>9+</sup><a name=videorecorder_reset1></a>
音频播放的状态机。可通过state属性获取当前状态。
> **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVPlayerState](#avplayerstate9)替代。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
| 名称 | 类型 | 说明 |
| ------- | ------ | ---------------------------------------------- |
| idle | string | 音频播放空闲，dataload/reset成功后处于此状态。 |
| playing | string | 音频正在播放，play成功后处于此状态。 |
| paused | string | 音频暂停播放，pause成功后处于此状态。 |
| stopped | string | 音频播放停止，stop/播放结束后处于此状态。 |
| error | string | 错误状态。 |
## VideoPlayer<sup>(deprecated)</sup><a name=videoplayer></a>
> **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[AVPlayer](#avplayer9)替代。
视频播放管理类，用于管理和播放视频媒体。在调用VideoPlayer的方法前，需要先通过[createVideoPlayer()](#createvideoplayer)构建一个VideoPlayer实例。
视频播放demo可参考：[视频播放开发指导](../../media/video-playback.md)
### 属性<a name=videoplayer_属性></a> reset(callback: AsyncCallback\<void>): void;
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer 异步方式重置视频录制。通过注册回调函数获取返回值。
| 名称 | 类型 | 可读 | 可写 | 说明 | 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。
| ------------------------------- | ------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
| url<sup>8+</sup> | string | 是 | 是 | 视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。<br>**支持路径示例**：<br>1. fd类型播放：fd://xx<br>![](figures/zh-cn_image_url.png)<br>2. http网络播放: http://xx<br/>3. https网络播放: https://xx<br/>4. hls网络播放路径：http://xx或者https://xx<br/> |
| fdSrc<sup>9+</sup> | [AVFileDescriptor](#avfiledescriptor9) | 是 | 是 | 视频媒体文件描述，使用场景：应用中的视频资源被连续存储在同一个文件中。<br/>**使用示例**：<br/>假设一个连续存储的音乐文件: <br/>视频1(地址偏移:0，字节长度:100)<br/>视频2(地址偏移:101，字节长度:50)<br/>视频3(地址偏移:151，字节长度:150)<br/>1. 播放视频1：AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; }<br/>2. 播放视频2：AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; }<br/>3. 播放视频3：AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; }<br/>假设是一个独立的视频文件: 请使用src=fd://xx <br/> |
| loop<sup>8+</sup> | boolean | 是 | 是 | 视频循环播放属性，设置为'true'表示循环播放。 |
| videoScaleType<sup>9+</sup> | [VideoScaleType](#videoscaletype9) | 是 | 是 | 视频缩放模式。 |
| audioInterruptMode<sup>9+</sup> | [audio.InterruptMode](js-apis-audio.md#interruptmode9) | 是 | 是 | 音频焦点模型。 |
| currentTime<sup>8+</sup> | number | 是 | 否 | 视频的当前播放位置，单位为毫秒（ms）。 |
| duration<sup>8+</sup> | number | 是 | 否 | 视频时长，单位为毫秒（ms），返回-1表示直播模式。 |
| state<sup>8+</sup> | [VideoPlayState](#videoplayerstate) | 是 | 否 | 视频播放的状态。 |
| width<sup>8+</sup> | number | 是 | 否 | 视频宽，单位为像素（px）。 |
| height<sup>8+</sup> | number | 是 | 否 | 视频高，单位为像素（px）。 |
### setDisplaySurface<sup>8+</sup> **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
setDisplaySurface(surfaceId: string, callback: AsyncCallback\<void>): void **系统接口：** 该接口为系统接口
通过回调方式设置SurfaceId。 **参数：**
*注意：SetDisplaySurface需要在设置url和Prepare之间，无音频的视频流必须设置Surface否则Prepare失败。 | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步重置视频录制的回调方法。 |
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **错误码：**
**参数：** 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 参数名 | 类型 | 必填 | 说明 | | 错误码ID | 错误信息 |
| --------- | -------------------- | ---- | ------------------------- | | -------- | --------------------------------- |
| surfaceId | string | 是 | SurfaceId | | 5400103 | I/O error. Return by callback. |
| callback | AsyncCallback\<void> | 是 | 设置SurfaceId的回调方法。 | | 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
let surfaceId = null; // asyncallback
videoPlayer.setDisplaySurface(surfaceId, (err) => { videoRecorder.reset((err) => {
if (err == null) { if (err == null) {
console.info('setDisplaySurface success!'); console.info('reset videorecorder success');
} else { } else {
console.info('setDisplaySurface fail!'); console.info('reset videorecorder failed and error is ' + err.message);
} }
}); });
``` ```
### setDisplaySurface<sup>8+</sup> ### reset<sup>9+</sup><a name=videorecorder_reset2></a>
setDisplaySurface(surfaceId: string): Promise\<void>
通过Promise方式设置SurfaceId。 reset(): Promise\<void>;
*注意：SetDisplaySurface需要在设置url和Prepare之间，无音频的视频流必须设置Surface否则Prepare失败。 异步方式重置视频录制。通过Promise获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。
**参数：** **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
| 参数名 | 类型 | 必填 | 说明 | **系统接口：** 该接口为系统接口
| --------- | ------ | ---- | --------- |
| surfaceId | string | 是 | SurfaceId |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------------ | | -------------- | ------------------------------------- |
| Promise\<void> | 设置SurfaceId的Promise返回值。 | | Promise\<void> | 异步重置视频录制方法的Promise返回值。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | -------------------------------- |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
let surfaceId = null; // promise
videoPlayer.setDisplaySurface(surfaceId).then(() => { videoRecorder.reset().then(() => {
console.info('setDisplaySurface success'); console.info('reset videorecorder success');
}).catch((error) => { }).catch((err) => {
console.info(`video catchCallback, error:${error}`); console.info('reset videorecorder failed and catch error is ' + err.message);
}); });
``` ```
### prepare<sup>8+</sup> ### on('error')<sup>9+</sup>
prepare(callback: AsyncCallback\<void>): void on(type: 'error', callback: ErrorCallback): void
通过回调方式准备播放视频。 开始订阅视频录制错误事件，当上报error错误事件后，用户需处理error事件，退出录制操作。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | ------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<void> | 是 | 准备播放视频的回调方法。 | | type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：视频录制过程中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
**示例：** **错误码：**
```js 以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
videoPlayer.prepare((err) => {
if (err == null) {
console.info('prepare success!');
} else {
console.info('prepare fail!');
}
});
```
### prepare<sup>8+</sup> | 错误码ID | 错误信息 |
| -------- | --------------------------------- |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
prepare(): Promise\<void> **示例：**
通过Promise方式准备播放视频。 ```js
// 当获取videoRecordState接口出错时通过此订阅事件上报
videoRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`);
})
```
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer ## VideoRecordState<sup>9+</sup>
**返回值：** 视频录制的状态机。可通过state属性获取当前状态。
| 类型 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
| -------------- | ----------------------------- |
| Promise\<void> | 准备播放视频的Promise返回值。 |
**示例：** **系统接口：** 该接口为系统接口
```js | 名称 | 类型 | 说明 |
videoPlayer.prepare().then(() => { | -------- | ------ | ---------------------- |
console.info('prepare success'); | idle | string | 视频录制空闲。 |
}).catch((error) => { | prepared | string | 视频录制参数设置完成。 |
console.info(`video catchCallback, error:${error}`); | playing | string | 视频正在录制。 |
}); | paused | string | 视频暂停录制。 |
``` | stopped | string | 视频录制停止。 |
| error | string | 错误状态。 |
### play<sup>8+</sup> ## VideoRecorderConfig<sup>9+</sup>
play(callback: AsyncCallback\<void>): void; 表示视频录制的参数设置。
通过回调方式开始播放视频。 **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统接口：** 该接口为系统接口
**参数：** | 名称 | 类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location) | 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) |
| 参数名 | 类型 | 必填 | 说明 | ## VideoRecorderProfile<sup>9+</sup>
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 开始播放视频的回调方法。 |
**示例：** 视频录制的配置文件。
```js **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
videoPlayer.play((err) => {
if (err == null) {
console.info('play success!');
} else {
console.info('play fail!');
}
});
```
### play<sup>8+</sup> **系统接口：** 该接口为系统接口
play(): Promise\<void>; | 名称 | 类型 | 必填 | 说明 |
| ---------------- | -------------------------------------------- | ---- | ---------------- |
| audioBitrate | number | 是 | 音频编码比特率。 |
| audioChannels | number | 是 | 音频采集声道数。 |
| audioCodec | [CodecMimeType](#codecmimetype8) | 是 | 音频编码格式。 |
| audioSampleRate | number | 是 | 音频采样率。 |
| fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 |
| videoBitrate | number | 是 | 视频编码比特率。 |
| videoCodec | [CodecMimeType](#codecmimetype8) | 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
| videoFrameRate | number | 是 | 录制视频帧率。 |
通过Promise方式开始播放视频。 ## media.createAudioPlayer<sup>(deprecated)</sup><a name=createaudioplayer></a>
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer createAudioPlayer(): AudioPlayer
同步方式创建音频播放实例。
> **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[createAVPlayer](#mediacreateavplayer9)替代。
**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ----------------------------- | | --------------------------- | ------------------------------------------------------------ |
| Promise\<void> | 开始播放视频的Promise返回值。 | | [AudioPlayer](#audioplayerdeprecated) | 返回AudioPlayer类实例，失败时返回null。可用于音频播放、暂停、停止等操作。 |
**示例：** **示例：**
```js ```js
videoPlayer.play().then(() => { let audioPlayer = media.createAudioPlayer();
console.info('play success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
``` ```
### pause<sup>8+</sup> ## media.createVideoPlayer<sup>(deprecated)</sup><a name=createvideoplayer></a>
pause(callback: AsyncCallback\<void>): void createVideoPlayer(callback: AsyncCallback\<VideoPlayer>): void
通过回调方式暂停播放视频。 异步方式创建视频播放实例，通过注册回调函数获取返回值。
> **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[createAVPlayer](#mediacreateavplayer9)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<void> | 是 | 暂停播放视频的回调方法。 | | callback | AsyncCallback<[VideoPlayer](#videoplayerdeprecated)> | 是 | 回调函数。异步返回VideoPlayer实例，失败时返回null。可用于管理和播放视频媒体。 |
**示例：** **示例：**
```js ```js
videoPlayer.pause((err) => { let videoPlayer
if (err == null) {
console.info('pause success!'); media.createVideoPlayer((error, video) => {
} else { if (video != null) {
console.info('pause fail!'); videoPlayer = video;
} console.info('video createVideoPlayer success');
} else {
console.info(`video createVideoPlayer fail, error:${error}`);
}
}); });
``` ```
### pause<sup>8+</sup> ## media.createVideoPlayer<sup>(deprecated)</sup>
pause(): Promise\<void> createVideoPlayer(): Promise\<VideoPlayer>
通过Promise方式暂停播放视频。 异步方式创建视频播放实例，通过Promise获取返回值。
> **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[createAVPlayer](#mediacreateavplayer9-1)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ----------------------------- | | ------------------------------------ | ------------------------------------------------------------ |
| Promise\<void> | 暂停播放视频的Promise返回值。 | | Promise<[VideoPlayer](#videoplayerdeprecated)> | Promise对象。异步返回VideoPlayer实例，失败时返回null。可用于管理和播放视频媒体。 |
**示例：** **示例：**
```js ```js
videoPlayer.pause().then(() => { let videoPlayer
console.info('pause success');
media.createVideoPlayer().then((video) => {
if (video != null) {
videoPlayer = video;
console.info('video createVideoPlayer success');
} else {
console.info('video createVideoPlayer fail');
}
}).catch((error) => { }).catch((error) => {
console.info(`video catchCallback, error:${error}`); console.info(`video catchCallback, error:${error}`);
}); });
``` ```
### stop<sup>8+</sup> ## media.createAudioRecorder<sup>(deprecated)</sup><a name=createaudiorecorder></a>
stop(callback: AsyncCallback\<void>): void createAudioRecorder(): AudioRecorder
通过回调方式停止播放视频。 创建音频录制的实例来控制音频的录制。
一台设备只允许创建一个录制实例。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer > **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[createAVRecorder](#mediacreateavrecorder9)替代。
**参数：** **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
| 参数名 | 类型 | 必填 | 说明 | **返回值:**
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 停止播放视频的回调方法。 | | 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| [AudioRecorder](#audiorecorderdeprecated) | 返回AudioRecorder类实例，失败时返回null。可用于录制音频媒体。 |
**示例：** **示例：**
```js ```js
videoPlayer.stop((err) => { let audioRecorder = media.createAudioRecorder();
if (err == null) {
console.info('stop success!');
} else {
console.info('stop fail!');
}
});
``` ```
### stop<sup>8+</sup> ## MediaErrorCode<sup>(deprecated)</sup><a name=mediaerrorcode></a>
stop(): Promise\<void> 媒体服务错误类型枚举。
通过Promise方式停止播放视频。 > **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[媒体错误码](../errorcodes/errorcode-media.md)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.Core
**返回值：** | 名称 | 值 | 说明 |
| -------------------------- | ---- | -------------------------------------- |
| MSERR_OK | 0 | 表示操作成功。 |
| MSERR_NO_MEMORY | 1 | 表示申请内存失败，系统可能无可用内存。 |
| MSERR_OPERATION_NOT_PERMIT | 2 | 表示无权限执行此操作。 |
| MSERR_INVALID_VAL | 3 | 表示传入入参无效。 |
| MSERR_IO | 4 | 表示发生IO错误。 |
| MSERR_TIMEOUT | 5 | 表示操作超时。 |
| MSERR_UNKNOWN | 6 | 表示未知错误。 |
| MSERR_SERVICE_DIED | 7 | 表示服务端失效。 |
| MSERR_INVALID_STATE | 8 | 表示在当前状态下，不允许执行此操作。 |
| MSERR_UNSUPPORTED | 9 | 表示在当前版本下，不支持此操作。 |
| 类型 | 说明 | ## AudioPlayer<sup>(deprecated)</sup>
| -------------- | ----------------------------- |
| Promise\<void> | 停止播放视频的Promise返回值。 |
**示例：** > **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVPlayer](#avplayer9)替代。
```js 音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过[createAudioPlayer()](#mediacreateaudioplayerdeprecated)构建一个AudioPlayer实例。
videoPlayer.stop().then(() => {
console.info('stop success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
```
### reset<sup>8+</sup> ### 属性<a name=audioplayer_属性></a>
reset(callback: AsyncCallback\<void>): void **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
通过回调方式重置播放视频。 | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------- | ------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(m4a、aac、mp3、ogg、wav)。<br>**支持路径示例**：<br>1. fd类型播放：fd://xx<br>![](figures/zh-cn_image_url.png)<br>2. http网络播放: http://xx<br/>3. https网络播放: https://xx<br/>4. hls网络播放路径：http://xx或者https://xx<br/>**需要权限：** ohos.permission.READ_MEDIA 或 ohos.permission.INTERNET。 |
| fdSrc<sup>9+</sup> | [AVFileDescriptor](#avfiledescriptor9) | 是 | 是 | 音频媒体文件描述，使用场景：应用中的音频资源被连续存储在同一个文件中。<br/>**使用示例**：<br/>假设一个连续存储的音乐文件: <br/>音乐1(地址偏移:0，字节长度:100)<br/>音乐2(地址偏移:101，字节长度:50)<br/>音乐3(地址偏移:151，字节长度:150)<br/>1. 播放音乐1：AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; }<br/>2. 播放音乐2：AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; }<br/>3. 播放音乐3：AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; }<br/>假设是一个独立的音乐文件: 请使用src=fd://xx <br/> |
| loop | boolean | 是 | 是 | 音频循环播放属性，设置为'true'表示循环播放。 |
| audioInterruptMode<sup>9+</sup> | [audio.InterruptMode](js-apis-audio.md#interruptmode9) | 是 | 是 | 音频焦点模型。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置，单位为毫秒（ms）。 |
| duration | number | 是 | 否 | 音频时长，单位为毫秒（ms）。 |
| state | [AudioState](#audiostate) | 是 | 否 | 可以查询音频播放的状态，该状态不可作为调用play/pause/stop等状态切换的触发条件。 |
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer ### play<a name=audioplayer_play></a>
**参数：** play(): void
| 参数名 | 类型 | 必填 | 说明 | 开始播放音频资源，需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用。
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 切换播放视频的回调方法。 | **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**示例：** **示例：**
```js ```js
videoPlayer.reset((err) => { audioPlayer.on('play', () => { //设置'play'事件回调
if (err == null) { console.log('audio play success');
console.info('reset success!');
} else {
console.info('reset fail!');
}
}); });
audioPlayer.play();
``` ```
### reset<sup>8+</sup> ### pause<a name=audioplayer_pause></a>
reset(): Promise\<void> pause(): void
通过Promise方式重置播放视频。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------------- |
| Promise\<void> | 切换播放视频的Promise返回值。 |
**示例：**
```js
videoPlayer.reset().then(() => {
console.info('reset success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
```
### seek<sup>8+</sup>
seek(timeMs: number, callback: AsyncCallback\<number>): void
通过回调方式跳转到指定播放位置，默认跳转到指定时间点的上一个关键帧。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** 暂停播放音频资源。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 |
| callback | AsyncCallback\<number> | 是 | 跳转到指定播放位置的回调方法。 |
**示例：** **示例：**
```js ```js
let seekTime = 5000; audioPlayer.on('pause', () => { //设置'pause'事件回调
videoPlayer.seek(seekTime, (err, result) => { console.log('audio pause success');
if (err == null) {
console.info('seek success!');
} else {
console.info('seek fail!');
}
}); });
audioPlayer.pause();
``` ```
### seek<sup>8+</sup> ### stop<a name=audioplayer_stop></a>
seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
通过回调方式跳转到指定播放位置。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer stop(): void
**参数：** 停止播放音频资源。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 |
| mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 |
| callback | AsyncCallback\<number> | 是 | 跳转到指定播放位置的回调方法。 |
**示例：** **示例：**
```js ```js
import media from '@ohos.multimedia.media' audioPlayer.on('stop', () => { //设置'stop'事件回调
let seekTime = 5000; console.log('audio stop success');
videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC, (err, result) => {
if (err == null) {
console.info('seek success!');
} else {
console.info('seek fail!');
}
}); });
audioPlayer.stop();
``` ```
### seek<sup>8+</sup> ### reset<sup>7+</sup><a name=audioplayer_reset></a>
seek(timeMs: number, mode?:SeekMode): Promise\<number>
通过Promise方式跳转到指定播放位置，如果没有设置mode则跳转到指定时间点的上一个关键帧。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 | reset(): void
| ------ | ---------------------- | ---- | ------------------------------------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 |
| mode | [SeekMode](#seekmode8) | 否 | 跳转模式。 |
**返回值：** 重置播放音频资源。
| 类型 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
| ---------------- | ------------------------------------------- |
| Promise\<number> | 跳转到指定播放位置的Promise返回值，单位ms。 |
**示例：** **示例：**
```js ```js
import media from '@ohos.multimedia.media' audioPlayer.on('reset', () => { //设置'reset'事件回调
let seekTime = 5000; console.log('audio reset success');
videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime表示seek完成后的时间点
console.info('seek success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC).then((seekDoneTime) => {
console.info('seek success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
}); });
audioPlayer.reset();
``` ```
### setVolume<sup>8+</sup> ### seek<a name=audioplayer_seek></a>
setVolume(vol: number, callback: AsyncCallback\<void>): void seek(timeMs: number): void
通过回调方式设置音量。 跳转到指定播放位置。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ----------------------------------------------------------- |
| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 | | timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围[0, duration]。 |
| callback | AsyncCallback\<void> | 是 | 设置音量的回调方法。 |
**示例：** **示例：**
```js ```js
let vol = 0.5; audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调
videoPlayer.setVolume(vol, (err, result) => { if (seekDoneTime == null) {
if (err == null) { console.info('audio seek fail');
console.info('setVolume success!'); return;
} else {
console.info('setVolume fail!');
} }
console.log('audio seek success. seekDoneTime: ' + seekDoneTime);
}); });
audioPlayer.seek(30000); //seek到30000ms的位置
``` ```
### setVolume<sup>8+</sup> ### setVolume<a name=audioplayer_setvolume></a>
setVolume(vol: number): Promise\<void> setVolume(vol: number): void
通过Promise方式设置音量。 设置音量。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
...@@ -3562,86 +3606,43 @@ setVolume(vol: number): Promise\<void> ...@@ -3562,86 +3606,43 @@ setVolume(vol: number): Promise\<void>
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 | | vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 |
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 设置音量的Promise返回值。 |
**示例：**
```js
let vol = 0.5;
videoPlayer.setVolume(vol).then(() => {
console.info('setVolume success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
```
### release<sup>8+</sup>
release(callback: AsyncCallback\<void>): void
通过回调方式释放视频资源。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 释放视频资源的回调方法。 |
**示例：** **示例：**
```js ```js
videoPlayer.release((err) => { audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调
if (err == null) { console.log('audio volumeChange success');
console.info('release success!');
} else {
console.info('release fail!');
}
}); });
audioPlayer.setVolume(1); //设置音量到100%
``` ```
### release<sup>8+</sup> ### release<a name=audioplayer_release></a>
release(): Promise\<void>
通过Promise方式释放视频资源。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer release(): void
**返回值：** 释放音频资源。
| 类型 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
| -------------- | ----------------------------- |
| Promise\<void> | 释放视频资源的Promise返回值。 |
**示例：** **示例：**
```js ```js
videoPlayer.release().then(() => { audioPlayer.release();
console.info('release success'); audioPlayer = undefined;
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
``` ```
### getTrackDescription<sup>8+</sup> ### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription1></a>
getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void
通过回调方式获取视频轨道信息。 通过回调方式获取音频轨道信息。需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
| callback | AsyncCallback\<Array\<[MediaDescription](#mediadescription8)>> | 是 | 视频轨道信息MediaDescription数组回调方法。 | | callback | AsyncCallback\<Array\<[MediaDescription](#mediadescription8)>> | 是 | 音频轨道信息MediaDescription数组回调方法。 |
**示例：** **示例：**
...@@ -3649,35 +3650,35 @@ getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void ...@@ -3649,35 +3650,35 @@ getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void
function printfDescription(obj) { function printfDescription(obj) {
for (let item in obj) { for (let item in obj) {
let property = obj[item]; let property = obj[item];
console.info('video key is ' + item); console.info('audio key is ' + item);
console.info('video value is ' + property); console.info('audio value is ' + property);
} }
} }
videoPlayer.getTrackDescription((error, arrList) => { audioPlayer.getTrackDescription((error, arrList) => {
if ((arrList) != null) { if (arrList != null) {
for (let i = 0; i < arrList.length; i++) { for (let i = 0; i < arrList.length; i++) {
printfDescription(arrList[i]); printfDescription(arrList[i]);
} }
} else { } else {
console.log(`video getTrackDescription fail, error:${error}`); console.log(`audio getTrackDescription fail, error:${error}`);
} }
}); });
``` ```
### getTrackDescription<sup>8+</sup> ### getTrackDescription<sup>8+</sup><a name=audioplayer_gettrackdescription2></a>
getTrackDescription(): Promise\<Array\<MediaDescription>> getTrackDescription(): Promise\<Array\<MediaDescription>>
通过Promise方式获取视频轨道信息。 通过Promise方式获取音频轨道信息。需在[dataLoad](#audioplayer_on)事件成功触发后，才能调用
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------ | ----------------------------------------------- | | ------------------------------------------------------ | ----------------------------------------------- |
| Promise<Array<[MediaDescription](#mediadescription8)>> | 视频轨道信息MediaDescription数组Promise返回值。 | | Promise<Array<[MediaDescription](#mediadescription8)>> | 音频轨道信息MediaDescription数组Promise返回值。 |
**示例：** **示例：**
...@@ -3685,1317 +3686,1301 @@ getTrackDescription(): Promise\<Array\<MediaDescription>> ...@@ -3685,1317 +3686,1301 @@ getTrackDescription(): Promise\<Array\<MediaDescription>>
function printfDescription(obj) { function printfDescription(obj) {
for (let item in obj) { for (let item in obj) {
let property = obj[item]; let property = obj[item];
console.info('video key is ' + item); console.info('audio key is ' + item);
console.info('video value is ' + property); console.info('audio value is ' + property);
} }
} }
let arrayDescription = null
let arrayDescription; audioPlayer.getTrackDescription().then((arrList) => {
videoPlayer.getTrackDescription().then((arrList) => {
if (arrList != null) { if (arrList != null) {
arrayDescription = arrList; arrayDescription = arrList;
} else { } else {
console.log('video getTrackDescription fail'); console.log('audio getTrackDescription fail');
} }
}).catch((error) => { }).catch((error) => {
console.info(`video catchCallback, error:${error}`); console.info(`audio catchCallback, error:${error}`);
}); });
for (let i = 0; i < arrayDescription.length; i++) { for (let i = 0; i < arrayDescription.length; i++) {
printfDescription(arrayDescription[i]); printfDescription(arrayDescription[i]);
} }
``` ```
### setSpeed<sup>8+</sup> ### on('bufferingUpdate')<sup>8+</sup>
setSpeed(speed:number, callback: AsyncCallback\<number>): void on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void
通过回调方式设置播放速度。 开始订阅音频缓存更新事件。仅网络播放支持该订阅事件。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------------------------- | | -------- | -------- | ---- | ------------------------------------------------------------ |
| speed | number | 是 | 指定播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 | | type | string | 是 | 音频缓存事件回调类型，支持的事件：'bufferingUpdate'。 |
| callback | AsyncCallback\<number> | 是 | 设置播放速度的回调方法。 | | callback | function | 是 | 音频缓存事件回调方法。<br>[BufferingInfoType](#bufferinginfotype8)为BUFFERING_PERCENT或CACHED_DURATION时，value值有效，否则固定为0。 |
**示例：** **示例：**
```js ```js
import media from '@ohos.multimedia.media' audioPlayer.on('bufferingUpdate', (infoType, value) => {
let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X; console.log('audio bufferingInfo type: ' + infoType);
console.log('audio bufferingInfo value: ' + value);
videoPlayer.setSpeed(speed, (err, result) => {
if (err == null) {
console.info('setSpeed success!');
} else {
console.info('setSpeed fail!');
}
}); });
``` ```
### setSpeed<sup>8+</sup> ### on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')<a name = audioplayer_on></a>
setSpeed(speed:number): Promise\<number> on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void
通过Promise方式设置播放速度。 开始订阅音频播放事件。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------------------------------------- | | -------- | ---------- | ---- | ------------------------------------------------------------ |
| speed | number | 是 | 指定播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 | | 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 | 是 | 播放事件回调方法。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ |
| Promise\<number> | 播放速度Promise返回值，具体见[PlaybackSpeed](#playbackspeed8)。 |
**示例：** **示例：**
```js ```js
import media from '@ohos.multimedia.media' import fileio from '@ohos.fileio'
let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
videoPlayer.setSpeed(speed).then(() => { let audioPlayer = media.createAudioPlayer(); //创建一个音频播放实例
console.info('setSpeed success'); audioPlayer.on('dataLoad', () => { //设置'dataLoad'事件回调，src属性设置成功后，触发此回调
}).catch((error) => { console.info('audio set source success');
console.info(`video catchCallback, error:${error}`); audioPlayer.play(); //开始播放，并触发'play'事件回调
});
audioPlayer.on('play', () => { //设置'play'事件回调
console.info('audio play success');
audioPlayer.seek(30000); //调用seek方法，并触发'timeUpdate'事件回调
});
audioPlayer.on('pause', () => { //设置'pause'事件回调
console.info('audio pause success');
audioPlayer.stop(); //停止播放，并触发'stop'事件回调
});
audioPlayer.on('reset', () => { //设置'reset'事件回调
console.info('audio reset success');
audioPlayer.release(); //释放播放实例资源
audioPlayer = undefined;
});
audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调
if (seekDoneTime == null) {
console.info('audio seek fail');
return;
}
console.info('audio seek success, and seek time is ' + seekDoneTime);
audioPlayer.setVolume(0.5); //设置音量为50%，并触发'volumeChange'事件回调
});
audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调
console.info('audio volumeChange success');
audioPlayer.pause(); //暂停播放，并触发'pause'事件回调
});
audioPlayer.on('finish', () => { //设置'finish'事件回调
console.info('audio play finish');
audioPlayer.stop(); //停止播放，并触发'stop'事件回调
});
audioPlayer.on('error', (error) => { //设置'error'事件回调
console.info(`audio error called, error: ${error}`);
});
// 用户选择视频设置fd(本地播放)
let fdPath = 'fd://';
// path路径的码流可通过"hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" 命令，将其推送到设备上
let path = '/data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
fileio.open(path).then((fdValue) => {
fdPath = fdPath + '' + fdValue;
console.info('open fd success fd is' + fdPath);
}, (err) => {
console.info('open fd failed err is' + err);
}).catch((err) => {
console.info('open fd failed err is' + err);
}); });
audioPlayer.src = fdPath; //设置src属性，并触发'dataLoad'事件回调
``` ```
### on('playbackCompleted')<sup>8+</sup> ### on('timeUpdate')
on(type: 'playbackCompleted', callback: Callback\<void>): void on(type: 'timeUpdate', callback: Callback\<number>): void
开始监听视频播放完成事件。 开始订阅音频播放时间更新事件。处于播放状态时，每隔1s上报一次该事件。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ----------------------------------------------------------- | | -------- | ----------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放完成事件回调类型，支持的事件：'playbackCompleted'。 | | type | string | 是 | 播放事件回调类型，支持的事件包括：'timeUpdate'。<br>- 'timeUpdate'：音频播放时间戳更新，开始播放后自动触发该事件。 |
| callback | function | 是 | 视频播放完成事件回调方法。 | | callback | Callback\<number> | 是 | 播放事件回调方法。回调方法入参为更新后的时间戳。 |
**示例：** **示例：**
```js ```js
videoPlayer.on('playbackCompleted', () => { audioPlayer.on('timeUpdate', (newTime) => { //设置'timeUpdate'事件回调
console.info('playbackCompleted success!'); if (newTime == null) {
console.info('audio timeUpadate fail');
return;
}
console.log('audio timeUpadate success. seekDoneTime: ' + newTime);
}); });
audioPlayer.play(); //开始播放后，自动触发时间戳更新事件
``` ```
### on('bufferingUpdate')<sup>8+</sup> ### on('error')
on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void on(type: 'error', callback: ErrorCallback): void
开始监听视频缓存更新事件。仅网络播放支持该订阅事件。 开始订阅音频播放错误事件，当上报error错误事件后，用户需处理error事件，退出播放操作。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | ------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频缓存事件回调类型，支持的事件：'bufferingUpdate'。 | | type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。<br>- 'error'：音频播放中发生错误，触发该事件。 |
| callback | function | 是 | 视频缓存事件回调方法。<br>[BufferingInfoType](#bufferinginfotype8)为BUFFERING_PERCENT或CACHED_DURATION时，value值有效，否则固定为0。 | | callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
**示例：** **示例：**
```js ```js
videoPlayer.on('bufferingUpdate', (infoType, value) => { audioPlayer.on('error', (error) => { //设置'error'事件回调
console.log('video bufferingInfo type: ' + infoType); console.info(`audio error called, error: ${error}`);
console.log('video bufferingInfo value: ' + value);
}); });
audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件
``` ```
### on('startRenderFrame')<sup>8+</sup> ## AudioState<sup>(deprecated)</sup>
on(type: 'startRenderFrame', callback: Callback\<void>): void 音频播放的状态机。可通过state属性获取当前状态。
开始监听视频播放首帧送显上报事件。 > **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVPlayerState](#avplayerstate9)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer
**参数：** | 名称 | 类型 | 说明 |
| ------- | ------ | ---------------------------------------------- |
| idle | string | 音频播放空闲，dataload/reset成功后处于此状态。 |
| playing | string | 音频正在播放，play成功后处于此状态。 |
| paused | string | 音频暂停播放，pause成功后处于此状态。 |
| stopped | string | 音频播放停止，stop/播放结束后处于此状态。 |
| error | string | 错误状态。 |
| 参数名 | 类型 | 必填 | 说明 | ## VideoPlayer<sup>(deprecated)</sup><a name=videoplayer></a>
| -------- | --------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放首帧送显上报事件回调类型，支持的事件：'startRenderFrame'。 |
| callback | Callback\<void> | 是 | 视频播放首帧送显上报事件回调方法。 |
**示例：** > **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[AVPlayer](#avplayer9)替代。
```js 视频播放管理类，用于管理和播放视频媒体。在调用VideoPlayer的方法前，需要先通过[createVideoPlayer()](#createvideoplayer)构建一个VideoPlayer实例。
videoPlayer.on('startRenderFrame', () => {
console.info('startRenderFrame success!');
});
```
### on('videoSizeChanged')<sup>8+</sup> 视频播放demo可参考：[视频播放开发指导](../../media/video-playback.md)
on(type: 'videoSizeChanged', callback: (width: number, height: number) => void): void ### 属性<a name=videoplayer_属性></a>
开始监听视频播放宽高变化事件。 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------- | ------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
| url<sup>8+</sup> | string | 是 | 是 | 视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。<br>**支持路径示例**：<br>1. fd类型播放：fd://xx<br>![](figures/zh-cn_image_url.png)<br>2. http网络播放: http://xx<br/>3. https网络播放: https://xx<br/>4. hls网络播放路径：http://xx或者https://xx<br/> |
| fdSrc<sup>9+</sup> | [AVFileDescriptor](#avfiledescriptor9) | 是 | 是 | 视频媒体文件描述，使用场景：应用中的视频资源被连续存储在同一个文件中。<br/>**使用示例**：<br/>假设一个连续存储的音乐文件: <br/>视频1(地址偏移:0，字节长度:100)<br/>视频2(地址偏移:101，字节长度:50)<br/>视频3(地址偏移:151，字节长度:150)<br/>1. 播放视频1：AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; }<br/>2. 播放视频2：AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; }<br/>3. 播放视频3：AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; }<br/>假设是一个独立的视频文件: 请使用src=fd://xx <br/> |
| loop<sup>8+</sup> | boolean | 是 | 是 | 视频循环播放属性，设置为'true'表示循环播放。 |
| videoScaleType<sup>9+</sup> | [VideoScaleType](#videoscaletype9) | 是 | 是 | 视频缩放模式。 |
| audioInterruptMode<sup>9+</sup> | [audio.InterruptMode](js-apis-audio.md#interruptmode9) | 是 | 是 | 音频焦点模型。 |
| currentTime<sup>8+</sup> | number | 是 | 否 | 视频的当前播放位置，单位为毫秒（ms）。 |
| duration<sup>8+</sup> | number | 是 | 否 | 视频时长，单位为毫秒（ms），返回-1表示直播模式。 |
| state<sup>8+</sup> | [VideoPlayState](#videoplayerstate) | 是 | 否 | 视频播放的状态。 |
| width<sup>8+</sup> | number | 是 | 否 | 视频宽，单位为像素（px）。 |
| height<sup>8+</sup> | number | 是 | 否 | 视频高，单位为像素（px）。 |
### setDisplaySurface<sup>8+</sup>
setDisplaySurface(surfaceId: string, callback: AsyncCallback\<void>): void
通过回调方式设置SurfaceId。
*注意：SetDisplaySurface需要在设置url和Prepare之间，无音频的视频流必须设置Surface否则Prepare失败。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | --------- | -------------------- | ---- | ------------------------- |
| type | string | 是 | 视频播放宽高变化事件回调类型，支持的事件：'videoSizeChanged'。 | | surfaceId | string | 是 | SurfaceId |
| callback | function | 是 | 视频播放宽高变化事件回调方法，width表示宽，height表示高。 | | callback | AsyncCallback\<void> | 是 | 设置SurfaceId的回调方法。 |
**示例：** **示例：**
```js ```js
videoPlayer.on('videoSizeChanged', (width, height) => { let surfaceId = null;
console.log('video width is: ' + width); videoPlayer.setDisplaySurface(surfaceId, (err) => {
console.log('video height is: ' + height); if (err == null) {
console.info('setDisplaySurface success!');
} else {
console.info('setDisplaySurface fail!');
}
}); });
``` ```
### on('error')<sup>8+</sup> ### setDisplaySurface<sup>8+</sup>
on(type: 'error', callback: ErrorCallback): void setDisplaySurface(surfaceId: string): Promise\<void>
开始监听视频播放错误事件，当上报error错误事件后，用户需处理error事件，退出播放操作。 通过Promise方式设置SurfaceId。
*注意：SetDisplaySurface需要在设置url和Prepare之间，无音频的视频流必须设置Surface否则Prepare失败。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------------------------------ | | --------- | ------ | ---- | --------- |
| type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。<br>- 'error'：视频播放中发生错误，触发该事件。 | | surfaceId | string | 是 | SurfaceId |
| callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------ |
| Promise\<void> | 设置SurfaceId的Promise返回值。 |
**示例：** **示例：**
```js ```js
videoPlayer.on('error', (error) => { // 设置'error'事件回调 let surfaceId = null;
console.info(`video error called, error: ${error}`); videoPlayer.setDisplaySurface(surfaceId).then(() => {
console.info('setDisplaySurface success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
}); });
videoPlayer.url = 'fd://error'; //设置错误的播放地址，触发'error'事件
``` ```
## VideoPlayState<sup>(deprecated)</sup><a name=videoplayerstate></a> ### prepare<sup>8+</sup>
视频播放的状态机，可通过state属性获取当前状态。 prepare(callback: AsyncCallback\<void>): void
> **说明：** 通过回调方式准备播放视频。
> 从API version 8开始支持，从API version 9开始废弃，建议使用[AVPlayerState](#avplayerstate9)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
| 名称 | 类型 | 说明 | **参数：**
| -------- | ------ | -------------- |
| idle | string | 视频播放空闲。 |
| prepared | string | 视频播放准备。 |
| playing | string | 视频正在播放。 |
| paused | string | 视频暂停播放。 |
| stopped | string | 视频播放停止。 |
| error | string | 错误状态。 |
## AudioRecorder<sup>(deprecated)</sup>
> **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorder](#avrecorder9)替代。
音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#mediacreateaudiorecorder) 构建一个AudioRecorder实例。 | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 准备播放视频的回调方法。 |
音频录制demo可参考：[音频录制开发指导](../../media/audio-recorder.md) **示例：**
### prepare<a name=audiorecorder_prepare></a> ```js
videoPlayer.prepare((err) => {
if (err == null) {
console.info('prepare success!');
} else {
console.info('prepare fail!');
}
});
```
prepare(config: AudioRecorderConfig): void ### prepare<sup>8+</sup>
录音准备。 prepare(): Promise\<void>
**需要权限：** ohos.permission.MICROPHONE 通过Promise方式准备播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| ------ | ------------------------------------------- | ---- | ------------------------------------------------------------ | | -------------- | ----------------------------- |
| config | [AudioRecorderConfig](#audiorecorderconfigdeprecated) | 是 | 配置录音的相关参数，包括音频输出URI、编码格式、采样率、声道数、输出格式等。 | | Promise\<void> | 准备播放视频的Promise返回值。 |
**示例：** **示例：**
```js ```js
let audioRecorderConfig = { videoPlayer.prepare().then(() => {
audioEncoder : media.AudioEncoder.AAC_LC, console.info('prepare success');
audioEncodeBitRate : 22050, }).catch((error) => {
audioSampleRate : 22050, console.info(`video catchCallback, error:${error}`);
numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'fd://1', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('prepare', () => { //设置'prepare'事件回调
console.log('prepare success');
}); });
audioRecorder.prepare(audioRecorderConfig);
``` ```
### play<sup>8+</sup>
### start<a name=audiorecorder_start></a> play(callback: AsyncCallback\<void>): void;
start(): void 通过回调方式开始播放视频。
开始录制，需在[prepare](#audiorecorder_on)事件成功触发后，才能调用start方法。 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 开始播放视频的回调方法。 |
**示例：** **示例：**
```js ```js
audioRecorder.on('start', () => { //设置'start'事件回调 videoPlayer.play((err) => {
console.log('audio recorder start success'); if (err == null) {
console.info('play success!');
} else {
console.info('play fail!');
}
}); });
audioRecorder.start();
``` ```
### pause<a name=audiorecorder_pause></a> ### play<sup>8+</sup>
pause():void play(): Promise\<void>;
暂停录制，需要在[start](#audiorecorder_on)事件成功触发后，才能调用pause方法。 通过Promise方式开始播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------------- |
| Promise\<void> | 开始播放视频的Promise返回值。 |
**示例：** **示例：**
```js ```js
audioRecorder.on('pause', () => { //设置'pause'事件回调 videoPlayer.play().then(() => {
console.log('audio recorder pause success'); console.info('play success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
}); });
audioRecorder.pause();
``` ```
### resume<a name=audiorecorder_resume></a> ### pause<sup>8+</sup>
resume():void pause(callback: AsyncCallback\<void>): void
恢复录制，需要在[pause](#audiorecorder_on)事件成功触发后，才能调用resume方法。 通过回调方式暂停播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 暂停播放视频的回调方法。 |
**示例：** **示例：**
```js ```js
audioRecorder.on('resume', () => { //设置'resume'事件回调 videoPlayer.pause((err) => {
console.log('audio recorder resume success'); if (err == null) {
console.info('pause success!');
} else {
console.info('pause fail!');
}
}); });
audioRecorder.resume();
``` ```
### stop<a name=audiorecorder_stop></a> ### pause<sup>8+</sup>
stop(): void pause(): Promise\<void>
停止录音。 通过Promise方式暂停播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------------- |
| Promise\<void> | 暂停播放视频的Promise返回值。 |
**示例：** **示例：**
```js ```js
audioRecorder.on('stop', () => { //设置'stop'事件回调 videoPlayer.pause().then(() => {
console.log('audio recorder stop success'); console.info('pause success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
}); });
audioRecorder.stop();
``` ```
### release<a name=audiorecorder_release></a> ### stop<sup>8+</sup>
release(): void stop(callback: AsyncCallback\<void>): void
释放录音资源。 通过回调方式停止播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是 | 停止播放视频的回调方法。 |
**示例：** **示例：**
```js ```js
audioRecorder.on('release', () => { //设置'release'事件回调 videoPlayer.stop((err) => {
console.log('audio recorder release success'); if (err == null) {
console.info('stop success!');
} else {
console.info('stop fail!');
}
}); });
audioRecorder.release();
audioRecorder = undefined;
``` ```
### reset<a name=audiorecorder_reset></a> ### stop<sup>8+</sup>
reset(): void stop(): Promise\<void>
重置录音。 通过Promise方式停止播放视频。
进行重置录音之前，需要先调用[stop()](#audiorecorder_stop)停止录音。重置录音之后，需要调用[prepare()](#audiorecorder_prepare)设置录音参数项，才能再次进行录音。 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **返回值：**
| 类型 | 说明 |
| -------------- | ----------------------------- |
| Promise\<void> | 停止播放视频的Promise返回值。 |
**示例：** **示例：**
```js ```js
audioRecorder.on('reset', () => { //设置'reset'事件回调 videoPlayer.stop().then(() => {
console.log('audio recorder reset success'); console.info('stop success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
}); });
audioRecorder.reset();
``` ```
### on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset')<a name=audiorecorder_on></a> ### reset<sup>8+</sup>
on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset', callback: () => void): void reset(callback: AsyncCallback\<void>): void
开始订阅音频录制事件。 通过回调方式重置播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 录制事件回调类型，支持的事件包括：'prepare'&nbsp;\|&nbsp;'start'&nbsp;\| 'pause' \| ’resume‘ \|&nbsp;'stop'&nbsp;\|&nbsp;'release'&nbsp;\|&nbsp;'reset'。<br/>-&nbsp;'prepare'&nbsp;：完成[prepare](#audiorecorder_prepare)调用，音频录制参数设置完成，触发该事件。<br/>-&nbsp;'start'&nbsp;：完成[start](#audiorecorder_start)调用，音频录制开始，触发该事件。<br/>-&nbsp;'pause': 完成[pause](#audiorecorder_pause)调用，音频暂停录制，触发该事件。<br/>-&nbsp;'resume': 完成[resume](#audiorecorder_resume)调用，音频恢复录制，触发该事件。<br/>-&nbsp;'stop'&nbsp;：完成[stop](#audiorecorder_stop)调用，音频停止录制，触发该事件。<br/>-&nbsp;'release'&nbsp;：完成[release](#audiorecorder_release)调用，音频释放录制资源，触发该事件。<br/>-&nbsp;'reset'：完成[reset](#audiorecorder_reset)调用，音频重置为初始状态，触发该事件。 | | callback | AsyncCallback\<void> | 是 | 切换播放视频的回调方法。 |
| callback | ()=>void | 是 | 录制事件回调方法。 |
**示例：** **示例：**
```js ```js
let audioRecorder = media.createAudioRecorder(); // 创建一个音频录制实例 videoPlayer.reset((err) => {
let audioRecorderConfig = { if (err == null) {
audioEncoder : media.AudioEncoder.AAC_LC, console.info('reset success!');
audioEncodeBitRate : 22050, } else {
audioSampleRate : 22050, console.info('reset fail!');
numberOfChannels : 2, }
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`);
});
audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.log('prepare success');
audioRecorder.start(); // 开始录制，并触发'start'事件回调
});
audioRecorder.on('start', () => { // 设置'start'事件回调
console.log('audio recorder start success');
});
audioRecorder.on('pause', () => { // 设置'pause'事件回调
console.log('audio recorder pause success');
});
audioRecorder.on('resume', () => { // 设置'resume'事件回调
console.log('audio recorder resume success');
});
audioRecorder.on('stop', () => { // 设置'stop'事件回调
console.log('audio recorder stop success');
});
audioRecorder.on('release', () => { // 设置'release'事件回调
console.log('audio recorder release success');
});
audioRecorder.on('reset', () => { // 设置'reset'事件回调
console.log('audio recorder reset success');
}); });
audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调
``` ```
### on('error') ### reset<sup>8+</sup>
on(type: 'error', callback: ErrorCallback): void reset(): Promise\<void>
开始订阅音频录制错误事件，当上报error错误事件后，用户需处理error事件，退出录制操作。 通过Promise方式重置播放视频。
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| -------- | ------------- | ---- | ------------------------------------------------------------ | | -------------- | ----------------------------- |
| type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：音频录制过程中发生错误，触发该事件。 | | Promise\<void> | 切换播放视频的Promise返回值。 |
| callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
**示例：** **示例：**
```js ```js
let audioRecorderConfig = { videoPlayer.reset().then(() => {
audioEncoder : media.AudioEncoder.AAC_LC, console.info('reset success');
audioEncodeBitRate : 22050, }).catch((error) => {
audioSampleRate : 22050, console.info(`video catchCallback, error:${error}`);
numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`);
}); });
audioRecorder.prepare(audioRecorderConfig); // prepare不设置参数，触发'error'事件
``` ```
## AudioRecorderConfig<sup>(deprecated)</sup> ### seek<sup>8+</sup>
> **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderConfig](#avrecorderconfig9)替代。
表示音频的录音配置。 seek(timeMs: number, callback: AsyncCallback\<number>): void
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder 通过回调方式跳转到指定播放位置，默认跳转到指定时间点的上一个关键帧。
| 名称 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
| ----------------------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioEncoder | [AudioEncoder](#audioencoderdeprecated) | 否 | 音频编码格式，默认设置为AAC_LC。<br/>**说明：** 从API version 8开始废弃，建议使用audioEncoderMime替代。 |
| audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。 |
| audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 |
| numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 |
| format | [AudioOutputFormat](#audiooutputformatdeprecated) | 否 | 音频输出封装格式，默认设置为MPEG_4。<br/>**说明：** 从API version 8开始废弃，建议使用fileFormat替代。 |
| location | [Location](#location) | 否 | 音频采集的地理位置。 |
| uri | string | 是 | 音频输出URI：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
| audioEncoderMime<sup>8+</sup> | [CodecMimeType](#codecmimetype8) | 否 | 音频编码格式。 |
| fileFormat<sup>8+</sup> | [ContainerFormatType](#containerformattype8) | 否 | 音频编码格式。 |
## AudioEncoder<sup>(deprecated)</sup> **参数：**
> **说明：** | 参数名 | 类型 | 必填 | 说明 |
> 从API version 6开始支持，从API version 8开始废弃，建议使用[CodecMimeType](#codecmimetype8)替代。 | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 |
| callback | AsyncCallback\<number> | 是 | 跳转到指定播放位置的回调方法。 |
表示音频编码格式的枚举。 **示例：**
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder ```js
let seekTime = 5000;
videoPlayer.seek(seekTime, (err, result) => {
if (err == null) {
console.info('seek success!');
} else {
console.info('seek fail!');
}
});
```
| 名称 | 值 | 说明 | ### seek<sup>8+</sup>
| ------- | ---- | ------------------------------------------------------------ |
| DEFAULT | 0 | 默认编码格式。<br/>仅做接口定义，暂不支持使用。 |
| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。<br/>仅做接口定义，暂不支持使用。 |
| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。<br/>仅做接口定义，暂不支持使用。 |
| AAC_LC | 3 | AAC-LC（Advanced&nbsp;Audio&nbsp;Coding&nbsp;Low&nbsp;Complexity）编码格式。 |
| HE_AAC | 4 | HE_AAC（High-Efficiency Advanced&nbsp;Audio&nbsp;Coding）编码格式。<br/>仅做接口定义，暂不支持使用。 |
## AudioOutputFormat<sup>(deprecated)</sup> seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
> **说明：** 通过回调方式跳转到指定播放位置。
> 从API version 6开始支持，从API version 8 开始废弃，建议使用[ContainerFormatType](#containerformattype8)替代。
表示音频封装格式的枚举。 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder **参数：**
| 名称 | 值 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| DEFAULT | 0 | 默认封装格式。<br/>仅做接口定义，暂不支持使用。 | | timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 |
| MPEG_4 | 2 | 封装为MPEG-4格式。 | | mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 |
| AMR_NB | 3 | 封装为AMR_NB格式。<br/>仅做接口定义，暂不支持使用。 | | callback | AsyncCallback\<number> | 是 | 跳转到指定播放位置的回调方法。 |
| AMR_WB | 4 | 封装为AMR_WB格式。<br/>仅做接口定义，暂不支持使用。 |
| AAC_ADTS | 6 | 封装为ADTS（Audio&nbsp;Data&nbsp;Transport&nbsp;Stream）格式，是AAC音频的传输流格式。 |
## VideoRecorder<sup>(deprecated)</sup><a name=videorecorder9> **示例：**
> **说明：** ```js
> 从API version 9开始支持，从API version 9开始废弃，建议使用[AVRecorder](#avrecorder9)替代。 import media from '@ohos.multimedia.media'
let seekTime = 5000;
videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC, (err, result) => {
if (err == null) {
console.info('seek success!');
} else {
console.info('seek fail!');
}
});
```
视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder9)构建一个[VideoRecorder](#videorecorder9)实例。 ### seek<sup>8+</sup>
视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md) seek(timeMs: number, mode?:SeekMode): Promise\<number>
### 属性 通过Promise方式跳转到指定播放位置，如果没有设置mode则跳转到指定时间点的上一个关键帧。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**系统接口：** 该接口为系统接口 **参数：**
| 名称 | 类型 | 可读 | 可写 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------ | -------------------------------------- | ---- | ---- | ---------------- | | ------ | ---------------------- | ---- | ------------------------------------------------------------ |
| state<sup>9+</sup> | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 | | timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 |
| mode | [SeekMode](#seekmode8) | 否 | 跳转模式。 |
### prepare<sup>9+</sup><a name=videorecorder_prepare1></a> **返回值：**
prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void; | 类型 | 说明 |
| ---------------- | ------------------------------------------- |
| Promise\<number> | 跳转到指定播放位置的Promise返回值，单位ms。 |
异步方式进行视频录制的参数设置。通过注册回调函数获取返回值。 **示例：**
**需要权限：** ohos.permission.MICROPHONE ```js
import media from '@ohos.multimedia.media'
let seekTime = 5000;
videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime表示seek完成后的时间点
console.info('seek success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC).then((seekDoneTime) => {
console.info('seek success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
```
**系统接口：** 该接口为系统接口 ### setVolume<sup>8+</sup>
**参数：** setVolume(vol: number, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | 通过回调方式设置音量。
| -------- | -------------------------------------------- | ---- | ----------------------------------- |
| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
| callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 |
**错误码：** **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) **参数：**
| 错误码ID | 错误信息 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------ | | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| 201 | Permission denied. Return by callback. | | vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 |
| 401 | Parameter error. Return by callback. | | callback | AsyncCallback\<void> | 是 | 设置音量的回调方法。 |
| 5400102 | Operation not allowed. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
let videoProfile = { let vol = 0.5;
audioBitrate : 48000, videoPlayer.setVolume(vol, (err, result) => {
audioChannels : 2,
audioCodec : 'audio/mp4a-latm',
audioSampleRate : 48000,
fileFormat : 'mp4',
videoBitrate : 48000,
videoCodec : 'video/mp4v-es',
videoFrameWidth : 640,
videoFrameHeight : 480,
videoFrameRate : 30
}
let videoConfig = {
audioSourceType : 1,
videoSourceType : 0,
profile : videoProfile,
url : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
// asyncallback
videoRecorder.prepare(videoConfig, (err) => {
if (err == null) { if (err == null) {
console.info('prepare success'); console.info('setVolume success!');
} else { } else {
console.info('prepare failed and error is ' + err.message); console.info('setVolume fail!');
} }
}) });
``` ```
### prepare<sup>9+</sup><a name=videorecorder_prepare2></a> ### setVolume<sup>8+</sup>
prepare(config: VideoRecorderConfig): Promise\<void>;
异步方式进行视频录制的参数设置。通过Promise获取返回值。
**需要权限：** ohos.permission.MICROPHONE setVolume(vol: number): Promise\<void>
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 通过Promise方式设置音量。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------------- | ---- | ------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 | | vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ---------------------------------------- | | -------------- | ------------------------- |
| Promise\<void> | 异步视频录制prepare方法的Promise返回值。 | | Promise\<void> | 设置音量的Promise返回值。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------------- |
| 201 | Permission denied. Return by promise. |
| 401 | Parameter error. Return by promise. |
| 5400102 | Operation not allowed. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
let videoProfile = { let vol = 0.5;
audioBitrate : 48000, videoPlayer.setVolume(vol).then(() => {
audioChannels : 2, console.info('setVolume success');
audioCodec : 'audio/mp4a-latm', }).catch((error) => {
audioSampleRate : 48000, console.info(`video catchCallback, error:${error}`);
fileFormat : 'mp4', });
videoBitrate : 48000, ```
videoCodec : 'video/mp4v-es',
videoFrameWidth : 640,
videoFrameHeight : 480,
videoFrameRate : 30
}
let videoConfig = {
audioSourceType : 1,
videoSourceType : 0,
profile : videoProfile,
url : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
// promise
videoRecorder.prepare(videoConfig).then(() => {
console.info('prepare success');
}).catch((err) => {
console.info('prepare failed and catch error is ' + err.message);
});
```
### getInputSurface<sup>9+</sup>
getInputSurface(callback: AsyncCallback\<string>): void;
异步方式获得录制需要的surface。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。
应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。 ### release<sup>8+</sup>
只能在[prepare()](#videorecorder_prepare1)接口调用后调用。 release(callback: AsyncCallback\<void>): void
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 通过回调方式释放视频资源。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------- | | -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<string> | 是 | 异步获得surface的回调方法。 | | callback | AsyncCallback\<void> | 是 | 释放视频资源的回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// asyncallback videoPlayer.release((err) => {
let surfaceID = null; // 传递给外界的surfaceID
videoRecorder.getInputSurface((err, surfaceId) => {
if (err == null) { if (err == null) {
console.info('getInputSurface success'); console.info('release success!');
surfaceID = surfaceId;
} else { } else {
console.info('getInputSurface failed and error is ' + err.message); console.info('release fail!');
} }
}); });
``` ```
### getInputSurface<sup>9+</sup> ### release<sup>8+</sup>
getInputSurface(): Promise\<string>;
异步方式获得录制需要的surface。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。
应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。
只能在[prepare()](#videorecorder_prepare1)接口调用后调用。 release(): Promise\<void>
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 通过Promise方式释放视频资源。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | -------------------------------- | | -------------- | ----------------------------- |
| Promise\<string> | 异步获得surface的Promise返回值。 | | Promise\<void> | 释放视频资源的Promise返回值。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. |
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
// promise videoPlayer.release().then(() => {
let surfaceID = null; // 传递给外界的surfaceID console.info('release success');
videoRecorder.getInputSurface().then((surfaceId) => { }).catch((error) => {
console.info('getInputSurface success'); console.info(`video catchCallback, error:${error}`);
surfaceID = surfaceId;
}).catch((err) => {
console.info('getInputSurface failed and catch error is ' + err.message);
}); });
``` ```
### start<sup>9+</sup><a name=videorecorder_start1></a> ### getTrackDescription<sup>8+</sup>
start(callback: AsyncCallback\<void>): void;
异步方式开始视频录制。通过注册回调函数获取返回值。
在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)后调用，需要依赖数据源先给surface传递数据。 getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 通过回调方式获取视频轨道信息。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
| callback | AsyncCallback\<void> | 是 | 异步开始视频录制的回调方法。 | | callback | AsyncCallback\<Array\<[MediaDescription](#mediadescription8)>> | 是 | 视频轨道信息MediaDescription数组回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// asyncallback function printfDescription(obj) {
videoRecorder.start((err) => { for (let item in obj) {
if (err == null) { let property = obj[item];
console.info('start videorecorder success'); console.info('video key is ' + item);
console.info('video value is ' + property);
}
}
videoPlayer.getTrackDescription((error, arrList) => {
if ((arrList) != null) {
for (let i = 0; i < arrList.length; i++) {
printfDescription(arrList[i]);
}
} else { } else {
console.info('start videorecorder failed and error is ' + err.message); console.log(`video getTrackDescription fail, error:${error}`);
} }
}); });
``` ```
### start<sup>9+</sup><a name=videorecorder_start2></a> ### getTrackDescription<sup>8+</sup>
start(): Promise\<void>; getTrackDescription(): Promise\<Array\<MediaDescription>>
异步方式开始视频录制。通过Promise获取返回值。 通过Promise方式获取视频轨道信息。
在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)后调用，需要依赖数据源先给surface传递数据。 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **返回值：**
**系统接口：** 该接口为系统接口 | 类型 | 说明 |
| ------------------------------------------------------ | ----------------------------------------------- |
| Promise<Array<[MediaDescription](#mediadescription8)>> | 视频轨道信息MediaDescription数组Promise返回值。 |
**返回值：** **示例：**
| 类型 | 说明 | ```js
| -------------- | ------------------------------------- | function printfDescription(obj) {
| Promise\<void> | 异步开始视频录制方法的Promise返回值。 | for (let item in obj) {
let property = obj[item];
console.info('video key is ' + item);
console.info('video value is ' + property);
}
}
**错误码：** let arrayDescription;
videoPlayer.getTrackDescription().then((arrList) => {
if (arrList != null) {
arrayDescription = arrList;
} else {
console.log('video getTrackDescription fail');
}
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
for (let i = 0; i < arrayDescription.length; i++) {
printfDescription(arrayDescription[i]);
}
```
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) ### setSpeed<sup>8+</sup>
| 错误码ID | 错误信息 | setSpeed(speed:number, callback: AsyncCallback\<number>): void
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. | 通过回调方式设置播放速度。
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. | **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------------------------- |
| speed | number | 是 | 指定播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 |
| callback | AsyncCallback\<number> | 是 | 设置播放速度的回调方法。 |
**示例：** **示例：**
```js ```js
// promise import media from '@ohos.multimedia.media'
videoRecorder.start().then(() => { let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
console.info('start videorecorder success');
}).catch((err) => { videoPlayer.setSpeed(speed, (err, result) => {
console.info('start videorecorder failed and catch error is ' + err.message); if (err == null) {
console.info('setSpeed success!');
} else {
console.info('setSpeed fail!');
}
}); });
``` ```
### pause<sup>9+</sup><a name=videorecorder_pause1></a> ### setSpeed<sup>8+</sup>
pause(callback: AsyncCallback\<void>): void;
异步方式暂停视频录制。通过注册回调函数获取返回值。
在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。 setSpeed(speed:number): Promise\<number>
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 通过Promise方式设置播放速度。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | ------ | ------ | ---- | ---------------------------------------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步暂停视频录制的回调方法。 | | speed | number | 是 | 指定播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) **返回值：**
| 错误码ID | 错误信息 | | 类型 | 说明 |
| -------- | ------------------------------------------ | | ---------------- | ------------------------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. | | Promise\<number> | 播放速度Promise返回值，具体见[PlaybackSpeed](#playbackspeed8)。 |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// asyncallback import media from '@ohos.multimedia.media'
videoRecorder.pause((err) => { let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
if (err == null) {
console.info('pause videorecorder success'); videoPlayer.setSpeed(speed).then(() => {
} else { console.info('setSpeed success');
console.info('pause videorecorder failed and error is ' + err.message); }).catch((error) => {
} console.info(`video catchCallback, error:${error}`);
}); });
``` ```
### pause<sup>9+</sup><a name=videorecorder_pause2></a> ### on('playbackCompleted')<sup>8+</sup>
pause(): Promise\<void>; on(type: 'playbackCompleted', callback: Callback\<void>): void
异步方式暂停视频录制。通过Promise获取返回值。 开始监听视频播放完成事件。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ----------------------------------------------------------- |
| type | string | 是 | 视频播放完成事件回调类型，支持的事件：'playbackCompleted'。 |
| callback | function | 是 | 视频播放完成事件回调方法。 |
在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。 **示例：**
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder ```js
videoPlayer.on('playbackCompleted', () => {
console.info('playbackCompleted success!');
});
```
**系统接口：** 该接口为系统接口 ### on('bufferingUpdate')<sup>8+</sup>
**返回值：** on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void
| 类型 | 说明 | 开始监听视频缓存更新事件。仅网络播放支持该订阅事件。
| -------------- | ------------------------------------- |
| Promise\<void> | 异步暂停视频录制方法的Promise返回值。 |
**错误码：** **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) **参数：**
| 错误码ID | 错误信息 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | | -------- | -------- | ---- | ------------------------------------------------------------ |
| 5400102 | Operation not allowed. Return by promise. | | type | string | 是 | 视频缓存事件回调类型，支持的事件：'bufferingUpdate'。 |
| 5400103 | I/O error. Return by promise. | | callback | function | 是 | 视频缓存事件回调方法。<br>[BufferingInfoType](#bufferinginfotype8)为BUFFERING_PERCENT或CACHED_DURATION时，value值有效，否则固定为0。 |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
// promise videoPlayer.on('bufferingUpdate', (infoType, value) => {
videoRecorder.pause().then(() => { console.log('video bufferingInfo type: ' + infoType);
console.info('pause videorecorder success'); console.log('video bufferingInfo value: ' + value);
}).catch((err) => {
console.info('pause videorecorder failed and catch error is ' + err.message);
}); });
``` ```
### resume<sup>9+</sup><a name=videorecorder_resume1></a> ### on('startRenderFrame')<sup>8+</sup>
resume(callback: AsyncCallback\<void>): void;
异步方式恢复视频录制。通过注册回调函数获取返回值。 on(type: 'startRenderFrame', callback: Callback\<void>): void
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 开始监听视频播放首帧送显上报事件。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | --------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<void> | 是 | 异步恢复视频录制的回调方法。 | | type | string | 是 | 视频播放首帧送显上报事件回调类型，支持的事件：'startRenderFrame'。 |
| callback | Callback\<void> | 是 | 视频播放首帧送显上报事件回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// asyncallback videoPlayer.on('startRenderFrame', () => {
videoRecorder.resume((err) => { console.info('startRenderFrame success!');
if (err == null) {
console.info('resume videorecorder success');
} else {
console.info('resume videorecorder failed and error is ' + err.message);
}
}); });
``` ```
### resume<sup>9+</sup><a name=videorecorder_resume2></a> ### on('videoSizeChanged')<sup>8+</sup>
resume(): Promise\<void>;
异步方式恢复视频录制。通过Promise获取返回值。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**返回值：** on(type: 'videoSizeChanged', callback: (width: number, height: number) => void): void
| 类型 | 说明 | 开始监听视频播放宽高变化事件。
| -------------- | ------------------------------------- |
| Promise\<void> | 异步恢复视频录制方法的Promise返回值。 |
**错误码：** **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) **参数：**
| 错误码ID | 错误信息 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | | -------- | -------- | ---- | ------------------------------------------------------------ |
| 5400102 | Operation not allowed. Return by promise. | | type | string | 是 | 视频播放宽高变化事件回调类型，支持的事件：'videoSizeChanged'。 |
| 5400103 | I/O error. Return by promise. | | callback | function | 是 | 视频播放宽高变化事件回调方法，width表示宽，height表示高。 |
| 5400105 | Service died. Return by promise. |
**示例：** **示例：**
```js ```js
// promise videoPlayer.on('videoSizeChanged', (width, height) => {
videoRecorder.resume().then(() => { console.log('video width is: ' + width);
console.info('resume videorecorder success'); console.log('video height is: ' + height);
}).catch((err) => {
console.info('resume videorecorder failed and catch error is ' + err.message);
}); });
``` ```
### stop<sup>9+</sup><a name=videorecorder_stop1></a> ### on('error')<sup>8+</sup>
stop(callback: AsyncCallback\<void>): void;
异步方式停止视频录制。通过注册回调函数获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。 on(type: 'error', callback: ErrorCallback): void
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 开始监听视频播放错误事件，当上报error错误事件后，用户需处理error事件，退出播放操作。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | ------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<void> | 是 | 异步停止视频录制的回调方法。 | | type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。<br>- 'error'：视频播放中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------ |
| 5400102 | Operation not allowed. Return by callback. |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// asyncallback videoPlayer.on('error', (error) => { // 设置'error'事件回调
videoRecorder.stop((err) => { console.info(`video error called, error: ${error}`);
if (err == null) {
console.info('stop videorecorder success');
} else {
console.info('stop videorecorder failed and error is ' + err.message);
}
}); });
videoPlayer.url = 'fd://error'; //设置错误的播放地址，触发'error'事件
``` ```
### stop<sup>9+</sup><a name=videorecorder_stop2></a> ## VideoPlayState<sup>(deprecated)</sup><a name=videoplayerstate></a>
stop(): Promise\<void>; 视频播放的状态机，可通过state属性获取当前状态。
异步方式停止视频录制。通过Promise获取返回值。 > **说明：**
> 从API version 8开始支持，从API version 9开始废弃，建议使用[AVPlayerState](#avplayerstate9)替代。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。 **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder | 名称 | 类型 | 说明 |
| -------- | ------ | -------------- |
| idle | string | 视频播放空闲。 |
| prepared | string | 视频播放准备。 |
| playing | string | 视频正在播放。 |
| paused | string | 视频暂停播放。 |
| stopped | string | 视频播放停止。 |
| error | string | 错误状态。 |
**系统接口：** 该接口为系统接口 ## AudioRecorder<sup>(deprecated)</sup>
**返回值：** > **说明：**
> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorder](#avrecorder9)替代。
| 类型 | 说明 | 音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#mediacreateaudiorecorder) 构建一个AudioRecorder实例。
| -------------- | ------------------------------------- |
| Promise\<void> | 异步停止视频录制方法的Promise返回值。 |
**错误码：** 音频录制demo可参考：[音频录制开发指导](../../media/audio-recorder.md)
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) ### prepare<a name=audiorecorder_prepare></a>
| 错误码ID | 错误信息 | prepare(config: AudioRecorderConfig): void
| -------- | ----------------------------------------- |
| 5400102 | Operation not allowed. Return by promise. | 录音准备。
| 5400103 | I/O error. Return by promise. |
| 5400105 | Service died. Return by promise. | **需要权限：** ohos.permission.MICROPHONE
**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| config | [AudioRecorderConfig](#audiorecorderconfigdeprecated) | 是 | 配置录音的相关参数，包括音频输出URI、编码格式、采样率、声道数、输出格式等。 |
**示例：** **示例：**
```js ```js
// promise let audioRecorderConfig = {
videoRecorder.stop().then(() => { audioEncoder : media.AudioEncoder.AAC_LC,
console.info('stop videorecorder success'); audioEncodeBitRate : 22050,
}).catch((err) => { audioSampleRate : 22050,
console.info('stop videorecorder failed and catch error is ' + err.message); numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'fd://1', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('prepare', () => { //设置'prepare'事件回调
console.log('prepare success');
}); });
audioRecorder.prepare(audioRecorderConfig);
``` ```
### release<sup>9+</sup><a name=videorecorder_release1></a>
release(callback: AsyncCallback\<void>): void; ### start<a name=audiorecorder_start></a>
异步方式释放视频录制资源。通过注册回调函数获取返回值。 start(): void
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 开始录制，需在[prepare](#audiorecorder_on)事件成功触发后，才能调用start方法。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**参数：** **示例：**
| 参数名 | 类型 | 必填 | 说明 | ```js
| -------- | -------------------- | ---- | -------------------------------- | audioRecorder.on('start', () => { //设置'start'事件回调
| callback | AsyncCallback\<void> | 是 | 异步释放视频录制资源的回调方法。 | console.log('audio recorder start success');
});
audioRecorder.start();
```
**错误码：** ### pause<a name=audiorecorder_pause></a>
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) pause():void
| 错误码ID | 错误信息 | 暂停录制，需要在[start](#audiorecorder_on)事件成功触发后，才能调用pause方法。
| -------- | --------------------------------- |
| 5400105 | Service died. Return by callback. | **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**示例：** **示例：**
```js ```js
// asyncallback audioRecorder.on('pause', () => { //设置'pause'事件回调
videoRecorder.release((err) => { console.log('audio recorder pause success');
if (err == null) {
console.info('release videorecorder success');
} else {
console.info('release videorecorder failed and error is ' + err.message);
}
}); });
audioRecorder.pause();
``` ```
### release<sup>9+</sup><a name=videorecorder_release2></a> ### resume<a name=audiorecorder_resume></a>
release(): Promise\<void>; resume():void
异步方式释放视频录制资源。通过Promise获取返回值。 恢复录制，需要在[pause](#audiorecorder_on)事件成功触发后，才能调用resume方法。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**系统接口：** 该接口为系统接口 **示例：**
**返回值：** ```js
audioRecorder.on('resume', () => { //设置'resume'事件回调
console.log('audio recorder resume success');
});
audioRecorder.resume();
```
| 类型 | 说明 | ### stop<a name=audiorecorder_stop></a>
| -------------- | ----------------------------------------- |
| Promise\<void> | 异步释放视频录制资源方法的Promise返回值。 |
**错误码：** stop(): void
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) 停止录音。
| 错误码ID | 错误信息 | **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
| -------- | --------------------------------- |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// promise audioRecorder.on('stop', () => { //设置'stop'事件回调
videoRecorder.release().then(() => { console.log('audio recorder stop success');
console.info('release videorecorder success');
}).catch((err) => {
console.info('release videorecorder failed and catch error is ' + err.message);
}); });
audioRecorder.stop();
``` ```
### reset<sup>9+</sup><a name=videorecorder_reset1></a> ### release<a name=audiorecorder_release></a>
reset(callback: AsyncCallback\<void>): void; release(): void
异步方式重置视频录制。通过注册回调函数获取返回值。 释放录音资源。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。 **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **示例：**
**系统接口：** 该接口为系统接口 ```js
audioRecorder.on('release', () => { //设置'release'事件回调
console.log('audio recorder release success');
});
audioRecorder.release();
audioRecorder = undefined;
```
**参数：** ### reset<a name=audiorecorder_reset></a>
| 参数名 | 类型 | 必填 | 说明 | reset(): void
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步重置视频录制的回调方法。 |
**错误码：** 重置录音。
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) 进行重置录音之前，需要先调用[stop()](#audiorecorder_stop)停止录音。重置录音之后，需要调用[prepare()](#audiorecorder_prepare)设置录音参数项，才能再次进行录音。
| 错误码ID | 错误信息 | **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
| -------- | --------------------------------- |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// asyncallback audioRecorder.on('reset', () => { //设置'reset'事件回调
videoRecorder.reset((err) => { console.log('audio recorder reset success');
if (err == null) {
console.info('reset videorecorder success');
} else {
console.info('reset videorecorder failed and error is ' + err.message);
}
}); });
audioRecorder.reset();
``` ```
### reset<sup>9+</sup><a name=videorecorder_reset2></a> ### on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset')<a name=audiorecorder_on></a>
reset(): Promise\<void>;
异步方式重置视频录制。通过Promise获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface9)接口才能重新录制。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口
**返回值：** on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset', callback: () => void): void
| 类型 | 说明 | 开始订阅音频录制事件。
| -------------- | ------------------------------------- |
| Promise\<void> | 异步重置视频录制方法的Promise返回值。 |
**错误码：** **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) **参数：**
| 错误码ID | 错误信息 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | | -------- | -------- | ---- | ------------------------------------------------------------ |
| 5400103 | I/O error. Return by promise. | | type | string | 是 | 录制事件回调类型，支持的事件包括：'prepare'&nbsp;\|&nbsp;'start'&nbsp;\| 'pause' \| ’resume‘ \|&nbsp;'stop'&nbsp;\|&nbsp;'release'&nbsp;\|&nbsp;'reset'。<br/>-&nbsp;'prepare'&nbsp;：完成[prepare](#audiorecorder_prepare)调用，音频录制参数设置完成，触发该事件。<br/>-&nbsp;'start'&nbsp;：完成[start](#audiorecorder_start)调用，音频录制开始，触发该事件。<br/>-&nbsp;'pause': 完成[pause](#audiorecorder_pause)调用，音频暂停录制，触发该事件。<br/>-&nbsp;'resume': 完成[resume](#audiorecorder_resume)调用，音频恢复录制，触发该事件。<br/>-&nbsp;'stop'&nbsp;：完成[stop](#audiorecorder_stop)调用，音频停止录制，触发该事件。<br/>-&nbsp;'release'&nbsp;：完成[release](#audiorecorder_release)调用，音频释放录制资源，触发该事件。<br/>-&nbsp;'reset'：完成[reset](#audiorecorder_reset)调用，音频重置为初始状态，触发该事件。 |
| 5400105 | Service died. Return by promise. | | callback | ()=>void | 是 | 录制事件回调方法。 |
**示例：** **示例：**
```js ```js
// promise let audioRecorder = media.createAudioRecorder(); // 创建一个音频录制实例
videoRecorder.reset().then(() => { let audioRecorderConfig = {
console.info('reset videorecorder success'); audioEncoder : media.AudioEncoder.AAC_LC,
}).catch((err) => { audioEncodeBitRate : 22050,
console.info('reset videorecorder failed and catch error is ' + err.message); audioSampleRate : 22050,
numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`);
});
audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.log('prepare success');
audioRecorder.start(); // 开始录制，并触发'start'事件回调
});
audioRecorder.on('start', () => { // 设置'start'事件回调
console.log('audio recorder start success');
});
audioRecorder.on('pause', () => { // 设置'pause'事件回调
console.log('audio recorder pause success');
});
audioRecorder.on('resume', () => { // 设置'resume'事件回调
console.log('audio recorder resume success');
});
audioRecorder.on('stop', () => { // 设置'stop'事件回调
console.log('audio recorder stop success');
});
audioRecorder.on('release', () => { // 设置'release'事件回调
console.log('audio recorder release success');
});
audioRecorder.on('reset', () => { // 设置'reset'事件回调
console.log('audio recorder reset success');
}); });
audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调
``` ```
### on('error')<sup>9+</sup> ### on('error')
on(type: 'error', callback: ErrorCallback): void on(type: 'error', callback: ErrorCallback): void
开始订阅视频录制错误事件，当上报error错误事件后，用户需处理error事件，退出录制操作。 开始订阅音频录制错误事件，当上报error错误事件后，用户需处理error事件，退出录制操作。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------------------------------ | | -------- | ------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：视频录制过程中发生错误，触发该事件。 | | type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：音频录制过程中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 录制错误事件回调方法。 | | callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
**错误码：**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------- |
| 5400103 | I/O error. Return by callback. |
| 5400105 | Service died. Return by callback. |
**示例：** **示例：**
```js ```js
// 当获取videoRecordState接口出错时通过此订阅事件上报 let audioRecorderConfig = {
videoRecorder.on('error', (error) => { // 设置'error'事件回调 audioEncoder : media.AudioEncoder.AAC_LC,
audioEncodeBitRate : 22050,
audioSampleRate : 22050,
numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`); console.info(`audio error called, error: ${error}`);
}) });
audioRecorder.prepare(audioRecorderConfig); // prepare不设置参数，触发'error'事件
``` ```
## VideoRecordState<sup>(deprecated)</sup><a name=VideoRecordState9> ## AudioRecorderConfig<sup>(deprecated)</sup>
视频录制的状态机。可通过state属性获取当前状态。</sup>
> **说明：** > **说明：**
> 从API version 9开始支持，从API version 9开始废弃，建议使用[AVRecorderConfig](#avrecorderconfig9)替代。 > 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderConfig](#avrecorderconfig9)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口 表示音频的录音配置。
| 名称 | 类型 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
| -------- | ------ | ---------------------- |
| idle | string | 视频录制空闲。 |
| prepared | string | 视频录制参数设置完成。 |
| playing | string | 视频正在录制。 |
| paused | string | 视频暂停录制。 |
| stopped | string | 视频录制停止。 |
| error | string | 错误状态。 |
## VideoRecorderConfig<sup>(deprecated)</sup><a name=VideoRecorderConfig9> | 名称 | 类型 | 必填 | 说明 |
| ----------------------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioEncoder | [AudioEncoder](#audioencoderdeprecated) | 否 | 音频编码格式，默认设置为AAC_LC。<br/>**说明：** 从API version 8开始废弃，建议使用audioEncoderMime替代。 |
| audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。 |
| audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 |
| numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 |
| format | [AudioOutputFormat](#audiooutputformatdeprecated) | 否 | 音频输出封装格式，默认设置为MPEG_4。<br/>**说明：** 从API version 8开始废弃，建议使用fileFormat替代。 |
| location | [Location](#location) | 否 | 音频采集的地理位置。 |
| uri | string | 是 | 音频输出URI：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
| audioEncoderMime<sup>8+</sup> | [CodecMimeType](#codecmimetype8) | 否 | 音频编码格式。 |
| fileFormat<sup>8+</sup> | [ContainerFormatType](#containerformattype8) | 否 | 音频编码格式。 |
表示视频录制的参数设置。 ## AudioEncoder<sup>(deprecated)</sup>
> **说明：** > **说明：**
> 从API version 9开始支持，从API version 9开始废弃，建议使用[AVRecorderConfig](#avrecorderconfig9)替代。 > 从API version 6开始支持，从API version 8开始废弃，建议使用[CodecMimeType](#codecmimetype8)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口：** 该接口为系统接口 表示音频编码格式的枚举。
| 名称 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location) | 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) |
## VideoRecorderProfile<sup>(deprecated)</sup><a name=VideoRecorderProfile9> | 名称 | 值 | 说明 |
| ------- | ---- | ------------------------------------------------------------ |
| DEFAULT | 0 | 默认编码格式。<br/>仅做接口定义，暂不支持使用。 |
| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。<br/>仅做接口定义，暂不支持使用。 |
| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。<br/>仅做接口定义，暂不支持使用。 |
| AAC_LC | 3 | AAC-LC（Advanced&nbsp;Audio&nbsp;Coding&nbsp;Low&nbsp;Complexity）编码格式。 |
| HE_AAC | 4 | HE_AAC（High-Efficiency Advanced&nbsp;Audio&nbsp;Coding）编码格式。<br/>仅做接口定义，暂不支持使用。 |
视频录制的配置文件。 ## AudioOutputFormat<sup>(deprecated)</sup>
> **说明：** > **说明：**
> 从API version 9开始支持，从API version 9开始废弃，建议使用[AVRecorderProfile](#avrecorderprofile9)替代。 > 从API version 6开始支持，从API version 8 开始废弃，建议使用[ContainerFormatType](#containerformattype8)替代。
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder 表示音频封装格式的枚举。
**系统接口：** 该接口为系统接口 **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder
| 名称 | 类型 | 必填 | 说明 | | 名称 | 值 | 说明 |
| ---------------- | -------------------------------------------- | ---- | ---------------- | | -------- | ---- | ------------------------------------------------------------ |
| audioBitrate | number | 是 | 音频编码比特率。 | | DEFAULT | 0 | 默认封装格式。<br/>仅做接口定义，暂不支持使用。 |
| audioChannels | number | 是 | 音频采集声道数。 | | MPEG_4 | 2 | 封装为MPEG-4格式。 |
| audioCodec | [CodecMimeType](#codecmimetype8) | 是 | 音频编码格式。 | | AMR_NB | 3 | 封装为AMR_NB格式。<br/>仅做接口定义，暂不支持使用。 |
| audioSampleRate | number | 是 | 音频采样率。 | | AMR_WB | 4 | 封装为AMR_WB格式。<br/>仅做接口定义，暂不支持使用。 |
| fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 | | AAC_ADTS | 6 | 封装为ADTS（Audio&nbsp;Data&nbsp;Transport&nbsp;Stream）格式，是AAC音频的传输流格式。 |
| videoBitrate | number | 是 | 视频编码比特率。 |
| videoCodec | [CodecMimeType](#codecmimetype8) | 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
| videoFrameRate | number | 是 | 录制视频帧率。 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或