概述

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

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

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

  • HMR 接口类提供了 SDK 初始化登录以及配置的功能。
  • PeerService 接口类提供了发送点对点消息和查询用户在线状态的能力。
  • RoomService 接口类提供了对应的房间和房间用户管理的相关接口能力。

基础方法

方法功能
init初始化Hummer,同时开始监听Hummer的状态改变
login登录SDK
getService获取对应的服务实例
logout登出SDK
getState获取HummerSDK 当前所处的状态
getVersion获取 SDK 版本信息
refreshToken刷新用户凭证
setLoggerFilePath需要设置的日志存储路径,调用方应确保路径存在
回调功能
onHummerStateChangedSDK状态变化回调
onHummerKickedSDK收到多端登录被踢的回调方法
onHummerPreviousTokenExpired用户凭证过期回调

点对点消息和用户状态

方法功能
queryUserOnlineStatus批量查询用户在线,可以查询具体用户是否在线
sendMessage发送点对点信令消息
addEventListener添加信令消息的监听器
removeEventListener移除信令消息的监听器
回调功能
onPeerMessageReceived当收到点对点信令消息时,会收到该事件的通知回调

房间管理

方法功能
queryMemberCounts批量查询房间成员总数
setRoomAttributes设置房间属性
addOrUpdateRoomAttributes更新指定房间的属性
deleteRoomAttributes删除指定房间的指定属性
clearRoomAttributes清空指定房间属性
queryRoomAttributes:ByKeys查询指定房间的指定属性
queryRoomAttributes查询指定房间的全部属性
sendMessage发送房间消息
addRoomEventListener添加 Room 的监听器
removeRoomEventListener移除 Room 的监听器
回调功能
onRoomMessageReceived用户往房间内发信令消息时,房间内成员收到的通知
onRoomAttributesSet房间属性设置通知
onRoomAttributesAddedOrUpdated房间属性新增或更新通知
onRoomAttributesDeleted房间属性删除通知
onRoomAttributesCleared房间属性清空通知

房间成员管理

方法功能
join进入房间
leave退出房间
queryMembers获取指定房间的成员列表
setMemberAttributes设置当前用户在当前房间的属性
addOrUpdateMemberAttributes新增或更新用户在当前房间属性
deleteMemberAttributes删除用户在当前房间的某些属性
clearMemberAttributes清空用户在房间内的所有属性
queryMemberAttributesByKeys查看用户在当前房间指定属性
queryMemberAttributtes查看用户在当前房间所有属性
addMemberEventListener添加 Member 的监听器
removeMemberEventListener移除 Member 的监听器
回调功能
onRoomMemberJoined成员进入房间通知
onRoomMemberLeft成员离开房间通知
onRoomMemberOffline当前用户断线超时离开房间通知
onRoomMemberCountChanged房间人数变更通知
onRoomMemberAttributesSet房间成员信息设置回调通知
onRoomMemberAttributesAddedOrUpdated房间成员信息新增或更新回调通知
onRoomMemberAttributesDeleted房间成员信息删除回调通知
onRoomMemberAttributesCleared房间成员信息清空回调通知
<