@ohos.multimedia.media (媒体服务)

说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

媒体子系统为开发者提供一套简单且易于理解的接口，使得开发者能够方便接入系统并使用系统的媒体资源。

媒体子系统包含了音视频相关媒体业务，提供以下常用功能：

• 音视频播放（AVPlayer⁹⁺）

  由AudioPlayer⁶⁺和VideoPlayer⁸⁺整合，升级了状态机和错误码，推荐使用。

• 音视频录制（AVRecorder⁹⁺）

  由AudioRecorder⁶⁺和VideoRecorder⁹⁺整合，推荐使用。

导入模块

import media from '@ohos.multimedia.media';

media.createAVPlayer⁹⁺

createAVPlayer(callback: AsyncCallback<AVPlayer>): void

异步方式创建音视频播放实例，通过注册回调函数获取返回值。

说明：

• 可创建的视频播放实例不能超过13个。
• 可创建的音视频播放实例（即音频、视频、音视频三类相加）不能超过16个。
• 可创建的音视频播放实例数量依赖于设备芯片的支持情况，如芯片支持创建的数量少于上述情况，请以芯片规格为准。如RK3568仅支持创建6个以内的视频播放实例。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

import { BusinessError } from '@ohos.base';

let avPlayer: media.AVPlayer;
media.createAVPlayer((error: BusinessError, video: media.AVPlayer) => {
  if (video != null) {
    avPlayer = video;
    console.info('createAVPlayer success');
  } else {
    console.error(`createAVPlayer fail, error message:${error.message}`);
  }
});

media.createAVPlayer⁹⁺

createAVPlayer(): Promise<AVPlayer>

异步方式创建音视频播放实例，通过Promise获取返回值。

说明：

• 可创建的视频播放实例不能超过13个。
• 可创建的音视频播放实例（即音频、视频、音视频三类相加）不能超过16个。
• 可创建的音视频播放实例数量依赖于设备芯片的支持情况，如芯片支持创建的数量少于上述情况，请以芯片规格为准。如RK3568仅支持创建6个以内的视频播放实例。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let avPlayer: media.AVPlayer;
media.createAVPlayer().then((video: media.AVPlayer) => {
  if (video != null) {
    avPlayer = video;
    console.info('createAVPlayer success');
  } else {
    console.error('createAVPlayer fail');
  }
}).catch((error: BusinessError) => {
  console.error(`AVPlayer catchCallback, error message:${error.message}`);
});

media.createAVRecorder⁹⁺

createAVRecorder(callback: AsyncCallback<AVRecorder>): void

异步方式创建音视频录制实例。通过注册回调函数获取返回值。

说明：

• 可创建的音视频录制实例不能超过2个。
• 由于设备共用音频通路，一个设备仅能有一个实例进行音频录制。创建第二个实例录制音频时，将会因为音频通路冲突导致创建失败。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let avRecorder: media.AVRecorder;

media.createAVRecorder((error: BusinessError, recorder: media.AVRecorder) => {
  if (recorder != null) {
    avRecorder = recorder;
    console.info('createAVRecorder success');
  } else {
    console.error(`createAVRecorder fail, error message:${error.message}`);
  }
});

media.createAVRecorder⁹⁺

createAVRecorder(): Promise<AVRecorder>

异步方式创建音视频录制实例。通过Promise获取返回值。

说明：

• 可创建的音视频录制实例不能超过2个。
• 由于设备共用音频通路，一个设备仅能有一个实例进行音频录制。创建第二个实例录制音频时，将会因为音频通路冲突导致创建失败。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let avRecorder: media.AVRecorder;

media.createAVRecorder().then((recorder: media.AVRecorder) => {
  if (recorder != null) {
    avRecorder = recorder;
    console.info('createAVRecorder success');
  } else {
    console.error('createAVRecorder fail');
  }
}).catch((error: BusinessError) => {
  console.error(`createAVRecorder catchCallback, error message:${error.message}`);
});

media.createVideoRecorder⁹⁺

createVideoRecorder(callback: AsyncCallback<VideoRecorder>): void

异步方式创建视频录制实例。通过注册回调函数获取返回值。 一台设备只允许创建一个录制实例。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let videoRecorder: media.VideoRecorder;

media.createVideoRecorder((error: BusinessError, video: media.VideoRecorder) => {
  if (video != null) {
    videoRecorder = video;
    console.info('video createVideoRecorder success');
  } else {
    console.error(`video createVideoRecorder fail, error message:${error.message}`);
  }
});

media.createVideoRecorder⁹⁺

createVideoRecorder(): Promise<VideoRecorder>

异步方式创建视频录制实例。通过Promise获取返回值。 一台设备只允许创建一个录制实例。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let videoRecorder: media.VideoRecorder;

