鸿蒙开发接口媒体:【@ohos.multimedia.media (媒体服务)】

 媒体服务

说明:  本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md点击或者复制转到。

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

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

导入模块

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

media.createAudioPlayer

createAudioPlayer(): [AudioPlayer]

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

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

返回值:

类型说明
[AudioPlayer]返回AudioPlayer类实例,失败时返回null。可用于音频播放、暂停、停止等操作。

示例:

let audioPlayer = media.createAudioPlayer();

media.createVideoPlayer8+

createVideoPlayer(callback: AsyncCallback<[VideoPlayer]>): void

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<[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.createVideoPlayer8+

createVideoPlayer(): Promise<[VideoPlayer]>

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

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

返回值:

类型说明
Promise<[VideoPlayer]>异步创建视频播放实例Promise返回值。

示例:

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

返回值:

类型说明
[AudioRecorder]返回AudioRecorder类实例,失败时返回null。

示例:

let audioRecorder = media.createAudioRecorder();

media.createVideoRecorder9+

createVideoRecorder(callback: AsyncCallback<[VideoRecorder]>): void

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<[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.createVideoRecorder9+

createVideoRecorder(): Promise<[VideoRecorder]>

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

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

返回值:

类型说明
Promise<[VideoRecorder]>异步创建视频录制实例Promise返回值。

示例:

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}`);
});

MediaErrorCode8+

媒体服务错误类型枚举。

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

名称说明
MSERR_OK0表示操作成功。
MSERR_NO_MEMORY1表示申请内存失败,系统可能无可用内存。
MSERR_OPERATION_NOT_PERMIT2表示无权限执行此操作。
MSERR_INVALID_VAL3表示传入入参无效。
MSERR_IO4表示发生IO错误。
MSERR_TIMEOUT5表示操作超时。
MSERR_UNKNOWN6表示未知错误。
MSERR_SERVICE_DIED7表示服务端失效。
MSERR_INVALID_STATE8表示在当前状态下,不允许执行此操作。
MSERR_UNSUPPORTED9表示在当前版本下,不支持此操作。

MediaType8+

媒体类型枚举。

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

名称说明
MEDIA_TYPE_AUD0表示音频。
MEDIA_TYPE_VID1表示视频。

[CodecMimeType8+

Codec MIME类型枚举。

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

名称说明
VIDEO_H263'video/h263'表示视频/h263类型。
VIDEO_AVC'video/avc'表示视频/avc类型。
VIDEO_MPEG2'video/mpeg2'表示视频/mpeg2类型。
VIDEO_MPEG4'video/mp4v-es'表示视频/mpeg4类型。
VIDEO_VP8'video/x-vnd.on2.vp8'表示视频/vp8类型。
AUDIO_AAC"audio/mp4a-latm"表示音频/mp4a-latm类型。
AUDIO_VORBIS'audio/vorbis'表示音频/vorbis类型。
AUDIO_FLAC'audio/flac'表示音频/flac类型。

MediaDescriptionKey8+

媒体信息描述枚举。

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

名称说明
MD_KEY_TRACK_INDEX"track_index"表示轨道序号,其对应键值类型为number。
MD_KEY_TRACK_TYPE"track_type"表示轨道类型,其对应键值类型为number,参考[MediaType]。
MD_KEY_CODEC_MIME"codec_mime"表示codec_mime类型,其对应键值类型为string。
MD_KEY_DURATION"duration"表示媒体时长,其对应键值类型为number,单位为毫秒(ms)。
MD_KEY_BITRATE"bitrate"表示比特率,其对应键值类型为number,单位为比特率(bps)。
MD_KEY_WIDTH"width"表示视频宽度,其对应键值类型为number,单位为像素(px)。
MD_KEY_HEIGHT"height"表示视频高度,其对应键值类型为number,单位为像素(px)。
MD_KEY_FRAME_RATE"frame_rate"表示视频帧率,其对应键值类型为number,单位为100帧每秒(100fps)。
MD_KEY_AUD_CHANNEL_COUNT"channel_count"表示声道数,其对应键值类型为number。
MD_KEY_AUD_SAMPLE_RATE"sample_rate"表示采样率,其对应键值类型为number,单位为赫兹(Hz)。

BufferingInfoType8+

缓存事件类型枚举。

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

名称说明
BUFFERING_START1表示开始缓存。
BUFFERING_END2表示结束缓存。
BUFFERING_PERCENT3表示缓存百分比。
CACHED_DURATION4表示缓存时长,单位为毫秒(ms)。

AudioPlayer

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

属性

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

名称类型可读可写说明
srcstring音频媒体URI,支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。 支持路径示例: 1、fd类型播放:fd://xx 

 2、http网络播放: http://xx 3、hls网络播放路径:开发中 注意事项: 使用媒体素材需要获取读权限,否则无法正常播放。
loopboolean音频循环播放属性,设置为'true'表示循环播放。
currentTimenumber音频的当前播放位置。
durationnumber音频时长。
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();

reset7+

reset(): void

切换播放音频资源。

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

示例:

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

seek

seek(timeMs: number): void

跳转到指定播放位置。

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

参数:

参数名类型必填说明
timeMsnumber指定的跳转时间节点,单位毫秒(ms)。

示例:

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

参数:

参数名类型必填说明
volnumber指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。

示例:

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

release

release(): void

释放音频资源。

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

示例:

audioPlayer.release();
audioPlayer = undefined;

getTrackDescription8+

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<Array<[MediaDescription]>>获取音频轨道信息回调方法。

示例:

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('audio key is ' + item);
        console.info('audio value is ' + property);
    }
}

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

getTrackDescription8+[]()

getTrackDescription(): Promise<Array<MediaDescription>>

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

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

返回值:

类型说明
Promise<Array<[MediaDescription]>>获取音频轨道信息Promise返回值。

示例:

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('audio key is ' + item);
        console.info('audio value is ' + property);
    }
}

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')8+

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

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

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

参数:

参数名类型必填说明
typestring音频缓存事件回调类型,支持的事件:'bufferingUpdate'。
callbackfunction音频缓存事件回调方法。 [BufferingInfoType]为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。

示例:

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

on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')[]()

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

开始订阅音频播放事件。

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

参数:

参数名类型必填说明
typestring播放事件回调类型,支持的事件包括:'play''pause''stop''reset''dataLoad''finish''volumeChange'。 - 'play':完成[play()]调用,音频开始播放,触发该事件。 - 'pause':完成[pause()]调用,音频暂停播放,触发该事件。 - 'stop':完成[stop()]调用,音频停止播放,触发该事件。 - 'reset':完成[reset()]调用,播放器重置,触发该事件。 - 'dataLoad':完成音频数据加载后触发该事件,即src属性设置完成后触发该事件。 - 'finish':完成音频播放后触发该事件。 - 'volumeChange':完成[setVolume()]调用,播放音量改变后触发该事件。
callback() => void播放事件回调方法。

示例:

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 success fd is' + fdPath);
}, (err) => {
   console.info('open fd failed err is' + err);
}).catch((err) => {
   console.info('open fd failed err is' + err);
});
audioPlayer.src = fdPath;  //设置src属性,并触发'dataLoad'事件回调

on('timeUpdate')

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

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

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

参数:

参数名类型必填说明
typestring播放事件回调类型,支持的事件包括:'timeUpdate'。 - 'timeUpdate':[seek()]调用完成,触发该事件。
callbackCallback<number>播放事件回调方法。回调方法入参为成功seek的时间。

示例:

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

参数:

参数名类型必填说明
typestring播放错误事件回调类型,支持的事件包括:'error'。 - 'error':音频播放中发生错误,触发该事件。
callbackErrorCallback播放错误事件回调方法。

示例:

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。

名称类型描述
idlestring音频播放空闲。
playingstring音频正在播放。
pausedstring音频暂停播放。
stoppedstring音频播放停止。
error8+string错误状态。

VideoPlayer8+

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

属性

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

setDisplaySurface8+

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

通过回调方式设置SurfaceId。

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

参数:

参数名类型必填说明
surfaceIdstringSurfaceId
callbackfunction设置SurfaceId的回调方法。

示例:

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

setDisplaySurface8+

setDisplaySurface(surfaceId: string): Promise<void>

通过Promise方式设置SurfaceId。

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

参数:

参数名类型必填说明
surfaceIdstringSurfaceId

返回值:

类型说明
Promise设置SurfaceId的Promise返回值。

示例:

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

prepare8+

prepare(callback: AsyncCallback<void>): void

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

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

参数:

参数名类型必填说明
callbackfunction准备播放视频的回调方法。

示例:

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

prepare8+

prepare(): Promise<void>

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

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

返回值:

类型说明
Promise<void>准备播放视频的Promise返回值。

示例:

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

play8+

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

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

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

参数:

参数名类型必填说明
callbackfunction开始播放视频的回调方法。

示例:

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

play8+

play(): Promise<void>;

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

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

返回值:

类型说明
Promise<void>开始播放视频的Promise返回值。

示例:

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

pause8+

pause(callback: AsyncCallback<void>): void

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

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

参数:

参数名类型必填说明
callbackfunction暂停播放视频的回调方法。

示例:

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

pause8+

pause(): Promise<void>

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

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

返回值:

类型说明
Promise<void>暂停播放视频的Promise返回值。

示例:

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

stop8+

stop(callback: AsyncCallback<void>): void

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

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

参数:

参数名类型必填说明
callbackfunction停止播放视频的回调方法。

示例:

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

stop8+

stop(): Promise<void>

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

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

返回值:

类型说明
Promise<void>停止播放视频的Promise返回值。

示例:

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

reset8+

reset(callback: AsyncCallback<void>): void

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

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

参数:

参数名类型必填说明
callbackfunction切换播放视频的回调方法。

示例:

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

reset8+

reset(): Promise<void>

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

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

返回值:

类型说明
Promise<void>切换播放视频的Promise返回值。

示例:

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

seek8+

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

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

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

参数:

参数名类型必填说明
timeMsnumber指定的跳转时间节点,单位毫秒(ms)。
callbackfunction跳转到指定播放位置的回调方法。

示例:

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

seek8+

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

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

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

参数:

参数名类型必填说明
timeMsnumber指定的跳转时间节点,单位毫秒(ms)。
mode[SeekMode]跳转模式。
callbackfunction跳转到指定播放位置的回调方法。

示例:

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

seek8+

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

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

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

参数:

参数名类型必填说明
timeMsnumber指定的跳转时间节点,单位毫秒(ms)。
mode[SeekMode]跳转模式。

返回值:

类型说明
Promise<void>跳转到指定播放位置的Promise返回值。

示例:

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}`);
});

