IRtcEngineEventHandler
The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
All methods in this interface have default (empty) implementation. You can choose to inherit events related to your app scenario.
- In the callbacks, avoid implementing time-consuming tasks or calling APIs that may cause thread blocking (such as
sendMessage). Otherwise, the SDK may not work properly. - The SDK no longer catches exceptions in the code logic that developers implement themselves in IRtcEngineEventHandler class. You need to handle this exception yourself, otherwise the app may crash when the exception occurs.
onActiveSpeaker
Occurs when the most active remote speaker is detected.
virtual void onActiveSpeaker(uid_t userId) { (void)userId; }
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.
- 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
- userId
- The user ID of the most active speaker.
onAudioDeviceStateChanged
Occurs when the audio device state changes.
virtual void onAudioDeviceStateChanged(const char* deviceId,
int deviceType,
int deviceState) {
(void)deviceId;
(void)deviceType;
(void)deviceState;
}
This callback notifies the application that the system's audio device state is changed. For example, a headset is unplugged from the device.
Parameters
- deviceId
- The device ID.
- deviceType
- The device type. See MEDIA_DEVICE_TYPE.
- deviceState
- Media device states.
onAudioDeviceVolumeChanged
Reports the volume change of the audio device or app.
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) {
(void)deviceType;
(void)volume;
(void)muted;
}
Occurs when the volume on the playback device, audio capture device, or the volume in the application changes.
Parameters
- deviceType
- The device type. See MEDIA_DEVICE_TYPE.
- volume
- The volume value. The range is [0, 255].
- muted
-
Whether the audio device is muted:
true: The audio device is muted.false: The audio device is not muted.
onAudioEffectFinished
Occurs when the playback of the local music file finishes.
virtual void onAudioEffectFinished(int soundId) {
}
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.
virtual void onAudioMixingFinished() {
}
- Deprecated:
- Use onAudioMixingStateChanged instead.
After you call startAudioMixing [2/2] to play a local music file, this callback occurs when the playback finishes. If the call of startAudioMixing [2/2] fails, the error code WARN_AUDIO_MIXING_OPEN_ERROR is returned.
onAudioMixingStateChanged
Occurs when the playback state of the music file changes.
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) {
(void)state;
(void)reason;
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 AUDIO_MIXING_STATE_TYPE.
- reason
- Error code. See AUDIO_MIXING_REASON_TYPE.
onAudioPublishStateChanged
Occurs when the audio publishing state changes.
virtual void onAudioPublishStateChanged(const char* channel,
STREAM_PUBLISH_STATE oldState,
STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) {
(void)channel;
(void)oldState;
(void)newState;
(void)elapseSinceLastState;
}
Parameters
- channel
- The channel name.
- oldState
- The previous publishing state. See STREAM_PUBLISH_STATE.
- newState
- The current publishing stat. See STREAM_PUBLISH_STATE.
- 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.
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) {
(void)uid;
(void)quality;
(void)delay;
(void)lost;
}
- 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
- uid
- The user ID of the remote user sending the audio stream.
- quality
- Audio quality of the user. See QUALITY_TYPE.
- 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.
virtual void onAudioRoutingChanged(int routing) { (void)routing; }
This method is for Android, iOS and macOS only.
Parameters
- routing
-
The current audio routing. See AudioRoute.
onAudioSubscribeStateChanged
Occurs when the audio subscribing state changes.
virtual void onAudioSubscribeStateChanged(const char* channel,
uid_t uid,
STREAM_SUBSCRIBE_STATE oldState,
STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) {
(void)channel;
(void)uid;
(void)oldState;
(void)newState;
(void)elapseSinceLastState;
}
Parameters
- channel
- The channel name.
- uid
- The user ID of the remote user.
- oldState
- The previous subscribing status. See STREAM_SUBSCRIBE_STATE.
- newState
- The current subscribing status. See STREAM_SUBSCRIBE_STATE.
- elapseSinceLastState
- The time elapsed (ms) from the previous state to the current state.
onAudioVolumeIndication
Reports the volume information of users.
virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers,
unsigned int speakerNumber,
int totalVolume) {
(void)speakers;
(void)speakerNumber;
(void)totalVolume;
}
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.
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
- 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. If the user calls startAudioMixing [2/2], then totalVolume is the volume after audio mixing.
onCameraExposureAreaChanged
Occurs when the camera exposure area changes.
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) {
(void)x;
(void)y;
(void)width;
(void)height;
}
The SDK triggers this callback when the local user changes the camera exposure position by calling setCameraExposurePosition.
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.
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) {
(void)x;
(void)y;
(void)width;
(void)height;
}
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.
virtual void onCameraReady()
- Deprecated:
-
Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in onLocalVideoStateChanged instead.
This callback indicates that the camera has been successfully turned on and you can start to capture video.
onChannelMediaRelayEvent
Reports events during the media stream relay.
virtual void onChannelMediaRelayEvent(int code) {
(void)code;
}
- Deprecated:
- This callback is deprecated.
Parameters
- code
-
The event code of channel media relay. See CHANNEL_MEDIA_RELAY_EVENT.
onChannelMediaRelayStateChanged
Occurs when the state of the media stream relay changes.
virtual void onChannelMediaRelayStateChanged(CHANNEL_MEDIA_RELAY_STATE state,CHANNEL_MEDIA_RELAY_ERROR code) {
}
The SDK returns the state of the current media relay with any error message.
Parameters
- state
-
The state code. See CHANNEL_MEDIA_RELAY_STATE.
- code
-
The error code of the channel media relay. See CHANNEL_MEDIA_RELAY_ERROR.
onClientRoleChanged
Occurs when the user role switches during the interactive live streaming.
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
(void)oldRole;
(void)newRole;
(void)newRoleOptions;
}
The SDK triggers this callback when the local user switches their user role by calling setClientRole [2/2] after joining the channel.
Parameters
- oldRole
- Role that the user switches from: CLIENT_ROLE_TYPE.
- newRole
- Role that the user switches to: CLIENT_ROLE_TYPE.
- newRoleOptions
-
Properties of the role that the user switches to. See ClientRoleOptions.
onClientRoleChangeFailed
Occurs when the user role switching fails in the interactive live streaming.
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) {
(void)reason;
(void)currentRole;
}
In the live broadcasting channel profile, when the local user calls setClientRole [2/2] to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
Parameters
- reason
- The reason for a user role switch failure. See CLIENT_ROLE_CHANGE_FAILED_REASON.
- currentRole
- Current user role. See CLIENT_ROLE_TYPE.
onConnectionBanned
Occurs when the connection is banned by the Agora server.
virtual void onConnectionBanned()
- Deprecated:
- Use onConnectionStateChanged instead.
onConnectionInterrupted
Occurs when the connection between the SDK and the server is interrupted.
virtual void onConnectionInterrupted() {}
- Deprecated:
- Use onConnectionStateChanged instead.
- 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.
onConnectionLost
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
virtual void onConnectionLost()
The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the joinChannel [2/2] 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.
onConnectionStateChanged
Occurs when the network connection state changes.
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) {
(void)state;
(void)reason;
}
When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.
Parameters
- state
-
The current connection state. See CONNECTION_STATE_TYPE.
- reason
-
The reason for a connection state change. See CONNECTION_CHANGED_REASON_TYPE.
onEncryptionError
Reports the built-in encryption errors.
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) {
(void)errorType;
}
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
- errorType
- Details about the error type. See ENCRYPTION_ERROR_TYPE.
onError
Reports an error during SDK runtime.
virtual void onError(int err, const char* msg) {
(void)err;
(void)msg;
}
This callback indicates that an error (concerning network or media) occurs during SDK runtime. In most cases, the SDK cannot fix the issue and resume running. The SDK requires the application to take action or informs the user about the issue.
Parameters
- err
- Error code. See ERROR_CODE_TYPE.
- msg
- The error message.
onExtensionError
Occurs when the extension runs incorrectly.
virtual void onExtensionError(const char* provider, const char* extension, int error, const char* message) {
(void)provider;
(void)extension;
(void)error;
(void)message;
}
When calling enableExtension(true) fails or the extension runs in error, the extension triggers this callback and reports the error code and reason.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- 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.
onExtensionEvent
The event callback of the extension.
virtual void onExtensionEvent(const char* provider, const char* extension, const char* key, const char* value) {
(void)provider;
(void)extension;
(void)key;
(void)value;
}
To listen for events while the extension is running, you need to register this callback.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
- value
- The value of the extension key.
onExtensionStarted
Occurs when the extension is enabled.
virtual void onExtensionStarted(const char* provider, const char* extension) {
(void)provider;
(void)extension;
}
After a successful call of enableExtension(true), the extension triggers this callback.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
onExtensionStopped
Occurs when the extension is disabled.
virtual void onExtensionStopped(const char* provider, const char* extension) {
(void)provider;
(void)extension;
}
After a successful call of enableExtension(false), this callback is triggered.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
onFacePositionChanged
Reports the face detection result of the local user.
virtual void onFacePositionChanged(int imageWidth, int imageHeight,
const Rectangle* vecRectangle, const int* vecDistance,
int numFaces) {
(void) imageWidth;
(void) imageHeight;
(void) vecRectangle;
(void) vecDistance;
(void) numFaces;
}
(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.
- This callback is for Android and iOS only.
- When it is detected that the face in front of the camera disappears, the callback will be triggered immediately. 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.
- On Android, the value of distance reported in this callback may be slightly different from the actual distance. Therefore, Agora does not recommend using it for accurate calculation.
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
-
An array of numFaces, representing the detected face information:
x: The x-coordinate (px) of the human face in the local view. Taking the top left corner of the view as the origin, the x-coordinate represents the horizontal position of the human face relative to the origin.y: The y-coordinate (px) of the human face in the local view. Taking the top left corner of the view as the origin, the y-coordinate represents the vertical position of the human face relative to the origin.width: The width (px) of the human face in the captured view.height: The height (px) of the human face in the captured view.
- vecDistance
- An array of numFaces, representing the distance (cm) between a face and the device screen.
- 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.
virtual void onFirstLocalAudioFramePublished(int elapsed) {
(void)elapsed;
}
- The local client enables the audio module and calls joinChannel [2/2] successfully.
- The local client calls muteLocalAudioStream(
true) and muteLocalAudioStream(false) in sequence. - The local client calls disableAudio and enableAudio in sequence.
- The local client calls pushAudioFrame to successfully push the audio frame to the SDK.
Parameters
- elapsed
- Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
onFirstLocalVideoFrame
Occurs when the first local video frame is displayed on the local video view.
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) {
(void)source;
(void)width;
(void)height;
(void)elapsed;
}
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 VIDEO_SOURCE_TYPE.
- width
- The width (px) of the first local video frame.
- height
- The height (px) of the first local video frame.
- elapsed
- Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback. If you call startPreview [2/2] before calling joinChannel [2/2], then this parameter is the time elapsed from calling the startPreview [2/2] method until the SDK triggers this callback.
onFirstLocalVideoFramePublished
Occurs when the first video frame is published.
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) {
(void)source;
(void)elapsed;
}
- The local client enables the video module and calls joinChannel [2/2] successfully.
- The local client calls muteLocalVideoStream(
true) and muteLocalVideoStream(false) in sequence. - The local client calls disableVideo and enableVideo in sequence.
- The local client calls pushVideoFrame to successfully push the video frame to the SDK.
Parameters
- source
- The type of the video source. See VIDEO_SOURCE_TYPE.
- elapsed
- Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
onFirstRemoteAudioFrame
Occurs when the SDK receives the first audio frame from a specific remote user.
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) AGORA_DEPRECATED_ATTRIBUTE {
(void)uid;
(void)elapsed;
}
- Deprecated:
- Use onRemoteAudioStateChanged instead.
Parameters
- uid
- The user ID of the remote user.
- elapsed
- The time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
onFirstRemoteAudioDecoded
Occurs when the SDK decodes the first remote audio frame for playback.
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) {
(void)uid;
(void)elapsed;
}
- Deprecated:
- Use onRemoteAudioStateChanged instead.
- 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
- uid
- The user ID of the remote user.
- elapsed
- The time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
onFirstRemoteVideoDecoded
Occurs when the first remote video frame is received and decoded.
virtual void onFirstRemoteVideoDecoded(uid_t uid,
int width,
int height,
int elapsed) {
(void)uid;
(void)width;
(void)height;
(void)elapsed;
}
- The remote user joins the channel and sends the video stream.
- The remote user stops sending the video stream and re-sends it after 15 seconds. Reasons for such an interruption include:
- The remote user leaves the channel.
- The remote user drops offline.
- The remote user calls muteLocalVideoStream to stop sending the video stream.
- The remote user calls disableVideo to disable video.
Parameters
- uid
- 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 [2/2] until the SDK triggers this callback.
onFirstRemoteVideoFrame
Occurs when the renderer receives the first frame of the remote video.
virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed) {
(void)userId;
(void)width;
(void)height;
(void)elapsed;
}
Parameters
- userId
- 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 [2/2] until the SDK triggers this callback.
onJoinChannelSuccess
Occurs when a user joins a channel.
virtual void onJoinChannelSuccess(const char* channel,
uid_t uid,
int elapsed) {
(void)channel;
(void)uid;
(void)elapsed;
}
This callback notifies the application that a user joins a specified channel.
Parameters
- channel
- The channel name.
- uid
- The ID of the user who joins the channel.
- elapsed
- The time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
onLastmileProbeResult
Reports the last mile network probe result.
virtual void onLastmileProbeResult(const LastmileProbeResult& result) {
(void)result;
}
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.
virtual void onLastmileQuality(int quality) {
(void)quality;
}
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 QUALITY_TYPE.
onLeaveChannel
Occurs when a user leaves a channel.
virtual void onLeaveChannel(const RtcStats& stats) {
(void)stats;
}
This callback notifies the app that the user leaves the channel by calling leaveChannel [2/2]. From this callback, the app can get information such as the call duration and quality statistics.
Parameters
- stats
- The statistics of the call. See RtcStats.
onLocalAudioStateChanged
Occurs when the local audio stream state changes.
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) {
(void)state;
(void)error;
}
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.
Parameters
- state
- The state of the local audio. See LOCAL_AUDIO_STREAM_STATE.
- error
- Local audio state error codes. See LOCAL_AUDIO_STREAM_ERROR.
onLocalAudioStats
Reports the statistics of the local audio stream.
virtual void onLocalAudioStats(const LocalAudioStats& stats) {
(void)stats;
}
The SDK triggers this callback once every two seconds.
Parameters
- stats
- Local audio statistics. See LocalAudioStats.
onLocalUserRegistered
Occurs when the local user registers a user account.
virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) {
(void)uid;
(void)userAccount;
}
After the local user successfully calls registerLocalUserAccount to register the user account or calls joinChannelWithUserAccount [2/2] 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.
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) {
(void)source;
(void)state;
(void)error;
}
When the state of the local video stream changes (including the state of the video capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.
LOCAL_VIDEO_STREAM_STATE_FAILED and error code of LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE in the following situations:- The app switches to the background, and the system gets the camera resource.
- If your app runs in the background on a device running Android 9 or later, you cannot access the camera.
- If your app runs in the background on a device running Android 6 or later, the camera is occupied by a third-party app. Once the camera is released, the SDK triggers the
onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_CAPTURING,LOCAL_VIDEO_STREAM_ERROR_OK)callback. - The camera starts normally, but does not output video frames for four consecutive seconds.
When the camera outputs the captured video frames, if the video frames are the same for 15 consecutive frames, the SDK triggers the onLocalVideoStateChanged callback with the state code of LOCAL_VIDEO_STREAM_STATE_CAPTURING and error code of LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE. 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.
Parameters
- source
- The type of the video source. See VIDEO_SOURCE_TYPE.
- state
-
The state of the local video, see LOCAL_VIDEO_STREAM_STATE.
- error
-
The detailed error information, see LOCAL_VIDEO_STREAM_ERROR.
onLocalVideoStats
Reports the statistics of the local video stream.
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) {
(void)source;
(void)stats;
}
The SDK triggers this callback once every two seconds to report the statistics of the local video stream.
Parameters
- source
- The type of the video source. See VIDEO_SOURCE_TYPE.
- stats
- The statistics of the local video stream. See LocalVideoStats.
onLocalVideoTranscoderError
Occurs when there's an error during the local video mixing.
virtual void onLocalVideoTranscoderError(const TranscodingVideoStream& stream, VIDEO_TRANSCODER_ERROR error){
(void)stream;
(void)error;
}
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 VIDEO_TRANSCODER_ERROR.
onNetworkQuality
Reports the last mile network quality of each user in the channel.
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) {
(void)uid;
(void)txQuality;
(void)rxQuality;
}
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.
UNKNOWN when the user is not sending a stream; rxQuality is UNKNOWN when the user is not receiving a stream.Parameters
- uid
-
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. See QUALITY_TYPE.
- rxQuality
- Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network. See QUALITY_TYPE.
onNetworkTypeChanged
Occurs when the local network type changes.
virtual void onNetworkTypeChanged(NETWORK_TYPE type) {
(void)type;
}
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
- type
-
The type of the local network connection. See NETWORK_TYPE.
onPermissionError
Occurs when the SDK cannot get the device permission.
virtual void onPermissionError(PERMISSION_TYPE permissionType) {
(void)permissionType;
}
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 PERMISSION_TYPE.
onProxyConnected
Reports the proxy connection state.
virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) {
(void)channel;
(void)uid;
(void)proxyType;
(void)localProxyIp;
(void)elapsed;
}
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 [2/2] until this callback is triggered.
Parameters
- channel
- The channel name.
- uid
- The user ID.
- proxyType
- The proxy type connected. See PROXY_TYPE.
- localProxyIp
- Reserved for future use.
- elapsed
- The time elapsed (ms) from the user calling joinChannel [2/2] until this callback is triggered.
onRejoinChannelSuccess
Occurs when a user rejoins the channel.
virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
(void)channel;
(void)uid;
(void)elapsed;
}
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
- The channel name.
- uid
- The ID of the user who rejoins the channel.
- elapsed
- Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
onRemoteAudioStateChanged
Occurs when the remote audio state changes.
virtual void onRemoteAudioStateChanged(uid_t uid,
REMOTE_AUDIO_STATE state,
REMOTE_AUDIO_STATE_REASON reason,
int elapsed) {
(void)uid;
(void)state;
(void)reason;
(void)elapsed;
}
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.
Parameters
- uid
- The ID of the remote user whose audio state changes.
- state
- The state of the remote audio. See REMOTE_AUDIO_STATE.
- reason
- The reason of the remote audio state change. See REMOTE_AUDIO_STATE_REASON.
- elapsed
- Time elapsed (ms) from the local user calling the joinChannel [2/2] method until the SDK triggers this callback.
onRemoteAudioStats
Reports the transport-layer statistics of each remote audio stream.
virtual void onRemoteAudioStats(const RemoteAudioStats& stats) {
(void)stats;
}
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
- stats
- The statistics of the received remote audio streams. See RemoteAudioStats.
onRemoteAudioTransportStats
Reports the transport-layer statistics of each remote audio stream.
virtual void onRemoteAudioTransportStats(uid_t uid,
unsigned short delay,
unsigned short lost,
unsigned short rxKBitRate) {
(void)uid;
(void)delay;
(void)lost;
(void)rxKBitRate;
}
- 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
- uid
- 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).
onRemoteVideoStateChanged
Occurs when the remote video stream state changes.
virtual void onRemoteVideoStateChanged(uid_t uid,
REMOTE_VIDEO_STATE state,
REMOTE_VIDEO_STATE_REASON reason,
int elapsed) {
(void)uid;
(void)state;
(void)reason;
(void)elapsed;
}
Parameters
- uid
- The ID of the remote user whose video state changes.
- state
-
The state of the remote video. See REMOTE_VIDEO_STATE.
- reason
-
The reason for the remote video state change. See REMOTE_VIDEO_STATE_REASON.
- elapsed
- Time elapsed (ms) from the local user calling the joinChannel [2/2] method until the SDK triggers this callback.
onRemoteVideoStats
Reports the statistics of the video stream sent by each remote users.
virtual void onRemoteVideoStats(const RemoteVideoStats& stats) {
(void)stats;
}
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
- stats
- Statistics of the remote video stream. See RemoteVideoStats.
onRemoteVideoTransportStats
Reports the transport-layer statistics of each remote video stream.
virtual void onRemoteVideoTransportStats(uid_t uid,
unsigned short delay,
unsigned short lost,
unsigned short rxKBitRate) {
(void)uid;
(void)delay;
(void)lost;
(void)rxKBitRate;
}
- 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
- uid
- 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.
virtual void onRequestToken()
When the token expires during a call, the SDK triggers this callback to remind the app to renew the token.
- Call renewToken to pass in the new token.
- Call leaveChannel [2/2] to leave the current channel and then pass in the new token when you call joinChannel [2/2] to join a channel.
Parameters
onRhythmPlayerStateChanged
Occurs when the state of virtual metronome changes.
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_ERROR_TYPE errorCode) {
(void)state;
(void)errorCode;
}
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 RHYTHM_PLAYER_STATE_TYPE.
- errorCode
- For the error codes and error messages related to virtual metronome errors, see RHYTHM_PLAYER_ERROR_TYPE.
onRtcStats
Reports the statistics of the current call.
virtual void onRtcStats(const RtcStats& stats) {
(void)stats;
}
The SDK triggers this callback once every two seconds after the user joins the channel.
Parameters
- stats
-
Statistics of the RTC engine. See RtcStats.
onRtmpStreamingEvent
Reports events during the Media Push.
virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) {
(void)url;
(void)eventCode;
}
Parameters
- url
- The URL for Media Push.
- eventCode
- The event code of Media Push. See RTMP_STREAMING_EVENT.
onRtmpStreamingStateChanged
Occurs when the state of Media Push changes.
virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state,
RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) {
(void)url;
(void)state;
(void)errCode;
}
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 RTMP_STREAM_PUBLISH_STATE.
- errCode
- The detailed error information for the Media Push. See RTMP_STREAM_PUBLISH_ERROR_TYPE.
onSnapshotTaken
Reports the result of taking a video snapshot.
virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) {
(void)uid;
(void)filePath;
(void)width;
(void)height;
(void)errCode;
}
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.
- 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.
virtual void onStreamMessage(uid_t userId, int streamId, const char* data, size_t length, uint64_t sentTs) {
(void)userId;
(void)streamId;
(void)data;
(void)length;
(void)sentTs;
}
The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the sendStreamMessage method.
Parameters
- userId
- 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.
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached) {
(void)userId;
(void)streamId;
(void)code;
(void)missed;
(void)cached;
}
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
- userId
- The ID of the remote user sending the message.
- streamId
- The stream ID of the received message.
- code
- The error code.
- 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.
virtual void onTokenPrivilegeWillExpire(const char* token) {
(void)token;
}
When the token is about to expire in 30 seconds, the SDK triggers this callback to remind the app to renew the token.
Upon receiving this callback, you need to generate a new token on your server, and call renewToken to pass the new token to the SDK. In scenarios involving multiple channels, you need to call updateChannelMediaOptionsEx to pass the new token to the SDK.
Parameters
- token
- The token that expires in 30 seconds.
onTranscodingUpdated
Occurs when the publisher's transcoding is updated.
virtual void onTranscodingUpdated()
When the LiveTranscoding class in the setLiveTranscoding method updates, the SDK triggers the onTranscodingUpdated callback to report the update information.
onUplinkNetworkInfoUpdated
Occurs when the uplink network information changes.
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info) {
(void)info;
}
The SDK triggers this callback when the uplink network information changes.
Parameters
- info
- The uplink network information. See UplinkNetworkInfo.
onUserEnableLocalVideo
Occurs when a specific remote user enables/disables the local video capturing function.
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) {
(void)uid;
(void)enabled;
}
The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.
Parameters
- uid
- The user ID of the remote user.
- enabled
-
Whether the specified remote user enables/disables the local video capturing function:
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.
virtual void onUserEnableVideo(uid_t uid, bool enabled) {
(void)uid;
(void)enabled;
}
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
- uid
- 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.
virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) {
(void)uid;
(void)info;
}
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.
virtual void onUserJoined(uid_t uid, int elapsed) {
(void)uid;
(void)elapsed;
}
- 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.
- 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.
Parameters
- uid
- The ID of the user or host who joins the channel.
- elapsed
- Time delay (ms) from the local user calling joinChannel [2/2] 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.
virtual void onUserMuteAudio(uid_t uid, bool muted) {
(void)uid;
(void)muted;
}
The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method.
Parameters
- uid
- 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.
virtual void onUserMuteVideo(uid_t uid, bool muted) {
(void)uid;
(void)muted;
}
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.
Parameters
- uid
- 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.
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) {
(void)uid;
(void)reason;
}
- Leave the channel: When a user/host leaves the channel, the user/host sends a goodbye message. When this message is received, the SDK determines that the user/host leaves the channel.
- Drop offline: When no data packet of the user or host is received for a certain period of time (20 seconds for the communication profile, and more for the live broadcast profile), the SDK assumes that the user/host drops offline. A poor network connection may lead to false detections. It's recommended to use the Agora RTM SDK for reliable offline detection.
Parameters
- uid
- The ID of the user who leaves the channel or goes offline.
- reason
-
Reasons why the user goes offline: USER_OFFLINE_REASON_TYPE.
onVideoDeviceStateChanged
Occurs when the video device state changes.
virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
(void)deviceId;
(void)deviceType;
(void)deviceState;
}
This callback reports the change of system video devices, such as being unplugged or removed. On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged.
Parameters
- deviceId
- The device ID.
- deviceType
- Media device types. See MEDIA_DEVICE_TYPE.
- deviceState
- Media device states.
onVideoPublishStateChanged
Occurs when the video publishing state changes.
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
(void)source;
(void)channel;
(void)oldState;
(void)newState;
(void)elapseSinceLastState;
}
Parameters
- channel
- The channel name.
- source
- The type of the video source. See VIDEO_SOURCE_TYPE.
- oldState
- The previous publishing state. See STREAM_PUBLISH_STATE.
- newState
- The current publishing stat. See STREAM_PUBLISH_STATE.
- 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.
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) {
(void)uid;
(void)width;
(void)height;
(void)rotation;
}
Parameters
- sourceType
- The type of the video source. See VIDEO_SOURCE_TYPE.
- 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).
onVideoStopped
Occurs when the video stops playing.
virtual void onVideoStopped()
- Deprecated:
- 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.
onVideoSubscribeStateChanged
Occurs when the video subscribing state changes.
virtual void onVideoSubscribeStateChanged(const char* channel,
uid_t uid,
STREAM_SUBSCRIBE_STATE oldState,
STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) {
(void)channel;
(void)uid;
(void)oldState;
(void)newState;
(void)elapseSinceLastState;
}
Parameters
- channel
- The channel name.
- uid
- The user ID of the remote user.
- oldState
- The previous subscribing status. See STREAM_SUBSCRIBE_STATE.
- newState
- The current subscribing status. See STREAM_SUBSCRIBE_STATE.
- elapseSinceLastState
- The time elapsed (ms) from the previous state to the current state.