媒体服务

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

API Version 9当前为Canary版本，仅供试用，不保证接口可稳定调用。

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

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

• 音频播放（AudioPlayer）
• 视频播放（VideoPlayer）
• 音频录制（AudioRecorder）
• 视频录制（VideoRecorder）

后续将提供以下功能：DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。

导入模块

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

media.createAudioPlayer

createAudioPlayer(): AudioPlayer

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

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

返回值：

示例：

let audioPlayer = media.createAudioPlayer();

media.createVideoPlayer⁸⁺

createVideoPlayer(callback: AsyncCallback<VideoPlayer>): void

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

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

参数：

示例：

let videoPlayer

media.createVideoPlayer((error, video) => {
   if (typeof(video) != 'undefined') {
       videoPlayer = video;
       console.info('video createVideoPlayer success');
   } else {
       console.info(`video createVideoPlayer fail, error:${error.message}`);
   }
});

media.createVideoPlayer⁸⁺

createVideoPlayer(): Promise<VideoPlayer>

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

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

返回值：

示例：

let videoPlayer

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

media.createAudioRecorder

createAudioRecorder(): AudioRecorder

创建音频录制的实例来控制音频的录制。

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

返回值:

示例：

let audiorecorder = media.createAudioRecorder();

media.createVideoRecorder⁹⁺

createVideoRecorder(callback: AsyncCallback<VideoRecorder>): void

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

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

参数：

示例：

let videoRecorder

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

media.createVideoRecorder⁹⁺

createVideoRecorder(): Promise<VideoRecorder>

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

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

返回值：

示例：

let videoRecorder

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

MediaErrorCode⁸⁺

媒体服务错误类型枚举。

系统能力： 以下各项对应的系统能力均为 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。

AudioPlayer

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

音频播放demo可参考：音频播放开发指导

属性

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.AudioPlayer。

名称	类型	可读	可写	说明
src	string	是	是	音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。 支持路径示例： 1、fd类型播放：fd://xx 2、http网络播放: http://xx 3、hls网络播放路径：开发中 注意事项： 使用媒体素材需要获取读权限，否则无法正常播放。
loop	boolean	是	是	音频循环播放属性，设置为'true'表示循环播放。
currentTime	number	是	否	音频的当前播放位置。
duration	number	是	否	音频时长。
state	AudioState	是	否	音频播放的状态。

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();

reset⁷⁺

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

参数：

示例：

audioPlayer.on('timeUpdate', (seekDoneTime) => {    //设置'timeUpdate'事件回调
    if (typeof (seekDoneTime) == 'undefined') {
        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

参数：

示例：

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

release

release(): void

释放音频资源。

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

示例：

audioPlayer.release();
audioPlayer = undefined;

getTrackDescription⁸⁺

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

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

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

参数：

示例：

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 (typeof (arrlist) != 'undefined') {
        for (let i = 0; i < arrlist.length; i++) {
            printfDescription(arrlist[i]);
        }
    } else {
        console.log(`audio getTrackDescription fail, error:${error.message}`);
    }
});

getTrackDescription⁸⁺

getTrackDescription(): Promise<Array<MediaDescription>>

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

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

返回值：

示例：

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().then((arrlist) => {
    if (typeof (arrlist) != 'undefined') {
        arrayDescription = arrlist;
    } else {
        console.log('audio getTrackDescription fail');
    }
}).catch((error) => {
   console.info(`audio catchCallback, error:${error.message}`);
});

for (let i = 0; i < arrayDescription.length; i++) {
    printfDescription(arrayDescription[i]);
}

on('bufferingUpdate')⁸⁺

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

开始订阅音频缓存更新事件。

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

参数：

示例：

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

参数：

示例：

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 (typeof(seekDoneTime) == "undefined") {
        console.info('audio seek fail');
        return;
    }
    console.info('audio seek success, and seek time is ' + seekDoneTime);
    audioPlayer.setVolume(0.5);                //设置音量为50%，并触发'volumeChange'事件回调
});
audioPlayer.on('volumeChange', () => {         //设置'volumeChange'事件回调
    console.info('audio volumeChange success');
    audioPlayer.pause();                       //暂停播放，并触发'pause'事件回调
});
audioPlayer.on('finish', () => {               //设置'finish'事件回调
    console.info('audio play finish');
    audioPlayer.stop();                        //停止播放，并触发'stop'事件回调
});
audioPlayer.on('error', (error) => {           //设置'error'事件回调
    console.info(`audio error called, errName is ${error.name}`);
    console.info(`audio error called, errCode is ${error.code}`);
    console.info(`audio error called, errMessage is ${error.message}`);
});

