媒体服务
本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
媒体子系统为开发者提供一套简单且易于理解的接口,使得开发者能够方便接入系统并使用系统的媒体资源。
媒体子系统包含了音视频相关媒体业务,提供以下常用功能:
- 音视频播放(AVPlayer9+),AudioPlayer6+和VideoPlayer8+整合,升级了状态机和错误码,推荐使用
- 音视频录制(AVRecorder9+),AudioRecorder6+和视频录制功能整合,推荐使用
- 音频播放(AudioPlayer6+),AVPlayer9+发布后停止维护,请使用AVPlayer9+
- 视频播放(VideoPlayer8+),AVPlayer9+发布后停止维护,请使用AVPlayer9+
- 音频录制(AudioRecorder6+),AVRecorder9+发布后停止维护,请使用AVRecorder9+
media.createAVPlayer9+
createAVPlayer(callback: AsyncCallback<AVPlayer>): void
异步方式创建音视频播放实例,通过注册回调函数获取返回值。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<AVPlayer> | 是 | 回调函数。异步返回AVPlayer实例,失败时返回null。可用于音视频播放。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400101 | No memory. Return by callback. |
示例:
- let avPlayer;
- media.createAVPlayer((error, video) => {
- if (video != null) {
- avPlayer = video;
- console.info('createAVPlayer success');
- } else {
- console.error(`createAVPlayer fail, error message:${error.message}`);
- }
- });
media.createAVPlayer9+
createAVPlayer(): Promise<AVPlayer>
异步方式创建音视频播放实例,通过Promise获取返回值。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<AVPlayer> | Promise对象。异步返回AVPlayer实例,失败时返回null。可用于音视频播放。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400101 | No memory. Return by promise. |
示例:
- let avPlayer;
- media.createAVPlayer().then((video) => {
- if (video != null) {
- avPlayer = video;
- console.info('createAVPlayer success');
- } else {
- console.error('createAVPlayer fail');
- }
- }).catch((error) => {
- console.error(`AVPlayer catchCallback, error message:${error.message}`);
- });
media.createAVRecorder9+
createAVRecorder(callback: AsyncCallback<AVRecorder>): void
异步方式创建音视频录制实例。通过注册回调函数获取返回值。
一台设备只允许创建一个录制实例。
注意,使用相机进行视频录制时,需要与相机模块配合,当前相机模块仅对系统应用开放。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<AVRecorder> | 是 | 回调函数。异步返回AVRecorder实例,失败时返回null。可用于录制音视频媒体。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400101 | No memory. Return by callback. |
示例:
- let avRecorder;
- media.createAVRecorder((error, recorder) => {
- if (recorder != null) {
- avRecorder = recorder;
- console.info('createAVRecorder success');
- } else {
- console.error(`createAVRecorder fail, error message:${error.message}`);
- }
- });
media.createAVRecorder9+
createAVRecorder(): Promise<AVRecorder>
异步方式创建音视频录制实例。通过Promise获取返回值。
一台设备只允许创建一个录制实例。
注意,使用相机进行视频录制时,需要与相机模块配合,当前相机模块仅对系统应用开放。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<AVRecorder> | Promise对象。异步返回AVRecorder实例,失败时返回null。可用于录制音视频媒体。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400101 | No memory. Return by promise. |
示例:
- let avRecorder;
- media.createAVRecorder().then((recorder) => {
- if (recorder != null) {
- avRecorder = recorder;
- console.info('createAVRecorder success');
- } else {
- console.error('createAVRecorder fail');
- }
- }).catch((error) => {
- console.error(`createAVRecorder catchCallback, error message:${error.message}`);
- });
AVErrorCode9+
媒体错误码类型枚举
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
AVERR_OK | 0 | 表示操作成功。 |
AVERR_NO_PERMISSION | 201 | 表示无权限执行此操作。 |
AVERR_INVALID_PARAMETER | 401 | 表示传入入参无效。 |
AVERR_UNSUPPORT_CAPABILITY | 801 | 表示当前版本不支持该API能力。 |
AVERR_NO_MEMORY | 5400101 | 表示系统内存不足或服务数量达到上限。 |
AVERR_OPERATE_NOT_PERMIT | 5400102 | 表示当前状态不允许或无权执行此操作。 |
AVERR_IO | 5400103 | 表示数据流异常信息。 |
AVERR_TIMEOUT | 5400104 | 表示系统或网络响应超时。 |
AVERR_SERVICE_DIED | 5400105 | 表示服务进程死亡。 |
AVERR_UNSUPPORT_FORMAT | 5400106 | 表示不支持当前媒体资源的格式。 |
MediaType8+
媒体类型枚举。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
MEDIA_TYPE_AUD | 0 | 表示音频。 |
MEDIA_TYPE_VID | 1 | 表示视频。 |
CodecMimeType8+
Codec MIME类型枚举。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
VIDEO_H263 | 'video/h263' | 表示视频/h263类型。 |
VIDEO_AVC | 'video/avc' | 表示视频/avc类型。 |
VIDEO_MPEG2 | 'video/mpeg2' | 表示视频/mpeg2类型。 |
VIDEO_MPEG4 | 'video/mp4v-es' | 表示视频/mpeg4类型。 |
VIDEO_VP8 | 'video/x-vnd.on2.vp8' | 表示视频/vp8类型。 |
AUDIO_AAC | 'audio/mp4a-latm' | 表示音频/mp4a-latm类型。 |
AUDIO_VORBIS | 'audio/vorbis' | 表示音频/vorbis类型。 |
AUDIO_FLAC | 'audio/flac' | 表示音频/flac类型。 |
MediaDescriptionKey8+
媒体信息描述枚举。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
MD_KEY_TRACK_INDEX | 'track_index' | 表示轨道序号,其对应键值类型为number。 |
MD_KEY_TRACK_TYPE | 'track_type' | 表示轨道类型,其对应键值类型为number,参考MediaType。 |
MD_KEY_CODEC_MIME | 'codec_mime' | 表示codec_mime类型,其对应键值类型为string。 |
MD_KEY_DURATION | 'duration' | 表示媒体时长,其对应键值类型为number,单位为毫秒(ms)。 |
MD_KEY_BITRATE | 'bitrate' | 表示比特率,其对应键值类型为number,单位为比特率(bps)。 |
MD_KEY_WIDTH | 'width' | 表示视频宽度,其对应键值类型为number,单位为像素(px)。 |
MD_KEY_HEIGHT | 'height' | 表示视频高度,其对应键值类型为number,单位为像素(px)。 |
MD_KEY_FRAME_RATE | 'frame_rate' | 表示视频帧率,其对应键值类型为number,单位为100帧每秒(100fps)。 |
MD_KEY_AUD_CHANNEL_COUNT | 'channel_count' | 表示声道数,其对应键值类型为number。 |
MD_KEY_AUD_SAMPLE_RATE | 'sample_rate' | 表示采样率,其对应键值类型为number,单位为赫兹(Hz)。 |
BufferingInfoType8+
缓存事件类型枚举。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
BUFFERING_START | 1 | 表示开始缓存。 |
BUFFERING_END | 2 | 表示结束缓存。 |
BUFFERING_PERCENT | 3 | 表示缓存百分比。 |
CACHED_DURATION | 4 | 表示缓存时长,单位为毫秒(ms)。 |
StateChangeReason9+
表示播放或录制实例状态机切换原因的枚举,伴随state一起上报。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
USER | 1 | 表示用户行为造成的状态切换,由用户或客户端主动调用接口产生。 |
BACKGROUND | 2 | 表示系统行为造成的状态切换,比如应用未注册播控中心权限,退到后台时被系统强制暂停或停止。 |
属性
系统能力: SystemCapability.Multimedia.Media.AVPlayer
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
url9+ | string | 是 | 是 | 媒体URL,只允许在idle状态下设置,静态属性。 支持的视频格式(mp4、mpeg-ts、webm、mkv)。 支持的音频格式(m4a、aac、mp3、ogg、wav)。 支持路径示例: 1. fd类型播放:fd://xx。 2. http网络播放: http://xx。 3. https网络播放: https://xx。 4. hls网络播放路径:http://xx或者https://xx。 |
fdSrc9+ | 是 | 是 | 媒体文件描述,只允许在idle状态下设置,静态属性。 使用场景:应用中的媒体资源被连续存储在同一个文件中。 使用示例: 假设一个连续存储的媒体文件: 视频1(地址偏移:0,字节长度:100); 视频2(地址偏移:101,字节长度:50); 视频3(地址偏移:151,字节长度:150); 1. 播放视频1:AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; }。 2. 播放视频2:AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; }。 3. 播放视频3:AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; }。 假设是一个独立的媒体文件: 请使用src=fd://xx。 | |
surfaceId9+ | string | 是 | 是 | 视频窗口ID,默认无窗口,只允许在initialized状态下设置,静态属性。 使用场景:视频播放的窗口渲染,纯音频播放不用设置。 使用示例: |
loop9+ | boolean | 是 | 是 | 视频循环播放属性,默认'false',设置为'true'表示循环播放,动态属性。 只允许在prepared/playing/paused/completed状态下设置。 |
videoScaleType9+ | 是 | 是 | 视频缩放模式,默认VIDEO_SCALE_TYPE_FIT_CROP,动态属性。 只允许在prepared/playing/paused/completed状态下设置。 | |
audioInterruptMode9+ | 是 | 是 | 音频焦点模型,默认SHARE_MODE,动态属性。 只允许在prepared/playing/paused/completed状态下设置。 | |
state9+ | 是 | 否 | 音视频播放的状态,全状态有效,可查询参数。 | |
currentTime9+ | number | 是 | 否 | 视频的当前播放位置,单位为毫秒(ms),可查询参数。 返回为(-1)表示无效值,prepared/playing/paused/completed状态下有效。 |
number | 是 | 否 | 视频时长,单位为毫秒(ms),可查询参数。 返回为(-1)表示无效值,prepared/playing/paused/completed状态下有效。 直播场景默认返回(-1)。 | |
width9+ | number | 是 | 否 | 视频宽,单位为像素(px),可查询参数。 返回为(0)表示无效值,prepared/playing/paused/completed状态下有效。 |
height9+ | number | 是 | 否 | 视频高,单位为像素(px),可查询参数。 返回为(0)表示无效值,prepared/playing/paused/completed状态下有效。 |
说明:
将资源句柄(fd)传递给媒体播放器之后,请不要通过该资源句柄做其他读写操作,包括但不限于将同一个资源句柄传递给多个媒体播放器。同一时间通过同一个资源句柄读写文件时存在竞争关系,将导致播放异常。
on('stateChange')9+
on(type: 'stateChange', callback: (state: AVPlayerState, reason: StateChangeReason) => void): void
监听播放状态机AVPlayerState切换的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 状态机切换事件回调类型,支持的事件:'stateChange',用户操作和系统都会触发此事件。 |
callback | function | 是 | 状态机切换事件回调方法: state: AVPlayerState,表示当前播放状态; reason: StateChangeReason,表示当前播放状态的切换原因。 |
示例:
- avPlayer.on('stateChange', async (state, reason) => {
- switch (state) {
- case 'idle':
- console.info('state idle called')
- break;
- case 'initialized':
- console.info('initialized prepared called')
- break;
- case 'prepared':
- console.info('state prepared called')
- break;
- case 'playing':
- console.info('state playing called')
- break;
- case 'paused':
- console.info('state paused called')
- break;
- case 'completed':
- console.info('state completed called')
- break;
- case 'stopped':
- console.info('state stopped called')
- break;
- case 'released':
- console.info('state released called')
- break;
- case 'error':
- console.info('state error called')
- break;
- default:
- console.info('unkown state :' + state)
- break;
- }
- })
off('stateChange')9+
off(type: 'stateChange'): void
取消监听播放状态机AVPlayerState切换的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 状态机切换事件回调类型,取消注册的事件:'stateChange' |
示例:
- avPlayer.off('stateChange')
on('error')9+
on(type: 'error', callback: ErrorCallback): void
监听AVPlayer的错误事件,该事件仅用于错误提示,不需要用户停止播控动作。如果此时AVPlayerState也切至error状态,用户需要通过reset()或者release()退出播放操作。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 错误事件回调类型,支持的事件:'error',用户操作和系统都会触发此事件。 |
callback | function | 是 | 错误事件回调方法:使用播放器的过程中发生错误,会提供错误码ID和错误信息。 |
错误码ID | 错误信息 | 说明 |
---|---|---|
201 | No Permission: | 无权限执行此操作,AVPlayerState会进入error状态。 |
401 | Invalid Parameter: | 入参错误,表示调用无效。 |
801 | Unsupport Capability: | 不支持该API能力,表示调用无效。 |
5400101 | No Memory: | 播放内存不足,AVPlayerState会进入error状态。 |
5400102 | Operate Not Permit: | 当前状态机不支持此操作,表示调用无效。 |
5400103 | IO Error: | 播放中发现码流异常,AVPlayerState会进入error状态。 |
5400104 | Network Timeout: | 网络原因超时响应,AVPlayerState会进入error状态。 |
5400105 | Service Died: | 播放进程死亡,AVPlayerState会进入error状态,需要调用release后创建新实例。 |
5400106 | Unsupport Format: | 不支持的文件格式,AVPlayerState会进入error状态。 |
示例:
- avPlayer.on('error', (error) => {
- console.error('error happened,and error message is :' + error.message)
- console.error('error happened,and error code is :' + error.code)
- })
off('error')9+
off(type: 'error'): void
取消监听播放的错误事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 错误事件回调类型,取消注册的事件:'error' |
示例:
- avPlayer.off('error')
prepare9+
prepare(callback: AsyncCallback<void>): void
通过回调方式准备播放视频,需在stateChange事件成功触发至initialized状态后,才能调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | function | 是 | 准备播放的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
5400106 | Unsupport format. Return by callback. |
示例:
- avPlayer.prepare((err) => {
- if (err == null) {
- console.info('prepare success');
- } else {
- console.error('prepare filed,error message is :' + err.message)
- }
- })
prepare9+
prepare(): Promise<void>
通过Promise方式准备播放视频,需在stateChange事件成功触发至initialized状态后,才能调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 准备播放的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
5400106 | Unsupport format. Return by promise. |
示例:
- avPlayer.prepare().then(() => {
- console.info('prepare success');
- }, (err) => {
- console.error('prepare filed,error message is :' + err.message)
- })
play9+
play(callback: AsyncCallback<void>): void
通过回调方式开始播放音视频资源,只能在prepared/paused/complete状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | function | 是 | 开始播放的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
示例:
- avPlayer.play((err) => {
- if (err == null) {
- console.info('play success');
- } else {
- console.error('play filed,error message is :' + err.message)
- }
- })
play9+
play(): Promise<void>
通过Promise方式开始播放音视频资源,只能在prepared/paused/complete状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 开始播放的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
示例:
- avPlayer.play().then(() => {
- console.info('play success');
- }, (err) => {
- console.error('play filed,error message is :' + err.message)
- })
pause9+
pause(callback: AsyncCallback<void>): void
通过回调方式暂停播放音视频资源,只能在playing状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | function | 是 | 暂停播放的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
示例:
- avPlayer.pause((err) => {
- if (err == null) {
- console.info('pause success');
- } else {
- console.error('pause filed,error message is :' + err.message)
- }
- })
pause9+
pause(): Promise<void>
通过Promise方式暂停播放音视频资源,只能在playing状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 暂停播放的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
示例:
- avPlayer.pause().then(() => {
- console.info('pause success');
- }, (err) => {
- console.error('pause filed,error message is :' + err.message)
- })
stop9+
stop(callback: AsyncCallback<void>): void
通过回调方式停止播放音视频资源,只能在prepared/playing/paused/complete状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | function | 是 | 停止播放的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
示例:
- avPlayer.stop((err) => {
- if (err == null) {
- console.info('stop success');
- } else {
- console.error('stop filed,error message is :' + err.message)
- }
- })
stop9+
stop(): Promise<void>
通过Promise方式停止播放音视频资源,只能在prepared/playing/paused/complete状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 停止播放的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
示例:
- avPlayer.stop().then(() => {
- console.info('stop success');
- }, (err) => {
- console.error('stop filed,error message is :' + err.message)
- })
reset9+
reset(callback: AsyncCallback<void>): void
通过回调方式重置播放,只能在initialized/prepared/playing/paused/complete/stopped/error状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | function | 是 | 重置播放的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
示例:
- avPlayer.reset((err) => {
- if (err == null) {
- console.info('reset success');
- } else {
- console.error('reset filed,error message is :' + err.message)
- }
- })
reset9+
reset(): Promise<void>
通过Promise方式通过Promise方式重置播放,只能在initialized/prepared/playing/paused/complete/stopped/error状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 重置播放的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
示例:
- avPlayer.reset().then(() => {
- console.info('reset success');
- }, (err) => {
- console.error('reset filed,error message is :' + err.message)
- })
release9+
release(callback: AsyncCallback<void>): void
通过回调方式销毁播放资源,除released状态,都可以调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | function | 是 | 销毁播放的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
示例:
- avPlayer.release((err) => {
- if (err == null) {
- console.info('reset success');
- } else {
- console.error('release filed,error message is :' + err.message)
- }
- })
release9+
release(): Promise<void>
通过Promise方式通过Promise方式销毁播放,除released状态,都可以调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 销毁播放的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
示例:
- avPlayer.release().then(() => {
- console.info('release success');
- }, (err) => {
- console.error('release filed,error message is :' + err.message)
- })
getTrackDescription9+
getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void
通过回调方式获取音视频轨道信息,可以在prepared/playing/paused状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<Array<MediaDescription>> | 是 | 音视频轨道信息MediaDescription数组回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by callback. |
示例:
- function printfDescription(obj) {
- for (let item in obj) {
- let property = obj[item];
- console.info('audio key is ' + item);
- console.info('audio value is ' + property);
- }
- }
- avPlayer.getTrackDescription((error, arrList) => {
- if ((arrList) != null) {
- for (let i = 0; i < arrList.length; i++) {
- printfDescription(arrList[i]);
- }
- } else {
- console.log(`video getTrackDescription fail, error:${error}`);
- }
- });
getTrackDescription9+
getTrackDescription(): Promise<Array<MediaDescription>>
通过Promise方式获取音视频轨道信息,可以在prepared/playing/paused状态调用。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
返回值:
类型 | 说明 |
---|---|
Promise<Array<MediaDescription>> | 音视频轨道信息MediaDescription数组Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operation not allowed. Return by promise. |
示例:
- let arrayDescription;
- function printfDescription(obj) {
- for (let item in obj) {
- let property = obj[item];
- console.info('audio key is ' + item);
- console.info('audio value is ' + property);
- }
- }
- avPlayer.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]);
- }
seek9+
seek(timeMs: number, mode?:SeekMode): void
跳转到指定播放位置,只能在prepared/playing/paused/complete状态调用,可以通过seekDone事件确认是否生效。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
示例:
- let seekTime = 1000
- avPlayer.seek(seekTime, media.SeekMode.SEEK_PREV_SYNC)
on('seekDone')9+
on(type: 'seekDone', callback: Callback<number>): void
监听seek生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | seek生效的事件回调类型,支持的事件:'seekDone',每次调用seek后都会回调此事件。 |
callback | Callback<number> | 是 | seek生效的事件回调方法,只会上报用户请求的time位置。 视频播放:SeekMode会造成实际跳转位置与用户设置产生偏差,精准位置需要通过currentTime获取,事件回调的time仅代表完成用户某一次请求。 |
示例:
- avPlayer.on('seekDone', (seekDoneTime:number) => {
- console.info('seekDone success,and seek time is:' + seekDoneTime)
- })
off('seekDone')9+
off(type: 'seekDone'): void
取消监听seek生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | seek生效的事件回调类型,取消注册的事件:'seekDone'。 |
示例:
- avPlayer.off('seekDone')
setSpeed9+
setSpeed(speed: PlaybackSpeed): void
设置倍速模式,只能在prepared/playing/paused/complete状态调用,可以通过speedDone事件确认是否生效。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
speed | 是 | 指定播放倍速模式。 |
示例:
- avPlayer.setSpeed(media.PlaybackSpeed.SPEED_FORWARD_2_00_X)
on('speedDone')9+
on(type: 'speedDone', callback: Callback<number>): void
监听setSpeed生效的事件
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | setSpeed生效的事件回调类型,支持的事件:'speedDone',每次调用setSpeed后都会回调此事件。 |
callback | Callback<number> | 是 | setSpeed生效的事件回调方法,上报生效的倍速模式,具体见PlaybackSpeed。 |
示例:
- avPlayer.on('speedDone', (speed:number) => {
- console.info('speedDone success,and speed value is:' + speed)
- })
off('speedDone')9+
off(type: 'speedDone'): void
取消监听setSpeed生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | setSpeed生效的事件回调类型,取消注册的事件:'speedDone'。 |
示例:
- avPlayer.off('speedDone')
setBitrate9+
setBitrate(bitrate: number): void
选择要播放的指定比特率,仅对HLS协议网络流有效,只能在prepared/playing/paused/complete状态调用,可以通过bitrateDone事件确认是否生效。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bitrate | number | 是 | 指定比特率,可以通过availableBitrates事件获得当前HLS协议流可用的比特率,如果用户指定的比特率不在此列表中,则播放器将从可用比特率列表中选择最小和最接近的比特率。 如果通过availableBitrates事件获得的比特率列表长度为0,则不支持指定比特率,也不会产生bitrateDone回调。 |
示例:
- let bitrate = 96000
- avPlayer.setBitrate(bitrate)
on('bitrateDone')9+
on(type: 'bitrateDone', callback: Callback<number>): void
监听setBitrate生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | setBitrate生效的事件回调类型,支持的事件:'bitrateDone',每次调用setBitrate后都会回调此事件。 |
callback | function | 是 | setBitrate生效的事件回调方法,上报生效的比特率。 |
示例:
- avPlayer.on('bitrateDone', (bitrate:number) => {
- console.info('bitrateDone success,and bitrate value is:' + bitrate)
- })
off('bitrateDone')9+
off(type: 'bitrateDone'): void
取消监听setBitrate生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | setBitrate生效的事件回调类型,取消注册的事件:'bitrateDone'。 |
示例:
- avPlayer.off('bitrateDone')
on('availableBitrates')9+
on(type: 'availableBitrates', callback: (bitrates: Array<number>) => void): void
监听HLS协议流可用的比特率列表,只会在切换prepared状态后上报。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | HLS协议可用比特率上报事件回调类型,支持的事件:'availableBitrates',只会在prepared之后上报一次。 |
callback | function | 是 | HLS协议可用比特率上报事件回调方法,使用数组存放支持的比特率。如果数组长度为0,则不支持指定比特率。 |
示例:
- avPlayer.on('availableBitrates', (bitrates: Array<number>) => {
- console.info('availableBitrates success,and availableBitrates length is:' + bitrates.length)
- })
off('availableBitrates')9+
off(type: 'availableBitrates'): void
取消监听HLS协议流可用的比特率列表。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | HLS协议可用比特率上报事件回调类型,取消注册的事件:'availableBitrates'。 |
示例:
- avPlayer.off('availableBitrates')
setVolume9+
setVolume(volume: number): void
设置媒体播放音量,只能在prepared/playing/paused/complete状态调用,可以通过volumeChange事件确认是否生效。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volume | number | 是 | 指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。 |
示例:
- let volume = 1.0
- avPlayer.setVolume(volume)
on('volumeChange')9+
on(type: 'volumeChange', callback: Callback<number>): void
监听setVolume生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | setVolume生效的事件回调类型,支持的事件:'volumeChange',每次调用setVolume后都会回调此事件。 |
callback | function | 是 | setVolume生效的事件回调方法,上报生效的媒体音量。 |
示例:
- avPlayer.on('volumeChange', (vol:number) => {
- console.info('volumeChange success,and new volume is :' + vol)
- })
off('volumeChange')9+
off(type: 'volumeChange'): void
取消监听setVolume生效的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | setVolume生效的事件回调类型,取消注册的事件:'volumeChange'。 |
示例:
- avPlayer.off('volumeChange')
on('endOfStream')9+
on(type: 'endOfStream', callback: Callback<void>): void
监听资源播放至结尾的事件;如果用户设置loop=1,播放会跳转至开头重播;如果用户没有设置loop,会通过stateChange上报completed状态。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 资源播放至结尾的事件回调类型,支持的事件:'endOfStream',当播放至结尾时会上报此事件。 |
callback | Callback<void> | 是 | 资源播放至结尾的事件回调方法。 |
示例:
- avPlayer.on('endOfStream', () => {
- console.info('endOfStream success')
- })
off('endOfStream')9+
off(type: 'endOfStream'): void
取消监听资源播放至结尾的事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 资源播放至结尾的事件回调类型,取消注册的事件:'endOfStream'。 |
示例:
- avPlayer.off('endOfStream')
on('timeUpdate')9+
on(type: 'timeUpdate', callback: Callback<number>): void
监听资源播放当前时间,单位为毫秒(ms),用于刷新进度条当前位置,默认间隔1s时间上报,因用户操作(seek)产生的时间变化会立刻上报。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 时间更新的回调类型,支持的事件:'timeUpdate'。 |
callback | function | 是 | 当前时间。 |
示例:
- avPlayer.on('timeUpdate', (time:number) => {
- console.info('timeUpdate success,and new time is :' + time)
- })
off('timeUpdate')9+
off(type: 'timeUpdate'): void
取消监听资源播放当前时间。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 时间更新的回调类型,取消注册的事件:'timeUpdate'。 |
示例:
- avPlayer.off('timeUpdate')
on('durationUpdate')9+
on(type: 'durationUpdate', callback: Callback<number>): void
监听资源播放资源的时长,单位为毫秒(ms),用于刷新进度条长度,默认只在prepared上报一次,同时允许一些特殊码流刷新多次时长。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 时长更新的回调类型,支持的事件:'durationUpdate'。 |
callback | function | 是 | 资源时长。 |
示例:
- avPlayer.on('durationUpdate', (duration) => {
- console.info('durationUpdate success,new duration is :' + duration)
- })
off('durationUpdate')9+
off(type: 'durationUpdate'): void
取消监听资源播放资源的时长。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 时长更新的回调类型,取消注册的事件:'durationUpdate'。 |
示例:
- avPlayer.off('durationUpdate')
on('bufferingUpdate')9+
on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void
订阅音视频缓存更新事件,仅网络播放支持该订阅事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 播放缓存事件回调类型,支持的事件:'bufferingUpdate'。 |
callback | function | 是 | 播放缓存事件回调方法。 BufferingInfoType为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。 |
示例:
- avPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
- console.info('bufferingUpdate success,and infoType value is:' + infoType + ', value is :' + value)
- })
off('bufferingUpdate')9+
off(type: 'bufferingUpdate'): void
取消监听音视频缓存更新事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 播放缓存事件回调类型,取消注册的事件:'bufferingUpdate'。 |
示例:
- avPlayer.off('bufferingUpdate')
on('startRenderFrame')9+
on(type: 'startRenderFrame', callback: Callback<void>): void
订阅视频播放开始首帧渲染的更新事件,仅视频播放支持该订阅事件,该事件仅代表播放服务将第一帧画面送显示模块,实际效果依赖显示服务渲染性能。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放开始首帧渲染事件回调类型,支持的事件:'startRenderFrame'。 |
callback | Callback<void> | 是 | 视频播放开始首帧渲染事件回调方法。 |
示例:
- avPlayer.on('startRenderFrame', () => {
- console.info('startRenderFrame success')
- })
off('startRenderFrame')9+
off(type: 'startRenderFrame'): void
取消监听视频播放开始首帧渲染的更新事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放开始首帧渲染事件回调类型,取消注册的事件:'startRenderFrame'。 |
示例:
- avPlayer.off('startRenderFrame')
on('videoSizeChange')9+
on(type: 'videoSizeChange', callback: (width: number, height: number) => void): void
监听视频播放宽高变化事件,仅视频播放支持该订阅事件,默认只在prepread状态上报一次,但HLS协议码流会在切换分辨率时上报;
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放宽高变化事件回调类型,支持的事件:'videoSizeChange'。 |
callback | function | 是 | 视频播放宽高变化事件回调方法,width表示宽,height表示高。 |
示例:
- avPlayer.on('videoSizeChange', (width: number, height: number) => {
- console.info('videoSizeChange success,and width is:' + width + ', height is :' + height)
- })
off('videoSizeChange')9+
off(type: 'videoSizeChange'): void
取消监听视频播放宽高变化事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放宽高变化事件回调类型,取消注册的事件:'videoSizeChange'。 |
示例:
- avPlayer.off('videoSizeChange')
on('audioInterrupt')9+
on(type: 'audioInterrupt', callback: (info: audio.InterruptEvent) => void): void
监听音频焦点变化事件,多个音视频资源同时播放时,会根据音频焦点模型audio.InterruptMode触发此事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 音频焦点变化事件回调类型,支持的事件:'audioInterrupt'。 |
callback | 是 | 音频焦点变化事件回调方法。 |
示例:
- import audio from '@ohos.multimedia.audio';
- avPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
- console.info('audioInterrupt success,and InterruptEvent info is:' + info)
- })
off('audioInterrupt')9+
off(type: 'audioInterrupt'): void
取消监听音频焦点变化事件。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 音频焦点变化事件回调类型,取消注册的事件:'audioInterrupt'。 |
示例:
- avPlayer.off('audioInterrupt')
AVPlayerState9+
AVPlayer的状态机,可通过state属性主动获取当前状态,也可通过监听stateChange事件上报当前状态,状态机之间的切换规则,可参考使用AVPlayer开发音频播放功能。
系统能力: SystemCapability.Multimedia.Media.AVPlayer
名称 | 类型 | 说明 |
---|---|---|
idle | string | 闲置状态,AVPlayer刚被创建createAVPlayer()或者调用了reset()方法之后,进入Idle状态。 首次创建createAVPlayer(),所有属性都为默认值。 调用reset()方法,url9+ 或 fdSrc9+属性会被重置,其他用户设置的属性将被保留。 |
initialized | string | 资源初始化,在Idle 状态设置 url9+ 或 fdSrc9+属性,AVPlayer会进入initialized状态,此时可以配置窗口、音频等静态属性。 |
prepared | string | 已准备状态,在initialized状态调用prepare()方法,AVPlayer会进入prepared状态,此时播放引擎的资源已准备就绪。 |
playing | string | 正在播放状态,在prepared/paused/completed状态调用play()方法,AVPlayer会进入playing状态。 |
paused | string | 暂停状态,在playing状态调用pause方法,AVPlayer会进入paused状态。 |
completed | string | 播放至结尾状态,当媒体资源播放至结尾时,如果用户未设置循环播放(loop = 1),AVPlayer会进入completed状态,此时调用play()会进入playing状态和重播,调用stop()会进入stopped状态。 |
stopped | string | 停止状态,在prepared/playing/paused/completed状态调用stop()方法,AVPlayer会进入stopped状态,此时播放引擎只会保留属性,但会释放内存资源,可以调用prepare()重新准备,也可以调用reset()重置,或者调用release()彻底销毁。 |
released | string | 销毁状态,销毁与当前AVPlayer关联的播放引擎,无法再进行状态转换,调用release()方法后,会进入released状态,结束流程。 |
error | string | 错误状态,当播放引擎发生不可逆的错误,详见错误分类,则会转换至当前状态,可以调用reset()重置,也可以调用release()销毁重建。 注意: 区分error状态和 on('error') : 1、进入error状态时,会触发on('error')监听事件,可以通过on('error')事件获取详细错误信息; 2、处于error状态时,播放服务进入不可播控的状态,要求客户端设计容错机制,使用reset()重置或者release()销毁重建; 3、如果客户端收到on('error'),但未进入error状态: 原因1:客户端未按状态机调用API或传入参数错误,被AVPlayer拦截提醒,需要客户端调整代码逻辑; 原因2:播放过程发现码流问题,导致容器、解码短暂异常,不影响连续播放和播控操作的,不需要客户端设计容错机制。 |
AVFileDescriptor9+
音视频文件资源描述,一种特殊资源的播放方式,使用场景:应用中的音频资源被连续存储在同一个文件中,需要根据偏移量和长度进行播放。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
fd | number | 是 | 资源句柄,通过resourceManager.getRawFileDescriptor获取。 |
offset | number | 是 | 资源偏移量,需要基于预置资源的信息输入,非法值会造成音视频资源解析错误。 |
length | number | 是 | 资源长度,需要基于预置资源的信息输入,非法值会造成音视频资源解析错误。 |
SeekMode8+
视频播放的Seek模式枚举,可通过seek方法作为参数传递下去。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
SEEK_NEXT_SYNC | 0 | 表示跳转到指定时间点的下一个关键帧,建议向后快进的时候用这个枚举值。 |
SEEK_PREV_SYNC | 1 | 表示跳转到指定时间点的上一个关键帧,建议向前快进的时候用这个枚举值。 |
PlaybackSpeed8+
视频播放的倍速枚举,可通过setSpeed方法作为参数传递下去。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
名称 | 值 | 说明 |
---|---|---|
SPEED_FORWARD_0_75_X | 0 | 表示视频播放正常播速的0.75倍。 |
SPEED_FORWARD_1_00_X | 1 | 表示视频播放正常播速。 |
SPEED_FORWARD_1_25_X | 2 | 表示视频播放正常播速的1.25倍。 |
SPEED_FORWARD_1_75_X | 3 | 表示视频播放正常播速的1.75倍。 |
SPEED_FORWARD_2_00_X | 4 | 表示视频播放正常播速的2.00倍。 |
VideoScaleType9+
枚举,视频缩放模式。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
名称 | 值 | 说明 |
---|---|---|
VIDEO_SCALE_TYPE_FIT | 0 | 视频拉伸至与窗口等大。 |
VIDEO_SCALE_TYPE_FIT_CROP | 1 | 保持视频宽高比拉伸至填满窗口,内容可能会有裁剪。 |
MediaDescription8+
通过key-value方式获取媒体信息。
系统能力: SystemCapability.Multimedia.Media.Core
示例:
- import media from '@ohos.multimedia.media'
- function printfItemDescription(obj, key) {
- let property = obj[key];
- console.info('audio key is ' + key); // 通过key值获取对应的value。key值具体可见[MediaDescriptionKey]
- console.info('audio value is ' + property); //对应key值得value。其类型可为任意类型,具体key对应value的类型可参考[MediaDescriptionKey]
- }
- let audioPlayer = media.createAudioPlayer();
- audioPlayer.getTrackDescription((error, arrList) => {
- if (arrList != null) {
- for (let i = 0; i < arrList.length; i++) {
- printfItemDescription(arrList[i], media.MediaDescriptionKey.MD_KEY_TRACK_TYPE); //打印出每条轨道MD_KEY_TRACK_TYPE的值
- }
- } else {
- console.log(`audio getTrackDescription fail, error:${error}`);
- }
- });
AVRecorder9+
音视频录制管理类,用于音视频媒体录制。在调用AVRecorder的方法前,需要先通过createAVRecorder()构建一个AVRecorder实例。
音视频录制demo可参考:使用AVRecorder开发音频录制功能
注意,使用相机进行视频录制时,需要与相机模块配合,当前相机模块仅对系统应用开放。
prepare9+
prepare(config: AVRecorderConfig, callback: AsyncCallback<void>): void
异步方式进行音视频录制的参数设置。通过注册回调函数获取返回值。
需要权限: ohos.permission.MICROPHONE
不涉及音频录制时,可以不需要获取ohos.permission.MICROPHONE权限。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
config | 是 | 配置音视频录制的相关参数。 | |
callback | AsyncCallback<void> | 是 | 异步音视频录制prepare方法的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission denied. Return by callback. |
401 | Parameter error. Return by callback. |
5400102 | Operate not permit. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- // 配置参数以实际硬件设备支持的范围为准
- let AVRecorderProfile = {
- audioBitrate : 48000,
- audioChannels : 2,
- audioCodec : media.CodecMimeType.AUDIO_AAC,
- audioSampleRate : 48000,
- fileFormat : media.ContainerFormatType.CFT_MPEG_4,
- videoBitrate : 2000000,
- videoCodec : media.CodecMimeType.VIDEO_AVC,
- videoFrameWidth : 640,
- videoFrameHeight : 480,
- videoFrameRate : 30
- }
- let AVRecorderConfig = {
- audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
- videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
- profile : AVRecorderProfile,
- url : 'fd://', // 文件需先由调用者创建,赋予读写权限,将文件fd传给此参数,eg.fd://45
- rotation : 0, // 合理值0、90、180、270,非合理值prepare接口将报错
- location : { latitude : 30, longitude : 130 }
- }
- avRecorder.prepare(AVRecorderConfig, (err) => {
- if (err == null) {
- console.info('prepare success');
- } else {
- console.error('prepare failed and error is ' + err.message);
- }
- })
prepare9+
prepare(config: AVRecorderConfig): Promise<void>
异步方式进行音视频录制的参数设置。通过Promise获取返回值。
需要权限: ohos.permission.MICROPHONE
不涉及音频录制时,可以不需要获ohos.permission.MICROPHONE权限。
系统能力: SystemCapability.Multimedia.Media.AVRecorde
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
config | 是 | 配置音视频录制的相关参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步音视频录制prepare方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission denied. Return by promise. |
401 | Parameter error. Return by promise. |
5400102 | Operate not permit. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- // 配置参数以实际硬件设备支持的范围为准
- let AVRecorderProfile = {
- audioBitrate : 48000,
- audioChannels : 2,
- audioCodec : media.CodecMimeType.AUDIO_AAC,
- audioSampleRate : 48000,
- fileFormat : media.ContainerFormatType.CFT_MPEG_4,
- videoBitrate : 2000000,
- videoCodec : media.CodecMimeType.VIDEO_AVC,
- videoFrameWidth : 640,
- videoFrameHeight : 480,
- videoFrameRate : 30
- }
- let AVRecorderConfig = {
- audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
- videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
- profile : AVRecorderProfile,
- url : 'fd://', // 文件需先由调用者创建,赋予读写权限,将文件fd传给此参数,eg.fd://45
- rotation : 0, // 合理值0、90、180、270,非合理值prepare接口报错
- location : { latitude : 30, longitude : 130 }
- }
- avRecorder.prepare(AVRecorderConfig).then(() => {
- console.info('prepare success');
- }).catch((err) => {
- console.error('prepare failed and catch error is ' + err.message);
- });
getInputSurface9+
getInputSurface(callback: AsyncCallback<string>): void
异步方式获得录制需要的surface。此surface提供给调用者,调用者从此surface中获取surfaceBuffer,填入相应的视频数据。
应当注意,填入的视频数据需要携带时间戳(单位ns)和buffersize。时间戳的起始时间请以系统启动时间为基准。
需在prepare()事件成功触发后,才能调用getInputSurface()方法。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<string> | 是 | 异步获得surface的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by callback. |
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- let surfaceID = null; // 该surfaceID用于传递给相机接口创造videoOutput
- avRecorder.getInputSurface((err, surfaceId) => {
- if (err == null) {
- console.info('getInputSurface success');
- surfaceID = surfaceId;
- } else {
- console.error('getInputSurface failed and error is ' + err.message);
- }
- });
getInputSurface9+
getInputSurface(): Promise<string>
异步方式获得录制需要的surface。此surface提供给调用者,调用者从此surface中获取surfaceBuffer,填入相应的视频数据。
应当注意,填入的视频数据需要携带时间戳(单位ns)和buffersize。时间戳的起始时间请以系统启动时间为基准。
需在prepare()事件成功触发后,才能调用getInputSurface方法。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<string> | 异步获得surface的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by promise. |
5400103 | IO error. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- let surfaceID = null; // 该surfaceID用于传递给相机接口创造videoOutput
- avRecorder.getInputSurface().then((surfaceId) => {
- console.info('getInputSurface success');
- surfaceID = surfaceId;
- }).catch((err) => {
- console.error('getInputSurface failed and catch error is ' + err.message);
- });
start9+
start(callback: AsyncCallback<void>): void
异步方式开始视频录制。通过注册回调函数获取返回值。
纯音频录制需在prepare()事件成功触发后,才能调用start方法。纯视频录制,音视频录制需在getInputSurface()事件成功触发后,才能调用start方法。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步开始视频录制的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by callback. |
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.start((err) => {
- if (err == null) {
- console.info('start AVRecorder success');
- } else {
- console.error('start AVRecorder failed and error is ' + err.message);
- }
- });
start9+
start(): Promise<void>
异步方式开始视频录制。通过Promise获取返回值。
纯音频录制需在prepare()事件成功触发后,才能调用start方法。纯视频录制,音视频录制需在getInputSurface()事件成功触发后,才能调用start方法。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步开始视频录制方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by promise. |
5400103 | IO error. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- avRecorder.start().then(() => {
- console.info('start AVRecorder success');
- }).catch((err) => {
- console.error('start AVRecorder failed and catch error is ' + err.message);
- });
pause9+
pause(callback: AsyncCallback<void>): void
异步方式暂停视频录制。通过注册回调函数获取返回值。
需要start()事件成功触发后,才能调用pause方法,可以通过调用resume()接口来恢复录制。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步获得surface的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by callback. |
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.pause((err) => {
- if (err == null) {
- console.info('pause AVRecorder success');
- } else {
- console.error('pause AVRecorder failed and error is ' + err.message);
- }
- });
pause9+
pause(): Promise<void>
异步方式暂停视频录制。通过Promise获取返回值。
需要start()事件成功触发后,才能调用pause方法,可以通过调用resume()接口来恢复录制。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步暂停视频录制方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by promise. |
5400103 | IO error. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- avRecorder.pause().then(() => {
- console.info('pause AVRecorder success');
- }).catch((err) => {
- console.error('pause AVRecorder failed and catch error is ' + err.message);
- });
resume9+
resume(callback: AsyncCallback<void>): void
异步方式恢复视频录制。通过注册回调函数获取返回值。
需要在pause()事件成功触发后,才能调用resume方法。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步恢复视频录制的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by callback. |
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.resume((err) => {
- if (err == null) {
- console.info('resume AVRecorder success');
- } else {
- console.error('resume AVRecorder failed and error is ' + err.message);
- }
- });
resume9+
resume(): Promise<void>
异步方式恢复视频录制。通过Promise获取返回值。
需要在pause()事件成功触发后,才能调用resume方法。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步恢复视频录制方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by promise. |
5400103 | IO error. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- avRecorder.resume().then(() => {
- console.info('resume AVRecorder success');
- }).catch((err) => {
- console.error('resume AVRecorder failed and catch error is ' + err.message);
- });
stop9+
stop(callback: AsyncCallback<void>): void
异步方式停止视频录制。通过注册回调函数获取返回值。
需要在start()或pause()事件成功触发后,才能调用stop方法。
纯音频录制时,需要重新调用prepare()接口才能重新录制。纯视频录制,音视频录制时,需要重新调用prepare()和getInputSurface()接口才能重新录制。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步停止视频录制的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by callback. |
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.stop((err) => {
- if (err == null) {
- console.info('stop AVRecorder success');
- } else {
- console.error('stop AVRecorder failed and error is ' + err.message);
- }
- });
stop9+
stop(): Promise<void>
异步方式停止视频录制。通过Promise获取返回值。
需要在start()或pause()事件成功触发后,才能调用stop方法。
纯音频录制时,需要重新调用prepare()接口才能重新录制。纯视频录制,音视频录制时,需要重新调用prepare()和getInputSurface()接口才能重新录制。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步停止视频录制方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400102 | Operate not permit. Return by promise. |
5400103 | IO error. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- avRecorder.stop().then(() => {
- console.info('stop AVRecorder success');
- }).catch((err) => {
- console.error('stop AVRecorder failed and catch error is ' + err.message);
- });
reset9+
reset(callback: AsyncCallback<void>): void
异步方式重置音视频录制。通过注册回调函数获取返回值。
纯音频录制时,需要重新调用prepare()接口才能重新录制。纯视频录制,音视频录制时,需要重新调用prepare()和getInputSurface()接口才能重新录制。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步重置音视频录制的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.reset((err) => {
- if (err == null) {
- console.info('reset AVRecorder success');
- } else {
- console.error('reset AVRecorder failed and error is ' + err.message);
- }
- });
reset9+
reset(): Promise<void>
异步方式重置音视频录制。通过Promise获取返回值。
纯音频录制时,需要重新调用prepare()接口才能重新录制。纯视频录制,音视频录制时,需要重新调用prepare()和getInputSurface()接口才能重新录制。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步重置音视频录制方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400103 | IO error. Return by promise. |
5400105 | Service died. Return by promise. |
示例:
- avRecorder.reset().then(() => {
- console.info('reset AVRecorder success');
- }).catch((err) => {
- console.error('reset AVRecorder failed and catch error is ' + err.message);
- });
release9+
release(callback: AsyncCallback<void>): void
异步方式释放音视频录制资源。通过注册回调函数获取返回值。
释放音视频录制资源之后,该AVRecorder实例不能再进行任何操作。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步释放音视频录制资源的回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400105 | Service died. Return by callback. |
示例:
- avRecorder.release((err) => {
- if (err == null) {
- console.info('release AVRecorder success');
- } else {
- console.error('release AVRecorder failed and error is ' + err.message);
- }
- });
release9+
release(): Promise<void>
异步方式释放音视频录制资源。通过Promise获取返回值。
释放音视频录制资源之后,该AVRecorder实例不能再进行任何操作。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
返回值:
类型 | 说明 |
---|---|
Promise<void> | 异步释放音视频录制资源方法的Promise返回值。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400105 | Service died. Return by callback. |
示例:
- avRecorder.release().then(() => {
- console.info('release AVRecorder success');
- }).catch((err) => {
- console.error('release AVRecorder failed and catch error is ' + err.message);
- });
on('stateChange')9+
on(type: 'stateChange', callback: (state: AVRecorderState, reason: StateChangeReason) => void): void
订阅录制状态机AVRecorderState切换的事件,当 AVRecorderState状态机发生变化时,会通过订阅的回调方法通知用户。用户只能订阅一个状态机切换事件的回调方法,当用户重复订阅时,以最后一次订阅的回调接口为准。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 状态机切换事件回调类型,支持的事件:'stateChange',用户操作和系统都会触发此事件。 |
callback | function | 是 | 状态机切换事件回调方法: state: AVRecorderState,表示当前播放状态 ; reason: StateChangeReason,表示当前播放状态的切换原因。 |
示例:
- avRecorder.on('stateChange', async (state, reason) => {
- console.info('case state has changed, new state is :' + state + ',and new reason is : ' + reason);
- });
off('stateChange')9+
off(type: 'stateChange'): void
取消订阅播放状态机AVRecorderState切换的事件。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 状态机切换事件回调类型,支持的事件:'stateChange',用户操作和系统都会触发此事件。 |
示例:
- avRecorder.off('stateChange');
on('error')9+
on(type: 'error', callback: ErrorCallback): void
订阅AVRecorder的错误事件,该事件仅用于错误提示,不需要用户停止播控动作。如果此时AVRecorderState也切至error状态,用户需要通过reset()或者release()退出录制操作。
用户只能订阅一个错误事件的回调方法,当用户重复订阅时,以最后一次订阅的回调接口为准。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 录制错误事件回调类型'error'。 - 'error':录制过程中发生错误,触发该事件。 |
callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.on('error', (err) => {
- console.info('case avRecorder.on(error) called, errMessage is ' + err.message);
- });
off('error')9+
off(type: 'error'): void
取消订阅录制错误事件,取消后不再接收到AVRecorder的错误事件。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 录制错误事件回调类型'error'。 - 'error':录制过程中发生错误,触发该事件。 |
错误码:
以下错误码的详细介绍请参见媒体错误码。
错误码ID | 错误信息 |
---|---|
5400103 | IO error. Return by callback. |
5400105 | Service died. Return by callback. |
示例:
- avRecorder.off('error');
AVRecorderState9+
音视频录制的状态机。可通过state属性获取当前状态。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
名称 | 类型 | 说明 |
---|---|---|
idle | string | 闲置状态。此时可以调用prepare()方法设置录制参数,进入prepared状态。AVRecorder刚被创建,或者在任何非released状态下调用reset()方法,均进入idle状态。 |
prepared | string | 参数设置完成。此时可以调用start()方法开始录制,进入started状态。 |
started | string | 正在录制。此时可以调用pause()方法暂停录制,进入paused状态。也可以调用stop()方法结束录制,进入stopped状态。 |
paused | string | 录制暂停。此时可以调用resume()方法继续录制,进入started状态。也可以调用stop()方法结束录制,进入stopped状态。 |
stopped | string | 录制停止。此时可以调用prepare()方法设置录制参数,重新进入prepared状态。 |
released | string | 录制资源释放。此时不能再进行任何操作。在任何其他状态下,均可以通过调用release()方法进入released状态。 |
error | string | 错误状态。当AVRecorder实例发生不可逆错误,会转换至当前状态。切换至error状态时会伴随on('error')事件,该事件会上报详细错误原因。在error状态时,用户需要调用reset()方法重置AVRecorder实例,或者调用release()方法释放资源。 |
AVRecorderConfig9+
表示音视频录制的参数设置。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
audioSourceType | 否 | 选择录制的音频源类型。选择音频录制时必填。 | |
videoSourceType | 否 | 选择录制的视频源类型。选择视频录制时必填。 | |
profile | 是 | 录制的profile,必要参数。 | |
url | string | 是 | 录制输出URL:fd://xx (fd number) ,必要参数。 |
rotation | number | 否 | 录制的视频旋转角度,仅支持0,90,180,270,默认值为0。 |
location | 否 | 录制的地理位置,默认不记录地理位置信息。 |
通过audioSourceType和videoSourceType区分纯音频录制、纯视频录制或音视频录制。纯音频录制时,仅需要设置audioSourceType;纯视频录制时,仅需要设置videoSourceType;音视频录制时,audioSourceType和videoSourceType均需要设置。
AVRecorderProfile9+
音视频录制的配置文件。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
audioBitrate | number | 否 | 音频编码比特率,选择音频录制时必填。 |
audioChannels | number | 否 | 音频采集声道数,选择音频录制时必填。 |
audioCodec | 否 | 音频编码格式,选择音频录制时必填。当前仅支持AUDIO_AAC。 | |
audioSampleRate | number | 否 | 音频采样率,选择音频录制时必填。 |
fileFormat | 是 | 文件的容器格式,必要参数。 | |
videoBitrate | number | 否 | 视频编码比特率,选择视频录制时必填。 |
videoCodec | 否 | 视频编码格式,选择视频录制时必填。需要查询设备支持的编码能力(包括编码格式,分辨率大小等)。 | |
videoFrameWidth | number | 否 | 视频帧的宽,选择视频录制时必填。 |
videoFrameHeight | number | 否 | 视频帧的高,选择视频录制时必填。 |
videoFrameRate | number | 否 | 视频帧率,选择视频录制时必填。 |
AudioSourceType9+
表示视频录制中音频源类型的枚举。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
名称 | 值 | 说明 |
---|---|---|
AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 |
AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 |
VideoSourceType9+
表示视频录制中视频源类型的枚举。
系统能力: SystemCapability.Multimedia.Media.AVRecorder
名称 | 值 | 说明 |
---|---|---|
VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 |
VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。 |
ContainerFormatType8+
表示容器格式类型的枚举,缩写为CFT。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 值 | 说明 |
---|---|---|
CFT_MPEG_4 | 'mp4' | 视频的容器格式,MP4。 |
CFT_MPEG_4A | 'm4a' | 音频的容器格式,M4A。 |
Location
视频录制的地理位置。
系统能力: SystemCapability.Multimedia.Media.Core
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
latitude | number | 是 | 地理位置的纬度。 |
longitude | number | 是 | 地理位置的经度。 |
media.createAudioPlayer(deprecated)
createAudioPlayer(): AudioPlayer
同步方式创建音频播放实例。
从API version 6开始支持,从API version 9开始废弃,建议使用createAVPlayer替代。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
返回值:
类型 | 说明 |
---|---|
返回AudioPlayer类实例,失败时返回null。可用于音频播放、暂停、停止等操作。 |
示例:
- let audioPlayer = media.createAudioPlayer();
media.createVideoPlayer(deprecated)
createVideoPlayer(callback: AsyncCallback<VideoPlayer>): void
异步方式创建视频播放实例,通过注册回调函数获取返回值。
从API version 8开始支持,从API version 9开始废弃,建议使用createAVPlayer替代。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<VideoPlayer> | 是 | 回调函数。异步返回VideoPlayer实例,失败时返回null。可用于管理和播放视频媒体。 |
示例:
- let videoPlayer;
- media.createVideoPlayer((error, video) => {
- if (video != null) {
- videoPlayer = video;
- console.info('video createVideoPlayer success');
- } else {
- console.error(`video createVideoPlayer fail, error:${error}`);
- }
- });
media.createVideoPlayer(deprecated)
createVideoPlayer(): Promise<VideoPlayer>
异步方式创建视频播放实例,通过Promise获取返回值。
从API version 8开始支持,从API version 9开始废弃,建议使用createAVPlayer替代。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<VideoPlayer> | Promise对象。异步返回VideoPlayer实例,失败时返回null。可用于管理和播放视频媒体。 |
示例:
- let videoPlayer;
- media.createVideoPlayer().then((video) => {
- if (video != null) {
- videoPlayer = video;
- console.info('video createVideoPlayer success');
- } else {
- console.info('video createVideoPlayer fail');
- }
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
media.createAudioRecorder(deprecated)
createAudioRecorder(): AudioRecorder
创建音频录制的实例来控制音频的录制。
一台设备只允许创建一个录制实例。
从API version 8开始支持,从API version 9开始废弃,建议使用createAVRecorder替代。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
返回值:
类型 | 说明 |
---|---|
返回AudioRecorder类实例,失败时返回null。可用于录制音频媒体。 |
示例:
- let audioRecorder = media.createAudioRecorder();
MediaErrorCode(deprecated)
媒体服务错误类型枚举。
从API version 8开始支持,从API version 9开始废弃,建议使用媒体错误码替代。
系统能力: 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(deprecated)
从API version 6开始支持,从API version 9开始废弃,建议使用AVPlayer替代。
音频播放管理类,用于管理和播放音频媒体。在调用AudioPlayer的方法前,需要先通过createAudioPlayer()构建一个AudioPlayer实例。
属性
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
src | string | 是 | 是 | 音频媒体URI,支持当前主流的音频格式(m4a、aac、mp3、ogg、wav)。 支持路径示例: 1. fd类型播放:fd://xx 2. http网络播放: http://xx 3. https网络播放: https://xx 4. hls网络播放路径:http://xx或者https://xx 需要权限: ohos.permission.READ_MEDIA 或 ohos.permission.INTERNET。 |
fdSrc9+ | 是 | 是 | 音频媒体文件描述,使用场景:应用中的音频资源被连续存储在同一个文件中。 使用示例: 假设一个连续存储的音乐文件: 音乐1(地址偏移:0,字节长度:100) 音乐2(地址偏移:101,字节长度:50) 音乐3(地址偏移:151,字节长度:150) 1. 播放音乐1:AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; } 2. 播放音乐2:AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; } 3. 播放音乐3:AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; } 假设是一个独立的音乐文件: 请使用src=fd://xx | |
loop | boolean | 是 | 是 | 音频循环播放属性,设置为'true'表示循环播放。 |
audioInterruptMode9+ | 是 | 是 | 音频焦点模型。 | |
currentTime | number | 是 | 否 | 音频的当前播放位置,单位为毫秒(ms)。 |
duration | number | 是 | 否 | 音频时长,单位为毫秒(ms)。 |
state | 是 | 否 | 可以查询音频播放的状态,该状态不可作为调用play/pause/stop等状态切换的触发条件。 |
play
play(): void
开始播放音频资源,需在dataLoad事件成功触发后,才能调用。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
示例:
- audioPlayer.on('play', () => { //设置'play'事件回调
- console.log('audio play success');
- });
- audioPlayer.play();
pause
pause(): void
暂停播放音频资源。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
示例:
- audioPlayer.on('pause', () => { //设置'pause'事件回调
- console.log('audio pause success');
- });
- audioPlayer.pause();
stop
stop(): void
停止播放音频资源。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
示例:
- audioPlayer.on('stop', () => { //设置'stop'事件回调
- console.log('audio stop success');
- });
- audioPlayer.stop();
reset7+
reset(): void
重置播放音频资源。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
示例:
- audioPlayer.on('reset', () => { //设置'reset'事件回调
- console.log('audio reset success');
- });
- audioPlayer.reset();
seek
seek(timeMs: number): void
跳转到指定播放位置。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围[0, duration]。 |
示例:
- audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调
- if (seekDoneTime == null) {
- console.info('audio seek fail');
- return;
- }
- console.log('audio seek success. seekDoneTime: ' + seekDoneTime);
- });
- audioPlayer.seek(30000); //seek到30000ms的位置
setVolume
setVolume(vol: number): void
设置音量。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
vol | number | 是 | 指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。 |
示例:
- audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调
- console.log('audio volumeChange success');
- });
- audioPlayer.setVolume(1); //设置音量到100%
release
release(): void
释放音频资源。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
示例:
- audioPlayer.release();
- audioPlayer = undefined;
getTrackDescription8+
getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void
通过回调方式获取音频轨道信息。需在dataLoad事件成功触发后,才能调用。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<Array<MediaDescription>> | 是 | 音频轨道信息MediaDescription数组回调方法。 |
示例:
- function printfDescription(obj) {
- for (let item in obj) {
- let property = obj[item];
- console.info('audio key is ' + item);
- 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 {
- console.log(`audio getTrackDescription fail, error:${error}`);
- }
- });
getTrackDescription8+
getTrackDescription(): Promise<Array<MediaDescription>>
通过Promise方式获取音频轨道信息。需在dataLoad事件成功触发后,才能调用
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
返回值:
类型 | 说明 |
---|---|
Promise<Array<MediaDescription>> | 音频轨道信息MediaDescription数组Promise返回值。 |
示例:
- function printfDescription(obj) {
- for (let item in obj) {
- let property = obj[item];
- console.info('audio key is ' + item);
- console.info('audio value is ' + property);
- }
- }
- let arrayDescription = null
- audioPlayer.getTrackDescription().then((arrList) => {
- if (arrList != null) {
- arrayDescription = arrList;
- } else {
- console.log('audio getTrackDescription fail');
- }
- }).catch((error) => {
- console.info(`audio catchCallback, error:${error}`);
- });
- for (let i = 0; i < arrayDescription.length; i++) {
- printfDescription(arrayDescription[i]);
- }
on('bufferingUpdate')8+
on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void
开始订阅音频缓存更新事件。仅网络播放支持该订阅事件。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 音频缓存事件回调类型,支持的事件:'bufferingUpdate'。 |
callback | function | 是 | 音频缓存事件回调方法。 BufferingInfoType为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。 |
示例:
- audioPlayer.on('bufferingUpdate', (infoType, value) => {
- console.log('audio bufferingInfo type: ' + infoType);
- console.log('audio bufferingInfo value: ' + value);
- });
on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')
on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void
开始订阅音频播放事件。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 播放事件回调类型,支持的事件包括:'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange'。 - 'play':完成play()调用,音频开始播放,触发该事件。 - 'pause':完成pause()调用,音频暂停播放,触发该事件。 - 'stop':完成stop()调用,音频停止播放,触发该事件。 - 'reset':完成reset()调用,播放器重置,触发该事件。 - 'dataLoad':完成音频数据加载后触发该事件,即src属性设置完成后触发该事件。 - 'finish':完成音频播放后触发该事件。 - 'volumeChange':完成setVolume()调用,播放音量改变后触发该事件。 |
callback | () => void | 是 | 播放事件回调方法。 |
示例:
- import fs from '@ohos.file.fs';
- let audioPlayer = media.createAudioPlayer(); //创建一个音频播放实例
- audioPlayer.on('dataLoad', () => { //设置'dataLoad'事件回调,src属性设置成功后,触发此回调
- console.info('audio set source success');
- 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.error(`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';
- fs.open(path).then((file) => {
- fdPath = fdPath + '' + file.fd;
- console.info('open fd success fd is' + fdPath);
- audioPlayer.src = fdPath; //设置src属性,并触发'dataLoad'事件回调
- }, (err) => {
- console.info('open fd failed err is' + err);
- }).catch((err) => {
- console.info('open fd failed err is' + err);
- });
on('timeUpdate')
on(type: 'timeUpdate', callback: Callback<number>): void
开始订阅音频播放时间更新事件。处于播放状态时,每隔1s上报一次该事件。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 播放事件回调类型,支持的事件包括:'timeUpdate'。 - 'timeUpdate':音频播放时间戳更新,开始播放后自动触发该事件。 |
callback | Callback<number> | 是 | 播放事件回调方法。回调方法入参为更新后的时间戳。 |
示例:
- 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事件,退出播放操作。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 播放错误事件回调类型,支持的事件包括:'error'。 - 'error':音频播放中发生错误,触发该事件。 |
callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
示例:
- audioPlayer.on('error', (error) => { //设置'error'事件回调
- console.error(`audio error called, error: ${error}`);
- });
- audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
AudioState(deprecated)
音频播放的状态机。可通过state属性获取当前状态。
从API version 6开始支持,从API version 9开始废弃,建议使用AVPlayerState替代。
系统能力: SystemCapability.Multimedia.Media.AudioPlayer
名称 | 类型 | 说明 |
---|---|---|
idle | string | 音频播放空闲,dataload/reset成功后处于此状态。 |
playing | string | 音频正在播放,play成功后处于此状态。 |
paused | string | 音频暂停播放,pause成功后处于此状态。 |
stopped | string | 音频播放停止,stop/播放结束后处于此状态。 |
error | string | 错误状态。 |
VideoPlayer(deprecated)
从API version 8开始支持,从API version 9开始废弃,建议使用AVPlayer替代。
视频播放管理类,用于管理和播放视频媒体。在调用VideoPlayer的方法前,需要先通过createVideoPlayer()构建一个VideoPlayer实例。
属性
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
url8+ | string | 是 | 是 | 视频媒体URL,支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。 支持路径示例: 1. fd类型播放:fd://xx 2. http网络播放: http://xx 3. https网络播放: https://xx 4. hls网络播放路径:http://xx或者https://xx |
fdSrc9+ | 是 | 是 | 视频媒体文件描述,使用场景:应用中的视频资源被连续存储在同一个文件中。 使用示例: 假设一个连续存储的音乐文件: 视频1(地址偏移:0,字节长度:100) 视频2(地址偏移:101,字节长度:50) 视频3(地址偏移:151,字节长度:150) 1. 播放视频1:AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; } 2. 播放视频2:AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; } 3. 播放视频3:AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; } 假设是一个独立的视频文件: 请使用src=fd://xx | |
loop8+ | boolean | 是 | 是 | 视频循环播放属性,设置为'true'表示循环播放。 |
videoScaleType9+ | 是 | 是 | 视频缩放模式。 | |
audioInterruptMode9+ | 是 | 是 | 音频焦点模型。 | |
currentTime8+ | number | 是 | 否 | 视频的当前播放位置,单位为毫秒(ms)。 |
duration8+ | number | 是 | 否 | 视频时长,单位为毫秒(ms),返回-1表示直播模式。 |
state8+ | 是 | 否 | 视频播放的状态。 | |
width8+ | number | 是 | 否 | 视频宽,单位为像素(px)。 |
height8+ | number | 是 | 否 | 视频高,单位为像素(px)。 |
setDisplaySurface8+
setDisplaySurface(surfaceId: string, callback: AsyncCallback<void>): void
通过回调方式设置SurfaceId。
*注意:SetDisplaySurface需要在设置url和Prepare之间,无音频的视频流必须设置Surface否则Prepare失败。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
surfaceId | string | 是 | SurfaceId |
callback | AsyncCallback<void> | 是 | 设置SurfaceId的回调方法。 |
示例:
- let surfaceId = null;
- videoPlayer.setDisplaySurface(surfaceId, (err) => {
- if (err == null) {
- console.info('setDisplaySurface success!');
- } else {
- console.error('setDisplaySurface fail!');
- }
- });
setDisplaySurface8+
setDisplaySurface(surfaceId: string): Promise<void>
通过Promise方式设置SurfaceId。
*注意:SetDisplaySurface需要在设置url和Prepare之间,无音频的视频流必须设置Surface否则Prepare失败。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
surfaceId | string | 是 | SurfaceId |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 设置SurfaceId的Promise返回值。 |
示例:
- let surfaceId = null;
- videoPlayer.setDisplaySurface(surfaceId).then(() => {
- console.info('setDisplaySurface success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
prepare8+
prepare(callback: AsyncCallback<void>): void
通过回调方式准备播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 准备播放视频的回调方法。 |
示例:
- videoPlayer.prepare((err) => {
- if (err == null) {
- console.info('prepare success!');
- } else {
- console.error('prepare fail!');
- }
- });
prepare8+
prepare(): Promise<void>
通过Promise方式准备播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 准备播放视频的Promise返回值。 |
示例:
- videoPlayer.prepare().then(() => {
- console.info('prepare success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
play8+
play(callback: AsyncCallback<void>): void;
通过回调方式开始播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 开始播放视频的回调方法。 |
示例:
- videoPlayer.play((err) => {
- if (err == null) {
- console.info('play success!');
- } else {
- console.error('play fail!');
- }
- });
play8+
play(): Promise<void>;
通过Promise方式开始播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 开始播放视频的Promise返回值。 |
示例:
- videoPlayer.play().then(() => {
- console.info('play success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
pause8+
pause(callback: AsyncCallback<void>): void
通过回调方式暂停播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 暂停播放视频的回调方法。 |
示例:
- videoPlayer.pause((err) => {
- if (err == null) {
- console.info('pause success!');
- } else {
- console.info('pause fail!');
- }
- });
pause8+
pause(): Promise<void>
通过Promise方式暂停播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 暂停播放视频的Promise返回值。 |
示例:
- videoPlayer.pause().then(() => {
- console.info('pause success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
stop8+
stop(callback: AsyncCallback<void>): void
通过回调方式停止播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 停止播放视频的回调方法。 |
示例:
- videoPlayer.stop((err) => {
- if (err == null) {
- console.info('stop success!');
- } else {
- console.error('stop fail!');
- }
- });
stop8+
stop(): Promise<void>
通过Promise方式停止播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 停止播放视频的Promise返回值。 |
示例:
- videoPlayer.stop().then(() => {
- console.info('stop success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
reset8+
reset(callback: AsyncCallback<void>): void
通过回调方式重置播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 切换播放视频的回调方法。 |
示例:
- videoPlayer.reset((err) => {
- if (err == null) {
- console.info('reset success!');
- } else {
- console.error('reset fail!');
- }
- });
reset8+
reset(): Promise<void>
通过Promise方式重置播放视频。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 切换播放视频的Promise返回值。 |
示例:
- videoPlayer.reset().then(() => {
- console.info('reset success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
seek8+
seek(timeMs: number, callback: AsyncCallback<number>): void
通过回调方式跳转到指定播放位置,默认跳转到指定时间点的上一个关键帧。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 |
callback | AsyncCallback<number> | 是 | 跳转到指定播放位置的回调方法。 |
示例:
- let seekTime = 5000;
- videoPlayer.seek(seekTime, (err, result) => {
- if (err == null) {
- console.info('seek success!');
- } else {
- console.error('seek fail!');
- }
- });
seek8+
seek(timeMs: number, mode:SeekMode, callback: AsyncCallback<number>): void
通过回调方式跳转到指定播放位置。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 |
mode | 是 | 跳转模式。 | |
callback | AsyncCallback<number> | 是 | 跳转到指定播放位置的回调方法。 |
示例:
- 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.error('seek fail!');
- }
- });
seek8+
seek(timeMs: number, mode?:SeekMode): Promise<number>
通过Promise方式跳转到指定播放位置,如果没有设置mode则跳转到指定时间点的上一个关键帧。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 |
mode | 否 | 基于视频I帧的跳转模式,默认为SEEK_PREV_SYNC模式。 |
返回值:
类型 | 说明 |
---|---|
Promise<number> | 跳转到指定播放位置的Promise返回值,单位ms。 |
示例:
- import media from '@ohos.multimedia.media'
- let seekTime = 5000;
- videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime表示seek完成后的时间点
- console.info('seek success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
- videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC).then((seekDoneTime) => {
- console.info('seek success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
setVolume8+
setVolume(vol: number, callback: AsyncCallback<void>): void
通过回调方式设置音量。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
vol | number | 是 | 指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。 |
callback | AsyncCallback<void> | 是 | 设置音量的回调方法。 |
示例:
- let vol = 0.5;
- videoPlayer.setVolume(vol, (err, result) => {
- if (err == null) {
- console.info('setVolume success!');
- } else {
- console.error('setVolume fail!');
- }
- });
setVolume8+
setVolume(vol: number): Promise<void>
通过Promise方式设置音量。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
vol | number | 是 | 指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 设置音量的Promise返回值。 |
示例:
- let vol = 0.5;
- videoPlayer.setVolume(vol).then(() => {
- console.info('setVolume success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
release8+
release(callback: AsyncCallback<void>): void
通过回调方式释放视频资源。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 释放视频资源的回调方法。 |
示例:
- videoPlayer.release((err) => {
- if (err == null) {
- console.info('release success!');
- } else {
- console.error('release fail!');
- }
- });
release8+
release(): Promise<void>
通过Promise方式释放视频资源。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<void> | 释放视频资源的Promise返回值。 |
示例:
- videoPlayer.release().then(() => {
- console.info('release success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
getTrackDescription8+
getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void
通过回调方式获取视频轨道信息。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<Array<MediaDescription>> | 是 | 视频轨道信息MediaDescription数组回调方法。 |
示例:
- function printfDescription(obj) {
- for (let item in obj) {
- let property = obj[item];
- 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 {
- console.log(`video getTrackDescription fail, error:${error}`);
- }
- });
getTrackDescription8+
getTrackDescription(): Promise<Array<MediaDescription>>
通过Promise方式获取视频轨道信息。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
返回值:
类型 | 说明 |
---|---|
Promise<Array<MediaDescription>> | 视频轨道信息MediaDescription数组Promise返回值。 |
示例:
- function printfDescription(obj) {
- 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]);
- }
setSpeed8+
setSpeed(speed:number, callback: AsyncCallback<number>): void
通过回调方式设置播放速度。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
speed | number | 是 | 指定播放视频速度,具体见PlaybackSpeed。 |
callback | AsyncCallback<number> | 是 | 设置播放速度的回调方法。 |
示例:
- import media from '@ohos.multimedia.media'
- let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
- videoPlayer.setSpeed(speed, (err, result) => {
- if (err == null) {
- console.info('setSpeed success!');
- } else {
- console.error('setSpeed fail!');
- }
- });
setSpeed8+
setSpeed(speed:number): Promise<number>
通过Promise方式设置播放速度。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
speed | number | 是 | 指定播放视频速度,具体见PlaybackSpeed。 |
返回值:
类型 | 说明 |
---|---|
Promise<number> | 播放速度Promise返回值,具体见PlaybackSpeed。 |
示例:
- import media from '@ohos.multimedia.media'
- let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
- videoPlayer.setSpeed(speed).then(() => {
- console.info('setSpeed success');
- }).catch((error) => {
- console.error(`video catchCallback, error:${error}`);
- });
on('playbackCompleted')8+
on(type: 'playbackCompleted', callback: Callback<void>): void
开始监听视频播放完成事件。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放完成事件回调类型,支持的事件:'playbackCompleted'。 |
callback | function | 是 | 视频播放完成事件回调方法。 |
示例:
- videoPlayer.on('playbackCompleted', () => {
- console.info('playbackCompleted success!');
- });
on('bufferingUpdate')8+
on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void
开始监听视频缓存更新事件。仅网络播放支持该订阅事件。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频缓存事件回调类型,支持的事件:'bufferingUpdate'。 |
callback | function | 是 | 视频缓存事件回调方法。 BufferingInfoType为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。 |
示例:
- videoPlayer.on('bufferingUpdate', (infoType, value) => {
- console.log('video bufferingInfo type: ' + infoType);
- console.log('video bufferingInfo value: ' + value);
- });
on('startRenderFrame')8+
on(type: 'startRenderFrame', callback: Callback<void>): void
开始监听视频播放首帧送显上报事件。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放首帧送显上报事件回调类型,支持的事件:'startRenderFrame'。 |
callback | Callback<void> | 是 | 视频播放首帧送显上报事件回调方法。 |
示例:
- videoPlayer.on('startRenderFrame', () => {
- console.info('startRenderFrame success!');
- });
on('videoSizeChanged')8+
on(type: 'videoSizeChanged', callback: (width: number, height: number) => void): void
开始监听视频播放宽高变化事件。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 视频播放宽高变化事件回调类型,支持的事件:'videoSizeChanged'。 |
callback | function | 是 | 视频播放宽高变化事件回调方法,width表示宽,height表示高。 |
示例:
- videoPlayer.on('videoSizeChanged', (width, height) => {
- console.log('video width is: ' + width);
- console.log('video height is: ' + height);
- });
on('error')8+
on(type: 'error', callback: ErrorCallback): void
开始监听视频播放错误事件,当上报error错误事件后,用户需处理error事件,退出播放操作。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 播放错误事件回调类型,支持的事件包括:'error'。 - 'error':视频播放中发生错误,触发该事件。 |
callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
示例:
- videoPlayer.on('error', (error) => { // 设置'error'事件回调
- console.error(`video error called, error: ${error}`);
- });
- videoPlayer.url = 'fd://error'; //设置错误的播放地址,触发'error'事件
VideoPlayState(deprecated)
视频播放的状态机,可通过state属性获取当前状态。
从API version 8开始支持,从API version 9开始废弃,建议使用AVPlayerState替代。
系统能力: SystemCapability.Multimedia.Media.VideoPlayer
名称 | 类型 | 说明 |
---|---|---|
idle | string | 视频播放空闲。 |
prepared | string | 视频播放准备。 |
playing | string | 视频正在播放。 |
paused | string | 视频暂停播放。 |
stopped | string | 视频播放停止。 |
error | string | 错误状态。 |
AudioRecorder(deprecated)
从API version 6开始支持,从API version 9开始废弃,建议使用AVRecorder替代。
音频录制管理类,用于录制音频媒体。在调用AudioRecorder的方法前,需要先通过createAudioRecorder() 构建一个AudioRecorder实例。
prepare
prepare(config: AudioRecorderConfig): void
录音准备。
需要权限: ohos.permission.MICROPHONE
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
config | 是 | 配置录音的相关参数,包括音频输出URI、编码格式、采样率、声道数、输出格式等。 |
示例:
- let audioRecorderConfig = {
- audioEncoder : media.AudioEncoder.AAC_LC,
- audioEncodeBitRate : 22050,
- audioSampleRate : 22050,
- 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);
start
start(): void
开始录制,需在prepare事件成功触发后,才能调用start方法。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
示例:
- audioRecorder.on('start', () => { //设置'start'事件回调
- console.log('audio recorder start success');
- });
- audioRecorder.start();
pause
pause():void
暂停录制,需要在start事件成功触发后,才能调用pause方法。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
示例:
- audioRecorder.on('pause', () => { //设置'pause'事件回调
- console.log('audio recorder pause success');
- });
- audioRecorder.pause();
resume
resume():void
恢复录制,需要在pause事件成功触发后,才能调用resume方法。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
示例:
- audioRecorder.on('resume', () => { //设置'resume'事件回调
- console.log('audio recorder resume success');
- });
- audioRecorder.resume();
stop
stop(): void
停止录音。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
示例:
- audioRecorder.on('stop', () => { //设置'stop'事件回调
- console.log('audio recorder stop success');
- });
- audioRecorder.stop();
release
release(): void
释放录音资源。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
示例:
- audioRecorder.on('release', () => { //设置'release'事件回调
- console.log('audio recorder release success');
- });
- audioRecorder.release();
- audioRecorder = undefined;
reset
reset(): void
重置录音。
进行重置录音之前,需要先调用stop()停止录音。重置录音之后,需要调用prepare()设置录音参数项,才能再次进行录音。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
示例:
- audioRecorder.on('reset', () => { //设置'reset'事件回调
- console.log('audio recorder reset success');
- });
- audioRecorder.reset();
on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset')
on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset', callback: () => void): void
开始订阅音频录制事件。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 录制事件回调类型,支持的事件包括:'prepare' | 'start' | 'pause' | ’resume‘ | 'stop' | 'release' | 'reset'。 - 'prepare' :完成prepare调用,音频录制参数设置完成,触发该事件。 - 'start' :完成start调用,音频录制开始,触发该事件。 - 'pause': 完成pause调用,音频暂停录制,触发该事件。 - 'resume': 完成resume调用,音频恢复录制,触发该事件。 - 'stop' :完成stop调用,音频停止录制,触发该事件。 - 'release' :完成release调用,音频释放录制资源,触发该事件。 - 'reset':完成reset调用,音频重置为初始状态,触发该事件。 |
callback | ()=>void | 是 | 录制事件回调方法。 |
示例:
- let audioRecorder = media.createAudioRecorder(); // 创建一个音频录制实例
- let audioRecorderConfig = {
- 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}`);
- });
- 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')
on(type: 'error', callback: ErrorCallback): void
开始订阅音频录制错误事件,当上报error错误事件后,用户需处理error事件,退出录制操作。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 录制错误事件回调类型'error'。 - 'error':音频录制过程中发生错误,触发该事件。 |
callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
示例:
- let audioRecorderConfig = {
- 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.error(`audio error called, error: ${error}`);
- });
- audioRecorder.prepare(audioRecorderConfig); // prepare不设置参数,触发'error'事件
AudioRecorderConfig(deprecated)
从API version 6开始支持,从API version 9开始废弃,建议使用AVRecorderConfig替代。
表示音频的录音配置。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
audioEncoder | 否 | 音频编码格式,默认设置为AAC_LC。 说明: 从API version 8开始废弃,建议使用audioEncoderMime替代。 | |
audioEncodeBitRate | number | 否 | 音频编码比特率,默认值为48000。 |
audioSampleRate | number | 否 | 音频采集采样率,默认值为48000。 |
numberOfChannels | number | 否 | 音频采集声道数,默认值为2。 |
format | 否 | 音频输出封装格式,默认设置为MPEG_4。 说明: 从API version 8开始废弃,建议使用fileFormat替代。 | |
location | 否 | 音频采集的地理位置。 | |
uri | string | 是 | 音频输出URI:fd://xx (fd number) 文件需要由调用者创建,并赋予适当的权限。 |
audioEncoderMime8+ | 否 | 音频编码格式。 | |
fileFormat8+ | 否 | 音频编码格式。 |
AudioEncoder(deprecated)
从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType替代。
表示音频编码格式的枚举。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
名称 | 值 | 说明 |
---|---|---|
DEFAULT | 0 | 默认编码格式。 仅做接口定义,暂不支持使用。 |
AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。 仅做接口定义,暂不支持使用。 |
AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。 仅做接口定义,暂不支持使用。 |
AAC_LC | 3 | AAC-LC(Advanced Audio Coding Low Complexity)编码格式。 |
HE_AAC | 4 | HE_AAC(High-Efficiency Advanced Audio Coding)编码格式。 仅做接口定义,暂不支持使用。 |
AudioOutputFormat(deprecated)
从API version 6开始支持,从API version 8 开始废弃,建议使用ContainerFormatType替代。
表示音频封装格式的枚举。
系统能力: SystemCapability.Multimedia.Media.AudioRecorder
名称 | 值 | 说明 |
---|---|---|
DEFAULT | 0 | 默认封装格式。 仅做接口定义,暂不支持使用。 |
MPEG_4 | 2 | 封装为MPEG-4格式。 |
AMR_NB | 3 | 封装为AMR_NB格式。 仅做接口定义,暂不支持使用。 |
AMR_WB | 4 | 封装为AMR_WB格式。 仅做接口定义,暂不支持使用。 |
AAC_ADTS | 6 |
更多建议: