IRtcEngineEventHandler

onActiveSpeaker

Occurs when the most active remote speaker is detected.

  onActiveSpeaker?(connection: RtcConnection, uid: number): void;

After a successful call of enableAudioVolumeIndication, the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user whose volume is detected as the loudest for the most times, is the most active user.

When the number of users is no less than two and an active remote speaker exists, the SDK triggers this callback and reports the uid of the most active remote speaker.

If the most active remote speaker is always the same user, the SDK triggers the onActiveSpeaker callback only once.
If the most active remote speaker changes to another user, the SDK triggers this callback again and reports the uid of the new active remote speaker.

Parameters

connection: The connection information. See RtcConnection.
uid: The user ID of the most active speaker.

onAudioEffectFinished

Occurs when the playback of the local music file finishes.

  onAudioEffectFinished?(soundId: number): void;

This callback occurs when the local audio effect file finishes playing.

Parameters

soundId: The ID of the audio effect. The ID of each audio effect file is unique.

onAudioMixingFinished

Occurs when the playback of the local music file finishes.

  onAudioMixingFinished?(): void;

Deprecated:: Use onAudioMixingStateChanged 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 error code WARN_AUDIO_MIXING_OPEN_ERROR is returned.

onAudioMixingPositionChanged

Reports the playback progress of a music file.

onAudioMixingPositionChanged?(position: number): void;

Details

After you called the startAudioMixing method to play a music file, the SDK triggers this callback every two seconds to report the playback progress.

Parameters

position: The playback progress (ms).

Returns

0: Success.
< 0: Failure.

onAudioMixingStateChanged

Occurs when the playback state of the music file changes.

  onAudioMixingStateChanged?(
    state: AudioMixingStateType,
    reason: AudioMixingReasonType
  ): void;

This callback occurs when the playback state of the music file changes, and reports the current state and error code.

Parameters

state: The playback state of the music file. See AudioMixingStateType.
reason: Error code. See AudioMixingReasonType.

onAudioPublishStateChanged

Occurs when the audio publishing state changes.

  onAudioPublishStateChanged?(
    channel: string,
    oldState: StreamPublishState,
    newState: StreamPublishState,
    elapseSinceLastState: number
  ): void;

Parameters

channel: The channel name.
oldState: The previous publishing state. See StreamPublishState.
newState: The current publishing stat. See StreamPublishState.
elapseSinceLastState: The time elapsed (ms) from the previous state to the current state.

onAudioQuality

Reports the statistics of the audio stream sent by each remote user.

  onAudioQuality?(
    connection: RtcConnection,
    remoteUid: number,
    quality: QualityType,
    delay: number,
    lost: number
  ): void;

Deprecated:: Use onRemoteAudioStats instead.

The SDK triggers this callback once every two seconds to report the audio quality of each remote user who is sending an audio stream. If a channel has multiple users sending audio streams, the SDK triggers this callback as many times.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The user ID of the remote user sending the audio stream.
quality: Audio quality of the user. See QualityType.
delay: The network delay (ms) from the sender to the receiver, including the delay caused by audio sampling pre-processing, network transmission, and network jitter buffering.
lost: The packet loss rate (%) of the audio packet sent from the remote user to the receiver.

onAudioRoutingChanged

Occurs when the local audio route changes.

  onAudioRoutingChanged?(routing: number): void;

Parameters

routing

The current audio routing.

-1: The default audio route.
0: The audio route is a headset with a microphone.
1: The audio route is an earpiece.
2: The audio route is a headset without a microphone.
3: The audio route is the speaker that comes with the device.
4: The audio route is an external speaker. (For iOS and macOS only)
(5): The audio route is a Bluetooth headset.

onAudioSubscribeStateChanged

Occurs when the audio subscribing state changes.

  onAudioSubscribeStateChanged?(
    channel: string,
    uid: number,
    oldState: StreamSubscribeState,
    newState: StreamSubscribeState,
    elapseSinceLastState: number
  ): void;

Parameters

channel: The channel name.
uid: The user ID of the remote user.
oldState: The previous subscribing status. See StreamSubscribeState.
newState: The current subscribing status. See StreamSubscribeState.
elapseSinceLastState: The time elapsed (ms) from the previous state to the current state.

onAudioVolumeIndication

Reports the volume information of users.

onAudioVolumeIndication?(
  connection: RtcConnection,
  speakers: AudioVolumeInfo[],
  speakerNumber: number,
  totalVolume: number
): void;

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 onAudioVolumeIndication callback according to the time interval set in enableAudioVolumeIndication. The SDK triggers two independent onAudioVolumeIndication 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 volume is the highest.

Attention:

Once this callback is enabled, if the local user calls the muteLocalAudioStream method to mute, the SDK continues to report the volume indication of the local user.

If a remote user whose volume is one of the three highest in the channel stops publishing the audio stream for 20 seconds, the callback excludes this user's information; if all remote users stop publishing audio streams for 20 seconds, the SDK stops triggering the callback for remote users.

Parameters

connection

The connection information. See RtcConnection.

speakers

The volume information of the users. See AudioVolumeInfo. An empty speakers array in the callback indicates that no remote user is in the channel or is sending a stream.

speakerNumber

The total number of users.

In the callback for the local user, if the local user is sending streams, the value of speakerNumber is 1.
In the callback for remote users, the value range of speakerNumber is [0,3]. If the number of remote users who send streams is greater than or equal to three, the value of speakerNumber is 3.

totalVolume

The volume of the speaker. The value range is [0,255].

In the callback for the local user, totalVolume is the volume of the local user who sends a stream.
In the callback for remote users, totalVolume is the sum of the volume of all remote users (up to three) whose instantaneous volume is the highest.

onCameraExposureAreaChanged

Occurs when the camera exposure area changes.

  onCameraExposureAreaChanged?(
    x: number,
    y: number,
    width: number,
    height: number
  ): void;

The SDK triggers this callback when the local user changes the camera exposure position by calling setCameraExposurePosition.

Attention: This callback is for Android and iOS only.

Parameters

x: The x coordinate of the changed camera exposure area.
y: The y coordinate of the changed camera exposure area.
width: The width of the changed camera exposure area.
height: The height of the changed exposure area.

onCameraFocusAreaChanged

Occurs when the camera focus area changes.

  onCameraFocusAreaChanged?(
    x: number,
    y: number,
    width: number,
    height: number
  ): void;

The SDK triggers this callback when the local user changes the camera focus position by calling setCameraFocusPositionInPreview.

Attention: This callback is for Android and iOS only.

Parameters

x: The x-coordinate of the changed camera focus area.
y: The y-coordinate of the changed camera focus area.
width: The width of the changed camera focus area.
height: The height of the changed camera focus area.

onCameraReady

Occurs when the camera turns on and is ready to capture the video.

  onCameraReady?(): void;

Deprecated:: Use LocalVideoStreamStateCapturing(1) in onLocalVideoStateChanged instead.

This callback indicates that the camera has been successfully turned on and you can start to capture video.

onChannelMediaRelayStateChanged

Occurs when the state of the media stream relay changes.

  onChannelMediaRelayStateChanged?(
    state: ChannelMediaRelayState,
    code: ChannelMediaRelayError
  ): void;

The SDK returns the state of the current media relay with any error message.

Parameters

state: The state code. See ChannelMediaRelayState.
code: The error code of the channel media relay. See ChannelMediaRelayError.

onClientRoleChanged

Occurs when the user role or the audience latency level changes.

  onClientRoleChanged?(
    connection: RtcConnection,
    oldRole: ClientRoleType,
    newRole: ClientRoleType
    newRoleOptions: ClientRoleOptions
  ): void;

Trigger timing

This callback will be triggered in any of the following situations:

Calling setClientRole to set the user role or audience latency level after joining a channel.
Calling setClientRole to set the user role to AUDIENCE before joining a channel.

Restrictions

This callback will not be triggered when you call or setClientRole and set the user role to BROADCASTER before joining a channel.

Parameters

connection: The connection information. See RtcConnection.
oldRole: Role that the user switches from: ClientRoleType.
newRole: Role that the user switches to: ClientRoleType.
newRoleOptions: Properties of the role that the user switches to. See ClientRoleOptions.

onClientRoleChangeFailed

Occurs when switching a user role fails.

  onClientRoleChangeFailed?(
    connection: RtcConnection,
    reason: ClientRoleChangeFailedReason,
    currentRole: ClientRoleType
  ): void;

This callback informs you about the reason for failing to switching and your current user role.

Trigger timing

The SDK triggers this callback when the local user calls setClientRole after joining a channel to switch the user role but the switching fails.

Restrictions

None.

Parameters

reason: The reason for a user role switch failure. See ClientRoleChangeFailedReason.
currentRole: Current user role. See ClientRoleType.
connection: The connection information. See RtcConnection.

onConnectionBanned

Occurs when the connection is banned by the Agora server.

  onConnectionBanned?(connection: RtcConnection): void;

Deprecated:: Use onConnectionStateChanged instead.

Parameters

connection: The connection information. See RtcConnection.

onConnectionInterrupted

Occurs when the connection between the SDK and the server is interrupted.

  onConnectionInterrupted?(connection: RtcConnection): void;

Deprecated:: Use onConnectionStateChanged 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 differences between this callback and onConnectionLost are as follow:

The SDK triggers the onConnectionInterrupted callback when it loses connection with the server for more than four seconds after it successfully joins the channel.
The SDK triggers the onConnectionLost 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.

Parameters

connection: The connection information. See RtcConnection.

onConnectionLost

Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.

  onConnectionLost?(connection: RtcConnection): void;

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.

Parameters

connection: The connection information. See RtcConnection.

onConnectionStateChanged

Occurs when the network connection state changes.

  onConnectionStateChanged?(
    connection: RtcConnection,
    state: ConnectionStateType,
    reason: ConnectionChangedReasonType
  ): void;

When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.

Parameters

connection: The connection information. See RtcConnection.
state: The current connection state. See ConnectionStateType.
reason: The reason for a connection state change. See ConnectionChangedReasonType.

onEncryptionError

Reports the built-in encryption errors.

  onEncryptionError?(
    connection: RtcConnection,
    errorType: EncryptionErrorType
  ): void;

When encryption is enabled by calling enableEncryption, the SDK triggers this callback if an error occurs in encryption or decryption on the sender or the receiver side.

Parameters

connection: The connection information. See RtcConnection.
errorType: Details about the error type. See EncryptionErrorType.

onError

Reports an error during SDK runtime.

  onError?(err: ErrorCodeType, msg: string): void;

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 app to take action or informs the user about the issue.

Parameters

err: Error code. See ErrorCodeType.
msg: The error message.

onExtensionErrorWithContext

Occurs when the extension runs incorrectly.

onExtensionErrorWithContext?(
    context: ExtensionContext,
    error: number,
    message: string
  ): void;

In case of extension enabling failure or runtime errors, the extension triggers this callback and reports the error code along with the reasons.

Parameters

context: The context information of the extension, see ExtensionContext.
error: Error code. For details, see the extension documentation provided by the extension provider.
message: Reason. For details, see the extension documentation provided by the extension provider.

onExtensionEventWithContext

The event callback of the extension.

onExtensionEventWithContext?(
    context: ExtensionContext,
    key: string,
    value: string
  ): void;

To listen for events while the extension is running, you need to register this callback.

Parameters

context: The context information of the extension, see ExtensionContext.
key: The key of the extension.
value: The value of the extension key.

onExtensionStartedWithContext

Occurrs when the extension is enabled.

onExtensionStartedWithContext?(context: ExtensionContext): void;

The callback is triggered after the extension is successfully enabled.

Parameters

context: The context information of the extension, see ExtensionContext.

onExtensionStoppedWithContext

Occurs when the extension is disabled.

onExtensionStoppedWithContext?(context: ExtensionContext): void;

The callback is triggered after the extension is successfully disabled.

Parameters

context: The context information of the extension, see ExtensionContext.

onFacePositionChanged

Reports the face detection result of the local user.

  onFacePositionChanged?(
    imageWidth: number,
    imageHeight: number,
    vecRectangle: Rectangle,
    vecDistance: number,
    numFaces: number
  ): void;

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 view.
The distance between the human face and the screen.

This value is based on the fitting calculation of the local video size and the position of the human face.

Attention:

When it is detected that the face in front of the camera disappears, the callback will be triggered immediately. When no human face is detected, the frequency of this callback to be triggered wil be decreased to reduce power consumption on the local device.
The SDK stops triggering this callback when a human face is in close proximity to the screen.

Parameters

imageWidth: The width (px) of the video image captured by the local camera.
imageHeight: The height (px) of the video image captured by the local camera.
vecRectangle: The information of the detected human face. See Rectangle.
vecDistance: The distance between the human face and the device screen (cm).
numFaces: The number of faces detected. If the value is 0, it means that no human face is detected.

onFirstLocalAudioFramePublished

Occurs when the first audio frame is published.

  onFirstLocalAudioFramePublished?(
    connection: RtcConnection,
    elapsed: number
  ): void;

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.

Parameters

connection: The connection information. See RtcConnection.
elapsed: Time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onFirstLocalVideoFrame

Occurs when the first local video frame is displayed on the local video view.

onFirstLocalVideoFrame?(
    source: VideoSourceType,
    width: number,
    height: number,
    elapsed: number
  ): void;

The SDK triggers this callback when the first local video frame is displayed on the local video view.

Parameters

source: The type of the video source. See VideoSourceType.
width: The width (px) of the first local video frame.
height: The height (px) of the first local video frame.
elapsed: The time elapsed (ms) from the local user calling joinChannel to join the channel to when the SDK triggers this callback. If startPreviewWithoutSourceType/startPreview is called before joining the channel, this parameter indicates the time elapsed from calling startPreviewWithoutSourceType or startPreview to when this event occurred.

onFirstLocalVideoFramePublished

Occurs when the first video frame is published.

  onFirstLocalVideoFramePublished?(
    connection: RtcConnection,
    elapsed: number
  ): void;

The SDK triggers this callback under one of the following circumstances:

The local client enables the video module and calls joinChannel to join the channel successfully.
The local client calls muteLocalVideoStream(true) and muteLocalVideoStream(false) in sequence.
The local client calls disableVideo and enableVideo in sequence.

Parameters

connection: The connection information. See RtcConnection.
elapsed: Time elapsed (ms) from the local user calling joinChannel until this callback is triggered.

onFirstRemoteAudioFrame

Occurs when the SDK receives the first audio frame from a specific remote user.

  onFirstRemoteAudioFrame?(
    connection: RtcConnection,
    userId: number,
    elapsed: number
  ): void;

Deprecated:: Use onRemoteAudioStateChanged instead.

Parameters

connection: The connection information. See RtcConnection.
userId: The user ID of the remote user.
elapsed: The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onFirstRemoteAudioDecoded

Occurs when the SDK decodes the first remote audio frame for playback.

  onFirstRemoteAudioDecoded?(
    connection: RtcConnection,
    uid: number,
    elapsed: number
  ): void;

