API
更新时间：2023-07-31
API调用流程
1 事件对象
BrtcSessionListener
监听事件回调类
1.1 onLogin
介绍
void onLogin(long sessionId, long userId);调用login时候返回登录结果事件
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| sessionId | long | 返回sessionID |
| peerId | long | 返回userId |
返回
无
1.2 onRemoteUserJoin
介绍
void onRemoteUserJoin(long sessionId, long peerId);远端用户登录成功回调事件
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| sessionId | long | 返回sessionID |
| peerId | long | 返回userId |
返回 无
1.3 onStreamUp
介绍
void onStreamUp(long sessionId);stream流管道建立成功事件，可以发送音视频数据。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| sessionId | long | 返回sessionID |
返回
无
1.4 onError
介绍
void onError(long sessionId, int erroCode);错误回调日志 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| sessionId | long | 返回sessionID |
| erroCode | long | 返回userId |
Coder类型整理：
| 参数 | 类型 | 描述 |
|---|---|---|
| RTC_MESSAGE_ROOM_EVENT_LOGIN_OK | int | 100 |
| RTC_MESSAGE_ROOM_EVENT_LOGIN_TIMEOUT | int | 101 |
| RTC_MESSAGE_ROOM_EVENT_LOGIN_ERROR | int | 102 |
| RTC_MESSAGE_ROOM_EVENT_CONNECTION_LOST | int | 103 |
| RTC_MESSAGE_ROOM_EVENT_REMOTE_COMING | int | 104 |
| RTC_MESSAGE_ROOM_EVENT_REMOTE_LEAVING | int | 105 |
| RTC_MESSAGE_ROOM_EVENT_REMOTE_RENDERING | int | 106 |
| RTC_MESSAGE_ROOM_EVENT_REMOTE_GONE | int | 107 |
| RTC_MESSAGE_ROOM_EVENT_SERVER_ERROR | int | 108 |
返回 无
1.5 onMessage
介绍
void onMessage(long sessionId, long peerId, ByteBuffer messageData, int len);自定义消息通知事件
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| sessionId | long | 返回sessionID |
| peerId | long | 返回userId |
| messageData | ByteBuffer | 自定义消息数据 |
| len | int | 长度 |
返回 无
1.6 onAudioData
介绍
void onAudioData(long sessionId, long peerId, ByteBuffer data, int len);音频数据回调 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| sessionId | long | 返回sessionID |
| peerId | long | 返回userId |
| data | ByteBuffer | 自定义消息数据 |
| len | int | 长度 |
返回 无
2 配置参数对象
UserParams
介绍 设置参数。
设置应用的AppID， 需要从百度智能云申请得到。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| SeverSignal | string | 对应得信令地址 |
| AppID | string | 应用的AppID |
| cerPath | string | cer证书文件的全路径 |
| forwardUrl | string | 转推的地址可以为空 |
| roomId | long | 房间号 |
| userId | long | 用户ID |
| videoCode | string | 视频编码Video 264 |
| audioChannel | int | 音频参数声道 |
| audioSample | int | 音频采样率 |
| isPublisher | boolean | 是否推流者身份 |
| isListener | boolean | 是否订者阅身份 |
| autoSub | boolean | 是否支持自动订阅模式 |
| enableLog | boolean | 是否支持日志 |
返回 无
3 会话对象
BrtcSession
介绍 BrtcSession brtcSession = new BrtcSession(); 创建BrtcSession对象 用户首先需要创建 BrtcSession, 通过成员函数方法进行初始化，发布流，订阅流等其他可提供的api 操作。
3.1 setSessionListener
介绍
void setSessionListener(BrtcSessionListener brtcSessionListener)绑定事件监听类 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| brtcSessionListener | BrtcSessionListener | void |
返回 无
3.2 removeSessionListener
介绍
void removeSessionListener()解绑定事件监听类
返回 无
3.3 login
介绍
long login(UserParams userParams)登录房间
参数 | 参数 | 类型 | 描述 | | --- | --- | --- | |userParams| UserParams |参数对象构建|
返回 无
3.4 logOut
介绍
boolean logOut()登录房间参数
| 参数 | 类型 | 描述 |
|---|---|---|
| userParams | UserParams | 参数对象构建 |
返回 无
3.5 subscribeUser
void subscibeUser(long feedId);介绍 手动订阅远端用户流 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| feedId | long | 订阅远端用户媒体数据，默认返回音频 |
返回 无
3.6 unsubscribeUser
void unsubscibeUser(long feedId);介绍
手动停止订阅远端用户流
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| feedId | long | 订阅远端用户媒体数据，默认返回音频 |
返回
无
3.7 destory
void destory()介绍
销毁内部资源
返回
无