setVolume8+

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

通过回调方式设置音量。

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

参数:

参数名类型必填说明
volnumber指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。
callbackfunction设置音量的回调方法。

示例:

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

setVolume8+

setVolume(vol: number): Promise<void>

通过Promise方式设置音量。

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

参数:

参数名类型必填说明
volnumber指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。

返回值:

类型说明
Promise<void>设置音量的Promise返回值。

示例:

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

release8+

release(callback: AsyncCallback<void>): void

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

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

参数:

参数名类型必填说明
callbackfunction释放视频资源的回调方法。

示例:

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

release8+

release(): Promise<void>

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

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

返回值:

类型说明
Promise<void>释放视频资源的Promise返回值。

示例:

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

getTrackDescription8+

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<Array<[MediaDescription]>>获取视频轨道信息回调方法。

示例:

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('video key is ' + item);
        console.info('video value is ' + property);
    }
}

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

getTrackDescription8+

getTrackDescription(): Promise<Array<MediaDescription>>

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

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

返回值:

类型说明
Promise<Array<[MediaDescription]>>获取视频轨道信息Promise返回值。

示例:

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('video key is ' + item);
        console.info('video value is ' + property);
    }
}

let arrayDescription;
videoPlayer.getTrackDescription().then((arrlist) => {
    if (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]);
}