Deprecated:: Use onRemoteAudioStateChanged 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.

Parameters

connection: The connection information. See RtcConnection.
uid: The user ID of the remote user.
elapsed: The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onFirstRemoteVideoDecoded

Occurs when the first remote video frame is received and decoded.

  onFirstRemoteVideoDecoded?(
    connection: RtcConnection,
    remoteUid: number,
    width: number,
    height: number,
    elapsed: number
  ): void;

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 disableVideo to disable video.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The user ID of the remote user sending the video stream.
width: The width (px) of the video stream.
height: The height (px) of the video stream.
elapsed: The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onFirstRemoteVideoFrame

Occurs when the renderer receives the first frame of the remote video.

  onFirstRemoteVideoFrame?(
    connection: RtcConnection,
    remoteUid: number,
    width: number,
    height: number,
    elapsed: number
  ): void;

Attention: This callback is only triggered when the video frame is rendered by the SDK; it will not be triggered if the user employs custom video rendering.You need to implement this independently using methods outside the SDK.

Parameters

remoteUid: The user ID of the remote user sending the video stream.
connection: The connection information. See RtcConnection.
width: The width (px) of the video stream.
height: The height (px) of the video stream.
elapsed: The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onJoinChannelSuccess

Occurs when a user joins a channel.

  onJoinChannelSuccess?(connection: RtcConnection, elapsed: number): void;

This callback notifies the application that a user joins a specified channel.

Trigger timing

The SDK triggers this callback when you call joinChannel, joinChannelWithUserAccount, joinChannelEx or joinChannelWithUserAccountEx to join a channel.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
elapsed: The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onLastmileProbeResult

Reports the last mile network probe result.

  onLastmileProbeResult?(result: LastmileProbeResult): void;

The SDK triggers this callback within 30 seconds after the app calls startLastmileProbeTest.

Parameters

result: The uplink and downlink last-mile network probe test result. See LastmileProbeResult.

onLastmileQuality

Reports the last-mile network quality of the local user.

  onLastmileQuality?(quality: QualityType): void;

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 oncestartLastmileProbeTest is called and reports the last-mile network conditions of the local user.

Parameters

quality: The last-mile network quality. See QualityType.

onLeaveChannel

Occurs when a user leaves a channel.

  onLeaveChannel?(connection: RtcConnection, stats: RtcStats): void;

You can obtain information such as the total duration of a call, and the data traffic that the SDK transmits and receives.

Trigger timing

The SDK triggers this callback after you call leaveChannel or leaveChannelEx to leave a channel.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
stats: Call statistics. See RtcStats.

onLocalAudioStateChanged

Occurs when the local audio stream state changes.

  onLocalAudioStateChanged?(
    connection: RtcConnection,
    state: LocalAudioStreamState,
    reason: LocalAudioStreamReason
  ): void;

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.

Attention: When the state is LocalAudioStreamStateFailed (3), you can view the error information in the error parameter.

Parameters

connection: The connection information. See RtcConnection.
state: The state of the local audio. See LocalAudioStreamState.
reason: Reasons for local audio state changes. See LocalAudioStreamReason.

onLocalAudioStats

Reports the statistics of the local audio stream.

  onLocalAudioStats?(connection: RtcConnection, stats: LocalAudioStats): void;

The SDK triggers this callback once every two seconds.

Parameters

connection: The connection information. See RtcConnection.
stats: Local audio statistics. See LocalAudioStats.

onLocalUserRegistered

Occurs when the local user registers a user account.

  onLocalUserRegistered?(uid: number, userAccount: string): void;

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.

Parameters

uid: The ID of the local user.
userAccount: The user account of the local user.

onLocalVideoStateChanged

Occurs when the local video stream state changes.

onLocalVideoStateChanged?(
    source: VideoSourceType,
    state: LocalVideoStreamState,
    reason: LocalVideoStreamReason
  ): void;

When the status of the local video changes, the SDK triggers this callback to report the current local video state and the reason for the state change.

Applicable scenarios

You can use this callback to stay updated on the state changes of the local video stream, and take corresponding measures based on the reasons for the state changes, to better manage and debug issues related to the video stream.

Trigger timing

The SDK triggeres this callback under the following circumstances, with the state as LocalVideoStreamStateFailed, and the reason as LocalVideoStreamReasonCaptureFailure:
- The app switches to the background, and the system revokes the camera resource.
- For Android 9 and later versions, after an app is in the background for a period, the system automatically revokes camera permissions.
- For Android 6 and later versions, if the camera is held by a third-party app for a certain duration and then released, the SDK triggers this callback and reports the onLocalVideoStateChanged(LocalVideoStreamStateCapturing,LocalVideoStreamReasonOk) callback.
- The camera starts normally, but does not output video frames for four consecutive seconds.
When the camera outputs captured video frames, if the SDK detects 15 consecutive duplicate video frames, it triggers this callback, with the state as LocalVideoStreamStateCapturing and the reason as LocalVideoStreamReasonCaptureFailure.
Note: 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.

Restrictions

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.

Parameters

source: The type of the video source. See VideoSourceType.
state: The state of the local video, see LocalVideoStreamState.
reason: The reasons for changes in local video state. See LocalVideoStreamReason.

onLocalVideoStats

Reports the statistics of the local video stream.

  onLocalVideoStats?(connection: RtcConnection, stats: LocalVideoStats): void;

The SDK triggers this callback once every two seconds to report the statistics of the local video stream.

Parameters

connection: The connection information. See RtcConnection.
stats: The statistics of the local video stream. See LocalVideoStats.

onLocalVideoTranscoderError

Occurs when there's an error during the local video mixing.

onLocalVideoTranscoderError?(
    stream: TranscodingVideoStream,
    error: VideoTranscoderError
  ): void;

Details

When you fail to call startLocalVideoTranscoder or updateLocalTranscoderConfiguration, the SDK triggers this callback to report the reason.

Parameters

stream: The video streams that cannot be mixed during video mixing. See TranscodingVideoStream.
error: The reason for local video mixing error. See VideoTranscoderError.

onNetworkQuality

Reports the last mile network quality of each user in the channel.

  onNetworkQuality?(
    connection: RtcConnection,
    remoteUid: number,
    txQuality: QualityType,
    rxQuality: QualityType
  ): void;

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.

This callback provides feedback on network quality through sending and receiving broadcast packets within the channel. Excessive broadcast packets can lead to broadcast storms. To prevent broadcast storms from causing a large amount of data transmission within the channel, this callback supports feedback on the network quality of up to 4 remote hosts simultaneously by default.

Note: txQuality is Unknown when the user is not sending a stream; rxQuality is Unknown when the user is not receiving a stream.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The user ID. The network quality of the user with this user ID is reported. If the uid is 0, the local network quality is reported.
txQuality: Uplink network quality rating of the user in terms of the transmission bit rate, packet loss rate, average RTT (Round-Trip Time) and jitter of the uplink network. This parameter is a quality rating helping you understand how well the current uplink network conditions can support the selected video encoder configuration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 × 480 and a frame rate of 15 fps in the LIVE_BROADCASTING profile, but might be inadequate for resolutions higher than 1280 × 720.
rxQuality: Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network.

onNetworkTypeChanged

Occurs when the local network type changes.

  onNetworkTypeChanged?(connection: RtcConnection, type: NetworkType): void;

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.

Parameters

connection: The connection information. See RtcConnection.
type: The type of the local network connection. See NetworkType.

onPermissionError

Occurs when the SDK cannot get the device permission.

  onPermissionError?(permissionType: PermissionType): void;

When the SDK fails to get the device permission, the SDK triggers this callback to report which device permission cannot be got.

Parameters

permissionType: The type of the device permission. See PermissionType.

onProxyConnected

Reports the proxy connection state.

  onProxyConnected?(
    channel: string,
    uid: number,
    proxyType: ProxyType,
    localProxyIp: string,
    elapsed: number
  ): void;

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 fromthe user calling joinChannel until this callback is triggered.

Parameters

channel: The channel name.
uid: The user ID.
proxyType: The proxy type connected. See ProxyType.
localProxyIp: Reserved for future use.
elapsed: The time elapsed (ms) from the user calling joinChannel until this callback is triggered.

onRejoinChannelSuccess

Occurs when a user rejoins the channel.

  onRejoinChannelSuccess?(connection: RtcConnection, elapsed: number): void;

Trigger timing

When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
elapsed: Time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.

onRemoteAudioStateChanged

Occurs when the remote audio state changes.

  onRemoteAudioStateChanged?(
    connection: RtcConnection,
    remoteUid: number,
    state: RemoteAudioState,
    reason: RemoteAudioStateReason,
    elapsed: number
  ): void;

When the audio state of a remote user (in a voice/video call channel) or host (in a live streaming channel) changes, the SDK triggers this callback to report the current state of the remote audio stream.

Attention: This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the remote user whose audio state changes.
state: The state of the remote audio. See RemoteAudioState.
reason: The reason of the remote audio state change. See RemoteAudioStateReason.
elapsed: Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

onRemoteAudioStats

Reports the transport-layer statistics of each remote audio stream.

  onRemoteAudioStats?(connection: RtcConnection, stats: RemoteAudioStats): void;

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.

Parameters

connection: The connection information. See RtcConnection.
stats: The statistics of the received remote audio streams. See RemoteAudioStats.

onRemoteAudioTransportStats

Reports the transport-layer statistics of each remote audio stream.

  onRemoteAudioTransportStats?(
    connection: RtcConnection,
    remoteUid: number,
    delay: number,
    lost: number,
    rxKBitRate: number
  ): void;

Deprecated:: Use onRemoteAudioStats instead.

This callback reports the transport-layer statistics, such as the packet loss rate and network time delay 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, the callback is triggered every 2 seconds.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the remote user sending the audio streams.
delay: The network delay (ms) from the remote user to the receiver.
lost: The packet loss rate (%) of the audio packet sent from the remote user to the receiver.
rxKBitrate: The bitrate of the received audio (Kbps).

