Reports a warning during SDK runtime.

In most cases, the app can ignore the warning reported by the SDK because the SDK can usually fix the issue and resume running.

For instance, the SDK may report a WARN_LOOKUP_CHANNEL_TIMEOUT warning upon disconnection with the server and tries to reconnect. For detailed warning codes, see Warning Codes.

Parameters

warn	Warning code

Reports an error 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.

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 invokes the leaveChannel method to leave the channel. For detailed error codes, see Error Codes.

Parameters

err	Error code

Occurs when the local user joins a specified channel.

The channel name assignment is based on channelName specified in the joinChannel method.

If the uid is not specified when joinChannel is called, the server automatically assigns a uid.

Parameters

channel	Channel name.
uid	User ID.
elapsed	Time elapsed (ms) from the user calling joinChannel until this callback is triggered.

Occurs when a user rejoins the channel after being disconnected due to network problems.

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

Parameters

channel	Channel name.
uid	User ID.
elapsed	Time elapsed (ms) from starting to reconnect until this callback is triggered.

Occurs when a user leaves the channel.

When the app calls the leaveChannel method, the SDK uses this callback to notify the app when the user leaves the channel.

With this callback, the application retrieves the channel information, such as the call duration and statistics.

Parameters

stats

Statistics of the call: RtcStats

Occurs when the user role switches in a live broadcast. For example, from a host to an audience or vice versa.

The SDK triggers this callback when the local user switches the user role by calling the setClientRole method after joining the channel.

Parameters

oldRole	Role that the user switches from.
newRole	Role that the user switches to.

Occurs when the local user registers a user account.

Since

v2.8.0.

This callback is triggered when the local user successfully registers a user account by calling the registerLocalUserAccount method, or joins a channel by calling the joinChannelWithUserAccount method. This callback reports the user ID and user account of the local user.

Parameters

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

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

Since

v2.8.0.

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 (UserInfo), and triggers this callback on the local client.

Parameters

uid	The ID of the remote user.
userInfo	The UserInfo object that contains the user ID and user account of the remote user.

Occurs when a remote user (Communication)/host (Live Broadcast) joins the channel.

• Communication profile: This callback notifies the app when another user joins the channel. If other users are already in the channel, the SDK also reports to the app on the existing users.
• Live Broadcast profile: This callback notifies the app when the host joins the channel. If other hosts are already in the channel, the SDK also reports to the app on the existing hosts. We recommend having at most 17 hosts in a channel

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 by calling the setClientRole method after joining the channel.
• A remote user/host rejoins the channel after a network interruption.
• The host injects an online media stream into the channel by calling the addInjectStreamUrl method.

Parameters

uid	ID of the user or host who joins the channel.
elapsed	Time delay (ms) from the local user calling joinChannel/setClientRole until this callback is triggered.

Note

In the Live Broadcast profile:

• The host receives the onUserJoined callback when another host joins the channel.
• The audience in the channel receives the onUserJoined callback when a new host joins the channel.
• When a web application joins the channel, the onUserJoined callback is triggered as long as the web application publishes streams.

Occurs when a remote user (Communication)/host (Live Broadcast) 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 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, so we recommend using the signaling system for reliable offline detection.

Parameters

uid

ID of the user or host who leaves the channel or goes offline.

reason

Reason why the user goes offline: USER_OFFLINE_QUIT(0): The user left the current channel. USER_OFFLINE_DROPPED(1): The SDK timed out and the user dropped offline because no data packet was received within a certain period of time. If a user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline. USER_OFFLINE_BECOME_AUDIENCE(2): (Live broadcast only.) The client role switched from the host to the audience.

Occurs when the network connection state changes.

Since

v2.3.2.

The Agora SDK returns this callback to report on the current network connection state when it changes, and the reason to such change.

Parameters

state

The current network connection state: CONNECTION_STATE_DISCONNECTED(1): The SDK is disconnected from Agora edge server. CONNECTION_STATE_CONNECTING(2): The SDK is connecting to Agora edge server. CONNECTION_STATE_CONNECTED(3): The SDK joined a channel and is connected to Agora edge server. You can now publish or subscribe to a media stream in the channel. CONNECTION_STATE_RECONNECTING(4): The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues. CONNECTION_STATE_FAILED(5): The SDK fails to join the channel.

reason

The reason causing the change of the connection state: CONNECTION_CHANGED_CONNECTING(0): Connecting. CONNECTION_CHANGED_JOIN_SUCCESS(1): The SDK has joined the channel successfully. CONNECTION_CHANGED_INTERRUPTED(2): The connection is interrupted. CONNECTION_CHANGED_BANNED_BY_SERVER(3): The connection is banned by Agora edge server. CONNECTION_CHANGED_JOIN_FAILED(4): The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel. CONNECTION_CHANGED_LEAVE_CHANNEL(5): The SDK has left the channel. CONNECTION_CHANGED_INVALID_APP_ID(6): The specified App ID is invalid. Try to rejoin the channel with a valid App ID. CONNECTION_CHANGED_INVALID_CHANNEL_NAME(7): The specified channel name is invalid. Try to rejoin the channel with a valid channel name. CONNECTION_CHANGED_INVALID_TOKEN(8): The generated token is invalid probably due to the following reasons: The App Certificate for the project is enabled in Console, but you do not use the token. The uid that you specify in the joinChannel method is different from the uid that you pass for generating the token. CONNECTION_CHANGED_TOKEN_EXPIRED(9): The token has expired. Generate a new token from your server. CONNECTION_CHANGED_REJECTED_BY_SERVER(10): The user is banned by the server. CONNECTION_CHANGED_SETTING_PROXY_SERVER(11): The SDK tries to reconnect after setting a proxy server. CONNECTION_CHANGED_RENEW_TOKEN(12): The token renews. CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED(13): The client IP address has changed, probably due to a change of the network type, IP address, or network port. CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT(14): Timeout for the keep-alive of the connection between the SDK and Agora edge server. The connection state changes to CONNECTION_STATE_RECONNECTING(4).

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

Deprecated:

From v2.3.2. Use onConnectionStateChanged instead.

The SDK triggers this callback when it loses connection to 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. This callback is different from onConnectionLost:

• The SDK triggers the onConnectionInterrupted callback when the SDK loses connection with the server for more than four seconds after it joins the channel.
• The SDK triggers the onConnectionLost callback when it loses connection with the server for more than 10 seconds, regardless of whether it joins the channel or not.

If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora edge server, the SDK stops rejoining the channel.

Occurs when the SDK cannot reconnect to Agora 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 joinChannel(), regardless of whether it is in the channel or not.

If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora edge server, the SDK stops rejoining the channel.

Occurs when your connection is banned by the Agora Server.

Deprecated:

From v2.3.2. Use onConnectionStateChanged instead.

Occurs when an API method is executed.

Parameters

error	Error Code that the SDK returns when the method call fails. If the SDK returns 0, then the method call was successful.
api	The method executed by the SDK.
result	The result of the method call.

Occurs when the token expires in 30 seconds.

The user becomes offline if the token used when joining the channel expires. This callback is triggered 30 seconds before the token expires to remind the app to get a new token. Upon receiving this callback, you need to generate a new token on the server and call renewToken to pass the new token to the SDK.

Parameters

token

The token that will expire in 30 seconds.

Occurs when the token has expired.

If a token is specified when the instance joins the channel, the token expires after a certain period of time, and a new token is required to reconnect to the server. This callback notifies the app to generate a new token and call joinChannel to rejoin the channel with the new token.

Occurs when the microphone is enabled/disabled.

Deprecated:

v2.9.0. This callback is deprecated. Use LOCAL_AUDIO_STREAM_STATE_STOPPED(0) or LOCAL_AUDIO_STREAM_STATE_RECORDING(1) in the onLocalAudioStateChanged callback instead.

The SDK triggers this callback when the local user resumes or stops capturing the local audio stream by calling the enableLocalAudio method.

Parameters

enabled

Whether the microphone is enabled/disabled: true: Enabled. false: Disabled.

Reports which users are speaking and the speakers' volume, and whether the local user is speaking.

This callback reports the IDs and volumes of the loudest speakers (at most three) at the moment in the channel, and whether the local user is speaking.

By default, this callback is disabled. You can enable it by calling the enableAudioVolumeIndication method. Once enabled, this callback is triggered at the set interval, regardless of whether a user speaks or not.

The SDK triggers two independent onAudioVolumeIndication callbacks at one time, which separately report the volume information of the local user and all the remote speakers. For more information, see the detailed parameter descriptions.

Note

• To enable the voice activity detection of the local user, ensure that you set report_vad as true in the enableAudioVolumeIndication method.
• Calling the muteLocalAudioStream method affects the SDK's behavior.
  • If the local user calls the muteLocalAudioStream method, the SDK stops triggering the local user's callback.
  • 20 seconds after a remote speaker calls the muteLocalAudioStream method, the remote speakers' callback does not include information of this remote user; 20 seconds after all remote users call the the muteLocalAudioStream method, the SDK stops triggering the remote speakers' callback.

Parameters

speakers

An array containing the user ID and volume information for each speaker: AudioVolumeInfo. In the local user’s callback, this array contains the following members: uid = 0, volume = totalVolume, which reports the sum of the voice volume and audio-mixing volume of the local user, and vad, which reports the voice activity status of the local user. In the remote speakers' callback, this array contains the following members: uid of each remote speaker, volume, which reports the sum of the voice volume and audio-mixing volume of each remote speaker, and vad = 0. An empty speakers array in the callback indicates that no remote user is speaking at the moment.

totalVolume

Total volume after audio mixing. The value ranges between 0 (lowest volume) and 255 (highest volume). In the local user’s callback, totalVolume is the sum of the voice volume and audio-mixing volume of the local user. In the remote speakers' callback, totalVolume is the sum of the voice volume and audio-mixing volume of all remote speakers.

Reports which user is the loudest speaker.

This callback reports the speaker with the highest accumulative volume during a certain period. If the user enables the audio volume indication by calling enableAudioVolumeIndication, this callback returns the uid of the active speaker whose voice is detected by the audio volume detection module of the SDK.

Parameters

uid	User ID of the active speaker. A uid of 0 represents the local user.

Note

• To receive this callback, you need to call enableAudioVolumeIndication.
• This callback returns the user ID of the user with the highest voice volume during a period of time, instead of at the moment.

Occurs when the first local audio frame is sent.

Parameters

elapsed

Time elapsed (ms) from the local user calling the joinChannel until this callback is triggered.

Occurs when the first remote audio frame is received.

Deprecated:

v3.0.0. Use REMOTE_AUDIO_STATE_STARTING(1) in onRemoteAudioStateChanged instead.

Parameters

uid	User ID of the remote user.
elapsed	Time elapsed (ms) from the local user calling the joinChannel method until this callback is triggered.

Occurs when the video stops playing.

Deprecated:

From v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_STOPPED(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.

Occurs when the first local video frame is rendered.

This callback is triggered after the first local video frame is rendered on the local video window.

Parameters

width	Width (pixels) of the first local video frame.
height	Height (pixels) of the first local video frame.
elapsed	Time elapsed (ms) from the local user calling joinChannel until this callback is triggered. If startPreview is called before joinChannel, elapsed is the time elapsed (ms) from the local user calling startPreview until this callback is triggered.

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

Deprecated:

v2.9.0. This callback is deprecated. Use REMOTE_VIDEO_STATE_STARTING(1) or REMOTE_VIDEO_STATE_DECODING(2) in the onRemoteVideoStateChanged callback instead.

This callback is triggered in either of the following scenarios:

• 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. Possible reasons include:
  • The remote user leaves channel.
  • The remote user drops offline.
  • The remote user calls the muteLocalVideoStream method.
  • The remote user calls the disableVideo method.

Parameters

uid	User ID of the remote user sending the video streams.
width	Width (pixels) of the video stream.
height	Height (pixels) of the video stream.
elapsed	Time elapsed (ms) from the local user calling the joinChannel method until this callback is triggered.

Occurs when the first remote video frame is rendered.

This callback is triggered after the first frame of the remote video is rendered on the video window. The application can retrieve the data of the time elapsed from the user joining the channel until the first video frame is displayed.

Parameters

uid	User ID of the remote user sending the video streams.
width	Width (pixels) of the video stream.
height	Height (pixels) of the video stream.
elapsed	Time elapsed (ms) from the local user calling the joinChannel method until this callback is triggered.

Occurs when a remote user stops/resumes sending the audio stream.

Deprecated:

v3.0.0. Use the onRemoteAudioStateChanged callback with the following parameters instead:

• REMOTE_AUDIO_STATE_STOPPED(0) and REMOTE_AUDIO_REASON_REMOTE_MUTED(5).
• REMOTE_AUDIO_STATE_DECODING(2) and REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6).

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

Note

This callback does not work properly when the number of users (in the Communication profile) or broadcasters (in the Live-broadcast profile) in the channel exceeds 17.

Parameters

uid	ID of the remote user.
muted	Whether the remote user's audio stream is muted/unmuted: true: Muted. false: Unmuted.

Occurs when a remote user stops/resumes sending the video stream.

Deprecated:

This callback is deprecated. Use the onRemoteVideoStateChanged callback with the following parameters for the same function:

• REMOTE_VIDEO_STATE_STOPPED(0) and REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5).
• REMOTE_VIDEO_STATE_DECODING(2) and REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6).

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

Note

This callback does not work properly when the number of users (in the Communication profile) or broadcasters (in the Live-broadcast profile) in the channel exceeds 17.

Parameters

uid	ID of the remote user.
muted	Whether the remote user's video stream playback pauses/resumes: true: Pause. false: Resume.

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

Deprecated:

v2.9.0. This callback is deprecated and replaced by the onRemoteVideoStateChanged callback with the following parameters:

• REMOTE_VIDEO_STATE_STOPPED(0) and REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5).
• REMOTE_VIDEO_STATE_DECODING(2) and REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6).

Once the video module is disabled, the remote user can only use a voice call. The remote user cannot send or receive any video from other users.

The SDK triggers this callback when the remote user enables or disables the video module by calling the enableVideo or disableVideo method.

Note

This callback is invalid when the number of users or broadcasters in the channel exceeds 20.

Parameters

uid	User ID of the remote user.
enabled	Whether the specific remote user enables/disables the video module: true: Enable. The remote user can enter a video session. false: Disable. The remote user can only enter a voice session, and cannot send or receive any video stream.

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

Deprecated:

v2.9.0. This callback is deprecated and replaced by the onRemoteVideoStateChanged callback with the following parameters:

• REMOTE_VIDEO_STATE_STOPPED(0) and REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5).
• REMOTE_VIDEO_STATE_DECODING(2) and REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6).

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

This callback is only applicable to the scenario when the remote user only wants to watch the remote video without sending any video stream to the other user.

Parameters

uid	User ID of the remote user.
enabled	Whether the specific remote user enables/disables the local video capturing function: true: Enabled. Other users in the channel can see the video of this remote user. false: 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.

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

Parameters

uid	User ID of the remote user or local user (0) whose video size or rotation changes.
width	New width (pixels) of the video.
height	New height (pixels) of the video.
rotation	New rotation of the video [0 to 360).

Occurs when the remote audio state changes.

Since

v2.9.0.

This callback indicates the state change of the remote audio stream.

Note

This callback does not work properly when the number of users (in the Communication profile) or broadcasters (in the Live-broadcast profile) in the channel exceeds 17.

Parameters

uid	ID of the user whose audio state changes.
state	State of the remote audio: REMOTE_AUDIO_STATE_STOPPED(0): The remote audio is in the default state, probably due to REMOTE_AUDIO_REASON_LOCAL_MUTED(3), REMOTE_AUDIO_REASON_REMOTE_MUTED(5), or REMOTE_AUDIO_REASON_REMOTE_OFFLINE(7). REMOTE_AUDIO_STATE_STARTING(1): The first remote audio packet is received. REMOTE_AUDIO_STATE_DECODING(2): The remote audio stream is decoded and plays normally, probably due to REMOTE_AUDIO_REASON_NETWORK_RECOVERY(2), REMOTE_AUDIO_REASON_LOCAL_UNMUTED(4) or REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6). REMOTE_AUDIO_STATE_FROZEN(3): The remote audio is frozen, probably due to REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1). REMOTE_AUDIO_STATE_FAILED(4): The remote audio fails to start, probably due to REMOTE_AUDIO_REASON_INTERNAL(0).
reason	The reason of the remote audio state change. REMOTE_AUDIO_REASON_INTERNAL(0): Internal reasons. REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1): Network congestion. REMOTE_AUDIO_REASON_NETWORK_RECOVERY(2): Network recovery. REMOTE_AUDIO_REASON_LOCAL_MUTED(3): The local user stops receiving the remote audio stream or disables the audio module. REMOTE_AUDIO_REASON_LOCAL_UNMUTED(4): The local user resumes receiving the remote audio stream or enables the audio module. REMOTE_AUDIO_REASON_REMOTE_MUTED(5): The remote user stops sending the audio stream or disables the audio module. REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6): The remote user resumes sending the audio stream or enables the audio module. REMOTE_AUDIO_REASON_REMOTE_OFFLINE(7): The remote user leaves the channel.
elapsed	Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

Occurs when the remote video state changes.

Since

v2.9.0.

Note

This callback does not work properly when the number of users (in the Communication profile) or broadcasters (in the Live-broadcast profile) in the channel exceeds 17.

Parameters

uid	ID of the remote user whose video state changes.
state	State of the remote video: REMOTE_VIDEO_STATE_STOPPED(0): The remote video is in the default state, probably due to REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED(3), REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5), or REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE(7). REMOTE_VIDEO_STATE_STARTING(1): The first remote video packet is received. REMOTE_VIDEO_STATE_DECODING(2): The remote video stream is decoded and plays normally, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY (2), REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED(4), REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6), or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY(9). REMOTE_VIDEO_STATE_FROZEN(3): The remote video is frozen, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION(1) or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK(8). REMOTE_VIDEO_STATE_FAILED(4): The remote video fails to start, probably due to REMOTE_VIDEO_STATE_REASON_INTERNAL(0).
reason	The reason of the remote video state change: REMOTE_VIDEO_STATE_REASON_INTERNAL(0): Internal reasons. REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION(1): Network congestion. REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY(2): Network recovery. REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED(3): The local user stops receiving the remote video stream or disables the video module. REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED(4): The local user resumes receiving the remote video stream or enables the video module. REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5): The remote user stops sending the video stream or disables the video module. REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6): The remote user resumes sending the video stream or enables the video module. REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE(7): The remote user leaves the channel. REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK(8): The remote media stream falls back to the audio-only stream due to poor network conditions. REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY(9): The remote media stream switches back to the video stream after the network conditions improve.
elapsed	Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

Occurs when the state of the media stream relay changes.

Since

v2.9.0.

The SDK reports the state of the current media relay and possible error messages in this callback.

Parameters

state

The state code: RELAY_STATE_IDLE(0): The SDK is initializing. RELAY_STATE_CONNECTING(1): The SDK tries to relay the media stream to the destination channel. RELAY_STATE_RUNNING(2): The SDK successfully relays the media stream to the destination channel. RELAY_STATE_FAILURE(3): A failure occurs. See the details in code.

code

The error code: RELAY_OK(0): The state is normal. RELAY_ERROR_SERVER_ERROR_RESPONSE(1): An error occurs in the server response. RELAY_ERROR_SERVER_NO_RESPONSE(2): No server response. You can call the leaveChannel method to leave the channel. RELAY_ERROR_NO_RESOURCE_AVAILABLE(3): The SDK fails to access the service, probably due to limited resources of the server. RELAY_ERROR_FAILED_JOIN_SRC(4): Fails to send the relay request. RELAY_ERROR_FAILED_JOIN_DEST(5): Fails to accept the relay request. RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC(6): The server fails to receive the media stream. RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST(7): The server fails to send the media stream. RELAY_ERROR_SERVER_CONNECTION_LOST(8): The SDK disconnects from the server due to poor network connections. You can call the leaveChannel method to leave the channel. RELAY_ERROR_INTERNAL_ERROR(9): An internal error occurs in the server. RELAY_ERROR_SRC_TOKEN_EXPIRED(10): The token of the source channel has expired. RELAY_ERROR_DEST_TOKEN_EXPIRED(11): The token of the destination channel has expired.

Reports events during the media stream relay.

Since

v2.9.0.

Parameters

code

The event code for media stream relay: RELAY_EVENT_NETWORK_DISCONNECTED(0): The user disconnects from the server due to poor network connections. RELAY_EVENT_NETWORK_CONNECTED(1): The network reconnects. RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL(2): The user joins the source channel. RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL(3): The user joins the destination channel. RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL(4): The SDK starts relaying the media stream to the destination channel. RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC(5): The server receives the video stream from the source channel. RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC(6): The server receives the audio stream from the source channel. RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL(7): The destination channel is updated. RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED(8): The destination channel update fails due to internal reasons. RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE(9): The destination channel does not change, which means that the destination channel fails to be updated. RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL(10): The destination channel name is NULL. RELAY_EVENT_VIDEO_PROFILE_UPDATE(11): The video profile is sent to the server.

Occurs when the published media stream falls back to an audio-only stream due to poor network conditions or switches back to video stream after the network conditions improve.

If you call setLocalPublishFallbackOption and set option as STREAM_FALLBACK_OPTION_AUDIO_ONLY(2), this callback is triggered when the locally published stream falls back to audio-only mode due to poor uplink conditions, or when the audio stream switches back to the video after the uplink network condition improves. Once the published stream falls back to audio only, the remote app receives the onRemoteVideoStateChanged callback.

Parameters

isFallbackOrRecover

Whether the published stream fell back to audio-only or switched back to the video: true: The published stream fell back to audio-only due to poor network conditions. false: The published stream switched back to the video after the network conditions improved.

Occurs when the remote media stream falls back to audio-only stream due to poor network conditions or switches back to video stream after the network conditions improve.

If you call setRemoteSubscribeFallbackOption and set option as STREAM_FALLBACK_OPTION_AUDIO_ONLY(2), this callback is triggered when the remotely subscribed media stream falls back to audio-only mode due to poor uplink conditions, or when the remotely subscribed media stream switches back to the video after the uplink network condition improves.

Parameters

uid	ID of the remote user sending the stream.
isFallbackOrRecover	Whether the remote media stream fell back to audio-only or switched back to the video: true: The remote media stream fell back to audio-only due to poor network conditions. false: The remote media stream switched back to the video stream after the network conditions improved.

Note

Once the remote media stream is switched to the low stream due to poor network conditions, you can monitor the stream switch between a high and low stream in the onRemoteVideoStats callback.

Occurs when the local audio playback route changes.

This callback returns that the audio route switched to an earpiece, speakerphone, headset, or Bluetooth device.

The definition of the routing is listed as follows:

• AUDIO_ROUTE_DEFAULT(-1): Default audio route.
• AUDIO_ROUTE_HEADSET(0): Headset.
• AUDIO_ROUTE_EARPIECE(1): Earpiece.
• AUDIO_ROUTE_HEADSETNOMIC(2): Headset with no microphone.
• AUDIO_ROUTE_SPEAKERPHONE(3): Speakerphone.
• AUDIO_ROUTE_LOUDSPEAKER(4): Loudspeaker.
• AUDIO_ROUTE_HEADSETBLUETOOTH(5): Bluetooth headset.

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

Deprecated:

From v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in the onLocalVideoStateChanged callback instead. If the camera fails to turn on, fix the error reported in the onError callback.

Occurs when the camera focus area is changed.

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

Parameters

rect	Rectangular area in the camera zoom specifying the focus area.

The camera exposure area has changed.

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

Since

v2.3.2.

Parameters

rect	Rectangular area in the camera zoom specifying the exposure area.

Reports the face detection result of the local user.

Since

3.0.1

Once you enable face detection by calling enableFaceDetection, 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 device screen. This value is based on the fitting calculation of the local video size and the position of the human face.

Note

• If the SDK does not detect a face, it reduces the frequency of this callback 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.
• On Android, the distance value reported in this callback may be slightly different from the actual distance. Therefore, Agora does not recommend using it for accurate calculation.

Parameters

imageWidth	The width (px) of the local video.
imageHeight	The height (px) of the local video.
faces	The information of the detected human face. For details, see AgoraFacePositionInfo. The number of the AgoraFacePositionInfo array depends on the number of human faces detected. If the array length is 0, it means that no human face is detected.

Reports the statistics of the audio stream from each remote user/host.

Deprecated:

From v2.3.2. Use onRemoteAudioStats 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 remote users/hosts sending audio streams, the SDK triggers this callback as many times.

Parameters

uid	User ID of the speaker.
quality	Audio quality of the user: QUALITY_UNKNOWN(0): The quality is unknown. QUALITY_EXCELLENT(1): The quality is excellent. QUALITY_GOOD(2): The quality is quite good, but the bitrate may be slightly lower than excellent. QUALITY_POOR(3): Users can feel the communication slightly impaired. QUALITY_BAD(4): Users can communicate not very smoothly. QUALITY_VBAD(5): The quality is so bad that users can barely communicate. QUALITY_DOWN(6): The network is disconnected and users cannot communicate at all. QUALITY_DETECTING(8): The SDK is detecting the network quality.
delay	Time delay (ms) of the audio packet from the sender to the receiver, including the time delay from audio sampling pre-processing, transmission, and the jitter buffer.
lost	Packet loss rate (%) of the audio packet sent from the sender to the receiver.

Reports the statistics of the RtcEngine once every two seconds.

Parameters

stats

RTC engine statistics: RtcStats.

Reports the last mile network quality of the local user once every two seconds before the user joins the channel. Last mile refers to the connection between the local device and Agora edge server. After the application calls the enableLastmileTest method, this callback reports once every two seconds the uplink and downlink last mile network conditions of the local user before the user joins the channel.

Parameters

quality

The last mile network quality based on the uplink and downlink packet loss rate and jitter: QUALITY_UNKNOWN(0): The quality is unknown. QUALITY_EXCELLENT(1): The quality is excellent. QUALITY_GOOD(2): The quality is quite good, but the bitrate may be slightly lower than excellent. QUALITY_POOR(3): Users can feel the communication slightly impaired. QUALITY_BAD(4): Users can communicate not very smoothly. QUALITY_VBAD(5): The quality is so bad that users can barely communicate. QUALITY_DOWN(6): The network is disconnected and users cannot communicate at all. QUALITY_DETECTING(8): The SDK is detecting the network quality.

Reports the last-mile network probe result.

Since

v2.4.0.

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

Parameters

result

The uplink and downlink last-mile network probe test result. For details, see LastmileProbeResult.

Reports the last mile network quality of each user in the channel once every two seconds.