media.createVideoRecorder().then((video: media.VideoRecorder) => {
  if (video != null) {
    videoRecorder = video;
    console.info('video createVideoRecorder success');
  } else {
    console.error('video createVideoRecorder fail');
  }
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error message:${error.message}`);
});

media.createSoundPool¹⁰⁺

createSoundPool(maxStreams: number, audioRenderInfo: audio.AudioRendererInfo, callback: AsyncCallback<SoundPool>): void

创建音频池实例，使用callback方式异步获取返回值。

系统能力： SystemCapability.Multimedia.Media.SoundPool

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

import audio from '@ohos.multimedia.audio'

let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

media.createSoundPool(5, audioRendererInfo, (error, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
  }
});

media.createSoundPool¹⁰⁺

createSoundPool(maxStreams: number, audioRenderInfo: audio.AudioRendererInfo): Promise<SoundPool>

创建音频池实例，使用Promise方式异步获取返回值。

系统能力： SystemCapability.Multimedia.Media.SoundPool

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

import audio from '@ohos.multimedia.audio'

let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

media.createSoundPool(5, audioRendererInfo).then((soundpool_: media.SoundPool) => {
  if (soundpool_ != null) {
    soundPool = soundpool_;
    console.info('create SoundPool success');
  } else {
    console.error('create SoundPool fail');
  }
}, (error: BusinessError) => {
  console.error(`soundpool catchCallback, error message:${error.message}`);
});

AVErrorCode⁹⁺

媒体错误码类型枚举

系统能力： SystemCapability.Multimedia.Media.Core

MediaType⁸⁺

媒体类型枚举。

系统能力： SystemCapability.Multimedia.Media.Core

CodecMimeType⁸⁺

Codec MIME类型枚举。

系统能力： SystemCapability.Multimedia.Media.Core

MediaDescriptionKey⁸⁺

媒体信息描述枚举。

系统能力： SystemCapability.Multimedia.Media.Core

BufferingInfoType⁸⁺

缓存事件类型枚举。

系统能力： SystemCapability.Multimedia.Media.Core

StateChangeReason⁹⁺

表示播放或录制实例状态机切换原因的枚举，伴随state一起上报。

系统能力： SystemCapability.Multimedia.Media.Core

AVPlayer⁹⁺

播放管理类，用于管理和播放媒体资源。在调用AVPlayer的方法前，需要先通过createAVPlayer()构建一个AVPlayer实例。

Audio/Video播放demo可参考：音频播放开发指导、视频播放开发指导。

属性

系统能力： SystemCapability.Multimedia.Media.AVPlayer

名称	类型	可读	可写	说明
url9+	string	是	是	媒体URL，只允许在idle状态下设置，静态属性。 支持的视频格式(mp4、mpeg-ts、webm、mkv)。 支持的音频格式(m4a、aac、mp3、ogg、wav、flac)。 支持路径示例： 1. fd类型播放：fd://xx。 2. http网络播放: http://xx。 3. https网络播放: https://xx。 4. hls网络播放路径：http://xx或者https://xx。
fdSrc9+	AVFileDescriptor	是	是	媒体文件描述，只允许在idle状态下设置，静态属性。 使用场景：应用中的媒体资源被连续存储在同一个文件中。 支持的视频格式(mp4、mpeg-ts、webm、mkv)。 支持的音频格式(m4a、aac、mp3、ogg、wav、flac)。 使用示例： 假设一个连续存储的媒体文件: 视频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。
dataSrc10+	AVDataSrcDescriptor	是	是	流式媒体资源描述，只允许在idle状态下设置，静态属性。 使用场景：应用播放从远端下载到本地的文件，在应用未下载完整音视频资源时，提前播放已获取的资源文件。 支持的视频格式(mp4、mpeg-ts、webm、mkv)。 支持的音频格式(m4a、aac、mp3、ogg、wav、flac)。 使用示例： 假设用户正在从远端服务器获取音视频媒体文件，希望下载到本地的同时播放已经下载好的部分: 1.用户需要获取媒体文件的总大小size（单位为字节），获取不到时设置为-1。 2.用户需要实现回调函数func用于填写数据，如果size = -1，则func形式为：func(buffer: ArrayBuffer, length: number)，此时播放器只会按照顺序获取数据；否则func形式为：func(buffer: ArrayBuffer, length: number, pos: number)，播放器会按需跳转并获取数据。 3.用户设置AVDataSrcDescriptor {fileSize = size, callback = func}。 注意事项： 如果播放的是mp4/m4a格式用户需要保证moov字段（媒体信息字段）在mdat字段（媒体数据字段）之前，或者moov之前的字段小于10M，否则会导致解析失败无法播放。
surfaceId9+	string	是	是	视频窗口ID，默认无窗口，只允许在initialized状态下设置，静态属性。 使用场景：视频播放的窗口渲染，纯音频播放不用设置。 使用示例： 通过Xcomponent创建surfaceId。
loop9+	boolean	是	是	视频循环播放属性，默认'false'，设置为'true'表示循环播放，动态属性。 只允许在prepared/playing/paused/completed状态下设置。 直播场景不支持loop设置。
videoScaleType9+	VideoScaleType	是	是	视频缩放模式，默认VIDEO_SCALE_TYPE_FIT，动态属性。 只允许在prepared/playing/paused/completed状态下设置。
audioInterruptMode9+	audio.InterruptMode	是	是	音频焦点模型，默认SHARE_MODE，动态属性。 只允许在prepared/playing/paused/completed状态下设置。
audioRendererInfo10+	audio.AudioRendererInfo	是	是	设置音频渲染信息，默认值usage为STREAM_USAGE_MUSIC，rendererFlags为0。 只允许在initialized状态下设置
audioEffectMode10+	audio.AudioEffectMode	是	是	设置音频音效模式，默认值为EFFECT_DEFAULT，动态属性。audioRendererInfo的usage变动时会恢复为默认值，只允许在prepared/playing/paused/completed状态下设置。
state9+	AVPlayerState	是	否	音视频播放的状态，全状态有效，可查询参数。
currentTime9+	number	是	否	视频的当前播放位置，单位为毫秒（ms），可查询参数。 返回为(-1)表示无效值，prepared/playing/paused/completed状态下有效。 直播场景默认返回(-1)。
duration9+	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')⁹⁺

on(type: 'stateChange', callback: (state: AVPlayerState, reason: StateChangeReason) => void): void

监听播放状态机AVPlayerState切换的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('stateChange', async (state: string, reason: media.StateChangeReason) => {
  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('unknown state :' + state);
      break;
  }
})

off('stateChange')⁹⁺

off(type: 'stateChange'): void

取消监听播放状态机AVPlayerState切换的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('stateChange')

on('error')⁹⁺

on(type: 'error', callback: ErrorCallback): void

监听AVPlayer的错误事件，该事件仅用于错误提示，不需要用户停止播控动作。如果此时AVPlayerState也切至error状态，用户需要通过reset()或者release()退出播放操作。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.on('error', (error: BusinessError) => {
  console.info('error happened,and error message is :' + error.message)
  console.info('error happened,and error code is :' + error.code)
})

off('error')⁹⁺

off(type: 'error'): void

取消监听播放的错误事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('error')

prepare⁹⁺

prepare(callback: AsyncCallback<void>): void

通过回调方式准备播放音频/视频，需在stateChange事件成功触发至initialized状态后，才能调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avPlayer.prepare((err: BusinessError) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare filed,error message is :' + err.message)
  }
})

prepare⁹⁺

prepare(): Promise<void>

通过Promise方式准备播放音频/视频，需在stateChange事件成功触发至initialized状态后，才能调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avPlayer.prepare().then(() => {
  console.info('prepare success');
}, (err: BusinessError) => {
  console.error('prepare filed,error message is :' + err.message)
})

play⁹⁺

play(callback: AsyncCallback<void>): void

通过回调方式开始播放音视频资源，只能在prepared/paused/completed状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avPlayer.play((err: BusinessError) => {
  if (err == null) {
    console.info('play success');
  } else {
    console.error('play filed,error message is :' + err.message)
  }
})

play⁹⁺

play(): Promise<void>

通过Promise方式开始播放音视频资源，只能在prepared/paused/completed状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.play().then(() => {
  console.info('play success');
}, (err: BusinessError) => {
  console.error('play filed,error message is :' + err.message)
})

pause⁹⁺

pause(callback: AsyncCallback<void>): void

通过回调方式暂停播放音视频资源，只能在playing状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.pause((err: BusinessError) => {
  if (err == null) {
    console.info('pause success');
  } else {
    console.error('pause filed,error message is :' + err.message)
  }
})

pause⁹⁺

pause(): Promise<void>

通过Promise方式暂停播放音视频资源，只能在playing状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.pause().then(() => {
  console.info('pause success');
}, (err: BusinessError) => {
  console.error('pause filed,error message is :' + err.message)
})

stop⁹⁺

stop(callback: AsyncCallback<void>): void

通过回调方式停止播放音视频资源，只能在prepared/playing/paused/completed状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.stop((err: BusinessError) => {
  if (err == null) {
    console.info('stop success');
  } else {
    console.error('stop filed,error message is :' + err.message)
  }
})

stop⁹⁺

stop(): Promise<void>

通过Promise方式停止播放音视频资源，只能在prepared/playing/paused/completed状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.stop().then(() => {
  console.info('stop success');
}, (err: BusinessError) => {
  console.error('stop filed,error message is :' + err.message)
})

reset⁹⁺

reset(callback: AsyncCallback<void>): void

通过回调方式重置播放，只能在initialized/prepared/playing/paused/completed/stopped/error状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.reset((err: BusinessError) => {
  if (err == null) {
    console.info('reset success');
  } else {
    console.error('reset filed,error message is :' + err.message)
  }
})

reset⁹⁺

reset(): Promise<void>

通过Promise方式重置播放，只能在initialized/prepared/playing/paused/completed/stopped/error状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.reset().then(() => {
  console.info('reset success');
}, (err: BusinessError) => {
  console.error('reset filed,error message is :' + err.message)
})

release⁹⁺

release(callback: AsyncCallback<void>): void

通过回调方式销毁播放资源，除released状态，都可以调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.release((err: BusinessError) => {
  if (err == null) {
    console.info('release success');
  } else {
    console.error('release filed,error message is :' + err.message)
  }
})

release⁹⁺

release(): Promise<void>

通过Promise方式销毁播放，除released状态，都可以调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.release().then(() => {
  console.info('release success');
}, (err: BusinessError) => {
  console.error('release filed,error message is :' + err.message)
})

getTrackDescription⁹⁺

getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void

通过回调方式获取音视频轨道信息，可以在prepared/playing/paused状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if ((arrList) != null) {
    console.info('getTrackDescription success');
  } else {
    console.error(`video getTrackDescription fail, error:${error}`);
  }
});

getTrackDescription⁹⁺

getTrackDescription(): Promise<Array<MediaDescription>>

通过Promise方式获取音视频轨道信息，可以在prepared/playing/paused状态调用。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

avPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  console.info('getTrackDescription success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

seek⁹⁺

seek(timeMs: number, mode?:SeekMode): void

跳转到指定播放位置，只能在prepared/playing/paused/completed状态调用，可以通过seekDone事件确认是否生效。 注：直播场景不支持seek。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

let seekTime: number = 1000
avPlayer.seek(seekTime, media.SeekMode.SEEK_PREV_SYNC)

on('seekDone')⁹⁺

on(type: 'seekDone', callback: Callback<number>): void

监听seek生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('seekDone', (seekDoneTime:number) => {
  console.info('seekDone success,and seek time is:' + seekDoneTime)
})

off('seekDone')⁹⁺

off(type: 'seekDone'): void

取消监听seek生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('seekDone')

setSpeed⁹⁺

setSpeed(speed: PlaybackSpeed): void

设置倍速模式，只能在prepared/playing/paused/completed状态调用，可以通过speedDone事件确认是否生效。 注：直播场景不支持setSpeed。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.setSpeed(media.PlaybackSpeed.SPEED_FORWARD_2_00_X)

on('speedDone')⁹⁺

on(type: 'speedDone', callback: Callback<number>): void

监听setSpeed生效的事件

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('speedDone', (speed:number) => {
  console.info('speedDone success,and speed value is:' + speed)
})

off('speedDone')⁹⁺

off(type: 'speedDone'): void

取消监听setSpeed生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('speedDone')

setBitrate⁹⁺

setBitrate(bitrate: number): void

选择要播放的指定比特率，仅对HLS协议网络流有效，只能在prepared/playing/paused/completed状态调用，可以通过bitrateDone事件确认是否生效。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

let bitrate: number = 96000
avPlayer.setBitrate(bitrate)

on('bitrateDone')⁹⁺

on(type: 'bitrateDone', callback: Callback<number>): void

监听setBitrate生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('bitrateDone', (bitrate:number) => {
  console.info('bitrateDone success,and bitrate value is:' + bitrate)
})

off('bitrateDone')⁹⁺

off(type: 'bitrateDone'): void

取消监听setBitrate生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('bitrateDone')

on('availableBitrates')⁹⁺

on(type: 'availableBitrates', callback: (bitrates: Array<number>) => void): void

监听HLS协议流可用的比特率列表，只会在切换prepared状态后上报。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('availableBitrates', (bitrates: Array<number>) => {
  console.info('availableBitrates success,and availableBitrates length is:' + bitrates.length)
})

off('availableBitrates')⁹⁺

off(type: 'availableBitrates'): void

取消监听HLS协议流可用的比特率列表。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('availableBitrates')

setVolume⁹⁺

setVolume(volume: number): void

设置媒体播放音量，只能在prepared/playing/paused/completed状态调用，可以通过volumeChange事件确认是否生效。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

let volume: number = 1.0
avPlayer.setVolume(volume)

on('volumeChange')⁹⁺

on(type: 'volumeChange', callback: Callback<number>): void

监听setVolume生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('volumeChange', (vol: number) => {
  console.info('volumeChange success,and new volume is :' + vol)
})

off('volumeChange')⁹⁺

off(type: 'volumeChange'): void

取消监听setVolume生效的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('volumeChange')

on('endOfStream')⁹⁺

on(type: 'endOfStream', callback: Callback<void>): void

监听资源播放至结尾的事件；如果用户设置loop=1，播放会跳转至开头重播；如果用户没有设置loop，会通过stateChange上报completed状态。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('endOfStream', () => {
  console.info('endOfStream success')
})

off('endOfStream')⁹⁺

off(type: 'endOfStream'): void

取消监听资源播放至结尾的事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('endOfStream')

on('timeUpdate')⁹⁺

on(type: 'timeUpdate', callback: Callback<number>): void

监听资源播放当前时间，单位为毫秒（ms），用于刷新进度条当前位置，默认间隔100ms时间上报，因用户操作(seek)产生的时间变化会立刻上报。 注：直播场景不支持timeUpdate上报。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('timeUpdate', (time:number) => {
  console.info('timeUpdate success,and new time is :' + time)
})

off('timeUpdate')⁹⁺

off(type: 'timeUpdate'): void

取消监听资源播放当前时间。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('timeUpdate')

on('durationUpdate')⁹⁺

on(type: 'durationUpdate', callback: Callback<number>): void

监听资源播放资源的时长，单位为毫秒（ms），用于刷新进度条长度，默认只在prepared上报一次，同时允许一些特殊码流刷新多次时长。 注：直播场景不支持durationUpdate上报。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('durationUpdate', (duration: number) => {
  console.info('durationUpdate success,new duration is :' + duration)
})

off('durationUpdate')⁹⁺

off(type: 'durationUpdate'): void

取消监听资源播放资源的时长。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('durationUpdate')

on('bufferingUpdate')⁹⁺

on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void

订阅音视频缓存更新事件，仅网络播放支持该订阅事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
  console.info('bufferingUpdate success,and infoType value is:' + infoType + ', value is :' + value)
})

off('bufferingUpdate')⁹⁺

off(type: 'bufferingUpdate'): void

取消监听音视频缓存更新事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('bufferingUpdate')

on('startRenderFrame')⁹⁺

on(type: 'startRenderFrame', callback: Callback<void>): void

订阅视频播放开始首帧渲染的更新事件，仅视频播放支持该订阅事件，该事件仅代表播放服务将第一帧画面送显示模块，实际效果依赖显示服务渲染性能。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('startRenderFrame', () => {
  console.info('startRenderFrame success')
})

off('startRenderFrame')⁹⁺

off(type: 'startRenderFrame'): void

取消监听视频播放开始首帧渲染的更新事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('startRenderFrame')

on('videoSizeChange')⁹⁺

on(type: 'videoSizeChange', callback: (width: number, height: number) => void): void

监听视频播放宽高变化事件，仅视频播放支持该订阅事件，默认只在prepared状态上报一次，但HLS协议码流会在切换分辨率时上报；

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.on('videoSizeChange', (width: number, height: number) => {
  console.info('videoSizeChange success,and width is:' + width + ', height is :' + height)
})

off('videoSizeChange')⁹⁺

off(type: 'videoSizeChange'): void

取消监听视频播放宽高变化事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('videoSizeChange')

on('audioInterrupt')⁹⁺

on(type: 'audioInterrupt', callback: (info: audio.InterruptEvent) => void): void

监听音频焦点变化事件，多个音视频资源同时播放时，会根据音频焦点模型audio.InterruptMode触发此事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

import audio from '@ohos.multimedia.audio';

avPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
  console.info('audioInterrupt success,and InterruptEvent info is:' + info)
})

off('audioInterrupt')⁹⁺

off(type: 'audioInterrupt'): void

取消监听音频焦点变化事件。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

参数：

示例：

avPlayer.off('audioInterrupt')

AVPlayerState⁹⁺

AVPlayer的状态机，可通过state属性主动获取当前状态，也可通过监听stateChange事件上报当前状态，状态机之间的切换规则，可参考音频播放开发指导。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

AVFileDescriptor⁹⁺

音视频文件资源描述，一种特殊资源的播放方式，使用场景：应用中的音频资源被连续存储在同一个文件中，需要根据偏移量和长度进行播放。

系统能力： SystemCapability.Multimedia.Media.Core

AVDataSrcDescriptor¹⁰⁺

音视频文件资源描述，用于DataSource播放方式，使用场景：应用在未获取完整音视频资源时，允许用户创建播放实例并开始播放，达到提前播放的目的。

系统能力： SystemCapability.Multimedia.Media.AVPlayer

SeekMode⁸⁺

视频播放的Seek模式枚举，可通过seek方法作为参数传递下去。

系统能力： SystemCapability.Multimedia.Media.Core

PlaybackSpeed⁸⁺

视频播放的倍速枚举，可通过setSpeed方法作为参数传递下去。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

VideoScaleType⁹⁺

枚举，视频缩放模式。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

MediaDescription⁸⁺

通过key-value方式获取媒体信息。

系统能力： SystemCapability.Multimedia.Media.Core

示例：

function printfItemDescription(obj: media.MediaDescription, key: string) {
  let property: Object = obj[key];
  console.info('audio key is ' + key); // 通过key值获取对应的value。key值具体可见[MediaDescriptionKey]
  console.info('audio value is ' + property); //对应key值得value。其类型可为任意类型，具体key对应value的类型可参考[MediaDescriptionKey]
}

avPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  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.error(`audio getTrackDescription fail, error:${error}`);
  }
});

AVRecorder⁹⁺

音视频录制管理类，用于音视频媒体录制。在调用AVRecorder的方法前，需要先通过createAVRecorder()构建一个AVRecorder实例。

音视频录制demo可参考：音频录制开发指导、视频录制开发指导。

说明：

使用相机进行视频录制时，需要与相机模块配合，相机模块接口开放状态以及使用详情见相机管理。

属性

系统能力： SystemCapability.Multimedia.Media.AVRecorder

prepare⁹⁺

prepare(config: AVRecorderConfig, callback: AsyncCallback<void>): void

异步方式进行音视频录制的参数设置。通过注册回调函数获取返回值。

需要权限： ohos.permission.MICROPHONE

不涉及音频录制时，可以不需要获取ohos.permission.MICROPHONE权限。

使用相机视频录制还需要与相机模块配合，权限获取以及接口使用详见相机管理。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

// 配置参数以实际硬件设备支持的范围为准
let avRecorderProfile: media.AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_MPEG4,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
}
let avRecorderConfig: media.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: BusinessError) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare failed and error is ' + err.message);
  }
})

prepare⁹⁺

prepare(config: AVRecorderConfig): Promise<void>

异步方式进行音视频录制的参数设置。通过Promise获取返回值。

需要权限： ohos.permission.MICROPHONE

不涉及音频录制时，可以不需要获ohos.permission.MICROPHONE权限。

使用相机视频录制还需要与相机模块配合，权限获取以及接口使用详见相机管理。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

// 配置参数以实际硬件设备支持的范围为准
let avRecorderProfile: media.AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_MPEG4,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
}
let avRecorderConfig: media.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: BusinessError) => {
  console.error('prepare failed and catch error is ' + err.message);
});

getInputSurface⁹⁺

getInputSurface(callback: AsyncCallback<string>): void

异步方式获得录制需要的surface。通过注册回调函数获取返回值。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的视频数据。

应当注意，填入的视频数据需要携带时间戳（单位ns）和buffersize。时间戳的起始时间请以系统启动时间为基准。

需在prepare()事件成功触发后，才能调用getInputSurface()方法。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let surfaceID: string; // 该surfaceID用于传递给相机接口创造videoOutput

avRecorder.getInputSurface((err: BusinessError, surfaceId: string) => {
  if (err == null) {
    console.info('getInputSurface success');
    surfaceID = surfaceId;
  } else {
    console.error('getInputSurface failed and error is ' + err.message);
  }
});

getInputSurface⁹⁺

getInputSurface(): Promise<string>

异步方式获得录制需要的surface。通过Promise获取返回值。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的视频数据。

应当注意，填入的视频数据需要携带时间戳（单位ns）和buffersize。时间戳的起始时间请以系统启动时间为基准。

需在prepare()事件成功触发后，才能调用getInputSurface方法。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

let surfaceID: string; // 该surfaceID用于传递给相机接口创造videoOutput

avRecorder.getInputSurface().then((surfaceId: string) => {
  console.info('getInputSurface success');
  surfaceID = surfaceId;
}).catch((err: BusinessError) => {
  console.error('getInputSurface failed and catch error is ' + err.message);
});

start⁹⁺

start(callback: AsyncCallback<void>): void

异步方式开始视频录制。通过注册回调函数获取返回值。

纯音频录制需在prepare()事件成功触发后，才能调用start方法。纯视频录制，音视频录制需在getInputSurface()事件成功触发后，才能调用start方法。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.start((err: BusinessError) => {
  if (err == null) {
    console.info('start AVRecorder success');
  } else {
    console.error('start AVRecorder failed and error is ' + err.message);
  }
});

start⁹⁺

start(): Promise<void>

异步方式开始视频录制。通过Promise获取返回值。

纯音频录制需在prepare()事件成功触发后，才能调用start方法。纯视频录制，音视频录制需在getInputSurface()事件成功触发后，才能调用start方法。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.start().then(() => {
  console.info('start AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('start AVRecorder failed and catch error is ' + err.message);
});

pause⁹⁺

pause(callback: AsyncCallback<void>): void

异步方式暂停视频录制。通过注册回调函数获取返回值。

需要start()事件成功触发后，才能调用pause方法，可以通过调用resume()接口来恢复录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.pause((err: BusinessError) => {
  if (err == null) {
    console.info('pause AVRecorder success');
  } else {
    console.error('pause AVRecorder failed and error is ' + err.message);
  }
});

pause⁹⁺

pause(): Promise<void>

异步方式暂停视频录制。通过Promise获取返回值。

需要start()事件成功触发后，才能调用pause方法，可以通过调用resume()接口来恢复录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.pause().then(() => {
  console.info('pause AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('pause AVRecorder failed and catch error is ' + err.message);
});

resume⁹⁺

resume(callback: AsyncCallback<void>): void

异步方式恢复视频录制。通过注册回调函数获取返回值。

需要在pause()事件成功触发后，才能调用resume方法。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.resume((err: BusinessError) => {
  if (err == null) {
    console.info('resume AVRecorder success');
  } else {
    console.error('resume AVRecorder failed and error is ' + err.message);
  }
});

resume⁹⁺

resume(): Promise<void>

异步方式恢复视频录制。通过Promise获取返回值。

需要在pause()事件成功触发后，才能调用resume方法。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.resume().then(() => {
  console.info('resume AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('resume AVRecorder failed and catch error is ' + err.message);
});

stop⁹⁺

stop(callback: AsyncCallback<void>): void

异步方式停止视频录制。通过注册回调函数获取返回值。

需要在start()或pause()事件成功触发后，才能调用stop方法。

纯音频录制时，需要重新调用prepare()接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.stop((err: BusinessError) => {
  if (err == null) {
    console.info('stop AVRecorder success');
  } else {
    console.error('stop AVRecorder failed and error is ' + err.message);
  }
});

stop⁹⁺

stop(): Promise<void>

异步方式停止视频录制。通过Promise获取返回值。

需要在start()或pause()事件成功触发后，才能调用stop方法。

纯音频录制时，需要重新调用prepare()接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.stop().then(() => {
  console.info('stop AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('stop AVRecorder failed and catch error is ' + err.message);
});

reset⁹⁺

reset(callback: AsyncCallback<void>): void

异步方式重置音视频录制。通过注册回调函数获取返回值。

纯音频录制时，需要重新调用prepare()接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.reset((err: BusinessError) => {
  if (err == null) {
    console.info('reset AVRecorder success');
  } else {
    console.error('reset AVRecorder failed and error is ' + err.message);
  }
});

reset⁹⁺

reset(): Promise<void>

异步方式重置音视频录制。通过Promise获取返回值。

纯音频录制时，需要重新调用prepare()接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.reset().then(() => {
  console.info('reset AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('reset AVRecorder failed and catch error is ' + err.message);
});

release⁹⁺

release(callback: AsyncCallback<void>): void

异步方式释放音视频录制资源。通过注册回调函数获取返回值。

释放音视频录制资源之后，该AVRecorder实例不能再进行任何操作。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.release((err: BusinessError) => {
  if (err == null) {
    console.info('release AVRecorder success');
  } else {
    console.error('release AVRecorder failed and error is ' + err.message);
  }
});

release⁹⁺

release(): Promise<void>

异步方式释放音视频录制资源。通过Promise获取返回值。

释放音视频录制资源之后，该AVRecorder实例不能再进行任何操作。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.release().then(() => {
  console.info('release AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('release AVRecorder failed and catch error is ' + err.message);
});

on('stateChange')⁹⁺

on(type: 'stateChange', callback: (state: AVRecorderState, reason: StateChangeReason) => void): void

订阅录制状态机AVRecorderState切换的事件，当 AVRecorderState状态机发生变化时，会通过订阅的回调方法通知用户。用户只能订阅一个状态机切换事件的回调方法，当用户重复订阅时，以最后一次订阅的回调接口为准。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.on('stateChange', async (state: media.AVRecorderState, reason: media.StateChangeReason) => {
  console.info('case state has changed, new state is :' + state + ',and new reason is : ' + reason);
});

off('stateChange')⁹⁺

off(type: 'stateChange'): void

取消订阅播放状态机AVRecorderState切换的事件。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

示例：

avRecorder.off('stateChange');

on('error')⁹⁺

on(type: 'error', callback: ErrorCallback): void

订阅AVRecorder的错误事件，该事件仅用于错误提示，不需要用户停止播控动作。如果此时AVRecorderState也切至error状态，用户需要通过reset()或者release()退出录制操作。

用户只能订阅一个错误事件的回调方法，当用户重复订阅时，以最后一次订阅的回调接口为准。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码。

示例：

avRecorder.on('error', (err: BusinessError) => {
  console.info('case avRecorder.on(error) called, errMessage is ' + err.message);
});

off('error')⁹⁺

off(type: 'error'): void

取消订阅录制错误事件，取消后不再接收到AVRecorder的错误事件。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

参数：

示例：

avRecorder.off('error');

AVRecorderState⁹⁺

音视频录制的状态机。可通过state属性获取当前状态。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

AVRecorderConfig⁹⁺

表示音视频录制的参数设置。

通过audioSourceType和videoSourceType区分纯音频录制、纯视频录制或音视频录制。纯音频录制时，仅需要设置audioSourceType；纯视频录制时，仅需要设置videoSourceType；音视频录制时，audioSourceType和videoSourceType均需要设置。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

名称	类型	必填	说明
audioSourceType	AudioSourceType	否	选择录制的音频源类型。选择音频录制时必填。
videoSourceType	VideoSourceType	否	选择录制的视频源类型。选择视频录制时必填。
profile	AVRecorderProfile	是	录制的profile，必要参数。
url	string	是	录制输出URL：fd://xx (fd number) ，必要参数。
rotation	number	否	录制的视频旋转角度，仅支持0，90，180，270，默认值为0。
location	Location	否	录制的地理位置，默认不记录地理位置信息。

AVRecorderProfile⁹⁺

音视频录制的配置文件。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

AudioSourceType⁹⁺

表示视频录制中音频源类型的枚举。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

VideoSourceType⁹⁺

表示视频录制中视频源类型的枚举。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

ContainerFormatType⁸⁺

表示容器格式类型的枚举，缩写为CFT。

系统能力： SystemCapability.Multimedia.Media.Core

Location

视频录制的地理位置。

系统能力： SystemCapability.Multimedia.Media.Core

VideoRecorder⁹⁺

说明： AVRecorder⁹⁺发布后，VideoRecorder停止维护，建议使用AVRecorder替代。

视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过createVideoRecorder()构建一个VideoRecorder实例。

属性

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

prepare⁹⁺

prepare(config: VideoRecorderConfig, callback: AsyncCallback<void>): void

异步方式进行视频录制的参数设置。通过注册回调函数获取返回值。

需要权限： ohos.permission.MICROPHONE

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

import { BusinessError } from '@ohos.base';

// 配置参数以实际硬件设备支持的范围为准
let videoProfile: media.VideoRecorderProfile = {
  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 videoConfig: media.VideoRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : videoProfile,
  url : 'fd://xx',   // 文件需先由调用者创建，并给予适当的权限
  rotation : 0,
  location : { latitude : 30, longitude : 130 },
}

// asyncallback
videoRecorder.prepare(videoConfig, (err: BusinessError) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare failed and error is ' + err.message);
  }
})

prepare⁹⁺

prepare(config: VideoRecorderConfig): Promise<void>

异步方式进行视频录制的参数设置。通过Promise获取返回值。

需要权限： ohos.permission.MICROPHONE

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// 配置参数以实际硬件设备支持的范围为准
let videoProfile: media.VideoRecorderProfile = {
  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 videoConfig: media.VideoRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : videoProfile,
  url : 'fd://xx',   // 文件需先由调用者创建，并给予适当的权限
  rotation : 0,
  location : { latitude : 30, longitude : 130 },
}

// promise
videoRecorder.prepare(videoConfig).then(() => {
  console.info('prepare success');
}).catch((err: BusinessError) => {
  console.error('prepare failed and catch error is ' + err.message);
});

getInputSurface⁹⁺

getInputSurface(callback: AsyncCallback<string>): void

异步方式获得录制需要的surface。通过注册回调函数获取返回值。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。

应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。

只能在prepare()接口调用后调用。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

import { BusinessError } from '@ohos.base';

// asyncallback
let surfaceID: string;   // 传递给外界的surfaceID
videoRecorder.getInputSurface((err: BusinessError, surfaceId: string) => {
  if (err == null) {
    console.info('getInputSurface success');
    surfaceID = surfaceId;
  } else {
    console.error('getInputSurface failed and error is ' + err.message);
  }
});

getInputSurface⁹⁺

getInputSurface(): Promise<string>;

异步方式获得录制需要的surface。通过Promise获取返回值。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。

应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。

只能在prepare()接口调用后调用。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
let surfaceID: string;                                               // 传递给外界的surfaceID
videoRecorder.getInputSurface().then((surfaceId: string) => {
  console.info('getInputSurface success');
  surfaceID = surfaceId;
}).catch((err: BusinessError) => {
  console.error('getInputSurface failed and catch error is ' + err.message);
});

start⁹⁺

start(callback: AsyncCallback<void>): void

异步方式开始视频录制。通过注册回调函数获取返回值。

在prepare()和getInputSurface()后调用，需要依赖数据源先给surface传递数据。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// asyncallback
videoRecorder.start((err: BusinessError) => {
  if (err == null) {
    console.info('start videorecorder success');
  } else {
    console.error('start videorecorder failed and error is ' + err.message);
  }
});

start⁹⁺

start(): Promise<void>

异步方式开始视频录制。通过Promise获取返回值。

在prepare()和getInputSurface()后调用，需要依赖数据源先给surface传递数据。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
videoRecorder.start().then(() => {
  console.info('start videorecorder success');
}).catch((err: BusinessError) => {
  console.error('start videorecorder failed and catch error is ' + err.message);
});

pause⁹⁺

pause(callback: AsyncCallback<void>): void

异步方式暂停视频录制。通过注册回调函数获取返回值。

在start()后调用。可以通过调用resume()接口来恢复录制。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// asyncallback
videoRecorder.pause((err: BusinessError) => {
  if (err == null) {
    console.info('pause videorecorder success');
  } else {
    console.error('pause videorecorder failed and error is ' + err.message);
  }
});

pause⁹⁺

pause(): Promise<void>

异步方式暂停视频录制。通过Promise获取返回值。

在start()后调用。可以通过调用resume()接口来恢复录制。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
videoRecorder.pause().then(() => {
  console.info('pause videorecorder success');
}).catch((err: BusinessError) => {
  console.error('pause videorecorder failed and catch error is ' + err.message);
});

resume⁹⁺

resume(callback: AsyncCallback<void>): void

异步方式恢复视频录制。通过注册回调函数获取返回值。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// asyncallback
videoRecorder.resume((err: BusinessError) => {
  if (err == null) {
    console.info('resume videorecorder success');
  } else {
    console.error('resume videorecorder failed and error is ' + err.message);
  }
});

resume⁹⁺

resume(): Promise<void>

异步方式恢复视频录制。通过Promise获取返回值。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
videoRecorder.resume().then(() => {
  console.info('resume videorecorder success');
}).catch((err: BusinessError) => {
  console.error('resume videorecorder failed and catch error is ' + err.message);
});

stop⁹⁺

stop(callback: AsyncCallback<void>): void

异步方式停止视频录制。通过注册回调函数获取返回值。

需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// asyncallback
videoRecorder.stop((err: BusinessError) => {
  if (err == null) {
    console.info('stop videorecorder success');
  } else {
    console.error('stop videorecorder failed and error is ' + err.message);
  }
});

stop⁹⁺

stop(): Promise<void>

异步方式停止视频录制。通过Promise获取返回值。

需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
videoRecorder.stop().then(() => {
  console.info('stop videorecorder success');
}).catch((err: BusinessError) => {
  console.error('stop videorecorder failed and catch error is ' + err.message);
});

release⁹⁺

release(callback: AsyncCallback<void>): void

异步方式释放视频录制资源。通过注册回调函数获取返回值。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// asyncallback
videoRecorder.release((err: BusinessError) => {
  if (err == null) {
    console.info('release videorecorder success');
  } else {
    console.error('release videorecorder failed and error is ' + err.message);
  }
});

release⁹⁺

release(): Promise<void>

异步方式释放视频录制资源。通过Promise获取返回值。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
videoRecorder.release().then(() => {
  console.info('release videorecorder success');
}).catch((err: BusinessError) => {
  console.error('release videorecorder failed and catch error is ' + err.message);
});

reset⁹⁺

reset(callback: AsyncCallback<void>): void

异步方式重置视频录制。通过注册回调函数获取返回值。

需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// asyncallback
videoRecorder.reset((err: BusinessError) => {
  if (err == null) {
    console.info('reset videorecorder success');
  } else {
    console.error('reset videorecorder failed and error is ' + err.message);
  }
});

reset⁹⁺

reset(): Promise<void>

异步方式重置视频录制。通过Promise获取返回值。

需要重新调用prepare()和getInputSurface()接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// promise
videoRecorder.reset().then(() => {
  console.info('reset videorecorder success');
}).catch((err: BusinessError) => {
  console.error('reset videorecorder failed and catch error is ' + err.message);
});

on('error')⁹⁺

on(type: 'error', callback: ErrorCallback): void

开始订阅视频录制错误事件，当上报error错误事件后，用户需处理error事件，退出录制操作。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见媒体错误码

示例：

// 当获取videoRecordState接口出错时通过此订阅事件上报
videoRecorder.on('error', (error: BusinessError) => {   // 设置'error'事件回调
  console.error(`audio error called, error: ${error}`);
})

VideoRecordState⁹⁺

视频录制的状态机。可通过state属性获取当前状态。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

VideoRecorderConfig⁹⁺

表示视频录制的参数设置。

通过audioSourceType和videoSourceType区分纯视频录制和音视频录制（纯音频录制请使用AVRecorder或AudioRecorder）。纯视频录制时，仅需要设置videoSourceType；音视频录制时，audioSourceType和videoSourceType均需要设置。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

名称	类型	必填	说明
audioSourceType	AudioSourceType	否	视频录制的音频源类型，选择音频录制时必填。
videoSourceType	VideoSourceType	是	视频录制的视频源类型。
profile	VideoRecorderProfile	是	视频录制的profile。
rotation	number	否	录制的视频旋转角度，仅支持0，90，180，270，默认值为0。
location	Location	否	录制视频的地理位置，默认不记录地理位置信息。
url	string	是	视频输出URL：fd://xx (fd number)

VideoRecorderProfile⁹⁺

视频录制的配置文件。

系统能力： SystemCapability.Multimedia.Media.VideoRecorder

系统接口： 该接口为系统接口

media.createAudioPlayer^(deprecated)

createAudioPlayer(): AudioPlayer

同步方式创建音频播放实例。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用createAVPlayer替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

返回值：

示例：

let audioPlayer: media.AudioPlayer = media.createAudioPlayer();

media.createVideoPlayer^(deprecated)

createVideoPlayer(callback: AsyncCallback<VideoPlayer>): void

异步方式创建视频播放实例，通过注册回调函数获取返回值。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用createAVPlayer替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

import { BusinessError } from '@ohos.base';

let videoPlayer: media.VideoPlayer;
media.createVideoPlayer((error: BusinessError, video: media.VideoPlayer) => {
  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

返回值：

示例：

import { BusinessError } from '@ohos.base';

let videoPlayer: media.VideoPlayer;
media.createVideoPlayer().then((video: media.VideoPlayer) => {
  if (video != null) {
    videoPlayer = video;
    console.info('video createVideoPlayer success');
  } else {
    console.error('video createVideoPlayer fail');
  }
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

media.createAudioRecorder^(deprecated)

createAudioRecorder(): AudioRecorder

创建音频录制的实例来控制音频的录制。 一台设备只允许创建一个录制实例。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用createAVRecorder替代。

系统能力： SystemCapability.Multimedia.Media.AudioRecorder

返回值:

示例：

let audioRecorder: media.AudioRecorder = media.createAudioRecorder();

MediaErrorCode^(deprecated)

媒体服务错误类型枚举。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用媒体错误码替代。

系统能力： SystemCapability.Multimedia.Media.Core

AudioPlayer^(deprecated)

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer替代。

音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过createAudioPlayer()构建一个AudioPlayer实例。

属性^(deprecated)

系统能力： 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+	AVFileDescriptor	是	是	音频媒体文件描述，使用场景：应用中的音频资源被连续存储在同一个文件中。 使用示例： 假设一个连续存储的音乐文件: 音乐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+	audio.InterruptMode	是	是	音频焦点模型。
currentTime	number	是	否	音频的当前播放位置，单位为毫秒（ms）。
duration	number	是	否	音频时长，单位为毫秒（ms）。
state	AudioState	是	否	可以查询音频播放的状态，该状态不可作为调用play/pause/stop等状态切换的触发条件。

play^(deprecated)

play(): void

开始播放音频资源，需在'dataLoad'事件成功触发后，才能调用。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.play替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

示例：

audioPlayer.on('play', () => {    //设置'play'事件回调
  console.info('audio play success');
});
audioPlayer.play();

pause^(deprecated)

pause(): void

暂停播放音频资源。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.pause替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

示例：

audioPlayer.on('pause', () => {    //设置'pause'事件回调
  console.info('audio pause success');
});
audioPlayer.pause();

stop^(deprecated)

stop(): void

停止播放音频资源。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.stop替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

示例：

audioPlayer.on('stop', () => {    //设置'stop'事件回调
  console.info('audio stop success');
});
audioPlayer.stop();

reset^(deprecated)

reset(): void

重置播放音频资源。

说明： 从API version 7开始支持，从API version 9开始废弃，建议使用AVPlayer.reset替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

示例：

audioPlayer.on('reset', () => {    //设置'reset'事件回调
  console.info('audio reset success');
});
audioPlayer.reset();

seek^(deprecated)

seek(timeMs: number): void

跳转到指定播放位置。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.seek替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

audioPlayer.on('timeUpdate', (seekDoneTime: number) => {    //设置'timeUpdate'事件回调
  if (seekDoneTime == null) {
    console.error('audio seek fail');
    return;
  }
  console.info('audio seek success. seekDoneTime: ' + seekDoneTime);
});
audioPlayer.seek(30000);    //seek到30000ms的位置

setVolume^(deprecated)

setVolume(vol: number): void

设置音量。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.setVolume替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

audioPlayer.on('volumeChange', () => {    //设置'volumeChange'事件回调
  console.info('audio volumeChange success');
});
audioPlayer.setVolume(1);    //设置音量到100%

release^(deprecated)

release(): void

释放音频资源。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.release替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

示例：

audioPlayer.release();
audioPlayer = undefined;

getTrackDescription^(deprecated)

getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void

通过回调方式获取音频轨道信息。需在'dataLoad'事件成功触发后，才能调用。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.getTrackDescription替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

audioPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if (arrList != null) {
    console.info('audio getTrackDescription success');
  } else {
    console.error(`audio getTrackDescription fail, error:${error}`);
  }
});

getTrackDescription^(deprecated)

getTrackDescription(): Promise<Array<MediaDescription>>

通过Promise方式获取音频轨道信息。需在'dataLoad'事件成功触发后，才能调用。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.getTrackDescription替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

返回值：

示例：

audioPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  console.info('audio getTrackDescription success');
}).catch((error: BusinessError) => {
  console.error(`audio catchCallback, error:${error}`);
});

on('bufferingUpdate')^(deprecated)

on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void

开始订阅音频缓存更新事件。仅网络播放支持该订阅事件。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.on('bufferingUpdate')替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

audioPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
  console.info('audio bufferingInfo type: ' + infoType);
  console.info('audio bufferingInfo value: ' + value);
});

on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')^(deprecated)

on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void

开始订阅音频播放事件。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.on('stateChange')替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

import fs from '@ohos.file.fs';

let audioPlayer: media.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: number) => {  //设置'timeUpdate'事件回调
  if (seekDoneTime == null) {
    console.error('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: BusinessError) => {           //设置'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';
fs.open(path).then((file) => {
  fdPath = fdPath + '' + file.fd;
  console.info('open fd success fd is' + fdPath);
  audioPlayer.src = fdPath;  //设置src属性，并触发'dataLoad'事件回调
}, (err: BusinessError) => {
  console.error('open fd failed err is' + err);
}).catch((err: BusinessError) => {
  console.error('open fd failed err is' + err);
});

on('timeUpdate')^(deprecated)

on(type: 'timeUpdate', callback: Callback<number>): void

开始订阅音频播放时间更新事件。处于播放状态时，每隔1s上报一次该事件。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.on('timeUpdate')替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

audioPlayer.on('timeUpdate', (newTime: number) => {    //设置'timeUpdate'事件回调
  if (newTime == null) {
    console.error('audio timeUpadate fail');
    return;
  }
  console.info('audio timeUpadate success. seekDoneTime: ' + newTime);
});
audioPlayer.play();    //开始播放后，自动触发时间戳更新事件

on('error')^(deprecated)

on(type: 'error', callback: ErrorCallback): void

开始订阅音频播放错误事件，当上报error错误事件后，用户需处理error事件，退出播放操作。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.on('error')替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

参数：

示例：

audioPlayer.on('error', (error: BusinessError) => {      //设置'error'事件回调
  console.info(`audio error called, error: ${error}`); 
});
audioPlayer.setVolume(3);  //设置volume为无效值，触发'error'事件

AudioState^(deprecated)

音频播放的状态机。可通过state属性获取当前状态。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayerState替代。

系统能力： SystemCapability.Multimedia.Media.AudioPlayer

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+	AVFileDescriptor	是	是	视频媒体文件描述，使用场景：应用中的视频资源被连续存储在同一个文件中。 使用示例： 假设一个连续存储的音乐文件: 视频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+	VideoScaleType	是	是	视频缩放模式。
audioInterruptMode9+	audio.InterruptMode	是	是	音频焦点模型。
currentTime8+	number	是	否	视频的当前播放位置，单位为毫秒（ms）。
duration8+	number	是	否	视频时长，单位为毫秒（ms），返回-1表示直播模式。
state8+	VideoPlayState	是	否	视频播放的状态。
width8+	number	是	否	视频宽，单位为像素（px）。
height8+	number	是	否	视频高，单位为像素（px）。

setDisplaySurface^(deprecated)

setDisplaySurface(surfaceId: string, callback: AsyncCallback<void>): void

通过回调方式设置SurfaceId。

*注意：SetDisplaySurface需要在设置url和Prepare之间，无音频的视频流必须设置Surface否则Prepare失败。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.surfaceId替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

let surfaceId: string = '';
videoPlayer.setDisplaySurface(surfaceId, (err: BusinessError) => {
  if (err == null) {
    console.info('setDisplaySurface success!');
  } else {
    console.error('setDisplaySurface fail!');
  }
});

setDisplaySurface^(deprecated)

setDisplaySurface(surfaceId: string): Promise<void>

通过Promise方式设置SurfaceId。

*注意：SetDisplaySurface需要在设置url和Prepare之间，无音频的视频流必须设置Surface否则Prepare失败。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.surfaceId替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

返回值：

示例：

let surfaceId: string = '';
videoPlayer.setDisplaySurface(surfaceId).then(() => {
  console.info('setDisplaySurface success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

prepare^(deprecated)

prepare(callback: AsyncCallback<void>): void

通过回调方式准备播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.prepare替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.prepare((err: BusinessError) => {
  if (err == null) {
    console.info('prepare success!');
  } else {
    console.error('prepare fail!');
  }
});

prepare^(deprecated)

prepare(): Promise<void>

通过Promise方式准备播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.prepare替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.prepare().then(() => {
  console.info('prepare success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

play^(deprecated)

play(callback: AsyncCallback<void>): void

通过回调方式开始播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.play替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.play((err: BusinessError) => {
  if (err == null) {
    console.info('play success!');
  } else {
    console.error('play fail!');
  }
});

play^(deprecated)

play(): Promise<void>

通过Promise方式开始播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.play替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.play().then(() => {
  console.info('play success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

pause^(deprecated)

pause(callback: AsyncCallback<void>): void

通过回调方式暂停播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.pause替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.pause((err: BusinessError) => {
  if (err == null) {
    console.info('pause success!');
  } else {
    console.error('pause fail!');
  }
});

pause^(deprecated)

pause(): Promise<void>

通过Promise方式暂停播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.pause替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.pause().then(() => {
  console.info('pause success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

stop^(deprecated)

stop(callback: AsyncCallback<void>): void

通过回调方式停止播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.stop替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.stop((err: BusinessError) => {
  if (err == null) {
    console.info('stop success!');
  } else {
    console.error('stop fail!');
  }
});

stop^(deprecated)

stop(): Promise<void>

通过Promise方式停止播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.stop替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.stop().then(() => {
  console.info('stop success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

reset^(deprecated)

reset(callback: AsyncCallback<void>): void

通过回调方式重置播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.reset替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.reset((err: BusinessError) => {
  if (err == null) {
    console.info('reset success!');
  } else {
    console.error('reset fail!');
  }
});

reset^(deprecated)

reset(): Promise<void>

通过Promise方式重置播放视频。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.reset替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.reset().then(() => {
  console.info('reset success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

seek^(deprecated)

seek(timeMs: number, callback: AsyncCallback<number>): void

通过回调方式跳转到指定播放位置，默认跳转到指定时间点的上一个关键帧。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.seek替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

let videoPlayer: media.VideoPlayer;
media.createVideoPlayer((error: BusinessError, video: media.VideoPlayer) => {
  if (video != null) {
    videoPlayer = video;
    console.info('video createVideoPlayer success');
  } else {
    console.error(`video createVideoPlayer fail, error:${error}`);
  }
});

let seekTime: number = 5000;
videoPlayer.seek(seekTime, (err: BusinessError, result: number) => {
  if (err == null) {
    console.info('seek success!');
  } else {
    console.error('seek fail!');
  }
});

seek^(deprecated)

seek(timeMs: number, mode:SeekMode, callback: AsyncCallback<number>): void

通过回调方式跳转到指定播放位置。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.seek替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

let videoPlayer: media.VideoPlayer | null = null;
media.createVideoPlayer((error: BusinessError, video: media.VideoPlayer) => {
  if (video != null) {
    videoPlayer = video;
    console.info('video createVideoPlayer success');
  } else {
    console.error(`video createVideoPlayer fail, error:${error}`);
  }
});
let seekTime: number = 5000;
if (videoPlayer) {
  (videoPlayer as media.VideoPlayer).seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC, (err: BusinessError, result: number) => {
    if (err == null) {
      console.info('seek success!');
    } else {
      console.error('seek fail!');
    }
  });
}

seek^(deprecated)

seek(timeMs: number, mode?:SeekMode): Promise<number>

通过Promise方式跳转到指定播放位置，如果没有设置mode则跳转到指定时间点的上一个关键帧。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.seek替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

返回值：

示例：

let videoPlayer: media.VideoPlayer | null = null;
media.createVideoPlayer((error: BusinessError, video: media.VideoPlayer) => {
  if (video != null) {
    videoPlayer = video;
    console.info('video createVideoPlayer success');
  } else {
    console.error(`video createVideoPlayer fail, error:${error}`);
  }
});
let seekTime: number = 5000;
if (videoPlayer) {
  (videoPlayer as media.VideoPlayer).seek(seekTime).then((seekDoneTime: number) => { // seekDoneTime表示seek完成后的时间点
    console.info('seek success');
  }).catch((error: BusinessError) => {
    console.error(`video catchCallback, error:${error}`);
  });

  (videoPlayer as media.VideoPlayer).seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC).then((seekDoneTime: number) => {
    console.info('seek success');
  }).catch((error: BusinessError) => {
    console.error(`video catchCallback, error:${error}`);
  });
}

setVolume^(deprecated)

setVolume(vol: number, callback: AsyncCallback<void>): void

通过回调方式设置音量。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.setVolume替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

let vol: number = 0.5;
videoPlayer.setVolume(vol, (err: BusinessError) => {
  if (err == null) {
    console.info('setVolume success!');
  } else {
    console.error('setVolume fail!');
  }
});

setVolume^(deprecated)

setVolume(vol: number): Promise<void>

通过Promise方式设置音量。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.setVolume替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

返回值：

示例：

let vol: number = 0.5;
videoPlayer.setVolume(vol).then(() => {
  console.info('setVolume success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

release^(deprecated)

release(callback: AsyncCallback<void>): void

通过回调方式释放视频资源。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.release替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.release((err: BusinessError) => {
  if (err == null) {
    console.info('release success!');
  } else {
    console.error('release fail!');
  }
});

release^(deprecated)

release(): Promise<void>

通过Promise方式释放视频资源。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.release替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.release().then(() => {
  console.info('release success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

getTrackDescription^(deprecated)

getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void

通过回调方式获取视频轨道信息。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.getTrackDescription替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

videoPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if ((arrList) != null) {
    console.info('video getTrackDescription success');
  } else {
    console.error(`video getTrackDescription fail, error:${error}`);
  }
});

getTrackDescription^(deprecated)

getTrackDescription(): Promise<Array<MediaDescription>>

通过Promise方式获取视频轨道信息。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.getTrackDescription替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

返回值：

示例：

videoPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  if (arrList != null) {
    console.info('video getTrackDescription success');
  } else {
    console.error('video getTrackDescription fail');
  }
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

setSpeed^(deprecated)

setSpeed(speed:number, callback: AsyncCallback<number>): void

通过回调方式设置播放速度。

说明： 从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.setSpeed替代。

系统能力： SystemCapability.Multimedia.Media.VideoPlayer

参数：

示例：

let videoPlayer: media.VideoPlayer | null = null;
media.createVideoPlayer((error: BusinessError, video: media.VideoPlayer) => {
  if (video != null) {
    videoPlayer = video;
    console.info('video createVideoPlayer success');
  } else {
    console.error(`video createVideoPlayer fail, error:${error}`);
  }
});
let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
if (videoPlayer) {
  (videoPlayer as media.VideoPlayer).setSpeed(speed, (err: BusinessError, result: number) => {
    if (err == null) {
      console.info('setSpeed success!');
    } else {
      console.error('setSpeed fail!');
    }
  });
}

setSpeed^(deprecated)

setSpeed(speed:number): Promise<number>