RtcEngineEventHandler class

The SDK uses the RtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.

Properties

activeSpeaker UidCallback?
Occurs when the most active speaker is detected. After a successful call of enableAudioVolumeIndication , the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, who is detected as the loudest for the most times, is the most active user. When the number of users exceeds two (included) and an active speaker is detected, the SDK triggers this callback and reports the uid of the most active speaker. If the most active speaker remains the same, the SDK triggers the activeSpeaker callback only once. If the most active speaker changes to another user, the SDK triggers this callback again and reports the uid of the new active speaker.
getter/setter pair
airPlayConnected EmptyCallback?
Occurs when the audio route switches to Apple AirPlay (iOS and macOS only)。
getter/setter pair
apiCallExecuted ApiCallCallback?
Occurs when a method is executed by the SDK.
getter/setter pair
audioDeviceStateChanged AudioDeviceStateChanged?
Occurs when the audio device state changes. This callback notifies the application that the system's audio device state is changed. For example, a headset is unplugged from the device. This method is for Windows and macOS only.
getter/setter pair
audioDeviceTestVolumeIndication OnAudioDeviceTestVolumeIndication?
Reports the result of an audio device test. After successfully calling startAudioRecordingDeviceTest , startAudioPlaybackDeviceTest , or startAudioDeviceLoopbackTest to start an audio device test, the SDK triggers the audioDeviceTestVolumeIndication callback at the set time interval to report the volume information of the audio device tested.
getter/setter pair
audioDeviceVolumeChanged AudioDeviceVolumeChanged?
Occurs when the volume on the playback or audio capture device, or the volume in the application changes.
getter/setter pair
audioEffectFinished SoundIdCallback?
Occurs when the playback of the local audio effect file finishes. This callback occurs when the local audio effect file finishes playing.
getter/setter pair
audioMixingFinished EmptyCallback?
Occurs when the playback of the local music file finishes. Deprecated: This method is deprecated as of v2.4.0. Use audioMixingStateChanged instead. After you call startAudioMixing to play a local music file, this callback occurs when the playback finishes. If the call of startAudioMixing fails, the callback returns the error code WARN_AUDIO_MIXING_OPEN_ERROR.
getter/setter pair
audioMixingStateChanged AudioMixingStateCallback?
Occurs when the playback state of the music file changes. This callback occurs when the playback state of the music file changes, and reports the current state and error code.
getter/setter pair
audioPublishStateChanged StreamPublishStateCallback?
Occurs when the audio publishing state changes.
getter/setter pair
audioQuality AudioQualityCallback?
Reports the statistics of the audio stream from each remote user. Deprecated: Deprecated.Please use remoteAudioStats instead. The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple users/hosts sending audio streams, the SDK triggers this callback as many times.
getter/setter pair
audioRouteChanged AudioRouteCallback?
Occurs when the local audio route changes.
getter/setter pair
audioSubscribeStateChanged StreamSubscribeStateCallback?
Occurs when the audio subscribing state changes.
getter/setter pair
audioVolumeIndication AudioVolumeCallback?
Reports the volume information of users. By default, this callback is disabled. You can enable it by calling enableAudioVolumeIndication . Once this callback is enabled and users send streams in the channel, the SDK triggers the enableAudioVolumeIndication callback at the time interval set in audioVolumeIndication. The SDK triggers two independent audioVolumeIndication callbacks simultaneously, which separately report the volume information of the local user who sends a stream and the remote users (up to three) whose instantaneous volumes are the highest. After you enable this callback, calling muteLocalAudioStream affects the SDK's behavior as follows: If the local user stops publishing the audio stream, the SDK stops triggering the local user's callback. 20 seconds after a remote user whose volume is one of the three highest stops publishing the audio stream, the callback excludes this user's information; 20 seconds after all remote users stop publishing audio streams, the SDK stops triggering the callback for remote users.
getter/setter pair
cameraExposureAreaChanged RectCallback?
Occurs when the camera exposure area changes. The SDK triggers this callback when the local user changes the camera exposure position by calling setCameraExposurePosition . This method is for Android and iOS only.
getter/setter pair
cameraFocusAreaChanged RectCallback?
Occurs when the camera focus area changes. The SDK triggers this callback when the local user changes the camera focus position by calling setCameraFocusPositionInPreview . This method is for Android and iOS only.
getter/setter pair
cameraReady EmptyCallback?
Occurs when the camera turns on and is ready to capture the video. Deprecated: Please use Capturing(1) in localVideoStateChanged instead. This callback indicates that the camera has been successfully turned on and you can start to capture video.
getter/setter pair
channelMediaRelayEvent MediaRelayEventCallback?
Reports events during the media stream relay.
getter/setter pair
channelMediaRelayStateChanged MediaRelayStateCallback?
Occurs when the state of the media stream relay changes. The SDK returns the state of the current media relay with any error message.
getter/setter pair
clientRoleChanged ClientRoleCallback?
Occurs when the user role switches successfully in the interactive live streaming. In the LIVE_BROADCASTING channel profile, when the local user successfully calls setClientRole to switch their user role after joining the channel, for example, from a host to an audience member or vice versa, the SDK triggers this callback to report the user role before and after the switch.
getter/setter pair
connectionBanned EmptyCallback?
Occurs when the connection is banned by the Agora server. Deprecated: Please use connectionStateChanged instead.
getter/setter pair
connectionInterrupted EmptyCallback?
Occurs when the connection between the SDK and the server is interrupted. Deprecated: Please use connectionStateChanged instead. The SDK triggers this callback when it loses connection with the server for more than four seconds after the connection is established. After triggering this callback, the SDK tries to reconnect to the server. You can use this callback to implement pop-up reminders. The difference between this callback and connectionLost is: The SDK triggers the connectionInterrupted callback when it loses connection with the server for more than four seconds after it successfully joins the channel. The SDK triggers the connectionLost callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel.
getter/setter pair
connectionLost EmptyCallback?
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the joinChannel method, regardless of whether it is in the channel. If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel.
getter/setter pair
connectionStateChanged ConnectionStateCallback?
Occurs when the network connection state changes. When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.
getter/setter pair
error ErrorCallback?
Reports an error during SDK runtime. This callback indicates that an error (concerning network or media) occurs during SDK runtime. In most cases, the SDK cannot fix the issue and resume running. The SDK requires the application to take action or informs the user about the issue. For example, the SDK reports an ERR_START_CALL error when failing to initialize a call. The app informs the user that the call initialization failed and calls leaveChannel to leave the channel.
getter/setter pair
facePositionChanged FacePositionCallback?
Reports the face detection result of the local user. Once you enable face detection by calling enableFaceDetection (true), you can get the following information on the local user in real-time: The width and height of the local video. The position of the human face in the local video. The distance between the human face and the screen. The distance between the human face and the screen is based on the fitting calculation of the local video size and the position of the human face captured by the camera. This callback is for Android and iOS only. When it is detected that the face in front of the camera disappears, the callback will be triggered immediately. In the state of no face, the trigger frequency of the callback will be reduced to save power consumption on the local device. The SDK stops triggering this callback when a human face is in close proximity to the screen. On Android, the value of distance reported in this callback may be slightly different from the actual distance. Therefore, Agora does not recommend using it for accurate calculation.
getter/setter pair
firstLocalAudioFrame ElapsedCallback?
Occurs when the engine sends the first local audio frame. Deprecated: Please use firstLocalAudioFramePublished instead.
getter/setter pair
firstLocalAudioFramePublished ElapsedCallback?
Occurs when the first audio frame is published. The SDK triggers this callback under one of the following circumstances: The local client enables the audio module and calls joinChannel successfully. The local client calls muteLocalAudioStream (true) and muteLocalAudioStream(false) in sequence. The local client calls disableAudio and enableAudio in sequence.
getter/setter pair
firstLocalVideoFrame VideoFrameCallback?
Occurs when the first local video frame is rendered. The SDK triggers this callback when the first local video frame is displayed/rendered on the local video view.
getter/setter pair
firstLocalVideoFramePublished ElapsedCallback?
Occurs when the first video frame is published. The SDK triggers this callback under one of the following circumstances: The local client enables the video module and calls joinChannel successfully. The local client calls muteLocalVideoStream (true) and muteLocalVideoStream(false) in sequence. The local client calls disableVideo and enableVideo in sequence.
getter/setter pair
firstRemoteAudioDecoded UidWithElapsedCallback?
Occurs when the SDK decodes the first remote audio frame for playback. Deprecated: Please use remoteAudioStateChanged instead. The SDK triggers this callback under one of the following circumstances: The remote user joins the channel and sends the audio stream for the first time. The remote user's audio is offline and then goes online to re-send audio. It means the local user cannot receive audio in 15 seconds. Reasons for such an interruption include: The remote user leaves channel. The remote user drops offline. The remote user calls muteLocalAudioStream to stop sending the audio stream. The remote user calls disableAudio to disable audio.
getter/setter pair
firstRemoteAudioFrame UidWithElapsedCallback?
Occurs when the SDK receives the first audio frame from a specific remote user. Deprecated: Please use remoteAudioStateChanged instead.
getter/setter pair
firstRemoteVideoDecoded VideoFrameWithUidCallback?
Occurs when the first remote video frame is received and decoded. Deprecated: Please use the remoteVideoStateChanged callback with the following parameters: Starting (1). Decoding (2). The SDK triggers this callback under one of the following circumstances: The remote user joins the channel and sends the video stream. The remote user stops sending the video stream and re-sends it after 15 seconds. Reasons for such an interruption include: The remote user leaves the channel. The remote user drops offline. The remote user calls muteLocalVideoStream to stop sending the video stream. The remote user calls disableVideo to disable video.
getter/setter pair
firstRemoteVideoFrame VideoFrameWithUidCallback?
Occurs when the first remote video frame is rendered. The SDK triggers this callback when the first local video frame is displayed/rendered on the local video view. The application can retrieve the time elapsed (the elapsed parameter) from a user joining the channel until the first video frame is displayed.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
joinChannelSuccess UidWithElapsedAndChannelCallback?
Occurs when a user joins a channel. This callback notifies the application that a user joins a specified channel.
getter/setter pair
lastmileProbeResult LastmileProbeCallback?
Reports the last mile network probe result. The SDK triggers this callback within 30 seconds after the app calls startLastmileProbeTest .
getter/setter pair
lastmileQuality NetworkQualityCallback?
Reports the last-mile network quality of the local user once every two seconds. This callback reports the last-mile network conditions of the local user before the user joins the channel. Last mile refers to the connection between the local device and Agora's edge server. Before the user joins the channel, this callback is triggered by the SDK once startLastmileProbeTest is called and reports the last-mile network conditions of the local user.
getter/setter pair
leaveChannel RtcStatsCallback?
Occurs when a user leaves a channel. This callback notifies the app that the user leaves the channel by calling leaveChannel . From this callback, the app can get information such as the call duration and quality statistics.
getter/setter pair
localAudioStateChanged LocalAudioStateCallback?
Occurs when the local audio stream state changes. When the state of the local audio stream changes (including the state of the audio capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local audio stream, and allows you to troubleshoot issues when audio exceptions occur. When the state isFailed (3), you can view the error information in the error parameter.
getter/setter pair
localAudioStats LocalAudioStatsCallback?
Reports the statistics of the local audio stream. The SDK triggers this callback once every two seconds.
getter/setter pair
localPublishFallbackToAudioOnly FallbackCallback?
Occurs when the published media stream falls back to an audio-only stream. If you call setLocalPublishFallbackOption and set option as AudioOnly, the SDK triggers this callback when the remote media stream falls back to audio-only mode due to poor uplink conditions, or when the remote media stream switches back to the video after the uplink network condition improves. If the local stream falls back to the audio-only stream, the remote user receives the userMuteVideo callback.
getter/setter pair
localUserRegistered UserAccountCallback?
Occurs when the local user registers a user account. After the local user successfully calls registerLocalUserAccount to register the user account or calls joinChannelWithUserAccount to join a channel, the SDK triggers the callback and informs the local user's UID and User Account.
getter/setter pair
localVideoStateChanged LocalVideoStateCallback?
Occurs when the local video stream state changes. When the state of the local video stream changes (including the state of the video capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur. The SDK triggers the localVideoStateChanged callback with the state code of Failed and error code of CaptureFailure in the following situations: The app switches to the background, and the system gets the camera resource. The camera starts normally, but does not output video for four consecutive seconds. When the camera outputs the captured video frames, if the video frames are the same for 15 consecutive frames, the SDK triggers the localVideoStateChanged callback with the state code of Capturing and error code of CaptureFailure. Note that the video frame duplication detection is only available for video frames with a resolution greater than 200 × 200, a frame rate greater than or equal to 10 fps, and a bitrate less than 20 Kbps. For some device models, the SDK does not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment.
getter/setter pair
localVideoStats LocalVideoStatsCallback?
Reports the statistics of the local video stream. The SDK triggers this callback once every two seconds to report the statistics of the local video stream.
getter/setter pair
localVoicePitchInHz OnLocalVoicePitchInHz?
Reports the voice pitch of the local user. After the local audio capture is enabled and you call enableLocalVoicePitchCallback , the SDK triggers the localVoicePitchInHz callback at the time interval set in enableLocalVoicePitchCallback. After this callback is enabled, if the user disables the local audio capture, for example, by calling enableLocalAudio , the SDK immediately stops sending the localVoicePitchInHz callback.
getter/setter pair
mediaEngineLoadSuccess EmptyCallback?
Occurs when the media engine loads.
getter/setter pair
mediaEngineStartCallSuccess EmptyCallback?
Occurs when the media engine call starts.
getter/setter pair
metadataReceived MetadataCallback?
Occurs when the local user receives the metadata.
getter/setter pair
microphoneEnabled EnabledCallback?
Occurs when the microphone is enabled/disabled. Deprecated: Please use the localAudioStateChanged callback: Stopped(0). Recording(1). The SDK triggers this callback when the local user enableLocalAudio resumes or stops capturing the local audio stream by calling the method.
getter/setter pair
networkQuality NetworkQualityWithUidCallback?
Reports the last mile network quality of each user in the channel. This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora's edge server. The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times.
getter/setter pair
networkTypeChanged NetworkTypeCallback?
Occurs when the local network type changes. This callback occurs when the connection state of the local user changes. You can get the connection state and reason for the state change in this callback. When the network connection is interrupted, this callback indicates whether the interruption is caused by a network type change or poor network conditions.
getter/setter pair
proxyConnected OnProxyConnected?
Reports the proxy connection state. You can use this callback to listen for the state of the SDK connecting to a proxy. For example, when a user calls setCloudProxy and joins a channel successfully, the SDK triggers this callback to report the user ID, the proxy type connected, and the time elapsed from the user calling until this callback is triggered.
getter/setter pair
rejoinChannelSuccess UidWithElapsedAndChannelCallback?
Occurs when a user rejoins the channel. When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.
getter/setter pair
remoteAudioMixingBegin EmptyCallback?
Occurs when a remote user starts audio mixing. When a remote user calls startAudioMixing to play the background music, the SDK reports this callback.
getter/setter pair
remoteAudioMixingEnd EmptyCallback?
Occurs when a remote user finishes audio mixing. The SDK triggers this callback when a remote user finishes audio mixing.
getter/setter pair
remoteAudioStateChanged RemoteAudioStateCallback?
Occurs when the remote audio state changes. When the audio state of a remote user (in the voice/video call channel) or host (in the live streaming channel) changes, the SDK triggers this callback to report the current state of the remote audio stream. This callback does not work properly when the number of users (in the voice/video call channel) or hosts (in the live streaming channel) in the channel exceeds 17.
getter/setter pair
remoteAudioStats RemoteAudioStatsCallback?
Reports the transport-layer statistics of each remote audio stream. The SDK triggers this callback once every two seconds for each remote user who is sending audio streams. If a channel includes multiple remote users, the SDK triggers this callback as many times.
getter/setter pair
remoteAudioTransportStats TransportStatsCallback?
Reports the transport-layer statistics of each remote audio stream. Deprecated: Please use remoteAudioStats instead. This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds after the local user receives an audio packet from a remote user. During a call, when the user receives the audio packet sent by the remote user/host, the callback is triggered every 2 seconds.
getter/setter pair
remoteSubscribeFallbackToAudioOnly FallbackWithUidCallback?
Occurs when the remote media stream falls back to the audio-only stream due to poor network conditions or switches back to the video stream after the network conditions improve. If you call setRemoteSubscribeFallbackOption and set option as AudioOnly, the SDK triggers this callback when the remote media stream falls back to audio-only mode due to poor downlink conditions, or when the remote media stream switches back to the video after the downlink network condition improves. Once the remote media stream switches to the low-quality stream due to poor network conditions, you can monitor the stream switch between a high-quality and low-quality stream in the remoteVideoStats callback.
getter/setter pair
remoteVideoStateChanged RemoteVideoStateCallback?
Occurs when the remote video state changes. This callback does not work properly when the number of users (in the voice/video call channel) or hosts (in the live streaming channel) in the channel exceeds 17.
getter/setter pair
remoteVideoStats RemoteVideoStatsCallback?
Reports the transport-layer statistics of each remote video stream. Reports the statistics of the video stream from the remote users. The SDK triggers this callback once every two seconds for each remote user. If a channel has multiple users/hosts sending video streams, the SDK triggers this callback as many times.
getter/setter pair
remoteVideoTransportStats TransportStatsCallback?
Reports the transport-layer statistics of each remote video stream. Deprecated: Please use remoteVideoStats instead. This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds after the local user receives a video packet from a remote user. During a call, when the user receives the video packet sent by the remote user/host, the callback is triggered every 2 seconds.
getter/setter pair
requestAudioFileInfo RequestAudioFileInfoCallback?
Reports the information of an audio file. After successfully calling getAudioFileInfo , the SDK triggers this callback to report the information of the audio file, such as the file path and duration.
getter/setter pair
requestToken EmptyCallback?
Occurs when the token expires. When the token expires during a call, the SDK triggers this callback to remind the app to renew the token. Once you receive this callback, generate a new token on your app server, and call joinChannel to rejoin the channel.
getter/setter pair
rtcStats RtcStatsCallback?
Reports the statistics of the current call. The SDK triggers this callback once every two seconds after the user joins the channel.
getter/setter pair
rtmpStreamingEvent RtmpStreamingEventCallback?
Reports events during the media push.
getter/setter pair
rtmpStreamingStateChanged RtmpStreamingStateCallback?
Occurs when the media push state changes. When the media push state changes, the SDK triggers this callback to report the current state and the reason why the state has changed. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the error code parameter.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
screenCaptureInfoUpdated OnScreenCaptureInfoUpdated?
Occurs when the screen sharing information is updated. When you call startScreenCaptureByDisplayId or startScreenCaptureByScreenRect to start screen sharing and use the excludeWindowList attribute to block the specified window, the SDK triggers this callback if the window blocking fails. This callback is for Windows only.
getter/setter pair
snapshotTaken SnapshotTakenCallback?
Reports the result of taking a video snapshot. After a successful takeSnapshot method call, the SDK triggers this callback to report whether the snapshot is successfully taken as well as the details for the snapshot taken.
getter/setter pair
streamInjectedStatus StreamInjectedStatusCallback?
Occurs when a media stream URL address is added to the interactive live streaming. Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it.
getter/setter pair
streamMessage StreamMessageCallback?
Occurs when the local user receives the data stream from the remote user. The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the sendStreamMessage method.
getter/setter pair
streamMessageError StreamMessageErrorCallback?
Occurs when the local user does not receive the data stream from the remote user. The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the sendStreamMessage method.
getter/setter pair
streamPublished UrlWithErrorCallback?
Occurs when an RTMP or RTMPS stream is published. Deprecated: Please use rtmpStreamingStateChanged instead. Reports the result of publishing an RTMP or RTMPS stream.
getter/setter pair
streamUnpublished UrlCallback?
Occurs when the media push stops. Deprecated: Please use rtmpStreamingStateChanged instead.
getter/setter pair
tokenPrivilegeWillExpire TokenCallback?
Occurs when the token expires in 30 seconds. When the token is about to expire in 30 seconds, the SDK triggers this callback to remind the app to renew the token. Upon receiving this callback, generate a new token on your server, and call renewToken to pass the new token to the SDK.
getter/setter pair
transcodingUpdated EmptyCallback?
Occurs when the publisher's transcoding is updated. When the LiveTranscoding class in the setLiveTranscoding method updates, the SDK triggers the transcodingUpdated callback to report the update information. If you call the setLiveTranscoding method to set the LiveTranscoding class for the first time, the SDK does not trigger this callback.
getter/setter pair
uploadLogResult UploadLogResultCallback?
Reports the result of uploading the SDK log files. Since v3.3.0 After uploadLogFile is called, the SDK triggers the callback to report the result of uploading the SDK log files. If the upload fails, refer to the reason parameter to troubleshoot.
getter/setter pair
userEnableLocalVideo UidWithEnabledCallback?
Occurs when a specific remote user enables/disables the local video capturing function. The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.
getter/setter pair
userEnableVideo UidWithEnabledCallback?
Occurs when a remote user enables/disables the video module. Once the video module is disabled, the user can only use a voice call. The user cannot send or receive any video. The SDK triggers this callback when a remote user enables or disables the video module by calling the enableVideo or disableVideo method.
getter/setter pair
userInfoUpdated UserInfoCallback?
Occurs when the SDK gets the user ID and user account of the remote user. After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers this callback on the local client.
getter/setter pair
userJoined UidWithElapsedCallback?
Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) joins the channel. In a communication channel, this callback indicates that a remote user joins the channel. The SDK also triggers this callback to report the existing users in the channel when a user joins the channel. In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Agora recommends limiting the number of hosts to 17. The SDK triggers this callback under one of the following circumstances: A remote user/host joins the channel by calling the joinChannel method. A remote user switches the user role to the host after joining the channel. A remote user/host rejoins the channel after a network interruption.
getter/setter pair
userMuteAudio UidWithMutedCallback?
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel. The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method. This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming profile) in the channel exceeds 17.
getter/setter pair
userMuteVideo UidWithMutedCallback?
Occurs when a remote user's video stream playback pauses/resumes. The SDK triggers this callback when the remote user stops or resumes sending the video stream by calling the muteLocalVideoStream method. This callback does not work properly when the number of users (in the COMMUNICATION profile) or hosts (in the LIVE_BROADCASTING profile) in the channel exceeds 17.
getter/setter pair
userOffline UserOfflineCallback?
Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) leaves the channel. There are two reasons for users to become offline: Leave the channel: When a 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 communication profile, and more for the live broadcast profile), the SDK assumes that the user/host drops offline. A poor network connection may lead to false detections. It's recommended to use the Agora RTM SDK for reliable offline detection.
getter/setter pair
userSuperResolutionEnabled UserSuperResolutionEnabledCallback?
Reports whether the super resolution feature is successfully enabled. After calling enableRemoteSuperResolution , the SDK triggers the callback to report whether super resolution is successfully enabled. If it is not successfully enabled, use reason for troubleshooting.
getter/setter pair
videoDeviceStateChanged VideoDeviceStateChanged?
Occurs when the video device state changes. This callback reports the change of system video devices, such as being unplugged or removed. On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged.
getter/setter pair
videoPublishStateChanged StreamPublishStateCallback?
Occurs when the video publishing state changes.
getter/setter pair
videoSizeChanged VideoSizeCallback?
Occurs when the video size or rotation of a specified user changes.
getter/setter pair
videoStopped EmptyCallback?
Occurs when the video stops playing. Deprecated: Please use Stopped(0) in the localVideoStateChanged callback instead. The application can use this callback to change the configuration of the view (for example, displaying other pictures in the view) after the video stops playing.
getter/setter pair
videoSubscribeStateChanged StreamSubscribeStateCallback?
Occurs when the video subscribing state changes.
getter/setter pair
virtualBackgroundSourceEnabled VirtualBackgroundSourceEnabledCallback?
Reports whether virtual background is successfully enabled. (beta feature) Since v3.5.0 After you call enableVirtualBackground , the SDK triggers this callback to report whether virtual background is successfully enabled. If the background image customized in the virtual background is in the PNG or JPG format, this callback is triggered after the image is read.
getter/setter pair
warning WarningCallback?
Reports a warning during SDK runtime. Occurs when a warning occurs during SDK runtime. In most cases, the app can ignore the warnings reported by the SDK because the SDK can usually fix the issue and resume running. For example, when losing connection with the server, the SDK may report WARN_LOOKUP_CHANNEL_TIMEOUT and automatically try to reconnect.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited