Agora Java API Reference for Android
|
Classes | |
class | AgoraFacePositionInfo |
class | AudioVolumeInfo |
class | ClientRole |
class | DownlinkNetworkInfo |
class | ErrorCode |
class | LastmileProbeResult |
class | LocalAudioStats |
class | LocalVideoStats |
class | Quality |
class | RemoteAudioStats |
class | RemoteVideoStats |
class | RtcStats |
class | UplinkNetworkInfo |
class | UserOfflineReason |
class | VideoLayout |
class | VideoLayoutInfo |
class | VideoProfile |
class | VideoRenderingTracingInfo |
class | WarnCode |
class | WlAccStats |
Public Member Functions | |
void | onError (int err) |
void | onJoinChannelSuccess (String channel, int uid, int elapsed) |
void | onRejoinChannelSuccess (String channel, int uid, int elapsed) |
void | onLeaveChannel (RtcStats stats) |
void | onClientRoleChanged (int oldRole, int newRole, ClientRoleOptions newRoleOptions) |
void | onClientRoleChangeFailed (int reason, int currentRole) |
void | onLocalUserRegistered (int uid, String userAccount) |
void | onUserInfoUpdated (int uid, UserInfo userInfo) |
void | onUserStateChanged (int uid, int state) |
void | onUserJoined (int uid, int elapsed) |
void | onUserOffline (int uid, int reason) |
void | onConnectionStateChanged (int state, int reason) |
void | onWlAccMessage (int reason, int action, String wlAccMsg) |
void | onWlAccStats (WlAccStats currentStats, WlAccStats averageStats) |
void | onConnectionInterrupted () |
void | onConnectionLost () |
void | onConnectionBanned () |
void | onTokenPrivilegeWillExpire (String token) |
void | onRequestToken () |
void | onLicenseValidationFailure (int error) |
void | onAudioVolumeIndication (AudioVolumeInfo[] speakers, int totalVolume) |
void | onActiveSpeaker (int uid) |
void | onVideoStopped () |
void | onFirstLocalVideoFrame (Constants.VideoSourceType source, int width, int height, int elapsed) |
void | onFirstLocalVideoFramePublished (Constants.VideoSourceType source, int elapsed) |
void | onFirstRemoteVideoDecoded (int uid, int width, int height, int elapsed) |
void | onFirstRemoteVideoFrame (int uid, int width, int height, int elapsed) |
void | onUserMuteAudio (int uid, boolean muted) |
void | onUserMuteVideo (int uid, boolean muted) |
void | onUserEnableVideo (int uid, boolean enabled) |
void | onUserEnableLocalVideo (int uid, boolean enabled) |
void | onVideoSizeChanged (Constants.VideoSourceType source, int uid, int width, int height, int rotation) |
void | onRemoteAudioStateChanged (int uid, int state, int reason, int elapsed) |
void | onAudioPublishStateChanged (String channel, int oldState, int newState, int elapseSinceLastState) |
void | onVideoPublishStateChanged (Constants.VideoSourceType source, String channel, int oldState, int newState, int elapseSinceLastState) |
void | onLocalPublishFallbackToAudioOnly (boolean isFallbackOrRecover) |
void | onAudioSubscribeStateChanged (String channel, int uid, int oldState, int newState, int elapseSinceLastState) |
void | onVideoSubscribeStateChanged (String channel, int uid, int oldState, int newState, int elapseSinceLastState) |
void | onRemoteVideoStateChanged (int uid, int state, int reason, int elapsed) |
void | onChannelMediaRelayStateChanged (int state, int code) |
void | onFirstLocalAudioFramePublished (int elapsed) |
void | onFirstRemoteAudioFrame (int uid, int elapsed) |
void | onFirstRemoteAudioDecoded (int uid, int elapsed) |
void | onRemoteSubscribeFallbackToAudioOnly (int uid, boolean isFallbackOrRecover) |
void | onAudioRouteChanged (int routing) |
void | onCameraReady () |
void | onCameraFocusAreaChanged (Rect rect) |
void | onCameraExposureAreaChanged (Rect rect) |
void | onSnapshotTaken (int uid, String filePath, int width, int height, int errCode) |
snapshot taken callback More... | |
void | onFacePositionChanged (int imageWidth, int imageHeight, AgoraFacePositionInfo[] faceRectArr) |
void | onAudioQuality (int uid, int quality, short delay, short lost) |
void | onRtcStats (RtcStats stats) |
void | onLastmileQuality (int quality) |
void | onLastmileProbeResult (LastmileProbeResult result) |
void | onNetworkQuality (int uid, int txQuality, int rxQuality) |
void | onLocalAudioStats (LocalAudioStats stats) |
void | onLocalVideoStats (Constants.VideoSourceType source, LocalVideoStats stats) |
void | onRemoteAudioStats (RemoteAudioStats stats) |
void | onRemoteVideoStats (RemoteVideoStats stats) |
void | onLocalVideoStat (int sentBitrate, int sentFrameRate) |
void | onRemoteVideoStat (int uid, int delay, int receivedBitrate, int receivedFrameRate) |
void | onRemoteAudioTransportStats (int uid, int delay, int lost, int rxKBitRate) |
void | onRemoteVideoTransportStats (int uid, int delay, int lost, int rxKBitRate) |
void | onAudioMixingStateChanged (int state, int reason) |
void | onAudioMixingPositionChanged (long position) |
Reports current AudioMixing progress. More... | |
void | onAudioMixingFinished () |
void | onAudioEffectFinished (int soundId) |
void | onRhythmPlayerStateChanged (int state, int reason) |
void | onLocalAudioStateChanged (int state, int reason) |
void | onLocalVideoStateChanged (Constants.VideoSourceType source, int state, int reason) |
void | onRtmpStreamingStateChanged (String url, int state, int reason) |
void | onRtmpStreamingEvent (String url, int event) |
void | onTranscodingUpdated () |
void | onStreamInjectedStatus (String url, int uid, int status) |
void | onStreamMessage (int uid, int streamId, byte[] data) |
void | onStreamMessageError (int uid, int streamId, int error, int missed, int cached) |
void | onMediaEngineLoadSuccess () |
void | onMediaEngineStartCallSuccess () |
void | onNetworkTypeChanged (int type) |
void | onIntraRequestReceived () |
void | onUplinkNetworkInfoUpdated (UplinkNetworkInfo info) |
void | onDownlinkNetworkInfoUpdated (DownlinkNetworkInfo info) |
void | onEncryptionError (int errorType) |
void | onPermissionError (int permission) |
void | onUploadLogResult (String requestId, boolean success, int reason) |
void | onContentInspectResult (int result) |
void | onProxyConnected (String channel, int uid, int proxyType, String localProxyIp, int elapsed) |
void | onVideoRenderingTracingResult (int uid, Constants.MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) |
void | onLocalVideoTranscoderError (LocalTranscoderConfiguration.TranscodingVideoStream stream, int error) |
void | onTranscodedStreamLayoutInfo (int uid, VideoLayoutInfo info) |
void | onAudioMetadataReceived (int uid, byte[] data) |
Occurs when the SDK receives audio metadata. More... | |
Callback methods.
The SDK uses the IRtcEngineEventHandler interface class to send callback event notifications to the application, and the application inherits the methods of this interface class to retrieve these event notifications. All methods in this interface class have their (empty) default implementations, and the application can inherit only some of the required events instead of all of them. In the callback methods, the application should avoid time-consuming tasks or call blocking APIs (such as SendMessage), otherwise, the SDK may not work properly.
void io.agora.rtc2.IRtcEngineEventHandler.onError | ( | int | err | ) |
An error occurred during SDK runtime.
In most cases, reporting an error means that the SDK cannot fix the issue and resume running, and therefore requires actions from the application or simply informs the user about the issue. In this case, the application informs the user that the call initialization has failed, and calls the leaveChannel method to exit the channel.
err | Error code |
void io.agora.rtc2.IRtcEngineEventHandler.onJoinChannelSuccess | ( | String | channel, |
int | uid, | ||
int | elapsed | ||
) |
Occurs when the local user successfully joins the specified channel.
channel | The channel name. |
uid | The user ID.
|
elapsed | The time elapsed (ms) from the local user calling joinChannel until this event occurs. |
void io.agora.rtc2.IRtcEngineEventHandler.onRejoinChannelSuccess | ( | String | channel, |
int | uid, | ||
int | elapsed | ||
) |
Occurs when the local user rejoins the channel after being disconnected due to network problems.
When the app loses connection with the server because of network problems, the SDK automatically tries to reconnect to the server, and triggers this callback method upon reconnection.
channel | The channel name. |
uid | The user ID. |
elapsed | Time elapsed (ms) from starting to reconnect until this callback is triggered |
void io.agora.rtc2.IRtcEngineEventHandler.onLeaveChannel | ( | RtcStats | stats | ) |
Occurs when the local user successfully leaves the channel.
When the user successfully leaves the channel after calling leaveChannel, the SDK uses this callback to notify the app that the user has left the channel.
This callback also reports information such as the call duration and the statistics of data received or transmitted by the SDK.
stats | The statistics on the call: RtcStats. |
void io.agora.rtc2.IRtcEngineEventHandler.onClientRoleChanged | ( | int | oldRole, |
int | newRole, | ||
ClientRoleOptions | newRoleOptions | ||
) |
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
oldRole | The old role of the user. |
newRole | The new role of the user. |
newRoleOptions | The client role options of the new role. |
void io.agora.rtc2.IRtcEngineEventHandler.onClientRoleChangeFailed | ( | int | reason, |
int | currentRole | ||
) |
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
reason | The reason of the failure of the local user role switches. |
currentRole | The current role of the user |
void io.agora.rtc2.IRtcEngineEventHandler.onLocalUserRegistered | ( | int | uid, |
String | userAccount | ||
) |
Occurs when the local user registers a user account.
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.
uid | The ID of the local user. |
userAccount | The user account of the local user. |
void io.agora.rtc2.IRtcEngineEventHandler.onUserInfoUpdated | ( | int | uid, |
UserInfo | userInfo | ||
) |
Occurs when the SDK gets the user ID and user account of the remote user.
After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object (UserInfo), and triggers this callback on the local client.
uid | The ID of the remote user. |
userInfo | The UserInfo object that contains the user ID and user account of the remote user. |
void io.agora.rtc2.IRtcEngineEventHandler.onUserStateChanged | ( | int | uid, |
int | state | ||
) |
Occurs when the remote user state is updated.
uid | The ID of the remote user. |
state | State of the remote user: Just & #REMOTE_USER_STATE
|
void io.agora.rtc2.IRtcEngineEventHandler.onUserJoined | ( | int | uid, |
int | elapsed | ||
) |
Occurs when a remote user or broadcaster joins the channel.
If other users are already in the channel, the SDK also reports to the app on the existing users.
The SDK triggers this callback under one of the following circumstances:
uid | ID of the remote user or broadcaster joining the channel. |
elapsed | The time elapsed (ms) from the local user calling joinChannel or setClientRole until this callback is triggered. |
void io.agora.rtc2.IRtcEngineEventHandler.onUserOffline | ( | int | uid, |
int | reason | ||
) |
Occurs when a remote user or broadcaster goes offline.
uid | ID of the remote user or broadcaster who leaves the channel or drops offline. |
reason | The reason why the remote user goes offline:
|
void io.agora.rtc2.IRtcEngineEventHandler.onConnectionStateChanged | ( | int | state, |
int | reason | ||
) |
Occurs when the network connection state changes.
The Agora SDK returns this callback to report on the current network connection state when it changes, and the reason to such change.
state | The current network connection state:
|
reason | The reason causing the change of the connection state:
|
void io.agora.rtc2.IRtcEngineEventHandler.onWlAccMessage | ( | int | reason, |
int | action, | ||
String | wlAccMsg | ||
) |
Occurs when the WIFI message need be sent to the user.
reason | The reason of notifying the user of a message. |
action | Suggest an action for the user. |
wlAccMsg | Notification message to the user. |
void io.agora.rtc2.IRtcEngineEventHandler.onWlAccStats | ( | WlAccStats | currentStats, |
WlAccStats | averageStats | ||
) |
Occurs when SDK statistics WIFI acceleration optimization effect.
currentStats | Instantaneous value of optimization effect. |
averageStats | Average value of cumulative optimization effect. |
void io.agora.rtc2.IRtcEngineEventHandler.onConnectionInterrupted | ( | ) |
The SDK has lost connection to the server. This method is triggered upon connection is lost, while the onConnectionLost method is triggered when the SDK attempts to reconnect after losing connection. Once the connection is lost, and if the application does not call leaveChannel, the SDK automatically tries to reconnect repeatedly.
void io.agora.rtc2.IRtcEngineEventHandler.onConnectionLost | ( | ) |
Occurs when the SDK cannot reconnect to the 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.
void io.agora.rtc2.IRtcEngineEventHandler.onConnectionBanned | ( | ) |
Your connection is banned by the Agora Server.
Note: The SDK does not try to reconnect.
void io.agora.rtc2.IRtcEngineEventHandler.onTokenPrivilegeWillExpire | ( | String | token | ) |
Occurs when the token will expire in 30 seconds.
If the token you specified when calling joinChannel expires, the user will drop offline. This callback is triggered 30 seconds before the token expires, to remind you to renew the token.
Upon receiving this callback, generate a new token at your app server and call renewToken to pass the new Token to the SDK.
token | The token that will expire in 30 seconds. |
void io.agora.rtc2.IRtcEngineEventHandler.onRequestToken | ( | ) |
Occurs when the token has expired.
If a token is specified when calling the joinChannel method, the token expires after a certain period of time and you need a new token to reconnect to the server.
Upon receiving this callback, generate a new token at your app server and call renewToken to pass the new token to the SDK.
void io.agora.rtc2.IRtcEngineEventHandler.onLicenseValidationFailure | ( | int | error | ) |
Occurs when connection license verification fails You can know the reason accordding to error code
error | license verify fail reason:
|
void io.agora.rtc2.IRtcEngineEventHandler.onAudioVolumeIndication | ( | AudioVolumeInfo[] | speakers, |
int | totalVolume | ||
) |
Reports which users are speaking and the speaker‘s volume.
This callback reports the IDs and volumes of the loudest speakers (at most 3) at the moment in the channel, and whether the local user is speaking. 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.
Calling the muteLocalAudioStream method affects the SDK's behavior.
muteLocalAudioStream
method, the SDK stops triggering the local user's callback.muteLocalAudioStream
method, the remote speakers' callback does not include information of this remote user; 20 seconds after all remote users call the muteLocalAudioStream
method, the SDK stops triggering the remote speakers' callback.speakers | An array containing the user ID and volume information for each speaker: AudioVolumeInfo.
|
totalVolume | The total volume after audio mixing. The value ranges between 0 (the lowest volume) and 255 (the highest volume).
|
void io.agora.rtc2.IRtcEngineEventHandler.onActiveSpeaker | ( | int | uid | ) |
Occurs when an active speaker is detected.
If you have called the enableAudioVolumeIndication method, this callback is triggered when the volume detecting unit has detected an active speaker in the channel. This callback also returns the uid
of the active speaker.
You can add relative functions on your app, for example, the active speaker, once detected, will have the portrait zoomed in.
enableAudioVolumeIndication
to receive this callback.uid | The ID of the active speaker. A uid of 0 means the local user. |
void io.agora.rtc2.IRtcEngineEventHandler.onVideoStopped | ( | ) |
The video has stopped playing.
The application can use this callback to change the configuration of the view (for example, display other pictures in the view) after the video stops.
void io.agora.rtc2.IRtcEngineEventHandler.onFirstLocalVideoFrame | ( | Constants.VideoSourceType | source, |
int | width, | ||
int | height, | ||
int | elapsed | ||
) |
The first local video frame is displayed on the screen.
source | source type of the originated video source. |
width | Width (pixels) of the video stream. |
height | Height (pixels) of the video stream. |
elapsed | Time elapsed (ms) from calling token, java.lang.String channelName, java.lang.String optionalInfo, int optionalUid) joinChannel until this callback is triggered. |
void io.agora.rtc2.IRtcEngineEventHandler.onFirstLocalVideoFramePublished | ( | Constants.VideoSourceType | source, |
int | elapsed | ||
) |
Occurs when the first video frame is published.
source | source type of the originated video source. |
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
void io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteVideoDecoded | ( | int | uid, |
int | width, | ||
int | height, | ||
int | elapsed | ||
) |
Occurs when the first remote video frame is received and decoded.
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:
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. |
void io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteVideoFrame | ( | int | uid, |
int | width, | ||
int | height, | ||
int | elapsed | ||
) |
The first frame of the remote video appears in the user’s video window.
The application can retrieve the data of time elapsed from user joining the channel until the first video frame is displayed.
uid | User ID of the user whose video streams are received. |
width | Width (pixels) of the video stream. |
height | Height (pixels) of the video stream. |
elapsed | Time elapsed (ms) from calling token, java.lang.String channelName, java.lang.String optionalInfo, int optionalUid) joinChannel until this callback is triggered. |
void io.agora.rtc2.IRtcEngineEventHandler.onUserMuteAudio | ( | int | uid, |
boolean | muted | ||
) |
Occurs when a remote user stops/resumes sending the audio stream.
The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method.
COMMUNICATION
profile) or hosts (in the LIVE_BROADCASTING
profile) in the channel exceeds 17.uid | ID of the remote user. |
muted | Whether the remote user's audio stream playback pauses/resumes:
|
void io.agora.rtc2.IRtcEngineEventHandler.onUserMuteVideo | ( | int | uid, |
boolean | muted | ||
) |
Occurs when a remote user stops/resumes sending the video stream.
The SDK triggers this callback when the remote user stops or resumes sending the video stream by calling the muteLocalVideoStream method.
COMMUNICATION
profile) or hosts (in the LIVE_BROADCASTING
profile) in the channel exceeds 17.uid | ID of the remote user. |
muted | Whether the remote user's video stream playback pauses/resumes:
|
void io.agora.rtc2.IRtcEngineEventHandler.onUserEnableVideo | ( | int | uid, |
boolean | enabled | ||
) |
Occurs when a remote user enables/disables the video module.
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.
uid | User ID of the remote user. |
enabled | Whether the specific remote user enables/disables the video module:
|
void io.agora.rtc2.IRtcEngineEventHandler.onUserEnableLocalVideo | ( | int | uid, |
boolean | enabled | ||
) |
Occurs when a remote user enables/disables the local video capture 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 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.
uid | User ID of the remote user. |
enabled | Whether the specific remote user enables/disables the local video capturing function:
|
void io.agora.rtc2.IRtcEngineEventHandler.onVideoSizeChanged | ( | Constants.VideoSourceType | source, |
int | uid, | ||
int | width, | ||
int | height, | ||
int | rotation | ||
) |
Occurs when the local or remote video size or rotation has changed.
source | The video source type. |
uid | The user ID. 0 indicates the local user. |
width | The new width (pixels) of the video. |
height | The new height (pixels) of the video. |
rotation | The rotation information of the video. |
void io.agora.rtc2.IRtcEngineEventHandler.onRemoteAudioStateChanged | ( | int | uid, |
int | state, | ||
int | reason, | ||
int | elapsed | ||
) |
Occurs when the remote audio state changes.
This callback indicates the state change of the remote audio stream.
uid | ID of the user whose audio state changes. |
state | The state of the remote audio:
|
reason | The reason of the remote audio state change.
|
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. |
void io.agora.rtc2.IRtcEngineEventHandler.onAudioPublishStateChanged | ( | String | channel, |
int | oldState, | ||
int | newState, | ||
int | elapseSinceLastState | ||
) |
Occurs when the audio publish state changed.
The publishing states include:
channel | The channel name of user joined. |
oldState | The old state of the audio stream publish. |
newState | The new state of the audio stream publish. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
void io.agora.rtc2.IRtcEngineEventHandler.onVideoPublishStateChanged | ( | Constants.VideoSourceType | source, |
String | channel, | ||
int | oldState, | ||
int | newState, | ||
int | elapseSinceLastState | ||
) |
Occurs when the audio publish state changed.
The publishing states include:
source | source type of the originated video source. |
channel | The channel name of user joined. |
oldState | The old state of the video stream subscribe state. |
newState | The new state of the video stream subscribe state. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
void io.agora.rtc2.IRtcEngineEventHandler.onAudioSubscribeStateChanged | ( | String | channel, |
int | uid, | ||
int | oldState, | ||
int | newState, | ||
int | elapseSinceLastState | ||
) |
Occurs when the audio subscribe state changed. The subscribing states include:
channel | The channel name of user joined. |
uid | The remote user ID that is subscribed to. |
oldState | The old state of the audio stream subscribe. |
newState | The new state of the audio stream subscribe . |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
void io.agora.rtc2.IRtcEngineEventHandler.onVideoSubscribeStateChanged | ( | String | channel, |
int | uid, | ||
int | oldState, | ||
int | newState, | ||
int | elapseSinceLastState | ||
) |
Occurs when the video subscribe state changed.
The subscribing states include:
channel | The channel name of user joined. |
uid | The remote user ID that is subscribed to. |
oldState | The old state of the video stream subscribe state. |
newState | The new state of the video stream subscribe state. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
void io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoStateChanged | ( | int | uid, |
int | state, | ||
int | reason, | ||
int | elapsed | ||
) |
Occurs when the remote video state has changed.
COMMUNICATION
profile) or hosts (in the LIVE_BROADCASTING
profile) in the channel exceeds 17.uid | ID of the user whose video state has changed. |
state | State of the remote video:
|
reason | The reason of the remote video state change:
|
elapsed | The time elapsed (ms) from the local user calling joinChannel until this callback is triggered. |
void io.agora.rtc2.IRtcEngineEventHandler.onChannelMediaRelayStateChanged | ( | int | state, |
int | code | ||
) |
Occurs when the state of the media stream relay changes.
The SDK reports the state of the current media relay and possible error messages in this callback.
state | The state code:
|
code | The error code:
|
void io.agora.rtc2.IRtcEngineEventHandler.onFirstLocalAudioFramePublished | ( | int | elapsed | ) |
Occurs when the first audio frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
void io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteAudioFrame | ( | int | uid, |
int | elapsed | ||
) |
Occurs when the first remote audio frame is received.
uid | ID of the remote user. |
elapsed | The time elapsed (ms) from the local user calling RtcEngine#joinChannel until this callback is triggered. |
void io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteAudioDecoded | ( | int | uid, |
int | elapsed | ||
) |
Occurs when the SDK decodes the first remote audio frame for playback.
uid | User ID of the remote user sending the audio stream. |
elapsed | The time elapsed (ms) from the loca user calling joinChannel() until this callback is triggered. |
void io.agora.rtc2.IRtcEngineEventHandler.onAudioRouteChanged | ( | int | routing | ) |
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:
void io.agora.rtc2.IRtcEngineEventHandler.onCameraReady | ( | ) |
The camera is turned on and ready to capture video.
If the camera fails to turn on, an error is passed in the onError method.
void io.agora.rtc2.IRtcEngineEventHandler.onCameraFocusAreaChanged | ( | Rect | rect | ) |
Occurs when the camera focus area has changed.
rect | Rectangular area in the camera zoom that specifies the focus area. |
void io.agora.rtc2.IRtcEngineEventHandler.onCameraExposureAreaChanged | ( | Rect | rect | ) |
Occurs when the camera exposure area has changed.
rect | Rectangular area in the camera zoom that specifies the focus area. |
void io.agora.rtc2.IRtcEngineEventHandler.onSnapshotTaken | ( | int | uid, |
String | filePath, | ||
int | width, | ||
int | height, | ||
int | errCode | ||
) |
snapshot taken callback
Occurs when takeSnapshot API result is obtained
uid | user id |
filePath | image is saveed file path |
width | image width |
height | image height |
errCode | 0 is ok negative is error |
void io.agora.rtc2.IRtcEngineEventHandler.onFacePositionChanged | ( | int | imageWidth, |
int | imageHeight, | ||
AgoraFacePositionInfo[] | faceRectArr | ||
) |
Occurs when the camera exposure area has changed.
imageWidth | width of output image. |
imageHeight | height of output image. |
faceRectArr | Rectangular area in the camera zoom that specifies the focus area. |
void io.agora.rtc2.IRtcEngineEventHandler.onAudioQuality | ( | int | uid, |
int | quality, | ||
short | delay, | ||
short | lost | ||
) |
The audio quality of the specified user every two seconds.
By default, this callback is enabled.
uid | User ID of the speaker. |
quality | Rating of the audio quality: |
delay | Time delay (ms). |
lost | Packet loss rate (%). |
void io.agora.rtc2.IRtcEngineEventHandler.onRtcStats | ( | RtcStats | stats | ) |
Reports the statistics of the current call.
This callback is triggered once every two seconds after the user joins the channel.
stats | The statistics on the current call: RtcStats. |
void io.agora.rtc2.IRtcEngineEventHandler.onLastmileQuality | ( | int | quality | ) |
Reports the last-mile network quality of the local user.
This callback is triggered once after startLastmileProbeTest
is called.
When the user is not in a channel and the last-mile network probe test is enabled (by calling startLastmileProbeTest
), this callback function is triggered to update the app on the network connection quality of the local user.
quality | The network quality:
|
void io.agora.rtc2.IRtcEngineEventHandler.onLastmileProbeResult | ( | LastmileProbeResult | result | ) |
Reports the last-mile network probe result.
The SDK triggers this callback within 30 seconds after the app calls the {startLastmileProbeTest} method. result The uplink and downlink lastmile network probe test result. For details, see LastmileProbeResult LastmileProbeResult}.
void io.agora.rtc2.IRtcEngineEventHandler.onNetworkQuality | ( | int | uid, |
int | txQuality, | ||
int | rxQuality | ||
) |
Reports the network quality of each user.
This callback is triggered once every two seconds after the user joins the channel.
uid | User ID. If uid is 0, the SDK reports the local network quality. |
txQuality | The transmission quality of the user:
|
rxQuality | The receiving quality of the user:
|
void io.agora.rtc2.IRtcEngineEventHandler.onLocalAudioStats | ( | LocalAudioStats | stats | ) |
Reports the statistics of the local audio stream.
The SDK triggers this callback once every two seconds.
stats | The statistics of the local audio stream. See LocalAudioStats. |
void io.agora.rtc2.IRtcEngineEventHandler.onLocalVideoStats | ( | Constants.VideoSourceType | source, |
LocalVideoStats | stats | ||
) |
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.
source | source type of the originated video source |
stats | The statistics of the local video stream. See LocalVideoStats. |
void io.agora.rtc2.IRtcEngineEventHandler.onRemoteAudioStats | ( | RemoteAudioStats | stats | ) |
Reports the statistics of the audio from each remote user or broadcaster.
The SDK triggers this callback once every two seconds for each remote user or broadcaster. If a channel has multiple remote users, the SDK triggers this callback as many times.
stats | The statistics of the received audio: RemoteAudioStats. |
void io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoStats | ( | RemoteVideoStats | stats | ) |
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.
stats | The statistics of the remote video streams. See RemoteVideoStats. |
void io.agora.rtc2.IRtcEngineEventHandler.onLocalVideoStat | ( | int | sentBitrate, |
int | sentFrameRate | ||
) |
sentBitrate | Data sending bitrate (kbit/s) since last count. |
sentFrameRate | Data sending frame rate (fps) since last count. |
void io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoStat | ( | int | uid, |
int | delay, | ||
int | receivedBitrate, | ||
int | receivedFrameRate | ||
) |
uid | User ID of the user whose video streams are received. |
delay | Time delay (ms). |
receivedBitrate | Data receiving bitrate (kbit/s). |
receivedFrameRate | Data receiving frame rate (fps). |
void io.agora.rtc2.IRtcEngineEventHandler.onAudioMixingStateChanged | ( | int | state, |
int | reason | ||
) |
Occurs when the state of the local user's audio mixing file changes.
When you call the startAudioMixing method and the state of audio mixing file changes, the Agora SDK triggers this callback.
void io.agora.rtc2.IRtcEngineEventHandler.onAudioMixingPositionChanged | ( | long | position | ) |
Reports current AudioMixing progress.
The callback occurs once every one second during the playback and reports the current playback progress.
position | Current AudioMixing progress (millisecond). |
void io.agora.rtc2.IRtcEngineEventHandler.onAudioMixingFinished | ( | ) |
The audio mixing file playback is finished after calling {startAudioMixing}. If you failed to execute the filePath, boolean loopback, int cycle) startAudioMixing method, it returns the error code in the onError callback.
void io.agora.rtc2.IRtcEngineEventHandler.onAudioEffectFinished | ( | int | soundId | ) |
The local audio effect playback has finished.
soundId | ID of the audio effect. Each audio effect has a unique ID. |
void io.agora.rtc2.IRtcEngineEventHandler.onRhythmPlayerStateChanged | ( | int | state, |
int | reason | ||
) |
Occurs when the state of the local user's rhythm player changes. When you call the startRhythmPlayer method and the state of rhythm player changes, the SDK triggers this callback.
state | The state code. See #RHYTHM_PLAYER_STATE_TYPE. |
reason | The error code. See #RHYTHM_PLAYER_REASON_TYPE. |
void io.agora.rtc2.IRtcEngineEventHandler.onLocalAudioStateChanged | ( | int | state, |
int | reason | ||
) |
Occurs when the local audio stream state changes.
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.
LOCAL_AUDIO_STREAM_STATE_FAILED(3)
, see the error
parameter for details.state | State of the local audio:
|
reason | The reason information of the local audio:
|
void io.agora.rtc2.IRtcEngineEventHandler.onLocalVideoStateChanged | ( | Constants.VideoSourceType | source, |
int | state, | ||
int | reason | ||
) |
Occurs when the local video stream state changes.
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.
source | source type of the originated video source. |
state | The local video state:
|
reason | The detailed reason information of the local video:
|
void io.agora.rtc2.IRtcEngineEventHandler.onRtmpStreamingStateChanged | ( | String | url, |
int | state, | ||
int | reason | ||
) |
Occurs when the state of the RTMP streaming changes.
void io.agora.rtc2.IRtcEngineEventHandler.onRtmpStreamingEvent | ( | String | url, |
int | event | ||
) |
Reports events during the RTMP or RTMPS streaming.
url | The CDN streaming URL. |
error | The event code.
|
void io.agora.rtc2.IRtcEngineEventHandler.onTranscodingUpdated | ( | ) |
Transcoding was successfully updated.
void io.agora.rtc2.IRtcEngineEventHandler.onStreamInjectedStatus | ( | String | url, |
int | uid, | ||
int | status | ||
) |
The status of the injected stream.
void io.agora.rtc2.IRtcEngineEventHandler.onStreamMessage | ( | int | uid, |
int | streamId, | ||
byte[] | data | ||
) |
Receives the data stream. onRtmpStreamingEvent The SDK triggers this callback when the user receives the data stream that another user sends by calling the sendStreamMessage method within 5 seconds.
uid | User ID. |
streamId | Stream ID. |
data | Data received by the recipients. |
void io.agora.rtc2.IRtcEngineEventHandler.onStreamMessageError | ( | int | uid, |
int | streamId, | ||
int | error, | ||
int | missed, | ||
int | cached | ||
) |
Fails to receive the data stream.
The SDK triggers this callback when the user does not receive the data stream that another user sends by calling the sendStreamMessage method within 5 seconds.
uid | ID of the user who sends the data stream. |
streamId | The ID of the stream data. |
error | The error code. See Error code. |
missed | The number of lost messages. |
cached | The number of incoming cached messages when the data stream is interrupted. |
void io.agora.rtc2.IRtcEngineEventHandler.onMediaEngineLoadSuccess | ( | ) |
Occurs when the media engine is loaded.
void io.agora.rtc2.IRtcEngineEventHandler.onMediaEngineStartCallSuccess | ( | ) |
Occurs when the media engine starts.
void io.agora.rtc2.IRtcEngineEventHandler.onNetworkTypeChanged | ( | int | type | ) |
Occurs when the network type is changed.
type | The network type.
|
void io.agora.rtc2.IRtcEngineEventHandler.onIntraRequestReceived | ( | ) |
Occurs when intra request from remote user is received.
This callback is triggered once remote user needs one Key frame.
void io.agora.rtc2.IRtcEngineEventHandler.onUplinkNetworkInfoUpdated | ( | UplinkNetworkInfo | info | ) |
Occurs when uplink network info is updated.
This callback is used for notifying user to adjust the send pace based on the target bitrate.
info | The uplink network info. |
void io.agora.rtc2.IRtcEngineEventHandler.onDownlinkNetworkInfoUpdated | ( | DownlinkNetworkInfo | info | ) |
Occurs when downlink network info is updated.
This callback is used for notifying user to switch major/minor stream if needed.
info | The network info. |
void io.agora.rtc2.IRtcEngineEventHandler.onEncryptionError | ( | int | errorType | ) |
Reports the error type of encryption.
type | See #ENCRYPTION_ERROR_TYPE. |
void io.agora.rtc2.IRtcEngineEventHandler.onPermissionError | ( | int | permission | ) |
Reports the permission error.
permission | of Constants.RECORD_AUDIO, Constants.CAMERA and {} |
void io.agora.rtc2.IRtcEngineEventHandler.onUploadLogResult | ( | String | requestId, |
boolean | success, | ||
int | reason | ||
) |
Reports the user log upload result
requestId | RequestId of the upload |
success | Is upload success |
reason | Reason of the upload, 0: OK, 1 Network Error, 2 Server Error. |
void io.agora.rtc2.IRtcEngineEventHandler.onProxyConnected | ( | String | channel, |
int | uid, | ||
int | proxyType, | ||
String | localProxyIp, | ||
int | elapsed | ||
) |
void io.agora.rtc2.IRtcEngineEventHandler.onVideoRenderingTracingResult | ( | int | uid, |
Constants.MEDIA_TRACE_EVENT | currentEvent, | ||
VideoRenderingTracingInfo | tracingInfo | ||
) |
Reports the tracing result of video rendering event of the user.
uid | The user ID. |
currentEvent | The current event of the tracing result: #MEDIA_TRACE_EVENT. |
tracingInfo | The tracing result: #VideoRenderingTracingInfo. |
void io.agora.rtc2.IRtcEngineEventHandler.onLocalVideoTranscoderError | ( | LocalTranscoderConfiguration.TranscodingVideoStream | stream, |
int | error | ||
) |
Occurs when local video transcoder stream has an error.
stream | Stream type of TranscodingVideoStream. |
error | The error code:
|
void io.agora.rtc2.IRtcEngineEventHandler.onAudioMetadataReceived | ( | int | uid, |
byte[] | data | ||
) |
Occurs when the SDK receives audio metadata.
metadata | The pointer of metadata |
length | Size of metadata @technical preview |