// 用户选择视频设置fd(本地播放)
let fdPath = 'fd://'
// path路径的码流可通过"hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" 命令，将其推送到设备上
let path = '/data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
fileIO.open(path).then(fdNumber) => {
   fdPath = fdPath + '' + fdNumber;
   console.info('open fd sucess fd is' + fdPath);
}, (err) => {
   console.info('open fd failed err is' + err);
}).catch((err) => {
   console.info('open fd failed err is' + err);
});
audioPlayer.src = fdPath;  //设置src属性，并触发'dataLoad'事件回调

on('timeUpdate')

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

开始订阅音频播放seek()时间更新事件。

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

参数：

示例：

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

on('error')

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

开始订阅音频播放错误事件。

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

参数：

示例：

audioPlayer.on('error', (error) => {      //设置'error'事件回调
    console.info(`audio error called, errName is ${error.name}`);      //打印错误类型名称
    console.info(`audio error called, errCode is ${error.code}`);      //打印错误码
    console.info(`audio error called, errMessage is ${error.message}`);//打印错误类型详细描述
});
audioPlayer.setVolume(3);  //设置volume为无效值，触发'error'事件

AudioState

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.AudioPlayer。

VideoPlayer⁸⁺

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

视频播放demo可参考：视频播放开发指导

属性

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoPlayer。

名称	类型	可读	可写	说明
url8+	string	是	是	视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。 支持路径示例： 1. fd类型播放：fd://xx 2、http网络播放: http://xx 3、hls网络播放路径：开发中 注意事项： 使用媒体素材需要获取读权限，否则无法正常播放。
loop8+	boolean	是	是	视频循环播放属性，设置为'true'表示循环播放。
currentTime8+	number	是	否	视频的当前播放位置。
duration8+	number	是	否	视频时长，返回-1表示直播模式。
state8+	VideoPlayState	是	否	视频播放的状态。
width8+	number	是	否	视频宽。
height8+	number	是	否	视频高。

setDisplaySurface⁸⁺

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

通过回调方式设置SurfaceId。

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

参数：

示例：

videoPlayer.setDisplaySurface(surfaceId, (err) => {
    if (typeof (err) == 'undefined') {
        console.info('setDisplaySurface success!');
    } else {
        console.info('setDisplaySurface fail!');
    }
});

setDisplaySurface⁸⁺

setDisplaySurface(surfaceId: string): Promise<void>

通过Promise方式设置SurfaceId。

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

参数：

返回值：

示例：

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

prepare⁸⁺

prepare(callback: AsyncCallback<void>): void

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

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

参数：

示例：

videoPlayer.prepare((err) => {
    if (typeof (err) == 'undefined') {
        console.info('prepare success!');
    } else {
        console.info('prepare fail!');
    }
});

prepare⁸⁺

prepare(): Promise<void>

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

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

返回值：

示例：

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

play⁸⁺

play(callback: AsyncCallback<void>): void;

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

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

参数：

示例：

videoPlayer.play((err) => {
    if (typeof (err) == 'undefined') {
        console.info('play success!');
    } else {
        console.info('play fail!');
    }
});

play⁸⁺

play(): Promise<void>;

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

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

返回值：

示例：

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

pause⁸⁺

pause(callback: AsyncCallback<void>): void

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

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

参数：

示例：

videoPlayer.pause((err) => {
    if (typeof (err) == 'undefined') {
        console.info('pause success!');
    } else {
        console.info('pause fail!');
    }
});

pause⁸⁺

pause(): Promise<void>

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

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

返回值：

示例：

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

stop⁸⁺

stop(callback: AsyncCallback<void>): void

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

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

参数：

示例：

videoPlayer.stop((err) => {
    if (typeof (err) == 'undefined') {
        console.info('stop success!');
    } else {
        console.info('stop fail!');
    }
});

stop⁸⁺

stop(): Promise<void>

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

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

返回值：

示例：

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

reset⁸⁺

reset(callback: AsyncCallback<void>): void

通过回调方式切换播放视频。

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

参数：

示例：

