概述

实时信令(Realtime Signaling, RTS)产品是基于低时延、高并发的全球实时消息系统框架开发的一套轻量级高可靠的消息传输服务。

通过集成RTS SDK既可以轻松获得高并发、低时延、稳定必达的消息传输通道。结合实时音视频互动SDK可帮助开发者快速构建如互动教学、语聊房、视频直播、通话等多种业务场景

聚联云移动端特有的实时信令服务SDK代号为Hummer

  • Hummer 实例提供了 SDK 初始化登录以及配置的功能,并通过creatRTSInstance创建RtsClient实例。

  • RtsClient 实例提供了发送点对点消息和查询用户在线状态的能力,并通过creatRoom创建RtsRoom实例。

  • RtsRoom 实例提供了对应的房间和房间用户管理的相关接口能力。

RTS js-sdk npm包路径

npm包发布路径: https://www.npmjs.com/package/hummer-rts-sdk

基础方法

方法功能
VERSION获取 SDK 版本信息
getState获取HummerSDK 当前所处的状态
createHummer初始化Hummer
login登录SDK
logout登出SDK
refreshToken刷新用户凭证
监听事件功能
ConnectionStateChangedSDK状态变化回调
TokenExpired用户凭证过期回调

点对点消息和用户状态

方法功能
createRTSInstance创建实例并初始化
queryUsersOnlineStatus批量查询用户在线,可以查询具体用户是否在线
sendMessageToUser发送点对点信令消息
监听事件功能
MessageFromUser当收到点对点信令消息时,会收到该事件的通知回调

房间管理

方法功能
getRoomMemberCount批量查询房间成员总数
setRoomAttributes设置房间属性
addOrUpdateRoomAttributes添加或者更新指定房间的属性
deleteRoomAttributes删除指定房间的指定属性
clearRoomAttributes清空指定房间属性
getRoomAttributesByKeys查询指定房间的指定属性
getRoomAttributes查询指定房间的全部属性
sendMessage发送房间消息
监听事件功能
RoomMessage用户往房间内发信令消息时,房间内成员收到的通知
RoomAttributesSet房间属性设置通知
RoomAttributesAddedOrUpdated房间属性新增或更新通知
RoomAttributesDeleted房间属性删除通知
RoomAttributesCleared房间属性清空通知

房间成员管理

方法功能
creatRoom创建实例并初始化
join进入房间
leave退出房间
getMembers获取指定房间的成员列表
setUserAttributes设置当前用户在当前房间的用户属性
addOrUpdateUserAttributes新增或更新用户在当前房间属性
deleteUserAttributes删除用户在当前房间的某些用户属性
clearUserAttributes清空用户在房间内的所有属性
getUserAttributesByKeys查看用户在当前房间指定属性
getUserAttributes查看用户在当前房间所有属性
监听事件功能
MemberJoined成员进入房间通知
MemberLeft成员离开房间通知
RoomMemberOffline当前用户断线超时离开房间通知
MemberCountUpdated房间人数变更通知
MemberAttributesSet房间成员的用户属性设置回调通知
MemberAttributesAddedOrUpdated房间成员的用户属性新增或更新回调通知
MemberAttributesDeleted房间成员的用户属性删除回调通知
MemberAttributesCleared房间成员的用户属性清空回调通知
<