setSpeed8+

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

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

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

参数:

参数名类型必填说明
speednumber指定播放视频速度,具体见[PlaybackSpeed]。
callbackfunction设置播放速度的回调方法。

示例:

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

setSpeed8+

setSpeed(speed:number): Promise<number>

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

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

参数:

参数名类型必填说明
speednumber指定播放视频速度,具体见[PlaybackSpeed]。

返回值:

类型说明
Promise<number>通过Promise获取设置结果。

示例:

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

on('playbackCompleted')8+

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

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

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

参数:

参数名类型必填说明
typestring视频播放完成事件回调类型,支持的事件:'playbackCompleted'。
callbackfunction视频播放完成事件回调方法。

示例:

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

on('bufferingUpdate')8+

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

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

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

参数:

参数名类型必填说明
typestring视频缓存事件回调类型,支持的事件:'bufferingUpdate'。
callbackfunction视频缓存事件回调方法。 [BufferingInfoType]为BUFFERING_PERCENT或CACHED_DURATION时,value值有效,否则固定为0。

示例:

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

on('startRenderFrame')8+

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

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

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

参数:

参数名类型必填说明
typestring视频播放首帧送显上报事件回调类型,支持的事件:'startRenderFrame'。
callbackCallback<void>视频播放首帧送显上报事件回调方法。

示例:

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

on('videoSizeChanged')8+

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

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

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

参数:

参数名类型必填说明
typestring视频播放宽高变化事件回调类型,支持的事件:'videoSizeChanged'。
callbackfunction视频播放宽高变化事件回调方法,width表示宽,height表示高。

示例:

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

on('error')8+

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

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

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

参数:

参数名类型必填说明
typestring播放错误事件回调类型,支持的事件包括:'error'。 - 'error':视频播放中发生错误,触发该事件。
callbackErrorCallback播放错误事件回调方法。

示例:

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'事件

VideoPlayState8+

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

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

名称类型描述
idlestring视频播放空闲。
preparedstring视频播放准备。
playingstring视频正在播放。
pausedstring视频暂停播放。
stoppedstring视频播放停止。
errorstring错误状态。

SeekMode8+

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

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

名称描述
SEEK_NEXT_SYNC0表示跳转到指定时间点的下一个关键帧,建议向后快进的时候用这个枚举值。
SEEK_PREV_SYNC1表示跳转到指定时间点的上一个关键帧,建议向前快进的时候用这个枚举值。

PlaybackSpeed8+

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

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

名称描述
SPEED_FORWARD_0_75_X0表示视频播放正常播速的0.75倍。
SPEED_FORWARD_1_00_X1表示视频播放正常播速。
SPEED_FORWARD_1_25_X2表示视频播放正常播速的1.25倍。
SPEED_FORWARD_1_75_X3表示视频播放正常播速的1.75倍。
SPEED_FORWARD_2_00_X4表示视频播放正常播速的2.00倍。

MediaDescription8+

[key : string] : Object

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

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

名称类型说明
keystring通过key值获取对应的value。key值具体可见[MediaDescriptionKey]。
valueany对应key值得value。其类型可为任意类型,具体key对应value的类型可参考[MediaDescriptionKey]的描述信息。

示例:

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]实例。

prepare[]()

prepare(config: AudioRecorderConfig): void

录音准备。

需要权限:  ohos.permission.MICROPHONE

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

参数:

参数名类型必填说明
config[AudioRecorderConfig]配置录音的相关参数,包括音频输出URI、编码格式、采样率、声道数、输出格式等。

示例:

let audioRecorderConfig = {
    audioEncoder : media.AudioEncoder.AAC_LC,
    audioEncodeBitRate : 22050,
    audioSampleRate : 22050,
    numberOfChannels : 2,
    format : media.AudioOutputFormat.AAC_ADTS,
    uri : 'fd://1',       // 文件需先由调用者创建,并给予适当的权限
    location : { latitude : 30, longitude : 130},
}
audioRecorder.on('prepare', () => {    //设置'prepare'事件回调
    console.log('prepare success');
});
audioRecorder.prepare(audioRecorderConfig);

start[]()

start(): void

开始录制,需在[prepare]事件成功触发后,才能调用start方法。

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

示例:

audioRecorder.on('start', () => {    //设置'start'事件回调
    console.log('audio recorder start success');
});
audioRecorder.start();

pause[]()

pause():void

暂停录制,需要在[start]事件成功触发后,才能调用pause方法。

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

示例:

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

resume[]()

resume():void

恢复录制,需要在[pause]事件成功触发后,才能调用resume方法。

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

示例:

audioRecorder.on('resume', () => {    //设置'resume'事件回调
    console.log('audio recorder resume success');
});
audioRecorder.resume();

stop[]()

stop(): void

停止录音。

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

示例:

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

release[]()

release(): void

释放录音资源。

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

示例:

audioRecorder.on('release', () => {    //设置'release'事件回调
    console.log('audio recorder release success');
});
audioRecorder.release();
audioRecorder = undefined;

reset[]()

reset(): void

重置录音。

进行重置录音之前,需要先调用[stop()]停止录音。重置录音之后,需要调用[prepare()]设置录音参数项,才能再次进行录音。

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

示例:

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

on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset')[]()

on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset', callback: () => void): void

开始订阅音频录制事件。

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

参数:

参数名类型必填说明
typestring录制事件回调类型,支持的事件包括:'prepare''start''pause'’resume‘'stop''release''reset'。 - 'prepare' :完成[prepare]调用,音频录制参数设置完成,触发该事件。 - 'start' :完成[start]调用,音频录制开始,触发该事件。 - 'pause': 完成[pause]调用,音频暂停录制,触发该事件。 - 'resume': 完成[resume]调用,音频恢复录制,触发该事件。 - 'stop' :完成[stop]调用,音频停止录制,触发该事件。 - 'release' :完成[release]调用,音频释放录制资源,触发该事件。 - 'reset':完成[reset]调用,音频重置为初始状态,触发该事件。
callback()=>void录制事件回调方法。

示例:

let audiorecorder = media.createAudioRecorder();                                  // 创建一个音频录制实例
let audioRecorderConfig = {
    audioEncoder : media.AudioEncoder.AAC_LC, ,
    audioEncodeBitRate : 22050,
    audioSampleRate : 22050,
    numberOfChannels : 2,
    format : media.AudioOutputFormat.AAC_ADTS,
    uri : 'fd://xx',                                                            // 文件需先由调用者创建,并给予适当的权限
    location : { latitude : 30, longitude : 130},
}
audioRecorder.on('error', (error) => {                                             // 设置'error'事件回调
    console.info(`audio error called, 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

参数:

参数名类型必填说明
typestring录制错误事件回调类型'error'。 - 'error':音频录制过程中发生错误,触发该事件。
callbackErrorCallback录制错误事件回调方法。

示例:

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(deprecated)[AudioEncoder]音频编码格式,默认设置为AAC_LC。 说明:  从API Version 8 开始废弃,建议使用audioEncoderMime替代。
audioEncodeBitRatenumber音频编码比特率,默认值为48000。
audioSampleRatenumber音频采集采样率,默认值为48000。
numberOfChannelsnumber音频采集声道数,默认值为2。
format(deprecated)[AudioOutputFormat]音频输出封装格式,默认设置为MPEG_4。 说明:  从API Version 8 开始废弃,建议使用fileFormat替代。
location[Location]音频采集的地理位置。
uristring音频输出URI:fd://xx (fd number) 

 文件需要由调用者创建,并赋予适当的权限。
audioEncoderMime8+[CodecMimeType]音频编码格式。
fileFormat8+[ContainerFormatType]音频编码格式。

AudioEncoder(deprecated)

说明:  从 API Version 8 开始废弃,建议使用[CodecMimeType]替代。

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

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

名称默认值说明
DEFAULT0默认编码格式。 仅做接口定义,暂不支持使用。
AMR_NB1AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。 仅做接口定义,暂不支持使用。
AMR_WB2AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。 仅做接口定义,暂不支持使用。
AAC_LC3AAC-LC(Advanced Audio Coding Low Complexity)编码格式。
HE_AAC4HE_AAC(High-Efficiency Advanced Audio Coding)编码格式。 仅做接口定义,暂不支持使用。

AudioOutputFormat(deprecated)

说明:  从 API Version 8 开始废弃,建议使用[ContainerFormatType]替代。

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

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

名称默认值说明
DEFAULT0默认封装格式。 仅做接口定义,暂不支持使用。
MPEG_42封装为MPEG-4格式。
AMR_NB3封装为AMR_NB格式。 仅做接口定义,暂不支持使用。
AMR_WB4封装为AMR_WB格式。 仅做接口定义,暂不支持使用。
AAC_ADTS6封装为ADTS(Audio Data Transport Stream)格式,是AAC音频的传输流格式。

VideoRecorder9+

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

属性

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

名称类型可读可写说明
state9+[VideoRecordState]视频录制的状态。

prepare9+[]()

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

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

需要权限:  ohos.permission.MICROPHONE

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

参数:

参数名类型必填说明
config[VideoRecorderConfig]配置视频录制的相关参数。
callbackAsyncCallback<void>异步视频录制prepare方法的回调方法。

示例:

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

prepare9+[]()

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

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

需要权限:  ohos.permission.MICROPHONE,ohos.permission.CAMERA

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

参数:

参数名类型必填说明
config[VideoRecorderConfig]配置视频录制的相关参数。

返回值:

类型说明
Promise<void>异步视频录制prepare方法的Promise返回值。

示例:

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

getInputSurface9+

getInputSurface(callback: AsyncCallback<string>): void;

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

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<string>异步获得surface的回调方法。

示例:

// 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);
    }
});

getInputSurface9+

getInputSurface(): Promise<string>;

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

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

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

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

返回值:

类型说明
Promise<string>异步获得surface的Promise返回值。

示例:

// 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);
});

start9+[]()

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

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<void>异步开始视频录制的回调方法。

示例:

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

start9+[]()

start(): Promise<void>;

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

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

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

返回值:

类型说明
Promise<void>异步开始视频录制方法的Promise返回值。

示例:

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

pause9+[]()

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

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<void>异步暂停视频录制的回调方法。

示例:

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

pause9+[]()

pause(): Promise<void>;

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

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

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

返回值:

类型说明
Promise<void>异步暂停视频录制方法的Promise返回值。

示例:

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

resume9+[]()

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<void>异步恢复视频录制的回调方法。

示例:

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

resume9+[]()

resume(): Promise<void>;

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

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

返回值:

类型说明
Promise<void>异步恢复视频录制方法的Promise返回值。

示例:

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

stop9+[]()

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

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<void>异步停止视频录制的回调方法。

示例:

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

stop9+[]()

stop(): Promise<void>;

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

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

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

返回值:

类型说明
Promise<void>异步停止视频录制方法的Promise返回值。

示例:

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

release9+[]()

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<void>异步释放视频录制资源的回调方法。

示例:

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

release9+[]()

release(): Promise<void>;

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

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

返回值:

类型说明
Promise<void>异步释放视频录制资源方法的Promise返回值。

示例:

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

reset9+[]()

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

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

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

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

参数:

参数名类型必填说明
callbackAsyncCallback<void>异步重置视频录制的回调方法。

示例:

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

reset9+[]()

reset(): Promise<void>;

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

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

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

返回值:

类型说明
Promise<void>异步重置视频录制方法的Promise返回值。

示例:

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

on('error')9+

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

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

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

参数:

参数名类型必填说明
typestring录制错误事件回调类型'error'。 - 'error':视频录制过程中发生错误,触发该事件。
callbackErrorCallback录制错误事件回调方法。

示例:

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接口出错时通过此订阅事件上报

VideoRecordState9+

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

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

名称类型描述
idlestring视频录制空闲。
preparedstring视频录制参数设置完成。
playingstring视频正在录制。
pausedstring视频暂停录制。
stoppedstring视频录制停止。
errorstring错误状态。

VideoRecorderConfig9+

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

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

名称参数类型必填说明
audioSourceType[AudioSourceType]视频录制的音频源类型。
videoSourceType[VideoSourceType]视频录制的视频源类型。
profile[VideoRecorderProfile]视频录制的profile。
rotationnumber录制视频的旋转角度。
location[Location]录制视频的地理位置。
urlstring视频输出URL:fd://xx (fd number) 

 文件需要由调用者创建,并赋予适当的权限。

AudioSourceType9+

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

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

名称说明
AUDIO_SOURCE_TYPE_DEFAULT0默认的音频输入源类型。
AUDIO_SOURCE_TYPE_MIC1表示MIC的音频输入源。

VideoSourceType9+

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

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

名称说明
VIDEO_SOURCE_TYPE_SURFACE_YUV0输入surface中携带的是raw data。
VIDEO_SOURCE_TYPE_SURFACE_ES1输入surface中携带的是ES data。

VideoRecorderProfile9+

视频录制的配置文件。

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

名称参数类型必填说明
audioBitratenumber音频编码比特率。
audioChannelsnumber音频采集声道数。
audioCodec[CodecMimeType]音频编码格式。
audioSampleRatenumber音频采样率。
fileFormat[ContainerFormatType]文件的容器格式。
videoBitratenumber视频编码比特率。
videoCodec[CodecMimeType]视频编码格式。
videoFrameWidthnumber录制视频帧的宽。
videoFrameHeightnumber录制视频帧的高。
videoFrameRatenumber录制视频帧率。

ContainerFormatType8+

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

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

名称说明
CFT_MPEG_4"mp4"视频的容器格式,MP4。
CFT_MPEG_4A"m4a"音频的容器格式,M4A。HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿

搜狗高速浏览器截图20240326151450.png

Location

视频录制的地理位置。

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

名称参数类型必填说明
latitudenumber地理位置的纬度。
longitudenumber地理位置的经度。

鸿蒙最值得程序员入行

为什么这么说?市场是决定人力需求的,数据说话最管用:

1、鸿蒙其全栈自研,头部大厂商都陆续加入合作开发鸿蒙原生应用——人才需求上涨

2、鸿蒙作为新系统、新技术,而现在市面上技术人才少——高薪招聘开启

3、鸿蒙1+8+N生态,不仅只有应用开发;还有车载、数码、智能家居、家电等——就业范围广

4、纯血鸿蒙,目前没有多少人熟悉。都处于0基础同一起跑线——无行业内卷

开发者最需要什么?岗位多、薪资高、不内卷、行业竞争低。而当下的鸿蒙恰恰符合要求。

那么这么好的鸿蒙岗位,应聘要求都很高吧?其实不然鸿蒙作为新出的独立系统,其源头上大家都处于同一水平线上,一开始的技术要求都不会很高,毕竟面试官也是刚起步学习。招聘要求示例:

从信息看出,几乎应职要求是对标有开发经验的人群。可以说鸿蒙对开发者非常友好,尽管上面没提鸿蒙要求,但是面试都会筛选具有鸿蒙开发技能的人。我们程序员都知道学习开发技术,最先是从语言学起,鸿蒙语言有TS、ArkTS等语法,那么除了这些基础知识之外,其核心技术点有那些呢?下面就用一张整理出的鸿蒙学习路线图表示:

从上面的OpenHarmony技术梳理来看,鸿蒙的学习内容也是很多的。现在全网的鸿蒙学习文档也是非常的少,下面推荐一些:完整内容可在头像页保存,或这qr23.cn/AKFP8k甲助力

内容包含:《鸿蒙NEXT星河版开发学习文档》

  • ArkTS
  • 声明式ArkUI
  • 多媒体
  • 通信问题
  • 系统移植
  • 系统裁剪
  • FW层的原理
  • 各种开发调试工具
  • 智能设备开发
  • 分布式开发等等。

这些就是对往后开发者的分享,希望大家多多点赞关注喔!

  • 11
    点赞
  • 22
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值