userOffline property

UserOfflineCallback? userOffline
getter/setter pair

Occurs when a remote user (ChannelProfile.Communication)/host (ChannelProfile.LiveBroadcasting) leaves the channel.

There are two reasons for users to become offline:

  • Leave the channel: When the user/host leaves the channel, the user/host sends a goodbye message. When this message is received, the SDK determines that the user/host leaves the channel.
  • Drop offline: When no data packet of the user or host is received for a certain period of time (20 seconds for the ChannelProfile.Communication profile, and more for the ChannelProfile.LiveBroadcasting profile), the SDK assumes that the user/host drops offline. A poor network connection may lead to false detections, so we recommend using the Agora RTM SDK for reliable offline detection.

The UserOfflineCallback typedef includes the following parameters:

  • int uid: ID of the user or host who leaves the channel or goes offline.
  • UserOfflineReason reason: Reason why the user goes offline.

Implementation

UserOfflineCallback? userOffline;