Last mile refers to the connection between the local device and Agora edge server. This callback reports once every two seconds the last mile network conditions of each user in the channel. If a channel includes multiple users, then this callback will be triggered as many times.

Parameters

uid	User ID. The network quality of the user with this uid is reported. If uid is 0, the local network quality is reported.
txQuality	Uplink transmission quality of the user in terms of the transmission bitrate, packet loss rate, average RTT (Round-Trip Time) and jitter of the uplink network. txQuality is a quality rating helping you understand how well the current uplink network conditions can support the selected VideoEncoderConfiguration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 680 × 480 and a frame rate of 30 fps, but may be inadequate for resolutions higher than 1280 × 720. QUALITY_UNKNOWN(0): The quality is unknown. QUALITY_EXCELLENT(1): The quality is excellent. QUALITY_GOOD(2): The quality is quite good, but the bitrate may be slightly lower than excellent. QUALITY_POOR(3): Users can feel the communication slightly impaired. QUALITY_BAD(4): Users can communicate not very smoothly. QUALITY_VBAD(5): The quality is so bad that users can barely communicate. QUALITY_DOWN(6): The network is disconnected and users cannot communicate at all. QUALITY_DETECTING(8): The SDK is detecting the network quality.
rxQuality	Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network. QUALITY_UNKNOWN(0): The quality is unknown. QUALITY_EXCELLENT(1): The quality is excellent. QUALITY_GOOD(2): The quality is quite good, but the bitrate may be slightly lower than excellent. QUALITY_POOR(3): Users can feel the communication slightly impaired. QUALITY_BAD(4): Users can communicate not very smoothly. QUALITY_VBAD(5): The quality is so bad that users can barely communicate. QUALITY_DOWN(6): The network is disconnected and users cannot communicate at all. QUALITY_DETECTING(8): The SDK is detecting the network quality.

Reports the statistics of the local video streams.

The SDK triggers this callback once every two seconds for each user/host. If there are multiple users/hosts in the channel, the SDK triggers this callback as many times.

Parameters

stats

The statistics of the local video stream. See LocalVideoStats.

Reports the statistics of the video stream from each remote user/host. The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times.

Parameters

stats

Statistics of the received remote video streams: RemoteVideoStats.

Reports the statistics of the local audio stream.

Since

v2.9.0. The SDK triggers this callback once every two seconds.

Parameters

stats

The statistics of the local audio stream. See LocalAudioStats.

Reports the statistics of the audio stream from each remote user/host.

Since

v2.3.2. This method replaces the onAudioQuality callback.

The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times.

Schemes such as FEC (Forward Error Correction) or retransmission counter the frame loss rate. Hence, users may find the overall audio quality acceptable even when the packet loss rate is high.

Parameters

stats

Statistics of the received remote audio streams: RemoteAudioStats.

Reports the statistics of the uploading local video streams.

Deprecated:

This method is deprecated. We recommend using onLocalVideoStats to get the local video statistics.

Parameters

sentBitrate	Data transmission bitrate (Kbps) since last count.
sentFrameRate	Data transmission frame rate (fps) since last count.

Reports the statistics of the video stream from each remote user/host.

Deprecated:

This method is deprecated. We recommend using onRemoteVideoStats to get the remote video statistics.

Parameters

uid	User ID of the remote user sending the video streams.
delay	Time delay (ms).
receivedBitrate	Data receiving bitrate (Kbps).
receivedFrameRate	Data receiving frame rate (fps).

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

Deprecated:

This callback is deprecated. Use onRemoteAudioStats instead.

This callback reports the transport-layer statistics, such as the packet loss rate and time delay, once every two seconds after the local user receives an audio packet from a remote user.

Parameters

uid	User ID of the remote user sending the audio packet.
delay	Network time delay (ms) from the remote user sending the audio packet to the local user.
lost	Packet loss rate (%) of the audio packet sent from the remote user.
rxKBitRate	Received bitrate (Kbps) of the audio packet sent from the remote user.

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

Deprecated:

This callback is deprecated. Use onRemoteVideoStats instead.

This callback reports the transport-layer statistics, such as the packet loss rate and time delay, once every two seconds after the local user receives the video packet from a remote user.

Parameters

uid	User ID of the remote user sending the video packet.
delay	Network time delay (ms) from the remote user sending the video packet to the local user.
lost	Packet loss rate (%) of the video packet sent from the remote user.
rxKBitRate	Received bitrate (Kbps) of the video packet sent from the remote user.

Occurs when the state of the local user's audio mixing file changes.

Since

v2.4.0. When the state of the audio mixing file changes, the SDK triggers this callback and reports the audio mixing status and the error code of the audio playback failure.

If the local audio mixing file does not exist, or if the SDK does not support the file format or cannot access the music file URL, the SDK returns WARN_AUDIO_MIXING_OPEN_ERROR = 701.

Parameters

state

The state code: MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY(710): The audio mixing file is playing after the method call of startAudioMixing or resumeAudioMixing succeeds. MEDIA_ENGINE_AUDIO_EVENT_MIXING_PAUSED(711): The audio mixing file pauses playing after the method call of pauseAudioMixing succeeds. MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED(713): The audio mixing file stops playing after the method call of stopAudioMixing succeeds. MEDIA_ENGINE_AUDIO_EVENT_MIXING_ERROR(714): An exception occurs during the playback of the audio mixing file. See the errorCode for details.

errorCode

