互动直播>客户端 API>uni-app

uni-app

编辑文档 更新于
BLive

Blive uni-app SDK 基于 BRTC uni-app SDK 基础上，补充了若干针对互动直播场景下的 API 及事件回调。BRTC uni-app SDK 绝大部分 API 和事件回调都被保留。如果 Blive uni-app SDK 的房间类型被设置为纯 RTC 模式，或者以主播角色进入房间，那么基本上可以认为 Blive 拥有全部 BRTC 的功能。

因此，本页仅列出了与 BRTC uni-app SDK 有差异的部分，其他接口和回调，请参考 BRTC uni-app SDK。

接口

房间

函数列表 描述
enablePureRtcMode 设置房间为纯 RTC 模式
enterRoom 进入房间
switchRole 切换角色

音视频合流

函数列表 描述
startMixTranscode 开始合流转码
stopMixTranscode 停止合流转码
playMixStream 开始播放合流
stopMixStream 停止播放合流

回调事件

事件名 描述
onEnterBliveRoom Blive 进房通知
onExitBliveRoom Blive 离房结果通知
onSwitchRole 角色切换结果通知
onStartTranscode 主播开始合流的回调
onStopTranscode 主播结束合流的回调
onMixStreamAdded 观众收到一个新的合流信息
onMixStreamUpdate 观众收到一个合流信息发生变更
onMixStreamRemoved 观众收到一个合流被删除的通知
onMixedNotification 收到一个已存在合流任务的通知

详细信息

enablePureRtcMode

设置房间为纯 RTC 模式。注意：必须在进房前调用此方法，进房后调用无效。

enablePureRtcMode(enable)

参数

Name Type Description
enable 布尔 设置为 true 时，房间为纯 RTC 模式，即此时 Blive 等同于 BRTC。默认是 false

enterRoom

加入房间

enterRoom(params)

参数

Name Type Description
params JSON字符串 进房参数 
{ 
    "roomId": "房间ID", 
    "userId": "用户ID", 
    "sdkAppId": "SDKAppID", 
    "userSig": "用户进房鉴权码",
    "roleType": 0,  //0: 观众，1: 主播
    "userNumber": "用户识别码"
}

详情

  • userNumber 是 Blive 新增字段，作用与 userId 类似。建议使用随机数转为字符串传入。
  • roleType 在 BRTC 中可选设置，在 Blive 要求必需设置。它将决定进房后的一系列默认行为。

switchRole

切换角色

switchRole(role)

参数

Name Type Description
role BLiveRoleType 角色类型
BLiveRoleAudience(0) 观众，不能发布自己的音视频流，只能观看房间中存在的合流。
BLiveRoleAnchor(1) 主播，可以发起音视频推流、触发服务器合流。

详情

  • 进房后，可以通过这个方法来切换角色。角色切换成功后，会收到 onSwithRole 回调通知。
  • 主播切为观众，建议主动禁用音视频（推流）、停止服务器合流、清理主播角色本地和远端视频渲染画面等。
  • 观众切为主播，建议主动停止播放合流、清理相关视图等。

startMixTranscode

开始合流转码

startMixTranscode(jsonMixStreamParams)

参数

Name Type Description
jsonMixStreamParams JSON 字符串 开始触发服务器合流 
{
    "mixStreamId": "",  //合流id
    "customData": "",   //用户自定义信息
    "liveLayoutMode": 1,    //1: Default, 2:Gallery画廊布局, 3:Speech演讲布局, 4:Floating悬浮球布局
    "forceMix": true,   //单路流时是否强制转码
    "layoutCanvasBean": {
        "width": 640,   //合流宽
        "height": 480,  //合流高
        "isPortrait": true, //是否竖屏
        "color": "#ff0000", //背景颜色
        "fitMode": 0,    //0:Fit, 1:AspectFill裁剪, 2:Fill拉伸填充
        "layoutVideoBean": {
            "useQp": true,  //是否使用Qp
            "codec": "h264",  //编码格式
            "bitrate": 1000,  //码率
            "fps": 15,        //帧率
            "gop": 2          //相邻关键帧间隔
        }
    },
    "streamCellModel": [
        {
            "cellName": "",   //合流单元格名称
            "x": 0,           //位置：X方向
            "y": 0,           //位置：Y方向
            "width": 640,     //宽
            "height": 480,    //高
            "zOrder": 0,      //z轴顺序
            "fitMode": 0,        //同上
            "color": "#ff0000",   //背景颜色
            "streamIdentifier": {
                "type": "brtc-vloud",   //常量
                "data": {         // 自定义扩展信息
                    "userId": "",
                    "roomId": "",
                }
            }
        }
    ]
}