videoPlayer.reset((err) => {
    if (typeof (err) == 'undefined') {
        console.info('reset success!');
    } else {
        console.info('reset fail!');
    }
});

reset⁸⁺

reset(): Promise<void>

通过Promise方式切换播放视频。

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

返回值：

示例：

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

seek⁸⁺

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

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

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

参数：

示例：

videoPlayer.seek((seekTime, err) => {
    if (typeof (err) == 'undefined') {
        console.info('seek success!');
    } else {
        console.info('seek fail!');
    }
});

seek⁸⁺

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

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

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

参数：

示例：

videoPlayer.seek((seekTime, seekMode, err) => {
    if (typeof (err) == 'undefined') {
        console.info('seek success!');
    } else {
        console.info('seek fail!');
    }
});

seek⁸⁺

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

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

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

参数：

返回值：

示例：

videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime表示seek完成后的时间点
    console.info('seek success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

videoPlayer.seek(seekTime, seekMode).then((seekDoneTime) => {
    console.info('seek success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

setVolume⁸⁺

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

通过回调方式设置音量。

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

参数：

示例：

videoPlayer.setVolume((vol, err) => {
    if (typeof (err) == 'undefined') {
        console.info('setVolume success!');
    } else {
        console.info('setVolume fail!');
    }
});

setVolume⁸⁺

setVolume(vol: number): Promise<void>

通过Promise方式设置音量。

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

参数：

返回值：

示例：

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

release⁸⁺

release(callback: AsyncCallback<void>): void

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

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

参数：

示例：

videoPlayer.release((err) => {
    if (typeof (err) == 'undefined') {
        console.info('release success!');
    } else {
        console.info('release fail!');
    }
});

release⁸⁺

release(): Promise<void>

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

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

返回值：

示例：

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

getTrackDescription⁸⁺

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

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

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

参数：

示例：

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 (typeof (arrlist) != 'undefined') {
        for (let i = 0; i < arrlist.length; i++) {
            printfDescription(arrlist[i]);
        }
    } else {
        console.log(`video getTrackDescription fail, error:${error.message}`);
    }
});

getTrackDescription⁸⁺

getTrackDescription(): Promise<Array<MediaDescription>>

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

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

返回值：

示例：

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 (typeof (arrlist) != 'undefined') {
        arrayDescription = arrlist;
    } else {
        console.log('video getTrackDescription fail');
    }
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});
for (let i = 0; i < arrayDescription.length; i++) {
    printfDescription(arrayDescription[i]);
}

setSpeed⁸⁺

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

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

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

参数：

示例：

videoPlayer.setSpeed((speed:number, err) => {
    if (typeof (err) == 'undefined') {
        console.info('setSpeed success!');
    } else {
        console.info('setSpeed fail!');
    }
});

setSpeed⁸⁺

setSpeed(speed:number): Promise<number>

通过Promise方式设置播放速度。

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

参数：

返回值：

示例：

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

on('playbackCompleted')⁸⁺

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

开始监听视频播放完成事件。

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

参数：

示例：

videoPlayer.on('playbackCompleted', () => {
    console.info('playbackCompleted success!');
});

on('bufferingUpdate')⁸⁺

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

开始监听视频缓存更新事件。

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

参数：

示例：

videoPlayer.on('bufferingUpdate', (infoType, value) => {
    console.log('video bufferingInfo type: ' + infoType);
    console.log('video bufferingInfo value: ' + value);
});

on('startRenderFrame')⁸⁺

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

开始监听视频播放首帧送显上报事件。

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

参数：

示例：

videoPlayer.on('startRenderFrame', () => {
    console.info('startRenderFrame success!');
});

on('videoSizeChanged')⁸⁺

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

开始监听视频播放宽高变化事件。

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

参数：

示例：

videoPlayer.on('videoSizeChanged', (width, height) => {
    console.log('video width is: ' + width);
    console.log('video height is: ' + height);
});

on('error')⁸⁺

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

开始监听视频播放错误事件。

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

参数：

示例：

videoPlayer.on('error', (error) => {      // 设置'error'事件回调
    console.info(`video error called, errName is ${error.name}`);      // 打印错误类型名称
    console.info(`video error called, errCode is ${error.code}`);      // 打印错误码
    console.info(`video error called, errMessage is ${error.message}`);// 打印错误类型详细描述
});
videoPlayer.setVolume(3);  //设置volume为无效值，触发'error'事件

