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

    iOS

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

    BRTC 媒体文件播放接口

    数据类型

    BRTCMediaPlayerState
    播放器的状态

    变量名 值 描述
    BRTCMediaPlayerState_IDLE 0 空闲, 播放器会在你打开媒体文件之前和结束播放之后返回该状态码
    BRTCMediaPlayerState_OPENING 1 正在打开媒体文件
    BRTCMediaPlayerState_OPEN_COMPLETED 2 成功打开媒体文件
    BRTCMediaPlayerState_PLAYING 3 正在播放
    BRTCMediaPlayerState_PAUSED 4 暂停播放
    BRTCMediaPlayerState_COMPLETED 5 播放完毕
    BRTCMediaPlayerState_STOPPED 6 播放已停止
    BRTCMediaPlayerState_FAILED 7 播放失败

    BRTCMediaPlayerReason
    播放器状态改变的原因

    变量名 值 描述
    BRTCMediaPlayerReason_NONE 0 没有错误
    BRTCMediaPlayerReason_INVALID_ARGUMENTS 1 无效的参数
    BRTCMediaPlayerReason_OBJ_NOT_INITIALIZED 2 对象未初始化
    BRTCMediaPlayerReason_SRC_BUFFER_UNDERFLOW 3 播放缓冲区数据不足
    BRTCMediaPlayerReason_CODEC_NOT_SUPPORTED 4 解码器不支持该 codec
    BRTCMediaPlayerReason_UNKNOWN 5 未知错误

    BRTCMediaPlayerEvent
    播放器的事件类型

    变量名 值 描述
    BRTCMediaPlayerEvent_FIRST_DISPLAYED 0 视频首帧出图
    BRTCMediaPlayerEvent_BUFFER_LOW 1 当前缓冲的数据不足以支持播放
    BRTCMediaPlayerEvent_BUFFER_RECOVER 2 当前缓冲的数据刚好能支持播放
    BRTCMediaPlayerEvent_SEEK_COMPLETE 3 seek 完成
    BRTCMediaPlayerEvent_SEEK_ERROR 4 seek 出错

    BRTCPlayerStreamInfo
    播放器媒体流信息

    变量名 类型 说明
    hasVideo BOOL 是否有视频
    hasAudio BOOL 是否有音频
    videoWidth int 视频宽度
    videoHeight int 视频高度
    audioSampleRate int 音频采样率
    audioChannels int 音频声道

    BRTCMediaPlayerStats
    播放器音视频统计信息

    变量名 类型 说明
    frameRate int 视频帧率
    videoBitrate int 视频码率，单位Kbps
    audioBitrate int 音频码率，单位Kbps
    totalBitrate int 总码率，单位Kbps

    BRTCMediaPlayerSource
    播放器媒体源

    变量名 类型 说明
    playerId int 播放器 ID
    path NSString 媒体路径，本地文件的绝对路径 或者 网络媒体 url
    loopCount int 媒体循环播放的次数, / 0: 表示播放一次；1 表示播放两次；以此类推, -1: 无限循环播放。/ 默认取值 0: 表示播放一次
    publish BOOL 是否将媒体传到远端, true：媒体在本地播放的同时，会上行至云端，因此远端用户也能看到听到该媒体; false：媒体不会上行至云端，因此只能在本地看到听到该媒体。 默认取值 false
    startTimeMS long 媒体开始播放时间点，单位毫秒
    autoPlay BOOL 打开媒体文件后，是否开启自动播放, true：开启自动播放；false：关闭自动播放。默认取值 true, 不用再调用 play 接口
    videoEncodeWidth int 播放器中的流推送到 rtc 房间内编码的宽度
    videoEncodeHeight int 播放器中的流推送到 rtc 房间内编码的高度
    videoEncodeFps int 播放器中的流推送到 rtc 房间内编码的帧率
    videoEncodeBitrate int 播放器中的流推送到 rtc 房间内编码的码率

    媒体播放器事件回调

    BRTCMediaPlayerDelegate
    播放器事件回调

    回调 描述
    onPlayerStateChanged 播放器状态变更回调
    onPlayProgress 当前媒体资源播放进度回调
    onPlayBufferUpdated 当前缓冲数据能播放的时间
    onPlayerEvent 播放器事件回调
    onPlayerMediaStats 播放器媒体统计信息
    onStreamInfo 播放器媒体流信息

    onPlayerStateChanged
    播放器状态变更回调

    - (void)onPlayerStateChanged:(int)playerId
                       state:(BRTCMediaPlayerState)state
                      reason:(BRTCMediaPlayerReason)reason
                         msg:(NSString *)msg;

    参数

    名称 描述
    playerId 播放器 ID
    state 状态码
    reason 原因码
    msg 附加信息

    onPlayProgress
    当前媒体资源播放进度回调

    - (void)onPlayProgress:(int)playerId curPtsMS:(long)curPtsMS durationMS:(long)durationMS;

    参数

    名称 描述
    playerId 播放器 ID
    curPtsMS 当前播放进度，单位毫秒
    durationMS 当前媒体资源总时长，单位毫秒

    onPlayBufferUpdated
    当前缓冲数据能播放的时间

    - (void)onPlayBufferUpdated:(int)playerId playCachedBuffer:(long)playCachedBuffer;

    参数

    名称 描述
    playerId 播放器 ID
    playCachedBuffer 当前缓冲的数据能支持的播放时间，单位毫秒

    详情

    • SDK 每隔 1 秒会自动触发该回调
    • 当缓冲数据支持的播放时间小于 0 时，返回 BRTCMediaPlayerEvent_BUFFER_LOW 事件
    • 当缓冲数据支持的播放时间大于 0 时，返回 BRTCMediaPlayerEvent_BUFFER_RECOVER 事件

    onPlayerEvent
    播放器事件回调

    - (void)onPlayerEvent:(int)playerId
                event:(BRTCMediaPlayerEvent)event
          elapsedTime:(long)elapsedTime
                  msg:(NSString *)msg;

    参数

    名称 描述
    playerId 播放器 ID
    event 事件类型
    elapsedTime 事件发生的时间，单位毫秒
    msg 附加信息

    onPlayerMediaStats
    播放器媒体统计信息

    - (void)onPlayerMediaStats:(int)playerId stats:(BRTCMediaPlayerStats *)stats;

    参数

    名称 描述
    playerId 播放器 ID
    stats 媒体流信息，主要包括码率、帧率等信息

    详情

    • SDK 每隔 2 秒会自动触发该回调

    onStreamInfo
    播放器媒体流信息

    - (void)onStreamInfo:(int)playerId info:(BRTCPlayerStreamInfo *)info;

    参数

    名称 描述
    playerId 播放器 ID
    info 媒体流信息，主要包括宽高、音频采样率、声道数等

    函数列表

    函数列表 描述
    delegate 设置事件回调
    setVideoRenderer 设置视频显示窗口
    open 打开媒体资源
    play 开始播放
    stop 停止播放
    seek 定位到媒体文件的指定播放位置
    pause 暂停播放
    resume 恢复播放
    muteAudio 设置是否静音
    setAllAudioVolume 同时设置该媒体中音频的本地音量和远端音量的大小
    setAudioPublishVolume 设置播放器中音频在远端听到的音量的大小
    setAudioPlayoutVolume 设置播放器中音频在本地播放音量的大小
    getCurrentPlayPosInMS 获取当前播放进度
    getDurationInMS 获取媒体文件的总时长

    详细信息

    delegate
    设置事件回调

    @property (nonatomic, weak) id<BRTCMediaPlayerDelegate> delegate;

    setVideoRenderer
    设置视频显示窗口

    - (int)setVideoRenderer:(int)playerId view:(BRTCView *)view;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID
    view 视频显示窗口

    open
    打开媒体资源

    - (int)open:(BRTCMediaPlayerSource *)source

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    source 媒体资源参数

    play
    开始播放

    - (int)play:(int)playerId;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID

    详情

    • 必须等待 onPlayerStateChanged 回调 BRTCMediaPlayerState_OPEN_COMPLETED 后才可以调用

    stop
    停止播放

    - (int)stop:(int)playerId;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID

    详情

    • 停止播放后，如需重新播放，需要重新调用 open, 非 autoPlay 的，还需要再调用 play 开始播放

    seek
    定位到媒体文件的指定播放位置（单位：毫秒）

    - (int)seek:(int)playerId newPos:(long)newPos;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID
    newPos 指定的播放位置（单位：毫秒）

    详情

    • 如果在播放过程中调用该接口，SDK 会自动从指定位置开始播放
    • 如果在暂停状态下调用该接口，SDK 会定位到您指定的位置，如需播放，请调用 resume

    pause
    暂停播放

    - (int)pause:(int)playerId;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID

    resume
    恢复播放

    - (int)resume:(int)playerId;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID

    muteAudio
    设置是否静音

    - (int)muteAudio:(int)playerId muted:(BOOL)muted;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID
    muted true: 静音 false: 取消静音

    setAllAudioVolume
    同时设置该媒体中音频的本地音量和远端音量的大小

    - (int)setAllAudioVolume:(int)playerId volume:(int)volume;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID
    volume 音量大小，取值范围为0 - 100，默认值：100

    详情

    • 本地音量：即主播本地可以听到的播放音量大小。
    • 远端音量：即观众端可以听到的音频的音量大小。
    • 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。

    setAudioPublishVolume
    设置播放器中音频在远端听到的音量的大小

    - (int)setAudioPublishVolume:(int)playerId volume:(int)volume;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID
    volume 音量大小，取值范围为0 - 100，默认值：100

    详情

    • 观众端可听到的音频的音量大小。
    • 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。

    setAudioPlayoutVolume
    设置播放器中音频在本地播放音量的大小

    - (int)setAudioPlayoutVolume:(int)playerId volume:(int)volume;

    返回

    • 0: 设置成功, <0: 设置失败

    参数

    名称 描述
    playerId 播放器 ID
    volume 音量大小，取值范围为0 - 100，默认值：100

    详情

    • 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。

    getCurrentPlayPosInMS
    获取当前播放进度（单位：毫秒）

    - (long)getCurrentPlayPosInMS:(int)playerId;

    返回

    • 成功返回当前播放时间，单位：毫秒，失败返回 -1

    参数

    名称 描述
    playerId 播放器 ID

    getDurationInMS
    获取媒体文件总时长（单位：毫秒）

    - (long)getDurationInMS:(int)playerId;

    返回

    • 成功返回媒体文件总时长，单位：毫秒，失败返回 -1

    参数

    名称 描述
    playerId 播放器 ID
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论