API
更新时间：2023-04-23
获取应用实例 const brtc = require('baidu.rtc.mp.sdk.js');
var BRTCClient = brtc.BRTC;
实例的各API函数说明如下:
启动BRTC SDK
BRTC_Start() 介绍
启动SDK时使用。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| server | string | 百度的RTC 服务器， 使用默认值即可。 |
| appid | string | 百度 派发的数字 ID, 开发者的唯一标识 |
| token | string | app server 派发的token字符串, 用来校验通信的合法性 |
该接口参数数量较多，请参考下面的参数详解进行了解。
返回
无
参数详解
| 参数 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| server | string | 百度智能云RTC服务器， 使用默认值即可。 | "wss://rtc.exp.bcelive.com/janus" |
| appid | string | 百度 派发的数字 ID, 开发者的唯一标识 | |
| token | string | app server 派发的token字符串, 用来校验对应通信的合法性 | |
| roomname | string | 房间名称 | |
| userid | string | 用户ID | 数字字符串 |
| displayname | string | 显示的用户名 | |
| aspublisher | bool | 是否是发布者 | 默认true，是发布者, fale表示只拉流 |
| usingvideo | bool | 是否使用本地视频设备 | 默认true |
| usingaudio | bool | 是否使用本地音频设备 | 默认true |
| remotevideocoming | function(id,display,attribute, pullurl) | 远端用户流上线的回调 | pullurl 是拉流的RTMP地址, 可以用liveplay进行播放 |
| remotevideoleaving | function(id) | 远端用户流离开的回调 | |
| onmessage | function(msg) | 消息事件回调{msg.id,msg.data} | |
| onattribute | function(a) | 属性事件回调{a.id,a.attribute} | |
| userevent | bool | 是否启用用户级事件 | true表示启用用户级事件， 当用户一旦加入房间就会发出事件。 false 表示不启用. 默认是true |
| userevent_joinedroom | function(id,display,attribute) | 用户加入房间的事件，此时用户还没有发布流 | |
| userevent_leavingroom | function(id,display) | 用户离开房间 | |
| success | function(pushurl) | BRTC_Start()成功 | pushurl是服务器分配的用于推流的RTMP地址, 可以用livepusher进行推流 |
| error | function(error) | BRTC_Start()失败，或运行过程中出现了错误 | |
| destroyed | function(error) | 运行过程中出现错误被销毁的回调 | |
| debuglevel | bool/array | 是否打印调试信息 | 默认值为false， 可取值为: true, false, 'all', ['debug','log','error'] |
停止BRTC
BRTC_Stop()介绍
停止BRTC
参数
无
返回
无
获得SDK的版本号
BRTC_Version(); 介绍
获得SDK的版本号信息。
参数
无
返回
返回BRTC SDK的版本号
获得房间中的远端用户列表
BRTC_GetRemoteUsers();介绍
获得房间中的远端用户列表
参数
无
返回
房间中的远端用户列表数组。
返回结果示例：
[
{"id":100219207,"display":"Tom","attribute":""},
{"id":100241823,"display":"brtc webclient","attribute":""}
]设置用户属性
BRTC_SetUserAttribute(attribute);介绍
属性事件回调会发生在BRTC_Start的onattribute 函数上。 属性值保存在BRTC_Start回调函数 remotevideocoming返回的参数里面。
参数
attribute, 表示用户属性的字符串，比如: "{name:'aaa',tel:'12345'}";
返回
无
获取用户属性值
BRTC_GetUserAttribute();介绍
根据用户id获得特定用户的属性值。
参数 {onattribute: function (a){} ,feedid: id} onattribute, 设置的回调函数。 feedid， 要获取的用户id号。
返回
返回的属性值在onattribute回调中。
发送用户消息
BRTC_SendMessageToUser(msg,id);介绍
本函数用来给特定id用户发送消息或者向房间内发送广播消息。 消息在接收端的onmessage回调函数中接收。发送用户消息的频率应小于100次/秒，超出的话用户消息可能会被丢弃。
参数
msg, 需要发送的消息内容， 为一个字符串， 比如: "{name:'aaa',tel:'12345'}" id, 需要发送消息给对端用户的id值。 注意: 当id为0或没有id参数时表示在房间内发送广播消息。
返回
无