The error code: MEDIA_ENGINE_AUDIO_ERROR_MIXING_OPEN(701): the SDK cannot open the audio mixing file. MEDIA_ENGINE_AUDIO_ERROR_MIXING_TOO_FREQUENT(702): the SDK opens the audio mixing file too frequently. MEDIA_ENGINE_AUDIO_EVENT_MIXING_INTERRUPTED_EOF(703): the audio mixing file playback is interrupted.

Occurs when the audio mixing file playback finishes.

Deprecated:

This callback is deprecated. Use onAudioMixingStateChanged instead.

You can start an audio mixing file playback by calling the startAudioMixing method. This callback is triggered when the audio mixing file playback finishes.

If the startAudioMixing method call fails, an WARN_AUDIO_MIXING_OPEN_ERROR warning returns in the onWarning callback.

Occurs when the audio effect file playback finishes.

You can start a local audio effect playback by calling the playEffect method. This callback is triggered when the local audio effect file playback finishes.

Parameters

soundId

ID of the local audio effect. Each local audio effect has a unique ID.

Occurs when the engine receives the first audio frame from a specified remote user.

Deprecated:

v3.0.0. Use REMOTE_AUDIO_STATE_DECODING(2) in onRemoteAudioStateChanged instead.

This callback is triggered in either of the following scenarios：

• The remote user joins the channel and sends the audio stream.
• The remote user stops sending the audio stream and re-sends it after 15 seconds. Possible reasons include:
  • The remote user leaves channel.
  • The remote user drops offline.
  • The remote user calls the muteLocalAudioStream method.
  • The remote user calls the disableAudio method.

Parameters

uid	User ID of the remote user sending the audio stream.
elapsed	The time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

Occurs when the local audio stream state changes.

Since

v2.9.0.

This callback indicates the state change of the local audio stream, including the state of the audio recording and encoding, and allows you to troubleshoot issues when exceptions occur.

Note

When the state is LOCAL_AUDIO_STREAM_STATE_FAILED(3), see the error parameter for details.

Parameters

state

State of the local audio: LOCAL_AUDIO_STREAM_STATE_STOPPED(0): The local audio is in the initial state. LOCAL_AUDIO_STREAM_STATE_CAPTURING(1): The recording device starts successfully. LOCAL_AUDIO_STREAM_STATE_ENCODING(2): The first audio frame encodes successfully. LOCAL_AUDIO_STREAM_STATE_FAILED(3): The local audio fails to start.

error

The error information of the local audio: LOCAL_AUDIO_STREAM_ERROR_OK(0): The local audio is normal. LOCAL_AUDIO_STREAM_ERROR_FAILURE(1): No specified reason for the local audio failure. LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION(2): No permission to use the local audio device. LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY(3): The microphone is in use. LOCAL_AUDIO_STREAM_ERROR_CAPTURE_FAILURE(4): The local audio recording fails. Check whether the recording device is working properly. LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE(5): The local audio encoding fails.

Occurs when the local video state changes.

Since

v2.4.1.

The SDK returns the current video state in this callback. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED(3), see the error parameter for details.

Parameters

localVideoState

The local video state: LOCAL_VIDEO_STREAM_STATE_STOPPED(0): The local video is in the initial state. LOCAL_VIDEO_STREAM_STATE_CAPTURING(1): The local video capturer starts successfully. LOCAL_VIDEO_STREAM_STATE_ENCODING(2): The first local video frame encodes successfully. LOCAL_VIDEO_STREAM_STATE_FAILED(3): The local video fails to start.

error

The detailed error information of the local video: LOCAL_VIDEO_STREAM_ERROR_OK(0): The local video is normal. LOCAL_VIDEO_STREAM_ERROR_FAILURE(1): No specified reason for the local video failure. LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION(2): No permission to use the local video device. LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3): The local video capturer is in use. LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4): The local video capture fails. Check whether the capturer is working properly. If your app runs in the background on a device running Android 9 or later, you cannot access the camera. If your app runs on a device running Android 6 or later, this error is reported if the camera is occupied by a third-part app and not property released. Once the camera is released, the SDK triggers this callback again, reporting state CAPTURING(1), and error ERROR_OK(0). LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE(5): The local video encoding fails.

Occurs when the state of the RTMP streaming changes.

Since

v2.4.1.

The SDK triggers this callback to report the result of the local user calling the addPublishStreamUrl or removePublishStreamUrl method. This callback returns the URL and its current streaming state. When the streaming state is RTMP_STREAM_PUBLISH_STATE_FAILURE(4), see the errCode parameter for details.

This callback indicates the state of the RTMP streaming. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the errCode parameter.

Parameters

