• 实时音视频
    • 实时音视频>客户端 API>HarmonyOS

    HarmonyOS

    编辑文档 更新于
    API 概览BRTCBrtcListenerBrtcDeviceManagerBrtcBeautyManagerBrtcAudioEffectManagerBrtcMediaPlayerManager枚举和类常见问题

    BRTC 用于播放来自本地或网络媒体文件（如 mp4）并作为实时流传输的管理类。

    BrtcMediaPlayerManager

    函数列表 含义
    open 打开一个本地或网络的媒体文件，并设置配置参数
    play 播放（并推流）指定 ID 的媒体文件
    stop 停止播放并取消推流指定 ID 的媒体文件
    seek 跳转到指定位置
    pause 暂停播放
    resume 恢复播放
    setMediaPlayerView 设置媒体文件视频画面回显视图
    muteAudio 对媒体文件中的音频进行静音/取消静音
    setPublishVolume 设置音频推流音量
    setPlayoutVolume 设置播放音量
    setAllVolume 同时设置推流和播放音量
    getCurrentPlayPosInMs 获取当前播放位置
    getDurationInMs 获取当前媒体文件时长
    on 设置媒体流回调事件监听器，接收各种事件和回调
    off 取消设置媒体流回调事件监听器

    结构体类型

    函数列表 含义
    BrtcMediaSource 媒体文件信息
    BrtcMediaPlayerState 播放状态
    BrtcMediaPlayerReason 判断播放异常时的具体原因
    BRTCMediaPlayerEvent 播放事件回调
    BrtcMediaPlayerStatistics 播放实时统计信息
    BrtcMediaPlayerStreamInfo 媒体流信息

    BRTCMediaPlayerListener

    函数列表 含义
    onPlayerStateChanged 播放状态发生变化
    onPlayProgress 播放进度通知
    onPlayBufferUpdated 播放缓冲区更新通知
    onPlayerEvent 播放事件通知
    onPlayerMediaStats 播放实时统计信息
    onStreamInfo 流信息回调通知

    详细信息

    open
    打开一个本地或网络的媒体文件，并设置配置参数

    open(source: BrtcMediaSource): number;

    参数

    名称 描述
    source 参考 BrtcMediaSource

    返回

    0 表示函数调用成功，非 0 表示函数执行错误。注意，打开文件如果发生失败，将会通过回调事件单独通知具体原因。

    play
    播放（并推流）指定 ID 的媒体文件

    play(id: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置

    返回

    0 表示函数调用成功，非 0 表示函数执行错误。

    stop
    停止播放并取消推流指定 ID 的媒体文件

    stop(id: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置

    返回

    0 表示函数调用成功，非 0 表示函数执行错误。

    seek
    跳转到指定位置继续播放

    seek(id: number, ptsMs: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    ptsMs 跳转位置，单位毫秒

    返回

    0 表示函数调用成功，非 0 表示函数执行错误。

    pause
    暂停播放

    pause(id: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置

    返回

    0 表示函数调用成功，非 0 表示函数执行错误。

    resume
    恢复播放

    resume(id: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置

    返回

    0 表示函数调用成功，非 0 表示函数执行错误。

    setMediaPlayerView
    设置媒体文件视频画面回显视图

    setMediaPlayerView(id: number, viewId: string): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    view 自定义视图基类。使用时需要创建的具体类是 BRTCAdaptCanvas

    详情

    • BRTCVideoView 是 BRTC Android SDK 自定义视图基类，实际使用时，请创建BRTCAdaptCanvas
    • 使用 BRTCVideoView.getView() 方法将获得一个 FrameLayout，请将此 FrameLayout 填充到您的视图容器充满显示
    • 在 SDK 内部实现中，FrameLayout 中不允许添加多个子视图，这要求您不可以在不同的视频画面上复用同一个 BRTCVideoView。例如，用于回显摄像头画面的，和媒体文件画面，需要创建两个不同的 BRTCAdaptCanvas

    muteAudio
    对媒体文件中的音频进行静音/取消静音

    muteAudio(id: number, mute: boolean): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    mute true 表示静音，false表示取消静音。

    详情

    • 设置静音后，本地和远端将都无法听到此媒体文件的声音

    setPublishVolume
    设置音频推流音量

    setPublishVolume(id: number, volume: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    volume 音量大小，取值范围为 0 - 150

    详情

    • 该接口可以设置推流到远端的音量，也就是拉流端可以听到的音量大小
    • 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 设置成 最大值150。但超过 100 的 volume 会有爆音的风险

    setPlayoutVolume
    设置播放音量

    setPlayoutVolume(id: number, volume: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    volume 音量大小，取值范围为 0 - 150

    setAllVolume
    同时设置推流和播放音量

    setAllVolume(id: number, volume: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    volume 音量大小，取值范围为 0 - 150

    getCurrentPlayPosInMs
    获取当前播放位置

    getCurrentPlayPosInMs(id: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置

    返回

    调用接口时的播放位置（毫秒）

    getDurationInMs
    获取当前媒体文件时长

    getDurationInMs(id: number): number;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置

    返回

    调用接口时的播放位置（毫秒）

    返回

    指定媒体文件的总时长（毫秒）

    BrtcMusicPlayListener
    媒体文件的各种事件回调监听，包括：

    onPlayerStateChanged
    播放状态发生变化

    onPlayerStateChanged(id: number, state: BrtcMediaPlayerState, reason: BrtcMediaPlayerReason, message: string): void

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    state 播放状态，参考 BrtcMediaPlayerState
    reason 播放出现异常时的具体原因，参考 BrtcMediaPlayerReason
    message 扩展信息描述，不一定有内容（空字符串）。

    onPlayProgress
    播放进度通知

    onPlayProgress(id: number, curPtsMs: number, durationMs: number): void;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    curPtsMs 当前播放位置，单位毫秒
    durationMs 总播放时长，单位毫秒

    onPlayBufferUpdated
    播放缓冲区更新通知

    onPlayBufferUpdated(id: number, playCachedBuffer: number): void;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    playCachedBuffer 当前缓冲的数据能支持的播放时间，单位毫秒

    onPlayerEvent
    播放事件通知

    onPlayerEvent(id: number, event: BrtcMediaPlayerEvent, elaspedTimeMs: number, message: string): void;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    event 事件名称，参考BRTCMediaPlayerEvent
    elaspedTimeMs 已经播放的时间，单位毫秒
    message 扩展信息描述，不一定有内容（空字符串）。

    onPlayerMediaStats
    播放实时统计信息

    onPlayerMediaStats(id: number, statistics: BrtcMediaPlayerStatistics): void;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    statistics 播放统计信息，参考BrtcMediaPlayerStatistics

    onStreamInfo
    流信息回调通知

    onStreamInfo(id: number, streamInfo: BrtcMediaPlayerStreamInfo): void;

    参数

    名称 描述
    id 媒体文件唯一 ID，在 BrtcMediaSource 中设置
    streamInfo 媒体流信息，参考BrtcMediaPlayerStreamInfo

    BrtcMediaSource
    媒体文件信息

    在调用 open 方法时，您需要指定媒体源的一些具体信息，例如唯一性 ID，文件 URL，循环次数，是否自动播放，以及视频编码参数等。

    名称 描述
    id 您需要为打开的媒体文件创建一个唯一 ID，并在此后调用的每个接口中传入此 ID。
    path 媒体文件的本地完整路径或网络文件 URL 地址
    loopCount 循环播放的次数。-1 表示无限次循环
    publish 是否将媒体文件推流到远端
    true: 在本地播放的同时也进行推流
    false: 只在本地播放，不推流
    startTimeMs 播放的起始位置，单位毫秒
    autoPlay 媒体文件打开后是否自动开始播放。true 表示播放，false 表示不播放
    videoEncodeWidth 视频编码宽度，如不设置，则由 SDK 自行选择
    videoEncodeHeight 视频编码高度，如不设置，则由 SDK 自行选择
    videoEncodeFps 视频编码帧率，如不设置，则由 SDK 自行选择
    videoEncodeBitrate 视频编码码率，如不设置，则由 SDK 自行选择

    BrtcMediaPlayerState
    播放状态

    枚举值 含义
    IDLE 空闲状态，在打开媒体文件之前和结束播放之后返回该状态码
    OPENING 正在打开
    OPEN_COMPLETED 在调用 open 方法后，如果状态变为此状态表示打开成功，可以播放了
    PLAYING 正在播放
    PAUSED 播放暂停
    PLAY_COMPLETED 播放完毕
    STOPPED 播放停止
    FAILED 播放失败了，此时请参考 BrtcMediaPlayerReason

    BrtcMediaPlayerReason
    判断播放异常时的具体原因

    枚举值 含义
    NONE 无异常
    INVALID_ARGUMENTS 参数不合法
    OBJ_NOT_INITIALIZED 函数执行时，相关对象尚未初始化完毕。
    SRC_BUFFER_UNDERFLOW 播放缓冲区数据不足
    CODEC_NOT_SUPPORTED 媒体文件的格式不支持
    UNKNOWN 未知错误

    BRTCMediaPlayerEvent
    播放事件

    枚举值 含义
    FIRST_DISPLAYED 视频首帧出图
    BUFFER_LOW 当前缓冲的数据不足以支持播放
    BUFFER_RECOVER 当前缓冲的数据刚好能支持播放
    SEEK_COMPLETE 跳转播放位置完成
    SEEK_ERROR 跳转播放位置出错

    BrtcMediaPlayerStatistics
    播放实时统计信息

    枚举值 含义
    frameRate 帧率
    videoBitrate 视频码率
    audioBitrate 音频码率
    totalBitrate 总码率

    BrtcMediaPlayerStreamInfo
    媒体流信息

    枚举值 含义
    hasVideo 帧率
    hasAudio 视频码率
    videoWidth 音频码率
    videoHeight 总码率
    audioSampleRate 音频采样率
    audioChannels 音频通道数
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论