onRemoteSubscribeFallbackToAudioOnly

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.

  onRemoteSubscribeFallbackToAudioOnly?(
    uid: number,
    isFallbackOrRecover: boolean
  ): void;

If you call setRemoteSubscribeFallbackOption and set option to StreamFallbackOptionAudioOnly, the SDK triggers this callback in the following situations:

The downstream network condition is poor, and the subscribed video stream is downgraded to audio-only stream.
The downstream network condition has improved, and the subscribed stream has been restored to video stream.

Attention: Once the remote media stream switches to the low-quality video stream due to weak network conditions, you can monitor the stream switch between a high-quality and low-quality stream in the onRemoteVideoStats callback.

Parameters

uid

The user ID of the remote user.

isFallbackOrRecover

true: The subscribed media stream falls back to audio-only due to poor network conditions.
false: The subscribed media stream switches back to the video stream after the network conditions improve.

onRemoteVideoStateChanged

Occurs when the remote video stream state changes.

  onRemoteVideoStateChanged?(
    connection: RtcConnection,
    remoteUid: number,
    state: RemoteVideoState,
    reason: RemoteVideoStateReason,
    elapsed: number
  ): void;

Attention: This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the remote user whose video state changes.
state: The state of the remote video. See RemoteVideoState.
reason: The reason for the remote video state change. See RemoteVideoStateReason.
elapsed: Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

onRemoteVideoStats

Reports the statistics of the video stream sent by each remote users.

  onRemoteVideoStats?(connection: RtcConnection, stats: RemoteVideoStats): void;

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.

Parameters

connection: The connection information. See RtcConnection.
stats: Statistics of the remote video stream. See RemoteVideoStats.

onRemoteVideoTransportStats

Reports the transport-layer statistics of each remote video stream.

  onRemoteVideoTransportStats?(
    connection: RtcConnection,
    remoteUid: number,
    delay: number,
    lost: number,
    rxKBitRate: number
  ): void;

Deprecated:: This callback is deprecated. Use onRemoteVideoStats instead.

This callback reports the transport-layer statistics, such as the packet loss rate and network time delay 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.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the remote user sending the video packets.
delay: The network delay (ms) from the sender to the receiver.
lost: The packet loss rate (%) of the video packet sent from the remote user.
rxKBitRate: The bitrate of the received video (Kbps).

onRequestToken

Occurs when the token expires.

  onRequestToken?(connection: RtcConnection): void;

The SDK triggers this callback if the token expires.

When receiving this callback, you need to generate a new token on your token server and you can renew your token through one of the following ways:

In scenarios involving one channel:
- Call renewToken to pass in the new token.
- Call leaveChannel to leave the current channel and then pass in the new token when you call joinChannel to join a channel.
In scenarios involving mutiple channels: Call updateChannelMediaOptionsEx to pass in the new token.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.

onRhythmPlayerStateChanged

Occurs when the state of virtual metronome changes.

onRhythmPlayerStateChanged?(
    state: RhythmPlayerStateType,
    reason: RhythmPlayerReason
  ): void;

When the state of the virtual metronome changes, the SDK triggers this callback to report the current state of the virtual metronome. This callback indicates the state of the local audio stream and enables you to troubleshoot issues when audio exceptions occur.

Parameters

state: For the current virtual metronome status, see RhythmPlayerStateType.
errorCode: For the error codes and error messages related to virtual metronome errors, see RhythmPlayerReason.

onRtcStats

Reports the statistics about the current call.

  onRtcStats?(connection: RtcConnection, stats: RtcStats): void;

Trigger timing

The SDK triggers this callback once every two seconds after the user joins the channel.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
stats: Statistics of the RTC engine. See RtcStats.

onRtmpStreamingEvent

Reports events during the Media Push.

  onRtmpStreamingEvent?(url: string, eventCode: RtmpStreamingEvent): void;

Parameters

url: The URL for Media Push.
eventCode: The event code of Media Push. See RtmpStreamingEvent.

onRtmpStreamingStateChanged

Occurs when the state of Media Push changes.

  onRtmpStreamingStateChanged?(
    url: string,
    state: RtmpStreamPublishState,
    reason: RtmpStreamPublishReason
  ): void;

When the state of Media Push changes, the SDK triggers this callback and reports the URL address and the current state of the Media Push. This callback indicates the state of the Media Push. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the error code parameter.

Parameters

url: The URL address where the state of the Media Push changes.
state: The current state of the Media Push. See RtmpStreamPublishState.
reason: Reasons for the changes in the Media Push status. See RtmpStreamPublishReason.

onSnapshotTaken

Reports the result of taking a video snapshot.

  onSnapshotTaken?(
    connection: RtcConnection,
    uid: number,
    filePath: string,
    width: number,
    height: number,
    errCode: number
  ): void;

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.

Parameters

uid

The user ID. One uid of 0 indicates the local user.

connection

The connection information. See RtcConnection.

filePath

The local path of the snapshot.

width

The width (px) of the snapshot.

height

The height (px) of the snapshot.

errCode