VideoPlayState⁸⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoPlayer。

SeekMode⁸⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。

PlaybackSpeed⁸⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoPlayer。

MediaDescription⁸⁺

[key : string] : Object

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。

示例：

function printfItemDescription(obj, key) {
    let property = obj[key];
    console.info('audio key is ' + key);
    console.info('audio value is ' + property);
}

audioPlayer.getTrackDescription((error, arrlist) => {
    if (typeof (arrlist) != 'undefined') {
        for (let i = 0; i < arrlist.length; i++) {
            printfItemDescription(arrlist[i], MD_KEY_TRACK_TYPE);  //打印出每条轨道MD_KEY_TRACK_TYPE的值
        }
    } else {
        console.log(`audio getTrackDescription fail, error:${error.message}`);
    }
});

AudioRecorder

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

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

prepare

prepare(config: AudioRecorderConfig): void

录音准备。

需要权限： ohos.permission.MICROPHONE

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

参数：

示例：

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

参数：

示例：

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, errName is ${error.name}`);
    console.info(`audio error called, errCode is ${error.code}`);
    console.info(`audio error called, errMessage is ${error.message}`);
});
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

开始订阅音频录制错误事件。

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

参数：

示例：

audioRecorder.on('error', (error) => {                                  // 设置'error'事件回调
    console.info(`audio error called, errName is ${error.name}`);       // 打印错误类型名称
    console.info(`audio error called, errCode is ${error.code}`);       // 打印错误码
    console.info(`audio error called, errMessage is ${error.message}`); // 打印错误类型详细描述
});
audioRecorder.prepare();                                                  // prepare不设置参数，触发'error'事件

AudioRecorderConfig

表示音频的录音配置。

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.AudioRecorder。

名称	参数类型	必填	说明
audioEncoder	AudioEncoder	否	音频编码格式，默认设置为AAC_LC。
audioEncodeBitRate	number	否	音频编码比特率，默认值为48000。
audioSampleRate	number	否	音频采集采样率，默认值为48000。
numberOfChannels	number	否	音频采集声道数，默认值为2。
format	AudioOutputFormat	否	音频输出封装格式，默认设置为MPEG_4。
location	Location	否	音频采集的地理位置。
uri	string	是	音频输出URI：fd://xx (fd number) 文件需要由调用者创建，并赋予适当的权限。
audioEncoderMime	CodecMimeType	否	音频编码格式。

AudioEncoder^(deprecated)

说明： 从 API Version 8 开始废弃，建议使用CodecMimeType替代。

表示音频编码格式的枚举。

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.AudioRecorder。

AudioOutputFormat^(deprecated)

说明： 从 API Version 8 开始废弃，建议使用ContainerFormatType 替代。

表示音频封装格式的枚举。

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.AudioRecorder。

VideoRecorder⁹⁺

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

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

属性

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。

prepare⁹⁺

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

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

需要权限： ohos.permission.MICROPHONE

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

参数：

示例：

let videoProfile = {
    audioBitrate : 48000,
    audioChannels : 2,
    audioCodec : 'audio/mp4a-latm',
    audioSampleRate : 48000,
    fileFormat : 'mp4',
    videoBitrate : 48000,
    videoCodec : 'video/mp4v-es',
    videoFrameWidth : 640,
    videoFrameHeight : 480,
    videoFrameRate : 30
}

let videoConfig = {
    audioSourceType : 1,
    videoSourceType : 0,
    profile : videoProfile,
    url : 'fd://xx',   // 文件需先由调用者创建，并给予适当的权限
    orientationHint : 0,
    location : { latitude : 30, longitude : 130 },
}

// asyncallback
let videoRecorder = null;
let events = require('events');
let eventEmitter = new events.EventEmitter();

eventEmitter.on('prepare', () => {
    videoRecorder.prepare(videoConfig, (err) => {
        if (typeof (err) == 'undefined') {
            console.info('prepare success');
        } else {
            console.info('prepare failed and error is ' + err.message);
        }
    });
});

media.createVideoRecorder((err, recorder) => {
    if (typeof (err) == 'undefined' && typeof (recorder) != 'undefined') {
        videoRecorder = recorder;
        console.info('createVideoRecorder success');
        eventEmitter.emit('prepare');                                        // prepare事件触发
    } else {
        console.info('createVideoRecorder failed and error is ' + err.message);
    }
});

prepare⁹⁺

prepare(config: VideoRecorderConfig): Promise<void>;

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

需要权限： ohos.permission.MICROPHONE，ohos.permission.CAMERA

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

参数：

返回值：

示例：

let videoProfile = {
    audioBitrate : 48000,
    audioChannels : 2,
    audioCodec : 'audio/mp4a-latm',
    audioSampleRate : 48000,
    fileFormat : 'mp4',
    videoBitrate : 48000,
    videoCodec : 'video/mp4v-es',
    videoFrameWidth : 640,
    videoFrameHeight : 480,
    videoFrameRate : 30
}

let videoConfig = {
    audioSourceType : 1,
    videoSourceType : 0,
    profile : videoProfile,
    url : 'fd://xx',   // 文件需先由调用者创建，并给予适当的权限
    orientationHint : 0,
    location : { latitude : 30, longitude : 130 },
}

// promise
let videoRecorder = null;
media.createVideoRecorder().then((recorder) => {
    if (typeof (recorder) != 'undefined') {
        videoRecorder = recorder;
        console.info('createVideoRecorder success');
    } else {
        console.info('createVideoRecorder failed');
    }
}).catch((err) => {
    console.info('catch err error message is ' + err.message);
});

videoRecorder.prepare(videoConfig).then(() => {
    console.info('prepare success');
}).catch((err) => {
    console.info('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

参数：

示例：

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

getInputSurface⁹⁺

getInputSurface(): Promise<string>;

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

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

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

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

返回值：

示例：

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

start⁹⁺

start(callback: AsyncCallback<void>): void;

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

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

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

参数：

示例：

// asyncallback
videoRecorder.start((err) => {
    if (typeof (err) == 'undefined') {
        console.info('start videorecorder success');
    } else {
        console.info('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) => {
    console.info('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) => {
    if (typeof (err) == 'undefined') {
        console.info('pause videorecorder success');
    } else {
        console.info('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) => {
    console.info('pause videorecorder failed and catch error is ' + err.message);
});

resume⁹⁺

resume(callback: AsyncCallback<void>): void;

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

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

参数：

示例：

// asyncallback
videoRecorder.resume((err) => {
    if (typeof (err) == 'undefined') {
        console.info('resume videorecorder success');
    } else {
        console.info('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) => {
    console.info('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) => {
    if (typeof (err) == 'undefined') {
        console.info('stop videorecorder success');
    } else {
        console.info('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) => {
    console.info('stop videorecorder failed and catch error is ' + err.message);
});

release⁹⁺

release(callback: AsyncCallback<void>): void;

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

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

参数：

示例：

// asyncallback
videoRecorder.release((err) => {
    if (typeof (err) == 'undefined') {
        console.info('release videorecorder success');
    } else {
        console.info('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) => {
    console.info('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) => {
    if (typeof (err) == 'undefined') {
        console.info('reset videorecorder success');
    } else {
        console.info('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) => {
    console.info('reset videorecorder failed and catch error is ' + err.message);
});

on('error')⁹⁺

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

开始订阅视频录制错误事件。

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

参数：

示例：

videoRecorder.on('error', (error) => {                                  // 设置'error'事件回调
    console.info(`audio error called, errName is ${error.name}`);       // 打印错误类型名称
    console.info(`audio error called, errCode is ${error.code}`);       // 打印错误码
    console.info(`audio error called, errMessage is ${error.message}`); // 打印错误类型详细描述
});
// 当获取videoRecordState接口出错时通过此订阅事件上报

VideoRecordState⁹⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。

VideoRecorderConfig⁹⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。

名称	参数类型	必填	说明
audioSourceType	AudioSourceType	是	视频录制的音频源类型。
videoSourceType	VideoSourceType	是	视频录制的视频源类型。
profile	VideoRecorderProfile	是	视频录制的profile。
rotation	number	否	录制视频的旋转角度。
location	Location	否	录制视频的地理位置。
url	string	是	视频输出URL：fd://xx (fd number) 文件需要由调用者创建，并赋予适当的权限。

AudioSourceType⁹⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。

VideoSourceType⁹⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。

VideoRecorderProfile⁹⁺

视频录制的配置文件。

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.VideoRecorder。

ContainerFormatType⁸⁺

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

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。

Location

视频录制的地理位置。

系统能力： 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。