Event Callback

API List

  • HummerEventListener

Public Callback FunctionFunction Name
voidonHummerStateChanged
voidonHummerKicked
voidonHummerPreviousTokenExpired
  • EventListener

Public Callback FunctionFunction Name
voidonPeerMessageReceived
  • RoomEventListener

Public Callback FunctionFunction Name
voidonRoomMessageReceived
voidonRoomAttributesSet
voidonRoomAttributesAddedOrUpdated
voidonRoomAttributesDeleted
voidonRoomAttributesCleared
  • MemberEventListener

Public Callback FunctionFunction Name
voidonRoomMemberJoined
voidonRoomMemberLeft
voidonRoomMemberOffline
voidonRoomMemberCountChanged
voidonRoomMemberAttributesSet
voidonRoomMemberAttributesAddedOrUpdated
voidonRoomMemberAttributesDeleted
voidonRoomMemberAttributesCleared
  • HummerLogCallback

Public Callback FunctionFunction Name
voidonHmrLogWithLevel

Callback Details

HummerEventListener

HummerEventListener.onHummerStateChanged

void onHummerStateChanged(State fromState, State toState, String reason);

Callback of status change of a Hummer SDK.

Parameter
ParameterDescription
fromStateStatus before change. See details in HMR.State for details..
toStateCurrent status
reasonChange reason

HummerEventListener.onHummerKicked

void onHummerKicked(int code, String description);

Callback of the SDK to remove users when login through multiple ends is detected.

Parameters
ParameterDescription
codeReason for removing a user
descriptionDescription of reasons for removing a user

HummerEventListener.onHummerPreviousTokenExpired

void onHummerPreviousTokenExpired();

Callback notification returned by the SDK to the service layer upon token expiration.

Notes:

  • This callback is triggered only when a token expires upon the SDK reconnection from disconnection. Once receiving this call, call refreshToken to refresh the token.

EventListener

EventListener.onPeerMessageReceived

void onPeerMessageReceived(long fromUserId, Message message);

A notification callback of this event will be received upon the receipt of P2P signaling messages.

Notes:

Parameters
ParameterDescription
fromUserIdSender ID
messageReceived signaling message

RoomEventListener

RoomEventListener.onRoomMessageReceived

void onRoomMessageReceived(@NonNull RoomId roomId,
                           long fromUserId,
                           Message message);

When you send a signaling message to a room, all members in this room will receive a callback notification of this event.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
fromUserIdSender ID
messageReceived signaling message

RoomEventListener.onRoomAttributesSet

void onRoomAttributesSet(@NonNull RoomId roomId,
                         long userId,
                         @NonNull Map<String, String> attributes);

Notification of setting room profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdOperator ID
attributesConfigured profiles

RoomEventListener.onRoomAttributesAddedOrUpdated

void onRoomAttributesAddedOrUpdated(@NonNull RoomId roomId,
                                    long userId,
                                    @NonNull Map<String, String> attributes);

Notification of adding or updating room profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdOperator ID
attributesAdded or updated profiles

RoomEventListener.onRoomAttributesDeleted

void onRoomAttributesDeleted(@NonNull RoomId roomId,
                             long userId,
                             @NonNull Map<String, String> attributes);

Notification of deleting room profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdOperator ID
attributesDeleted profiles

RoomEventListener.onRoomAttributesCleared

void onRoomAttributesCleared(@NonNull RoomId roomId,
                             long userId,
                             @NonNull Map<String, String> attributes);

Notification of clearing room profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdOperator ID
attributesCleared profiles

MemberEventListener

MemberEventListener.onRoomMemberJoined

void onRoomMemberJoined(@NonNull RoomId roomId, @NonNull Set<Long> joinMembers);

Notification of members joining a room.

Notes:

  • Call join to perform callback.
  • This notification will not be sent if over 500 members have joined the room.
Parameters
ParameterDescription
roomIdRoom ID
joinMembersList of member IDs

MemberEventListener.onRoomMemberLeft

void onRoomMemberLeft(@NonNull RoomId roomId, @NonNull Set<Long> leftMembers);

Notification of members exiting a room.

Notes:

  • Call leave to perform callback.
  • This notification may not be received when you exit a room by calling leaveRoom.
  • It can be received by other members when they exit the room.
  • This notification will not be sent if over 500 members have joined the room.
Parameters
ParameterDescription
roomIdRoom ID
leftMembersList of member IDs

MemberEventListener.onRoomMemberOffline

void onRoomMemberOffline(Set<RoomId> roomIds);

Notification of the current user exited the room due to disconnection timeout.

Notes:

  • This notification is triggered only when the current user exits the room due to local disconnection timeout.
Parameters
ParameterDescription
roomIdsRoom ID list

MemberEventListener.onRoomMemberCountChanged

void onRoomMemberCountChanged(@NonNull RoomId roomId, Integer count);

Notification of number change of room members.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
countNumber of room members

MemberEventListener.onRoomMemberAttributesSet

void onRoomMemberAttributesSet(@NonNull RoomId roomId,
                               long userId,
                               @NonNull Map<String, String> attributes);

Callback notification of setting room member profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdRoom member ID
attributesConfigured profiles

MemberEventListener.onRoomMemberAttributesAddedOrUpdated

void onRoomMemberAttributesAddedOrUpdated(@NonNull RoomId roomId,
                                          long userId,
                                          @NonNull Map<String, String> attributes);

Callback notification of adding or updating room member profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdRoom member ID
attributesAdded or updated profiles

MemberEventListener.onRoomMemberAttributesDeleted

void onRoomMemberAttributesDeleted(@NonNull RoomId roomId,
                                   long userId,
                                   @NonNull Map<String, String> attributes);

Callback notification of deleting room member profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdRoom member ID
attributesDeleted profiles

MemberEventListener.onRoomMemberAttributesCleared

void onRoomMemberAttributesCleared(@NonNull RoomId roomId,
                                   long userId,
                                   @NonNull Map<String, String> attributes);

Callback notification of clearing room member profiles.

Notes:

Parameters
ParameterDescription
roomIdRoom ID
userIdRoom member ID
attributesCleared profiles

HummerLogCallback

HummerLogCallback.onHmrLogWithLevel

void onHmrLogWithLevel(HMRLogLevel level, String msg)

Log output callback for getting logs.

Parameters
ParameterDescription
levelLevel of logs to be output, see details in HMR.HMRLogLevel
msgLogs to be output

Was this page helpful?

Helpful Not helpful
Submitted! Your feedback would help us improve the website.
Feedback
Top