The message that confirms success or gives the reason why the snapshot is not successfully taken:

0: Success.
< 0: Failure:
- -1: The SDK fails to write data to a file or encode a JPEG image.
- -2: The SDK does not find the video stream of the specified user within one second after the takeSnapshot method call succeeds. The possible reasons are: local capture stops, remote end stops publishing, or video data processing is blocked.
- -3: Calling the takeSnapshot method too frequently.

onStreamMessage

Occurs when the local user receives the data stream from the remote user.

onStreamMessage?(
  connection: RtcConnection,
  remoteUid: number,
  streamId: number,
  data: Uint8Array,
  length: number,
  sentTs: number
): void;

The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the sendStreamMessage method.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the remote user sending the message.
streamId: The stream ID of the received message.
data: The data received.
length: The data length (byte).
sentTs: The time when the data stream is sent.

onStreamMessageError

Occurs when the local user does not receive the data stream from the remote user.

  onStreamMessageError?(
    connection: RtcConnection,
    remoteUid: number,
    streamId: number,
    code: ErrorCodeType,
    missed: number,
    cached: number
  ): void;

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.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the remote user sending the message.
streamId: The stream ID of the received message.
code: The error code. See ErrorCodeType.
missed: The number of lost messages.
cached: Number of incoming cached messages when the data stream is interrupted.

onTokenPrivilegeWillExpire

Occurs when the token expires in 30 seconds.

onTokenPrivilegeWillExpire?(connection: RtcConnection, token: string): void;

When receiving this callback, you need to generate a new token on your token server and you can renew your token through one of the following ways:

In scenarios involving one channel:
- Call renewToken to pass in the new token.
- Call leaveChannel to leave the current channel and then pass in the new token when you call joinChannel to join a channel.
In scenarios involving mutiple channels: Call updateChannelMediaOptionsEx to pass in the new token.

Trigger timing

The SDK triggers this callback 30 seconds before the token expires, reminding the app to update the token.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
token: The token that is about to expire.

onTranscodedStreamLayoutInfo

Occurs when the local user receives a mixed video stream carrying layout information.

onTranscodedStreamLayoutInfo?(
    connection: RtcConnection,
    uid: number,
    width: number,
    height: number,
    layoutCount: number,
    layoutlist: VideoLayout[]
  ): void;

Details

When the local user receives a mixed video stream sent by the video mixing server for the first time, or when there is a change in the layout information of the mixed stream, the SDK triggers this callback, reporting the layout information of each sub-video stream within the mixed video stream.

Parameters

connection: The connection information. See RtcConnection.
uid: User ID who published this mixed video stream.
width: Width (px) of the mixed video stream.
height: Heitht (px) of the mixed video stream.
layoutCount: The number of layout information in the mixed video stream.
layoutlist: Layout information of a specific sub-video stream within the mixed stream. See VideoLayout.

onTranscodingUpdated

Occurs when the publisher's transcoding is updated.

  onTranscodingUpdated?(): void;

When the LiveTranscoding class in the startRtmpStreamWithTranscoding method updates, the SDK triggers the onTranscodingUpdated callback to report the update information.

Attention: If you call the startRtmpStreamWithTranscoding method to set the LiveTranscoding class for the first time, the SDK does not trigger this callback.

onUplinkNetworkInfoUpdated

Occurs when the uplink network information changes.

  onUplinkNetworkInfoUpdated?(info: UplinkNetworkInfo): void;

The SDK triggers this callback when the uplink network information changes.

Attention: This callback only applies to scenarios where you push externally encoded video data in H.264 format to the SDK.

Parameters

info: The uplink network information. See UplinkNetworkInfo.

onUserEnableLocalVideo

Occurs when a specific remote user enables/disables the local video capturing function.

  onUserEnableLocalVideo?(
    connection: RtcConnection,
    remoteUid: number,
    enabled: boolean
  ): void;

Deprecated:

This callback is deprecated, use the following enumerations in the onRemoteVideoStateChanged callback:

RemoteVideoStateStopped(0) and RemoteVideoStateReasonRemoteMuted(5).
RemoteVideoStateDecoding(2) and RemoteVideoStateReasonRemoteUnmuted(6).

The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.

Parameters

connection

The connection information. See RtcConnection.

remoteUid

The user ID of the remote user.

enabled

Whether the specified remote user enables/disables local video capturing:

true: The video module is enabled. Other users in the channel can see the video of this remote user.
false: The video module is disabled. Other users in the channel can no longer receive the video stream from this remote user, while this remote user can still receive the video streams from other users.

onUserEnableVideo

Occurs when a remote user enables or disables the video module.

  onUserEnableVideo?(
    connection: RtcConnection,
    remoteUid: number,
    enabled: boolean
  ): void;

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.

Parameters

connection

The connection information. See RtcConnection.

remoteUid

The user ID of the remote user.

enabled

true: The video module is enabled.
false: The video module is disabled.

onUserInfoUpdated

Occurs when the SDK gets the user ID and user account of the remote user.

  onUserInfoUpdated?(uid: number, info: UserInfo): void;

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.

