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

    UniApp

    编辑文档 更新于
    BRTC

    BRTC

    基础接口

    函数列表 描述
    sharedInstance 创建单例
    destroySharedInstance 释放单例
    on 监听事件
    off 取消监听事件

    房间相关接口

    函数列表 描述
    enterRoom 进入房间
    exitRoom 离开房间
    switchRole 切换角色
    callExperimentalAPI 调用实验性接口

    音视频相关接口

    函数列表 描述
    startLocalPreview 开启本地摄像头的预览画面
    stopLocalPreview 停止摄像头预览
    switchCamera 切换摄像头
    startLocalAudio 开启本地音频的采集和发布
    stopLocalAudio 停止本地音频的采集和发布
    muteLocalAudio 暂停/恢复发布本地的音频流
    muteLocalVideo 暂停/恢复发布本地的视频流
    setAudioRoute 设置音频路由
    startRemoteView 订阅远端用户的视频流，并绑定视频渲染控件
    stopRemoteView 停止订阅远端用户的视频流，并释放渲染控件
    muteRemoteAudio 暂停/恢复播放远端的音频流
    muteRemoteVideoStream 暂停/恢复订阅远端用户的视频流
    muteAllRemoteAudio 暂停/恢复播放所有远端用户的音频流
    enableAudioVolumeEvaluation 启用音量大小提示
    setVideoEncoderParam 设置视频编码器的编码参数
    setLocalRenderParams 设置本地画面的渲染参数
    setRemoteRenderParams 设置远端画面的渲染模式
    setRemoteAudioVolume 设定某一个远端用户的声音播放音量
    setAudioPlayoutVolume 设置 SDK 播放音量
    snapshotVideo 视频画面截图

    屏幕分享相关接口

    函数列表 描述
    startScreenCapture 开始全系统的屏幕分享（仅支持安卓系统）
    startScreenCaptureByReplaykit 开始全系统的屏幕分享（仅支持 iOS 11.0 及以上系统）
    startScreenCaptureInApp 开始应用内的屏幕分享（仅支持 iOS 13.0 及以上系统）
    stopScreenCapture 停止屏幕分享
    pauseScreenCapture 暂停屏幕分享
    resumeScreenCapture 恢复屏幕分享

    美颜相关接口

    函数列表 描述
    setBeautyLevel 设置美颜级别
    setWhitenessLevel 设置美白级别

    音效相关接口

    函数列表 描述
    startPlayMusic 开始播放音乐
    stopPlayMusic 停止背景音乐播放
    pausePlayMusic 暂停背景音乐播放
    resumePlayMusic 恢复背景音乐播放
    setAllMusicVolume 设置所有背景音乐的本地和远端音量
    setMusicPublishVolume 设置指定背景音乐的远端音量
    setMusicPlayoutVolume 设置指定背景音乐的本地音量
    setMusicPitch 设置音乐音调
    setMusicSpeedRate 设置音乐变速播放
    getMusicPlayProgress 获取当前播放进度 ms
    getMusicDurationInMS 获取音频总时长 ms
    seekMusicToPosInMS 跳转到指定进度 ms
    enableVoiceEarMonitor 开启耳返功能（仅安卓系统有效）
    setVoiceEarMonitorVolume 设置耳返音量大小（仅安卓系统有效）

    详细信息

    创建 BRTC 单例 

    (static) sharedInstance()

    详情

    • BRTC 类的所有接口函数，如无特殊说明，都是异步调用，对接口的调用建议在同一个线程进行。
    • 请确保在调用其他 API 前先调用该方法创建并初始化。
    • BRTC SDK 只支持创建一个 BRTC 单例。

    销毁 BRTC 单例 

    (static) destroySharedInstance()

    详情

    • 该方法释放 BRTC SDK 使用的所有资源。
    • 调用 destroySharedIntance 方法后，你将无法再使用 SDK 的其它方法和回调。
    • 如需再次使用实时音视频通信功能，你必须重新调用 sharedInstance 方法创建一个新的 BRTC 实例。
    • 如需在销毁后再次创建 BRTC 单例，需要等待 destroySharedIntance 方法执行结束后再创建实例。

    设置 BRTC 事件监听 

    (static) on(event, callback)

    参数

    Name Type Description
    event String 事件名称
    callback Function 回调函数

    取消事件监听 

    (static) off(event)

    参数

    Name Type Description
    event String 事件名称，传入通配符 '*' 会解除所有事件绑定。

    加入房间 

    (static) enterRoom(params)

    参数

    Name Type Description
    params BRTCParams 进房参数

    BRTCParams 参数

    Name Type Description
    sdkAppId String 应用标识（必填）
    userSig String 用户签名（必填）
    userId String 用户 ID （必填）
    roomId String 房间 ID （必填）

    详情

    • 调用接口后，SDK 会通过 onEnterRoom(result) 事件通知到您。
    • 如果加入成功，result 会是一个正数（result > 0），表示加入房间的时间消耗，单位是毫秒（ms）。
    • 如果加入失败，result 会是一个负数（result < 0），表示进房失败的错误码。
    • 不管进房是否成功，enterRoom() 都必须与 exitRoom() 配对使用，在调用 exitRoom() 前再次调用 enterRoom() 函数会导致不可预期的错误问题。

    离开房间 

    (static) exitRoom()

    详情

    • 调用 exitRoom() 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等。
    • 待资源释放完毕，SDK 会通过 onExitRoom() 回调通知到您。
    • 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK，请等待 onExitRoom() 回调到来之后再执行相关操作，否则可能会遇到摄像头或麦克风（例如 iOS 里的 AudioSession）被占用等各种异常问题。

    切换角色 

    (static) switchRole(role)

    参数

    Name Type Description
    role BRTCRoleType 目标角色，默认为主播
    BRTCRoleAnchor(0) 主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。
    BRTCRoleAudience(1) 观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成“主播”，同一个房间内同时最多可以容纳 10 万名观众。

    调用实验性 API 接口

    (static) callExperimentalAPI(JsonString)

    参数

    Name Type Description
    JsonString String 接口及参数描述的 JSON 字符串

    详情

    • 该接口用于调用一些实验性功能。

    开启本地视频的预览画面

    (static) startLocalPreview(isFrontCamera, userId)

    参数

    Name Type Description
    isFrontCamera Boolean 前置、后置摄像头，true：前置摄像头；false：后置摄像头，默认为 true
    userId String 用户 ID

    详情

    • 开启本地视频的预览画面
    • 当开始渲染首帧摄像头画面时，您会收到 onFirstVideoFrame(null) 回调

    停止本地视频采集及预览

    (static) stopLocalPreview()

    切换前置或后置摄像头

    (static) switchCamera(isFrontCamera)

    参数

    Name Type Description
    isFrontCamera Boolean 前置、后置摄像头，true：前置摄像头；false：后置摄像头

    开启本地音频的采集和上行, 并设置音频质量 

    (static) startLocalAudio(quality)

    参数

    Name Type Description
    quality BRTCAudioQuality(Int) 声音音质
    BRTCAudioQualitySpeech(0)，流畅：采样率：16k；单声道；音频裸码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话。
    BRTCAudioQualityDefault(1)，默认：采样率：48k；单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。
    BRTCAudioQualityMusic(2)，高音质：采样率：48k；双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，比如在线K歌、音乐直播等

    详情

    • SDK 默认不采集声音，您需要调用该函数启动麦克风采集。
    • 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会向用户申请开启。

    关闭本地音频的采集和上行

    (static) stopLocalAudio()

    详情

    • 当关闭本地音频的采集和上行，房间里的其它成员会收到 onUserAudioAvailable(false) 回调通知

    静音/取消静音本地的音频

    (static) muteLocalAudio(mute)

    参数

    Name Type Description
    mute Boolean true：屏蔽；false：开启，默认值：false

    详情

    • 当静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(false) 回调通知。
    • 当取消静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(true) 回调通知。

    暂停/恢复推送本地的视频数据

    (static) muteLocalVideo(mute)

    参数

    Name Type Description
    mute Boolean true：屏蔽；false：开启，默认值：false

    详情

    • 当暂停推送本地视频后，房间里的其它成员将会收到 onUserVideoAvailable(false)回调通知。
    • 当恢复推送本地视频后，房间里的其它成员将会收到 onUserVideoAvailable(true)回调通知。

    设置音频路由

    (static) setAudioRoute(route)

    参数

    Name Type Description
    route BRTCAudioRoute(Int) 音频路由，即声音由哪里输出（扬声器、听筒）, 默认值：BRTCAudioRouteSpeaker（扬声器）
    0: 扬声器, 1: 听筒, 2: 蓝牙, 3: 有线耳机

    详情

    • 微信和手机 QQ 视频通话功能的免提模式就是基于音频路由实现的。
    • 一般手机都有两个扬声器，一个是位于顶部的听筒扬声器，声音偏小；一个是位于底部的立体声扬声器，声音偏大，设置音频路由的作用就是决定声音使用哪个扬声器播放。

    开始拉取并显示指定用户的远端画面

    (static) startRemoteView(userId, streamType, viewId)

    参数

    Name Type Description
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)
    userId String 用户 ID
    viewId String 承载视频画面的控件 ID

    详情

    • 显示远端视频或辅流

    停止显示远端视频画面，同时不再拉取该远端用户的视频数据流

    (static) stopRemoteView(userId, streamType)

    参数

    Name Type Description
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)
    userId String 用户 ID

    详情

    • 调用此接口后，SDK 会停止接收该用户的远程视频流，同时会清理相关的视频显示资源。

    静音/取消静音指定的远端用户的声音

    (static) muteRemoteAudio(userId, mute)

    参数

    Name Type Description
    userId String 用户 ID
    mute Boolean true：静音；false：非静音

    详情

    • 静音时会停止接收该用户的远端音频流并停止播放，取消静音时会自动拉取该用户的远端音频流并进行播放。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    拉取/取消拉取指定的远端用户的视频流

    (static) muteRemoteVideoStream(userId, streamType, mute)

    参数

    Name Type Description
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)
    userId String 用户 ID
    mute Boolean true：取消拉取；false：拉取

    详情

    • 该接口仅暂停/恢复接收指定类型的远端用户的视频流，但并不释放显示资源。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    静音/取消静音所有用户的声音

    (static) muteAllRemoteAudio(mute)

    参数

    Name Type Description
    mute Boolean true：静音；false：非静音

    详情

    • 静音时会停止接收所有用户的远端音频流并停止播放，取消静音时会自动拉取所有用户的远端音频流并进行播放。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    启用音量大小提示

    (static) enableAudioVolumeEvaluation(interval)

    参数

    Name Type Description
    mute Number 设置 onUserVoiceVolume 回调的触发间隔，单位为ms，最小间隔为100ms，如果小于等于0则会关闭回调，建议设置为300ms

    详情

    • 开启此功能后，SDK 会在 onUserVoiceVolume() 中反馈对每一路声音音量大小值的评估。

    设置视频编码器相关参数

    (static) setVideoEncoderParam(param)

    参数

    Name Type Description
    param BRTCVideoEncParam 用于设置视频编码器的相关参数

    BRTCVideoEncParam 参数

    Name Type Description
    videoWidth Number 视频宽
    videoHeight Number 视频高度
    videoFPS Number 视频帧率
    videoBitrate Number 视频码率
    videoResolutionMode Number 视频宽高比模式。默认值是竖屏模式
    BRTCVideoResolutionModeLandscape(0): 横屏分辨率
    BRTCVideoResolutionModePortrait(1): 竖屏分辨率

    详情

    • 该设置决定了远端用户看到的画面质量（同时也是云端录制出的视频文件的画面质量）。

    本地图像的渲染设置

    (static) setLocalRenderParams(params)

    参数

    Name Type Description
    param BRTCRenderParams 本地图像的参数

    BRTCRenderParams 参数

    Name Type Description
    rotation BRTCVideoRotation 图像的顺时针旋转角度，支持90、180以及270旋转角度，默认值：BRTCVideoRotation_0, values: 0, 90, 180, 270
    fillMode BRTCVideoFillMode 视频画面填充模式，填充（画面可能会被拉伸裁剪）或适应（画面可能会有黑边），默认值：BRTCVideoFillMode_Fill, 0: fill, 1: fit
    mirrorType BRTCVideoMirrorType 画面镜像模式，默认值：BRTCVideoMirrorType_Auto, 0: auto, 1: enable, 2: disable

    远端图像的渲染设置

    (static) setRemoteRenderParams(params)

    参数

    Name Type Description
    param BRTCRenderParams 远端图像的参数

    BRTCRenderParams 参数

    Name Type Description
    rotation BRTCVideoRotation 图像的顺时针旋转角度，支持90、180以及270旋转角度，默认值：BRTCVideoRotation_0, values: 0, 90, 180, 270
    fillMode BRTCVideoFillMode 视频画面填充模式，填充（画面可能会被拉伸裁剪）或适应（画面可能会有黑边），默认值：BRTCVideoFillMode_Fill, 0: fill, 1: fit
    mirrorType BRTCVideoMirrorType 画面镜像模式，默认值：BRTCVideoMirrorType_Auto, 0: auto, 1: enable, 2: disable
    userId String 用户 ID
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)

    设定某一个远端用户的声音播放音量

    (static) setRemoteAudioVolume(userId, volume)

    参数

    Name Type Description
    userId String 用户 ID
    volume int 音量大小，100为原始音量，范围是:[0 ~ 150]，默认值为100

    设置 SDK 播放音量

    (static) setAudioPlayoutVolume(volume)

    参数

    Name Type Description
    volume int 音量大小，100为原始音量，范围是:[0 ~ 150]，默认值为100

    详情

    • 该函数会控制最终交给系统播放的声音音量，会影响录制本地音频文件的音量大小，但不会影响耳返的音量。

    视频画面截图

    (static) snapshotVideo(userId, streamType)

    参数

    Name Type Description
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)
    userId String 用户 ID

    详情

    • 截取本地、远程主路和远端辅流的视频画面。

    开始屏幕分享（该接口仅支持安卓系统）

    (static) startScreenCapture(encParams)

    参数

    Name Type Description
    param BRTCVideoEncParam 用于设置视频编码器的相关参数

    BRTCVideoEncParam 参数

    Name Type Description
    width Number 视频宽
    height Number 视频高度
    fps Number 视频帧率
    bitrate Number 视频码率
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)

    开始应用内的屏幕分享（该接口仅支持 iOS 13.0 及以上的 iPhone 和 iPad）

    (static) startScreenCaptureInApp(encParams)

    参数

    Name Type Description
    param BRTCVideoEncParam 用于设置视频编码器的相关参数

    BRTCVideoEncParam 参数

    Name Type Description
    width Number 视频宽
    height Number 视频高度
    fps Number 视频帧率
    bitrate Number 视频码率
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)

    详情

    • iPhone 屏幕分享的推荐配置参数:
      • 分辨率(videoResolution): 1280 x 720
      • 帧率(videoFps): 10 FPS
      • 码率(videoBitrate): 1600 kbps
      • 分辨率自适应(enableAdjustRes): NO

    开始全系统的屏幕分享（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）

    (static) startScreenCaptureByReplaykit(encParams)

    参数

    Name Type Description
    param BRTCVideoEncParam 用于设置视频编码器的相关参数

    BRTCVideoEncParam 参数

    Name Type Description
    width Number 视频宽
    height Number 视频高度
    fps Number 视频帧率
    bitrate Number 视频码率
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)
    groupId String 系统扩展进程使用的 groupId

    详情

    • iPhone 屏幕分享的推荐配置参数:
      • 分辨率(width x height): 1280 x 720
      • 帧率(fps): 10 FPS
      • 码率(bandWidth): 1600 kbps

    停止屏幕采集

    (static) stopScreenCapture()

    暂停屏幕分享

    (static) pauseScreenCapture()

    恢复屏幕分享

    (static) resumeScreenCapture()

    设置美颜级别

    (static) setBeautyLevel(beautyLevel)

    参数

    Name Type Description
    beautyLevel Number 美颜级别，取值范围0 - 100； 0表示关闭，100表示效果最明显。

    设置美白级别

    (static) setBeautyLevel(level)

    参数

    Name Type Description
    beautyLevel Number 美白级别，取值范围0 - 100； 0表示关闭，100表示效果最明显。

    开始播放音乐

    (static) startPlayMusic(param)

    参数

    Name Type Description
    param BRTCAudioMusicParameter 用于设置音效的相关参数

    BRTCAudioMusicParameter 参数

    Name Type Description
    path String 音乐文件的绝对路径
    loopCount Number 音乐循环次数，取值范围0 - 任意正整数；默认值：0。0表示播放音乐一次；1表示播放音乐两次；以此类推
    publish Boolean 是否发布音乐，默认值：false
    true: 音乐在本地播放的同时，会上行至云端，因此远端用户也能听到该音乐；
    false：音乐不会上行至云端，因此只能在本地听到该音乐。
    startTimeMS Number 播放音乐的起始时间，单位：毫秒。默认值：0。
    endTimeMS Number 播放音乐的结束时间，单位：毫秒，0表示播放至文件结尾。默认值：0。
    id Number 音乐流的ID，默认值：0。
    isShortFile Boolen 是否为短音频文件，默认值：false。
    true：短音乐文件会主动重复播放；
    false：正常的音乐文件。

    停止背景音乐播放

    (static) stopPlayMusic(musicId)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等

    暂停背景音乐播放

    (static) pausePlayMusic(musicId)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等

    恢复背景音乐播放

    (static) resumePlayMusic(musicId)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等

    设置所有背景音乐的本地和远端音量

    (static) setAllMusicVolume(volume)

    参数

    Name Type Description
    volume Number 取值 0 - 150，默认 100

    设置指定背景音乐的远端音量

    (static) setMusicPublishVolume(musicId, volume)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等
    volume Number 取值 0 - 150，默认 100

    设置指定背景音乐的本地音量

    (static) setMusicPlayoutVolume(musicId, volume)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等
    volume Number 取值 0 - 150，默认 100

    设置音乐音调

    (static) setMusicPitch(musicId, pitch)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等
    pitch Number 默认: 0.0f，[-1 ~ 1]

    设置音乐变速播放

    (static) setMusicSpeedRate(musicId, rate)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等
    rate Number 变速范围, 默认: 10.0f，[5 ~ 20]

    获取当前播放进度 ms

    (static) getMusicPlayProgress(musicId)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等

    返回 | Type | Description | |---------|---------| | Number | 当前播放进度 ms |

    获取音频总时长 ms

    (static) getMusicDurationInMS(musicId)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等

    返回 | Type | Description | |---------|---------| | Number | 音频总时长 ms |

    跳转到指定进度 ms

    (static) seekMusicToPosInMS(musicId, pos)

    参数

    Name Type Description
    musicId Number 音乐 ID, 进行标记，用于控制音乐的开始、停止等
    pos Number 跳转到的进度 ms

    开启耳返功能（仅安卓系统有效）

    (static) enableVoiceEarMonitor(enable)

    参数

    Name Type Description
    enable Boolean 是否开启耳返功能, true 表示开启耳返，false 表示不开启

    设置耳返音量大小（仅安卓系统有效） 

    (static) setVoiceEarMonitorVolume(volume)

    参数

    Name Type Description
    volume Number 设置耳返音量大小，取值范围 0~100

    Events

    onError

    错误回调，表示 SDK 不可恢复的错误，一定要监听并分情况给用户适当的界面提示

    参数

    Name Type Description
    code Number 错误码
    message String 错误信息
    extraInfo Object 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题

    onEnterRoom

    进房后的回调

    调用 enterRoom() 接口执行进房操作后，会收到 onEnterRoom(result) 回调

    如果加入成功，result 会是一个正数（result > 0），代表加入房间的时间消耗，单位是毫秒（ms）。

    如果加入失败，result 会是一个负数（result < 0），代表进房失败的错误码。

    参数

    Name Type Description
    result Number 进房耗时

    onExitRoom

    离开房间的事件回调

    调用 exitRoom() 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等。待资源释放完毕，会通过 onExitRoom() 回调通知到您

    Note

    如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK，请等待 onExitRoom() 回调到来之后再执行相关操作。 否则可能会遇到音频设备被占用等各种异常问题

    参数

    Name Type Description
    reason Number 离开房间原因，0：主动调用 exitRoom 退房；1：被服务器踢出当前房间；2：当前房间整个被解散

    onSwitchRole

    切换角色的事件回调 调用 BRTC 中的 switchRole() 接口会切换主播和观众的角色，该操作会伴随一个线路切换的过程， 待 SDK 切换完成后，会抛出 onSwitchRole() 事件回调

    参数

    Name Type Description
    code Number 错误码
    message String 错误信息

    onFirstVideoFrame

    开始渲染本地或远程用户的首帧画面

    参数

    Name Type Description
    userId String 用户 ID
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)
    width Number 视频宽度
    height Number 视频高度

    onFirstAudioFrame

    开始播放远程用户的首帧音频

    参数

    Name Type Description
    userId String 用户 ID

    onRemoteUserEnterRoom

    远端用户加入当前房间

    参数

    Name Type Description
    userId String 用户 ID

    onRemoteUserLeaveRoom

    用户离开当前房间

    参数

    Name Type Description
    userId String 用户 ID
    reason Number 离开房间原因，0：主动调用 exitRoom 退房；1 表示用户超时退出，2 表示被踢出房间

    onSendFirstLocalVideoFrame

    本地视频首帧数据已经被送出

    参数

    Name Type Description
    streamType BRTCVideoStreamType(Int) 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig(0)
    低清小画面:BRTCVideoStreamTypeSmall(1)
    辅流（屏幕分享）:BRTCVideoStreamTypeSub(2)

    onSendFirstLocalAudioFrame

    本地音频首帧数据已经被送出

    onUserAudioAvailable

    远端用户是否存在可播放的音频数据

    参数

    Name Type Description
    userId String 用户 ID
    available Boolean 是否存在可播放的音频数据

    onUserVideoAvailable

    远端用户是否存在可播放的主路画面（一般用于摄像头）

    参数

    Name Type Description
    userId String 用户 ID
    available Boolean 是否存在可播放的视频数据

    onUserSubStreamAvailable

    远端用户发布/取消了辅路视频画面

    参数

    Name Type Description
    userId String 用户 ID
    available Boolean 是否存在辅流可用，true 表示辅流可用

    onConnectionLost

    SDK 跟服务器的连接断开

    onTryToReconnect

    SDK 尝试重新连接到服务器

    onConnectionRecovery

    SDK 跟服务器的连接恢复

    onStatistics

    技术指标统计回调

    如果您是熟悉音视频领域相关术语，可以通过这个回调获取 SDK 的所有技术指标。

    参数

    Name Type Description
    statics Object 状态数据

    onUserVoiceVolume

    用于提示音量大小的回调，包括每个 userId 的音量和远端总音量

    参数

    Name Type Description
    userVolumes Array 是一个数组，用于承载所有正在说话的用户的音量大小，取值范围 0 - 100
    totalVolume Number 远端总音量大小，取值范围 0 - 100

    onScreenCaptureStarted

    屏幕分享开启的事件回调

    当您通过 startScreenCapture 等相关接口启动屏幕分享时，SDK 便会抛出此事件回调

    onScreenCapturePaused

    屏幕分享停止的事件回调

    当您通过 pauseScreenCapture 停止屏幕分享时，SDK 便会抛出此事件回调

    onScreenCaptureResumed

    屏幕分享恢复的事件回调

    当您通过 resumeScreenCapture 恢复屏幕分享时，SDK 便会抛出此事件回调

    onScreenCaptureStoped

    屏幕分享停止的事件回调

    当您通过 stopScreenCapture 停止屏幕分享时，SDK 便会抛出此事件回调

    参数

    Name Type Description
    reason Number 停止原因，0：用户主动停止；1：屏幕窗口关闭导致停止；2：表示屏幕分享的显示屏状态变更（如接口被拔出、投影模式变更等）

    onSwitchRole

    切换角色的事件回调

    参数

    Name Type Description
    code Number 错误码
    message String 错误信息

    onCameraDidReady

    摄像头准备就绪

    onMicDidReady

    麦克风准备就绪

    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论