Agora C++ API Reference for All Platforms
|
Inherited by agora::rtc::IRtcEngineEventHandlerEx.
Public Member Functions | |
virtual | ~IRtcEngineEventHandler () |
virtual const char * | eventHandlerType () const |
virtual void | onJoinChannelSuccess (const char *channel, uid_t uid, int elapsed) |
virtual void | onRejoinChannelSuccess (const char *channel, uid_t uid, int elapsed) |
virtual void | onWarning (int warn, const char *msg) |
virtual void | onError (int err, const char *msg) |
virtual void | onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost) |
virtual void | onLastmileProbeResult (const LastmileProbeResult &result) |
virtual void | onAudioVolumeIndication (const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume) |
virtual void | onLeaveChannel (const RtcStats &stats) |
virtual void | onRtcStats (const RtcStats &stats) |
virtual void | onAudioDeviceStateChanged (const char *deviceId, int deviceType, int deviceState) |
virtual void | onAudioMixingFinished () |
virtual void | onAudioEffectFinished (int soundId) |
virtual void | onVideoDeviceStateChanged (const char *deviceId, int deviceType, int deviceState) |
virtual void | onMediaDeviceChanged (int deviceType) |
virtual void | onNetworkQuality (uid_t uid, int txQuality, int rxQuality) |
virtual void | onIntraRequestReceived () |
virtual void | onUplinkNetworkInfoUpdated (const UplinkNetworkInfo &info) |
virtual void | onDownlinkNetworkInfoUpdated (const DownlinkNetworkInfo &info) |
virtual void | onLastmileQuality (int quality) |
virtual void | onFirstLocalVideoFrame (int width, int height, int elapsed) |
virtual void | onFirstLocalVideoFramePublished (int elapsed) |
virtual void | onVideoSourceFrameSizeChanged (VIDEO_SOURCE_TYPE sourceType, int width, int height) |
virtual void | onFirstRemoteVideoDecoded (uid_t uid, int width, int height, int elapsed) |
virtual void | onVideoSizeChanged (uid_t uid, int width, int height, int rotation) |
virtual void | onLocalVideoStateChanged (LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) |
virtual void | onRemoteVideoStateChanged (uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
virtual void | onFirstRemoteVideoFrame (uid_t userId, int width, int height, int elapsed) |
virtual void | onUserJoined (uid_t uid, int elapsed) |
virtual void | onUserOffline (uid_t uid, USER_OFFLINE_REASON_TYPE reason) |
virtual void | onUserMuteVideo (uid_t userId, bool muted) |
virtual void | onUserEnableVideo (uid_t uid, bool enabled) |
virtual void | onUserEnableLocalVideo (uid_t uid, bool enabled) |
virtual void | onApiCallExecuted (int err, const char *api, const char *result) |
virtual void | onLocalAudioStats (const LocalAudioStats &stats) |
virtual void | onRemoteAudioStats (const RemoteAudioStats &stats) |
virtual void | onLocalVideoStats (const LocalVideoStats &stats) |
virtual void | onRemoteVideoStats (const RemoteVideoStats &stats) |
virtual void | onCameraReady () |
virtual void | onCameraFocusAreaChanged (int x, int y, int width, int height) |
virtual void | onCameraExposureAreaChanged (int x, int y, int width, int height) |
virtual void | onFacePositionChanged (int imageWidth, int imageHeight, const Rectangle *vecRectangle, const int *vecDistance, int numFaces) |
virtual void | onVideoStopped () |
virtual void | onAudioMixingStateChanged (AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_ERROR_TYPE errorCode) |
virtual void | onConnectionLost () |
virtual void | onConnectionInterrupted () |
virtual void | onConnectionBanned () |
virtual void | onStreamMessage (uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs) |
virtual void | onStreamMessageError (uid_t userId, int streamId, int code, int missed, int cached) |
virtual void | onRequestToken () |
virtual void | onTokenPrivilegeWillExpire (const char *token) |
virtual void | onFirstLocalAudioFramePublished (int elapsed) |
virtual void | onLocalAudioStateChanged (LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) |
virtual void | onRemoteAudioStateChanged (uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
virtual void | onActiveSpeaker (uid_t userId) |
virtual void | onClientRoleChanged (CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
virtual void | onAudioDeviceVolumeChanged (MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) |
virtual void | onRtmpStreamingStateChanged (const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode) |
virtual void | onStreamPublished (const char *url, int error) |
virtual void | onStreamUnpublished (const char *url) |
virtual void | onTranscodingUpdated () |
virtual void | onAudioRoutingChanged (int routing) |
virtual void | onChannelMediaRelayStateChanged (int state, int code) |
virtual void | onChannelMediaRelayEvent (int code) |
virtual void | onLocalPublishFallbackToAudioOnly (bool isFallbackOrRecover) |
virtual void | onRemoteSubscribeFallbackToAudioOnly (uid_t uid, bool isFallbackOrRecover) |
virtual void | onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onConnectionStateChanged (CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) |
virtual void | onNetworkTypeChanged (NETWORK_TYPE type) |
virtual void | onEncryptionError (ENCRYPTION_ERROR_TYPE errorType) |
virtual void | onPermissionError (PERMISSION_TYPE permissionType) |
virtual void | onLocalUserRegistered (uid_t uid, const char *userAccount) |
virtual void | onUserInfoUpdated (uid_t uid, const UserInfo &info) |
virtual void | onAudioSubscribeStateChanged (const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onVideoSubscribeStateChanged (const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onAudioPublishStateChanged (const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onVideoPublishStateChanged (const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onExtensionEvent (const char *provider_name, const char *ext_name, const char *key, const char *json_value) |
virtual void | onExtensionStarted (const char *provider_name, const char *ext_name) |
virtual void | onExtensionStopped (const char *provider_name, const char *ext_name) |
virtual void | onExtensionErrored (const char *provider_name, const char *ext_name, int error, const char *msg) |
virtual void | onUserAccountUpdated (uid_t uid, const char *userAccount) |
The IRtcEngineEventHandler class.
The SDK uses this class to send callback event notifications to the app, and the app inherits the methods in this class to retrieve these event notifications.
All methods in this class have their default (empty) implementations, and the app can inherit only some of the required events instead of all. In the callback methods, the app should avoid time-consuming tasks or calling blocking APIs, otherwise the SDK may not work properly.
|
inlinevirtual |
|
inlinevirtual |
Reimplemented in agora::rtc::IRtcEngineEventHandlerInternal, and agora::rtc::IRtcEngineEventHandlerEx.
|
inlinevirtual |
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. |
|
inlinevirtual |
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. |
|
inlinevirtual |
A warning occurs during the SDK runtime.
In most cases, the app can ignore the warnings reported by the SDK, because the SDK can fix the issues and resume running.
warn | The warning code. |
msg | The detailed warning message: WARN_CODE_TYPE. |
|
inlinevirtual |
An error occurs during the SDK runtime.
err | The error code. |
msg | The detailed error message: ERROR_CODE_TYPE. |
|
inlinevirtual |
Reports the statistics of the audio stream from each remote user/broadcaster.
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.
uid | The user ID of the speaker. |
quality | The audio quality of the user: QUALITY_TYPE |
delay | The time delay (ms) of the audio packet from the sender to the receiver. |
lost | The audio packet loss rate (%) from the sender to the receiver. |
|
inlinevirtual |
Reports the result of 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 last-mile network probe test result: LastmileProbeResult. |
|
inlinevirtual |
Reports which users are speaking and the speaker‘s volume.
This callback reports the IDs and volumes of the loudest speakers 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.
|
speakerNumber | The total number of speakers. The value range is [0, 3].
|
totalVolume | The total volume after audio mixing. The value ranges between 0 (the lowest volume) and 255 (the highest volume).
|
|
inlinevirtual |
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. |
|
inlinevirtual |
Reports the statistics of the current call.
This callback is triggered once every two seconds after the user joins the channel.
stats | The statistics of the current call: RtcStats. |
|
inlinevirtual |
Occurs when the audio device state changes.
This callback notifies the application that the system's audio device state is changed. For example, a headset is unplugged from the device.
deviceId | Pointer to the device ID. |
deviceType | Device type: MEDIA_DEVICE_TYPE. |
deviceState | Device state: MEDIA_DEVICE_STATE_TYPE. |
|
inlinevirtual |
Occurs when the audio mixing file playback finishes.
You can start an audio mixing file playback by calling the startAudioMixing method. The SDK triggers this callback when the audio mixing file playback finishes.
|
inlinevirtual |
|
inlinevirtual |
Occurs when the video device state changes.
This callback notifies the application that the system's video device state is changed.
deviceId | Pointer to the device ID. |
deviceType | Device type: MEDIA_DEVICE_TYPE. |
deviceState | Device state: MEDIA_DEVICE_STATE_TYPE. |
|
inlinevirtual |
Occurs when the device changes.
This callback notifies the application that the system's video device state is changed.
deviceType | Device type: MEDIA_DEVICE_TYPE. |
|
inlinevirtual |
Reports the network quality of each user.
This callback is triggered once every two seconds after the user joins the channel.
uid | The user ID. If uid is 0, the SDK reports the local network quality. |
txQuality | The transmission quality of the user: QUALITY_TYPE. |
rxQuality | The receiving quality of the user: QUALITY_TYPE. |
|
inlinevirtual |
Occurs when intra request from remote user is received.
This callback is triggered once remote user needs one Key frame.
|
inlinevirtual |
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 collections. |
|
inlinevirtual |
Occurs when downlink network info is updated.
This callback is used for notifying user to switch major/minor stream if needed.
info | The downlink network info collections. |
|
inlinevirtual |
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 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: QUALITY_TYPE. |
|
inlinevirtual |
Occurs when the first local video frame is rendered on the local video view.
width | Width (px) of the first local video frame. |
height | Height (px) of the first local video frame. |
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. If you call the startPreview method before calling the joinChannel method, then elapsed is the time elapsed from calling the startPreview method until the SDK triggers this callback. |
|
inlinevirtual |
Occurs when the first local video frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
|
inlinevirtual |
|
inlinevirtual |
Occurs when the first remote video frame is received and decoded.
This callback is triggered upon the SDK receiving and successfully decoding the first video frame from a remote video. The app can configure the user view settings in this callback.
uid | ID of the user whose video streams are received. |
width | The width (pixels) of the video stream. |
height | The height (pixels) of the video stream. |
elapsed | The time elapsed (ms) from the local user calling joinChannel until this callback is triggered. |
|
inlinevirtual |
|
inlinevirtual |
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.
state | State type LOCAL_VIDEO_STREAM_STATE. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED (3), see the error parameter for details. |
error | The detailed error information: LOCAL_VIDEO_STREAM_ERROR. |
|
inlinevirtual |
Occurs when the remote video state has changed.
COMMUNICATION
profile) or hosts (in the LIVE_BROADCASTING
profile) in the channel exceeds 17.userId | ID of the user whose video state has changed. |
state | The remote video state: REMOTE_VIDEO_STATE. |
reason | The reason of the remote video state change: REMOTE_VIDEO_STATE_REASON. |
elapsed | The time elapsed (ms) from the local client calling joinChannel until this callback is triggered. |
|
inlinevirtual |
Occurs when the first remote video frame is rendered.
The SDK triggers this callback when the first frame of the remote video is rendered in the user's video window.
The application can retrieve the time elapsed from a user joining the channel until the first video frame is rendered.
userId | ID of the remote user sending the video stream. |
width | Width (px) of the video frame. |
height | Height (px) of the video stream. |
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. |
|
inlinevirtual |
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:
joinChannel
.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. |
|
inlinevirtual |
Occurs when a remote user or broadcaster goes offline.
There are two reasons for a user to go 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: USER_OFFLINE_REASON_TYPE. |
|
inlinevirtual |
Occurs when a remote user pauses or resumes sending the video stream.
uid | ID of the remote user. |
muted |
|
|
inlinevirtual |
Occurs when a remote user enables or disables the video module.
Once the video function is disabled, the users cannot see any video.
uid | ID of the remote user. |
enabled |
|
|
inlinevirtual |
Occurs when a remote user enables or disables the local video function.
uid | ID of the remote user. |
enabled |
|
|
inlinevirtual |
Occurs when an API method is executed.
api | The API method that the SDK executes. |
err | The error code that the SDK returns when the method call fails. |
result | The result of the method call. |
|
inlinevirtual |
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. |
|
inlinevirtual |
Reports the statistics of the audio stream from each remote user/host.
This callback 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.
stats | Statistics of the received remote audio streams. See RemoteAudioStats. |
|
inlinevirtual |
Reports the statistics of the local video stream.
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.
stats | Statistics of the local video stream. See LocalVideoStats. |
|
inlinevirtual |
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 | Statistics of the remote video stream. See RemoteVideoStats. |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
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 SDK triggers this callback.
state
, and 0 in errorCode
.state
and an error in errorCode
.state | The state code. See AUDIO_MIXING_STATE_TYPE. |
errorCode | The error code. See AUDIO_MIXING_ERROR_TYPE. |
|
inlinevirtual |
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.
|
inlinevirtual |
Occurs when the connection between the SDK and the server is interrupted.
The SDK triggers this callback when it loses connection with the serer for more than 4 seconds after the connection is established. After triggering this callback, the SDK tries to reconnect to the server. If the reconnection fails within a certain period (10 seconds by default), the onConnectionLost() callback is triggered.
Once the connection is lost, the SDK continues to reconnect until the app calls leaveChannel.
|
inlinevirtual |
Occurs when your connection is banned by the Agora Server.
|
inlinevirtual |
Occurs when the user receives the data stream.
The SDK triggers this callback when the user receives the data stream that another user sends by calling the sendStreamMessage method within 5 seconds.
userId | ID of the user who sends the data stream. |
streamId | The ID of the stream data. |
data | The data stream. |
length | The length (byte) of the data stream. |
sentTs | The time of the data stream sent. |
|
inlinevirtual |
Occurs when the user 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.
userId | ID of the user who sends the data stream. |
streamId | The ID of the stream data. |
code | The error code: ERROR_CODE_TYPE. |
missed | The number of lost messages. |
cached | The number of incoming cached messages when the data stream is interrupted. |
|
inlinevirtual |
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.
|
inlinevirtual |
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. |
|
inlinevirtual |
Occurs when the first local audio frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
|
inlinevirtual |
Occurs when the local audio 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.
error
parameter for details.state | State of the local audio. See LOCAL_AUDIO_STREAM_STATE. |
error | The error information of the local audio. See LOCAL_AUDIO_STREAM_ERROR. |
|
inlinevirtual |
Occurs when the remote audio state changes.
This callback indicates the state change of the remote audio stream.
uid | ID of the remote user whose audio state changes. |
state | 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 method until the SDK triggers this callback. |
|
inlinevirtual |
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.
uid | The ID of the active speaker. A uid of 0 means the local user. |
|
inlinevirtual |
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: CLIENT_ROLE_TYPE. |
newRole | The new role of the user: CLIENT_ROLE_TYPE. |
|
inlinevirtual |
Occurs when the audio device volume changes.
deviceType | The device type, see MEDIA_DEVICE_TYPE |
volume | The volume of the audio device. |
muted | Whether the audio device is muted:
|
|
inlinevirtual |
Occurs when the state of the RTMP streaming changes.
The SDK triggers this callback to report the result of the local user calling the addPublishStreamUrl or removePublishStreamUrl method.
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.
url | The RTMP URL address. |
state | The RTMP streaming state. See: RTMP_STREAM_PUBLISH_STATE. |
errCode | The detailed error information for streaming: RTMP_STREAM_PUBLISH_ERROR. |
|
inlinevirtual |
Reports the result of calling the addPublishStreamUrl() method.
This callback indicates whether you have successfully added an RTMP stream to the CDN.
url | The RTMP URL address. |
error | The error code. Main errors include:
|
|
inlinevirtual |
Reports the result of calling the removePublishStreamUrl() method.
This callback indicates whether you have successfully removed an RTMP stream from the CDN.
url | The RTMP URL address. |
|
inlinevirtual |
Occurs when the publisher's transcoding settings are updated.
When the LiveTranscoding
class in setLiveTranscoding updates, the SDK triggers this callback to report the update information.
setLiveTranscoding
method to set the LiveTranscoding
class for the first time, the SDK does not trigger this callback.
|
inlinevirtual |
Occurs when the local audio route changes (for Android and iOS only).
The SDK triggers this callback when the local audio route switches to an earpiece, speakerphone, headset, or Bluetooth device.
routing | Audio output routing:
|
|
inlinevirtual |
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:
|
|
inlinevirtual |
Reports events during the media stream relay.
code | The event code for media stream relay:
|
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Reports the transport-layer statistics of each remote audio stream.
This callback is triggered every two seconds once the user has received the audio data packet sent from a remote user.
uid | ID of the remote user whose audio data packet is received. |
delay | The network time delay (ms) from the remote user sending the audio packet to the local user. |
lost | The 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. |
|
inlinevirtual |
Reports the transport-layer statistics of each remote video stream.
This callback is triggered every two seconds once the user has received the video data packet sent from a remote user.
uid | ID of the remote user whose video packet is received. |
delay | The network time delay (ms) from the remote user sending the video packet to the local user. |
lost | The packet loss rate (%) of the video packet sent from the remote user. |
rxKBitRate | The Received bitrate (Kbps) of the video packet sent from the remote user. |
|
inlinevirtual |
Occurs when the connection state of the SDK to the server is changed.
state | See CONNECTION_STATE_TYPE. |
reason | See CONNECTION_CHANGED_REASON_TYPE. |
|
inlinevirtual |
Occurs when the network type is changed.
type | See NETWORK_TYPE. |
|
inlinevirtual |
Reports the error type of encryption.
type | See ENCRYPTION_ERROR_TYPE. |
|
inlinevirtual |
Reports the permission error type related device.
type | See PERMISSION_TYPE. |
|
inlinevirtual |
Occurs 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. |
|
inlinevirtual |
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. |
info | The UserInfo object that contains the user ID and user account of the remote user. |
|
inlinevirtual |
Occurs when the audio subscribe state changed.
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 : STREAM_SUBSCRIBE_STATE. |
newState | The new state of the audio stream subscribe : STREAM_SUBSCRIBE_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
|
inlinevirtual |
Occurs when the video subscribe state changed.
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 : STREAM_SUBSCRIBE_STATE. |
newState | The new state of the video stream subscribe : STREAM_SUBSCRIBE_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
|
inlinevirtual |
Occurs when the audio publish state changed.
channel | The channel name of user joined. |
oldState | The old state of the audio stream publish : STREAM_PUBLISH_STATE. |
newState | The new state of the audio stream publish : STREAM_PUBLISH_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
|
inlinevirtual |
Occurs when the video publish state changed.
channel | The channel name of user joined. |
oldState | The old state of the video stream publish : STREAM_PUBLISH_STATE. |
newState | The new state of the video stream publish : STREAM_PUBLISH_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |