概述

聚联云提供各种客户端SDK,通过SDK连接全球部署的实时通信网络,来为开发者提供质量稳定可靠、高并发、超低时延的实时信令服务(Real-Time Signaling,RTS),帮助你实现快速构建业务场景。

聚联云PC端特有的即时消息服务SDK代号为Hummer

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

基础方法

方法功能
init初始化Hummer,同时开始监听Hummer的状态改变
getSDKVersion获取Hummer的版本号
login登录SDK
logout登出SDK
getState获取HummerSDK 当前所处的状态
refreshToken刷新用户凭证
setLoggerFilePath日志根目录路径
回调功能
onHummerLoginHummer登陆结果回调
onRefreshToken用户凭证刷新结果回调
通知功能
onHummerStateChangedSDK状态变化通知
onHummerKickedSDK收到多端登录被踢的通知
onHummerPreviousTokenExpired用户凭证过期通知

点对点消息和用户状态

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

房间管理

方法功能
sendMessage发送房间消息
addRoomEventHandler添加房间的监听器
removeRoomEventHandler移除房间的监听器
setRoomAttributes设置房间属性(支持进房间和不进房间全量设置房间属性)
addOrUpdateRoomAttributes更新指定房间的属性:属性存在则更新;属性不存在则添加
deleteRoomAttributes删除指定房间的指定属性
clearRoomAttributes清空指定房间属性
queryRoomAttributes查询指定房间的全部属性
queryRoomAttributesByKeys查询指定房间的指定属性
queryMemberCounts批量查询房间成员总数
queryMembers获取房间成员列表
回调功能
onQueryMembers房间成员列表查询结果回调
onQueryMemberCounts房间成员查询结果回调
onSendMessage发送房间消息结果回调
onSetRoomAttributes设置房间属性设置结果回调
onAddOrUpdateRoomAttributes更新指定房间的属性结果回调
onDeleteRoomAttributes删除房间属性结果回调
onClearRoomAttributes清除房间所有属性结果回调
onQueryRoomAttributes查询房间所有属性结果回调
onQueryRoomAttributesByKeys查询房间指定属性结果回调
通知功能
onRoomMessageReceived当有一个用户往房间内发一条信令消息时,房间内所有的成员都会受到该事件的通知
onRoomAttributesSet房间属性设置通知
onRoomAttributesDeleted房间属性删除通知
onRoomAttributesCleared房间属性清空通知
onRoomAttributesAddedOrUpdated房间属性新增或更新通知

房间成员管理

方法功能
joinRoom进入房间的接口
leaveRoom退出房间的接口
addMemberEventHandler添加成员事件的监听器
removeMemberEventHandler移除成员的监听器
setMemberAttributes设置用户在当前房间的信息
addOrUpdateMemberAttributes添加或更新用户在当前房间的信息
deleteMemberAttributes删除用户在当前房间的某些信息
clearMemberAttributes删除用户在当前房间的所有信息
queryMemberAttributes查询用户在当前房间的全部属性
queryMemberAttributesByKeys查询用户在房间的指定属性
回调功能
onJoinRoom进入房间结果回调
onLeaveRoom离开房间结果回调
onSetMemberAttributes房间成员属性设置结果回调
onAddOrUpdateMemberAttributes房间成员属性更新结果回调
onClearMemberAttributes清除房间成员所有属性结果回调
onDeleteMemberAttributes房间成员属性删除结果回调
onQueryMemberAttributes查询房间成员所有属性结果回调
onQueryMemberAttributesByKeys查询房间成员指定属性结果回调
通知功能
onRoomMemberJoined成员进入房间通知
onRoomMemberLeft成员离开房间通知
onRoomMemberOffline当前用户断线超时离开房间通知
onRoomMemberCountChanged房间人数变更通知
onRoomMemberAttributesSet房间成员信息设置回调通知
onRoomMemberAttributesDeleted房间成员信息删除回调通知
onRoomMemberAttributesCleared房间成员信息清空回调通知
onRoomMemberAttributesAddedOrUpdated房间成员信息新增或更新回调通知
<