Overview

Realtime Signaling (RTS) is a lightweight and high-reliable message transmission service developed on the low-latency and high-concurrency global real-time message system architecture.

The RTS SDK can be integrated to implement high-concurrency, low-latency, and stable message transmission channels. Interworking with the audio/video interaction SDK, RTS can help developers to create service scenarios, including interactive teaching, voice chatroom, video live streaming, and calling.

The code of the RTS SDK specific to Jocloud mobile terminals is Hummer.

  • The HMR API class provides SDKs initialized login and configuration functions.
  • The PeerService API class provides capabilities of sending P2P messages and searching user online status.
  • The RoomService API class provides capabilities of managing rooms and room members.

Basic APIs

APIFunction
initInitialize Hummer and start listening to Hummer status change
loginLog in an SDK
getServiceGet the service instance
logoutLog out an SDK
getStateGet the current status of HummerSDK
getVersionGet SDK version information
refreshTokenRefresh a user token
setLoggerFilePathSet a log saving path. The caller should ensure that the path is valid.
CallbackFunction
onHummerStateChangedCallback of SDK status change
onHummerKickedSDK callback method for removing users when login through multiple ends is detected
onHummerPreviousTokenExpiredCallback of a user token expired

P2P Messages and User Status

APIFunction
queryUserOnlineStatusBatch search of user online status for indicating the status of specific users
sendMessageSend P2P signaling messages
addEventListenerAdd listeners for signaling messages
removeEventListenerRemove listeners for signaling messages
CallbackFunction
onPeerMessageReceivedYou will receive a notification callback of this event upon the receipt of P2P signaling messages

Room Management

APIFunction
queryMemberCountsBatch search of member counts
setRoomAttributesSet room profiles
addOrUpdateRoomAttributesUpdate profiles of specific rooms
deleteRoomAttributesDelete specific profiles of specific rooms
clearRoomAttributesClear profiles of specific rooms
queryRoomAttributes:ByKeysSearch specific profiles of specific rooms
queryRoomAttributesSearch all profiles of specific rooms
sendMessageSend room messages
addRoomEventListenerAdd listeners for Room
removeRoomEventListenerRemove listeners for Room
CallbackFunction
onRoomMessageReceivedNotification received by room members when a user sends signaling messages to this room
onRoomAttributesSetNotification of setting room profiles
onRoomAttributesAddedOrUpdatedNotification of adding or updating room profiles
onRoomAttributesDeletedNotification of deleting room profiles
onRoomAttributesClearedNotification of clearing room profiles

Room Member Management

APIFunction
joinJoin a room
leaveExit a room
queryMembersSearch a member list of a specific room
setMemberAttributesSet user profiles in the current room
addOrUpdateMemberAttributesAdd or update user profiles in the current room
deleteMemberAttributesDelete specific user profiles in the current room
clearMemberAttributesClear all user profiles in the room
queryMemberAttributesByKeysSearch specific user profiles in the current room
queryMemberAttributtesSearch all user profiles in the current room
addMemberEventListenerAdd listeners for Member
removeMemberEventListenerRemove listeners for Member
CallbackFunction
onRoomMemberJoinedNotification of members joined the room
onRoomMemberLeftNotification of members exited the room
onRoomMemberOfflineNotification of the current user exited the room due to disconnection timeout
onRoomMemberCountChangedNotification of member count changed
onRoomMemberAttributesSetCallback notification of setting room member information
onRoomMemberAttributesAddedOrUpdatedCallback notification of adding or updating room member information
onRoomMemberAttributesDeletedCallback notification of deleting room member information
onRoomMemberAttributesClearedCallback notification of clearing room member information
<