Parameters

uid: The user ID of the remote user.
info: The UserInfo object that contains the user ID and user account of the remote user. See UserInfo for details.

onUserJoined

Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel.

  onUserJoined?(
    connection: RtcConnection,
    remoteUid: number,
    elapsed: number
  ): void;

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.

Trigger timing

The SDK triggers this callback under one of the following circumstances:

A remote user/host joins the channel.
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.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the user or host who joins the channel.
elapsed: Time delay (ms) from the local user calling joinChannel until this callback is triggered.

onUserMuteAudio

Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) stops/resumes sending the audio stream.

  onUserMuteAudio?(
    connection: RtcConnection,
    remoteUid: number,
    muted: boolean
  ): void;

The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method.

Attention: This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.

Parameters

connection

The connection information. See RtcConnection.

remoteUid

The user ID.

muted

Whether the remote user's audio stream is muted:

true: User's audio stream is muted.
false: User's audio stream is unmuted.

onUserMuteVideo

Occurs when a remote user stops or resumes publishing the video stream.

  onUserMuteVideo?(
    connection: RtcConnection,
    remoteUid: number,
    muted: boolean
  ): void;

When a remote user calls muteLocalVideoStream to stop or resume publishing the video stream, the SDK triggers this callback to report to the local user the state of the streams published by the remote user.

Attention: This callback can be inaccurate when the number of users (in the communication profile) or hosts (in the live streaming profile) in a channel exceeds 17.

Parameters

connection

The connection information. See RtcConnection.

remoteUid

The user ID of the remote user.

muted

Whether the remote user stops publishing the video stream:

true: The remote user stops publishing the video stream.
false: The remote user resumes publishing the video stream.

onUserOffline

Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel.

  onUserOffline?(
    connection: RtcConnection,
    remoteUid: number,
    reason: UserOfflineReasonType
  ): void;

There are generally two reasons for users to become offline:

Leave the channel: When a user/host leaves the channel, the user/host sends a goodbye message.
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 is recommended to use the Agora RTM SDK for reliable offline detection.

Trigger timing

This callback is triggered when a remote user (in the communication profile) or host (in the live streaming profile) leaves a channel.

Restrictions

None.

Parameters

connection: The connection information. See RtcConnection.
remoteUid: The ID of the user who leaves the channel or goes offline.
reason: Reasons why a remote user (in the communication profile) or host (in the live streaming profile) goes offline. See UserOfflineReasonType.

onVideoPublishStateChanged

Occurs when the video publishing state changes.

  onVideoPublishStateChanged?(
    source: VideoSourceType,
    channel: string,
    oldState: StreamPublishState,
    newState: StreamPublishState,
    elapseSinceLastState: number
  ): void;

Parameters

channel: The channel name.
source: The type of the video source. See VideoSourceType.
oldState: The previous publishing state. See StreamPublishState.
newState: The current publishing stat. See StreamPublishState.
elapseSinceLastState: The time elapsed (ms) from the previous state to the current state.

onVideoSizeChanged

Occurs when the video size or rotation of a specified user changes.

 onVideoSizeChanged?(
    connection: RtcConnection,
    sourceType: VideoSourceType,
    uid: number,
    width: number,
    height: number,
    rotation: number
  ): void;

Parameters

connection: The connection information. See RtcConnection.
sourceType: The type of the video source. See VideoSourceType.
uid: The ID of the user whose video size or rotation changes. (The uid for the local user is 0. The video is the local user's video preview).
width: The width (pixels) of the video stream.
height: The height (pixels) of the video stream.
rotation: The rotation information. The value range is [0,360).
Note: On the iOS platform, the parameter value is always 0.

onVideoStopped

Occurs when the video stops playing.

  onVideoStopped?(): void;

Deprecated:: Use LocalVideoStreamStateStopped(0) in the onLocalVideoStateChanged 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.

onVideoSubscribeStateChanged

Occurs when the video subscribing state changes.

  onVideoSubscribeStateChanged?(
    channel: string,
    uid: number,
    oldState: StreamSubscribeState,
    newState: StreamSubscribeState,
    elapseSinceLastState: number
  ): void;

Parameters

channel: The channel name.
uid: The user ID of the remote user.
oldState: The previous subscribing status. See StreamSubscribeState.
newState: The current subscribing status. See StreamSubscribeState.
elapseSinceLastState: The time elapsed (ms) from the previous state to the current state.

onVideoRenderingTracingResult

Video frame rendering event callback.

onVideoRenderingTracingResult?(
    connection: RtcConnection,
    uid: number,
    currentEvent: MediaTraceEvent,
    tracingInfo: VideoRenderingTracingInfo
  ): void;

After calling the startMediaRenderingTracing method or joining the channel, the SDK triggers this callback to report the events of video frame rendering and the indicators during the rendering process. Developers can optimize the indicators to improve the efficiency of the first video frame rendering.

Parameters

connection: The connection information. See RtcConnection.
uid: The user ID.
currentEvent: The current video frame rendering event. See MediaTraceEvent.
tracingInfo: The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. See VideoRenderingTracingInfo.