详情

  • 只有主播可以调用该接口
  • 该接口需要在主播开启推流后调用

stopMixTranscode

停止合流转码

stopMixTranscode(mixStreamId)

参数

参数 描述
mixStreamId 合流ID

详情

  • 只有主播可以调用该接口
  • 主播停止合流转码后，观众端将会收到onMixStreamRemoved回调通知

playMixStream

播放合流

playMixStream(jsonMixStreamInfo)

参数

参数 描述
jsonMixStreamInfo JSON格式的流信息，具体格式见下方 
{
    "viewId": "",   // 播放视图控件ID，用于显示合流视频画面
    "mixStreamId": "",  // 合流ID，通过 onMixStreamAdded 回调获取
    "videoOn": true,  // 当前版本传常量 true
    "audioOn": true   // 当前版本传常量 true
}

stopMixStream

停止播放合流

stopMixStream(mixStreamId)

参数

参数 描述
mixStreamId 合流ID

详情

  • 当收到 onMixStreamRemoved 时，应调用此方法停止播放合流，并清理界面资源

onEnterBliveRoom

Blive 进房回调通知

onEnterBliveRoom(result)

参数

Name Type Description
result Number 进房返回值。小于0表示进房失败的错误码，大于0表示进房耗时（毫秒）

onExitBliveRoom

Blive 离房回调通知

onExitBliveRoom(reason)

参数

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

onSwitchRole

切换角色的事件回调通知

onSwitchRole(role)

参数

Name Type Description
role Number 0：观众；1：主播

onStartTranscode

主播开始合流的回调

onStartTranscode(mixStreamId)
参数 描述
mixStreamId 合流 ID

onStopTranscode

主播结束合流的回调

onStopTranscode(mixStreamId)
参数 描述
mixStreamId 合流 ID

onMixStreamAdded

观众收到主播开始合流的事件回调

onMixStreamAdded(jsonMixStreamInfo)
参数 描述
jsonMixStreamInfo JSON 格式的合流信息，具体内容见下方 
{
    "mixStreamId": "合流ID，使用此ID调用 playMixStream 来播放合流",
    "mixStreamInfo": {
        "roomId": "",
        "taskId": "",
        "customData": "",
        "pull": false,
        "index": 0,
        "timeout": 2,
        "streamList": [],
        "streamResolutionList": [
            {
                "cdnList": [
                    {
                        "flvUrl": "",
                        "httpDnsUrl": [],
                        "m3u8Url": "",
                        "resolution": "",
                        "rtmpUrl": ""
                    }
                ],
                "cdnName": ""
            }
        ]
    }
}

上面格式中，mixStreamInfo在不同平台可能内容格式略有不同，目前里面的字段暂未对外公布使用，如果您需要利用其中某些属性，请联系我们了解更多细节。

onMixStreamUpdate

观众收到主播更新合流的事件回调

onMixStreamUpdate(jsonMixStreamInfo)
参数 描述
jsonMixStreamInfo JSON 格式的合流信息，具体内容参考onMixStreamAdded

onMixStreamRemoved

观众收到主播停止推流的事件回调

onMixStreamRemoved(mixStreamId)
参数 描述
mixStreamId 流 Id

onMixedNotification

房间内已存在的合流任务通知

onMixedNotification(jsonMixStreamInfo)
参数 描述
jsonMixStreamInfo JSON格式的流信息，具体格式见下方 
{
    "taskId": "合流ID",
    "customData": "自定义数据",
}

通常一个房间内只会有一个主播发起合流任务，但如果以主播角色进房后，房间内已有其他主播发布了合流任务，您会通过 onMixedNotification 回调获得合流ID。这种情况下，您通常有以下几种选择：
1、放弃发起新的合流任务
2、发起新的合流任务，使用新的合流ID，这样相当于房间内会产生多路合流
3、发起新的合流任务，使用 onMixedNotification 回调中的 taskId，这样相当于当再次调用 startMixTranscode 发起合流时，使用新的合流参数覆盖原有合流任务

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