url	The RTMP URL address.
state	The RTMP streaming state: RTMP_STREAM_PUBLISH_STATE_IDLE(0): The RTMP streaming has not started or has ended. This state is also triggered after you remove an RTMP address from the CDN by calling removePublishStreamUrl. RTMP_STREAM_PUBLISH_STATE_CONNECTING(1): The SDK is connecting to Agora streaming server and the RTMP server. This state is triggered after you call the addPublishStreamUrl method. RTMP_STREAM_PUBLISH_STATE_RUNNING(2): The RTMP streaming publishes. The SDK successfully publishes the RTMP streaming and returns this state. RTMP_STREAM_PUBLISH_STATE_RECOVERING(3): The RTMP streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK attempts to resume RTMP streaming and returns this state. If the SDK successfully resumes the streaming, RTMP_STREAM_PUBLISH_STATE_RUNNING(2) returns. If the streaming does not resume within 60 seconds or server errors occur, RTMP_STREAM_PUBLISH_STATE_FAILURE(4) returns. You can also reconnect to the server by calling the removePublishStreamUrl and addPublishStreamUrl methods. RTMP_STREAM_PUBLISH_STATE_FAILURE(4): The RTMP streaming fails. See the errCode parameter for the detailed error information. You can also call the addPublishStreamUrl method to publish the RTMP streaming again.
errCode	The detailed error information for streaming: RTMP_STREAM_PUBLISH_ERROR_OK(0): The RTMP streaming publishes successfully. RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMEN(1): Invalid argument used. If, for example, you do not call the setLiveTranscoding method to configure the LiveTranscoding parameters before calling the addPublishStreamUrl method, the SDK returns this error. Check whether you set the parameters in the setLiveTranscoding method properly. RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED(2): The RTMP streaming is encrypted and cannot be published. RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT(3): Timeout for the RTMP streaming. Call the addPublishStreamUrl method to publish the streaming again. RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR(4): An error occurs in Agora streaming server. Call the addPublishStreamUrl method to publish the streaming again. RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR(5): An error occurs in the RTMP server. RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN(6): The RTMP streaming publishes too frequently. RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT(7): The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones. RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED(8): The host manipulates other hosts' URLs. Check your app logic. RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND(9): Agora server fails to find the RTMP streaming. RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED(10): The format of the RTMP streaming URL is not supported. Check whether the URL format is correct.

Reports the result of calling the addPublishStreamUrl method.

Deprecated:

v3.0.0. Use onRtmpStreamingStateChanged instead.

This callback indicates whether you have successfully added an RTMP stream to the CDN.

Parameters

url

The RTMP URL address.

error

The detailed error information: ERR_OK(0): The publishing succeeded. ERR_FAILED(1): The publishing failed. ERR_INVALID_ARGUMENT(2): Invalid argument used. If, for example, you have not called setLiveTranscoding to configure LiveTranscoding before calling addPublishStreamUrl, the SDK will report this error. ERR_TIMEOUT(10): The publishing timed out. ERR_ALREADY_IN_USE(19): The chosen HTTP/HTTPS URL address is already in use for CDN live streaming. ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED(130): You cannot publish an encrypted stream. ERR_PUBLISH_STREAM_CDN_ERROR(151): CDN related errors. Remove the original URL address and add a new one by calling the removePublishStreamUrl and addPublishStreamUrl methods. ERR_PUBLISH_STREAM_NUM_REACH_LIMIT(152): The host manipulates more than 10 URLs. Delete the unnecessary URLs before adding new ones. ERR_PUBLISH_STREAM_NOT_AUTHORIZED(153): The host manipulates other hosts' URLs. Check your app logic. ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR(154): An error occurs in Agora streaming server. Call the addPublishStreamUrl method to publish the streaming again. ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED(156): The format of the RTMP stream URL is not supported. Check whether the URL format is correct.

Reports the result of calling the removePublishStreamUrl method.

Deprecated:

v3.0.0. Use onRtmpStreamingStateChanged instead.

This callback indicates whether you have successfully removed an RTMP stream from the CDN.

Parameters

url	The RTMP URL address.

Occurs when the publisher's transcoding settings are updated.

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

Note

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

Reports the status of injecting the online media stream.

Parameters

url	The URL address of the externally injected stream.
uid	User ID.
status	State of the externally injected stream: INJECT_STREAM_STATUS_START_SUCCESS(0): The external video stream imports successfully. INJECT_STREAM_STATUS_START_ALREADY_EXIST(1): The external video stream already exists. INJECT_STREAM_STATUS_START_UNAUTHORIZED(2): The external video stream import is unauthorized. INJECT_STREAM_STATUS_START_TIMEDOUT(3): Timeout when importing the external video stream. INJECT_STREAM_STATUS_START_FAILED(4): The external video stream fails to import. INJECT_STREAM_STATUS_STOP_SUCCESS(5): The external video stream stops importing successfully. INJECT_STREAM_STATUS_STOP_NOT_FOUND(6): No external video stream is found. INJECT_STREAM_STATUS_STOP_UNAUTHORIZED(7): The external video stream stops from being unauthorized. INJECT_STREAM_STATUS_STOP_TIMEDOUT(8): Timeout when stopping the import of the external video stream. INJECT_STREAM_STATUS_STOP_FAILED(9): Fails to stop importing the external video stream. INJECT_STREAM_STATUS_BROKEN(10): The external video stream import is interrupted.

Occurs when the local user receives a remote data stream.

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

Parameters

uid	User ID of the remote user sending the data stream.
streamId	Stream ID.
data	Data received by the local user.

Occurs when the local user fails to receive a remote data stream.

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

uid	User ID of the remote user sending the data stream.
streamId	Stream ID.
error	Error code.
missed	The number of lost messages.
cached	The number of incoming cached messages when the data stream is interrupted.

Occurs when the media engine is loaded.

Occurs when the media engine starts.

Occurs when the network type changes.

Since

v2.4.1.

The SDK returns the current network type 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

type

The network type: NETWORK_TYPE_UNKNOWN(-1): The network type is unknown. NETWORK_TYPE_DISCONNECTED(0):The SDK disconnects from the network. NETWORK_TYPE_LAN(1): The network type is LAN. NETWORK_TYPE_WIFI(2): The network type is Wi-Fi (including hotspots). NETWORK_TYPE_MOBILE_2G(3): The network type is mobile 2G. NETWORK_TYPE_MOBILE_3G(4): The network type is mobile 3G. NETWORK_TYPE_MOBILE_4G(5): The network type is mobile 4G.