• 实时音视频
    • 实时音视频>客户端 API>C++

    全平台 (C++)

    编辑文档 更新于
    概况BRTCBRTCCallBackBRTCDeviceManagerBRTCMediaPlayerManager对象和枚举错误码

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

    BRTCMediaPlayerManager

    此类从 BRTC C++ SDK 3.6 版本开始支持。

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

    结构体类型

    函数列表 含义
    MediaSource 媒体文件信息
    BRTCMediaPlayerState 播放状态
    BRTCMediaPlayerReason 判断播放异常时的具体原因
    BRTCMediaPlayerEvent 播放事件回调
    BRTCMediaPlayerStats 播放实时统计信息
    BRTCPlayerStreamInfo 流信息回调通知

    BRTCMediaPlayerListener

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

    详细信息

    setObserver
    设置媒体流回调事件监听器，接收各种事件和回调

    virtual int setObserver(BRTCMediaPlayerObserver* observer) = 0;

    参数

    名称 描述
    observer 参考 BRTCMediaPlayerObserver

    详情

    说明

    建议在获取到 BRTCMediaPlayerManager 后就立刻设置事件监听，以免错过关键回调或事件通知。

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

    virtual int open(MediaSource* source) = 0;

    参数

    名称 描述
    source 参考 MediaSource

    返回

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

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

    virtual int play(int playerId) = 0;

    参数

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

    返回

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

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

    virtual int stop(int playerId) = 0;

    参数

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

    返回

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

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

    virtual int seek(int playerId, long newPos) = 0;

    参数

    名称 描述
    playerId 媒体文件唯一 ID，在 MediaSource 中设置
    newPos 跳转位置，单位毫秒

    返回

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

    pause
    暂停播放

    virtual int pause(int playerId) = 0;

    参数

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

    返回

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

    resume
    恢复播放

    virtual int resume(int playerId) = 0;

    参数

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

    返回

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

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

    virtual int setVideoView(int playerId, BRTCView view) = 0;

    参数

    名称 描述
    playerId 媒体文件唯一 ID，在 MediaSource 中设置
    view 视频显示窗口句柄

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

    virtual int muteAudio(int playerId, bool muted) = 0;

    参数

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

    详情

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

    setAudioPublishVolume
    设置音频推流音量

    virtual int setAudioPublishVolume(int playerId, int volume) = 0;

    参数

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

    详情

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

    setAudioPlayoutVolume
    设置播放音量

    virtual int setAudioPlayoutVolume(int playerId, int volume) = 0;

    参数

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

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

    virtual int setAllAudioVolume(int playerId, int volume) = 0;

    参数

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

    getCurrentPlayPosInMS
    获取当前播放位置

    virtual long getCurrentPlayPosInMS(int playerId) = 0;

    参数

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

    返回

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

    getDurationInMS
    获取当前媒体文件时长

    virtual long getDurationInMS(int playerId) = 0;

    参数

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

    返回

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

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

    onPlayerStateChanged
    播放状态发生变化

    virtual void onPlayerStateChanged(int playerId, BRTCMediaPlayerState state, BRTCMediaPlayerReason reason,
                                      const char* msg) = 0;

    参数

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

    onPlayProgress
    播放进度通知

    virtual void onPlayProgress(int playerId, long curPtsMS, long durationMS) = 0;

    参数

    名称 描述
    playerId 媒体文件唯一 ID，在 MediaSource 中设置
    curPtsMS 当前播放位置，单位毫秒
    durationMS 总播放时长，单位毫秒

    onPlayBufferUpdated
    播放缓冲区更新通知

    virtual void onPlayBufferUpdated(int playerId, long playCachedBuffer) = 0;

    参数

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

    onPlayerEvent
    播放事件通知

    virtual void onPlayerEvent(int playerId, BRTCMediaPlayerEvent event, long elapsedTime, const char* msg) = 0;

    参数

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

    onPlayerMediaStats
    播放实时统计信息

    virtual void onPlayerMediaStats(int playerId, const BRTCMediaPlayerStats& stats) = 0;

    参数

    名称 描述
    playerId 媒体文件唯一 ID，在 MediaSource 中设置
    stats 播放统计信息，参考BRTCMediaPlayerStats

    onStreamInfo
    流信息回调通知

    virtual void onStreamInfo(int playerId, const BRTCPlayerStreamInfo& info) = 0;

    参数

    名称 描述
    playerId 媒体文件唯一 ID，在 MediaSource 中设置
    info 媒体流信息，参考BRTCPlayerStreamInfo

    MediaSource
    媒体文件信息

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

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

    BRTCMediaPlayerState
    播放状态

    枚举值 含义
    PLAYER_STATE_IDLE 空闲状态，在打开媒体文件之前和结束播放之后返回该状态码
    PLAYER_STATE_OPENING 正在打开
    PLAYER_STATE_OPEN_COMPLETED 在调用 open 方法后，如果状态变为此状态表示打开成功，可以播放了
    PLAYER_STATE_PLAYING 正在播放
    PLAYER_STATE_PAUSED 播放暂停
    PLAYER_STATE_PLAY_COMPLETED 播放完毕
    PLAYER_STATE_STOPPED 播放停止
    PLAYER_STATE_FAILED 播放失败了，此时请参考 BRTCMediaPlayerReason

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

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

    BRTCMediaPlayerEvent
    播放事件

    枚举值 含义
    PLAYER_EVENT_FIRST_DISPLAYED 视频首帧出图
    PLAYER_EVENT_BUFFER_LOW 当前缓冲的数据不足以支持播放
    PLAYER_EVENT_BUFFER_RECOVER 当前缓冲的数据刚好能支持播放
    PLAYER_EVENT_SEEK_COMPLETE 跳转播放位置完成
    PLAYER_EVENT_SEEK_ERROR 跳转播放位置出错

    BRTCMediaPlayerStats
    播放实时统计信息

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

    BRTCPlayerStreamInfo
    媒体流信息

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