The current music file playback state. See AudioMixingStateCode.
The reason for the change of the music file playback state. See AudioMixingReason.
User ID of the speaker.
Audio quality of the user.
Time delay (ms) of the audio packet from the sender to the receiver, including the time delay from audio sampling pre-processing, transmission, and the jitter buffer.
Packet loss rate (%) of the audio packet sent from the sender to the receiver.
Audio output routing.
An array containing the user ID and volume information for each speaker.
In the local user’s callback, this array contains the following members:
uid = 0,volume = totalVolume, which reports the sum of the voice volume and audio-mixing volume of the local user, andvad, which reports the voice activity status of the local user.In the remote speakers' callback, this array contains the following members:
uid of each remote speaker,volume, which reports the sum of the voice volume and audio-mixing volume of each remote speaker, andvad = 0.An empty speakers array in the callback indicates that no remote user is speaking at the moment.
Total volume after audio mixing. The value ranges between 0 (lowest volume) and 255 (highest volume).
totalVolume is the sum of the voice volume and audio-mixing volume of the local user.totalVolume is the sum of the voice volume and audio-mixing
volume of all remote speakers.Role that the user switches from.
Role that the user switches to.
The reason for the user role switch failure. See ClientRoleChangeFailedReason.
The current user role. See ClientRole.
The current network connection state.
The reason causing the change of the connection state.
Time elapsed (ms) from the local user calling the joinChannel until
this callback is triggered.
Whether the microphone is enabled/disabled:
true: Enabled.false: Disabled.Error code.
The width (px) of the local video.
The height (px) of the local video.
The information of the detected human face. For details, see FacePositionInfo.
The number of the FacePositionInfo array depends on the number of human faces detected.
If the array length is 0, it means that no human face is detected.
Whether the published stream fell back to audio-only or switched back to the video:
true: The published stream fell back to audio-only due to poor network conditions.false: The published stream switched back to the video after the network conditions improved.ID of the remote user sending the stream.
Whether the remote media stream fell back to audio-only or switched back to the video:
true: The remote media stream fell back to audio-only due to poor network conditions.false: The remote media stream switched back to the video stream after the network conditions improved.The uplink and downlink last-mile network probe test result.
State of the local audio.
The error information of the local audio.
The statistics of the local audio stream.
The local video state.
The detailed error information of the local video.
The statistics of the local video stream.
The voice pitch (Hz) of the local user.
The event code for media stream relay.
The state code.
The error code.
The received metadata.
The ID of the user who sent the metadata.
The timestamp (ms) of the received metadata.
The last mile network quality based on the uplink and downlink packet loss rate and jitter.
User ID. The network quality of the user with this uid is reported.
Uplink transmission quality of the user in terms of the transmission bitrate, packet loss rate, average RTT (Round-Trip Time)
and jitter of the uplink network. txQuality is a quality rating helping you understand how well the current uplink
network conditions can support the selected VideoEncoderConfiguration.
For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution
of 680 × 480 and a frame rate of 30 fps, but may be inadequate for resolutions higher than 1280 × 720.
Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network.
The network type.
Information for the recording file. See RecorderInfo.
The current recording state:
-1: An error occurs during the recording. See error message for the reason.2: The audio and video recording is started.3: The audio and video recording is stopped.The reason for the state change:
0: No error occurs.1: The SDK fails to write the recorded data to a file.2: The SDK does not detect audio and video streams to be recorded, or audio and video streams are interrupted for more than five seconds during recording.3: The recording duration exceeds the upper limit.4: The recording configuration changes.5: The SDK detects audio and video streams from users using versions of the SDK earlier than v3.0.0 in the Communication channel profile.Rectangular area in the camera zoom specifying the focus area.
ID of the user whose audio state changes.
State of the remote audio.
The reason of the remote audio state change.
Time elapsed (ms) from the local user calling joinChannel until the
SDK triggers this callback.
Statistics of the received remote audio streams.
ID of the remote user whose video state changes.
State of the remote video.
The reason of the remote video state change.
Time elapsed (ms) from the local user calling joinChannel until the SDK
triggers this callback.
Statistics of the received remote video streams.
The information of an audio file. See AudioFileInfo.
The information acquisition state. See AudioFileInfoError.
Statistics of the call.
The RTMP or RTMPS streaming URL.
The event code. See RtmpStreamingEvent.
The CDN streaming URL.
The RTMP or RTMPS streaming state.
The detailed error information for streaming.
The channel name.
The user ID of the user. A uid of 0 indicates the local user.
The local path of the snapshot.
The width (px) of the snapshot.
The height (px) of the snapshot.
The message that confirms success or the reason why the snapshot is not successfully taken:
0: Success.-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.ID of the local audio effect. Each local audio effect has a unique ID.
User ID of the remote user sending the data stream.
Stream ID.
Data received by the local user.
User ID of the remote user sending the data stream.
Stream ID.
Error code.
The number of lost messages.
The number of incoming cached messages when the data stream is interrupted.
The channel name.
The previous publishing state. See StreamPublishState.
The current publishing state. See StreamPublishState.
The time elapsed (ms) from the previous state to the current state.
The channel name.
The ID of the remote user whose subscribe state changes.
The previous publishing state. See StreamPublishState.
The current publishing state. See StreamPublishState.
The time elapsed (ms) from the previous state to the current state.
The token that will expire in 30 seconds.
User ID of the remote user sending the audio packet/video packet.
Network time delay (ms) from the remote user sending the audio packet/video packet to the local user.
Packet loss rate (%) of the audio packet/video packet sent from the remote user.
Received bitrate (Kbps) of the audio packet/video packet sent from the remote user.
The user ID of the most active remote speaker. A uid of 0 represents the local user.
Channel name.
User ID.
Time elapsed (ms) from the user calling joinChannel until
this callback is triggered.
This parameter has the following definitions in different events:
UserJoined: ID of the user or host who joins the channel.FirstRemoteAudioFrame: User ID of the remote user.FirstRemoteAudioDecoded: User ID of the remote user sending the audio stream.JoinChannelSuccess: User ID.RejoinChannelSuccess: User ID.This parameter has the following definitions in different events:
UserJoined: Time delay (ms) from the local user calling joinChannel or setClientRole
until this callback is triggered.FirstRemoteAudioFrame: Time elapsed (ms) from the local user calling joinChannel until this callback is triggered.FirstRemoteAudioDecoded: Time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.JoinChannelSuccess: Time elapsed (ms) from the local user calling joinChannel until this callback is triggered.RejoinChannelSuccess: Time elapsed (ms) from the local user starting to reconnect until this callback is triggered.User ID of the remote user.
Whether the specific remote user enables/disables the video module:
true: Enabled. The remote user can enter a video session.false: Disabled. The remote user can only enter a voice session, and cannot send or receive
any video stream.ID of the remote user.
Whether the remote user's video stream playback pauses/resumes:
true: Pause.false: Resume.The CDN streaming URL.
The RTMP or RTMPS streaming URL.
The detailed error information.
The ID of the local user.
The user account of the local user.
The ID of the remote user.
The UserInfo object that contains the user ID and user account of the remote user.
ID of the user or host who leaves the channel or goes offline.
Reason why the user goes offline.
The user ID of the remote user.
Whether super resolution is successfully enabled:
true: Super resolution is successfully enabled.false: Super resolution is not successfully enabled.The reason why super resolution is not successfully enabled or the message that confirms success. See [SuperResolutionStateReason]{@link enum.SuperResolutionStateReason}.
Width (pixels) of the first local video frame.
Height (pixels) of the first local video frame.
Time elapsed (ms) from the local user calling joinChannel until this
callback is triggered.
If startPreview is called before joinChannel, elapsed is the
time elapsed (ms) from the local user calling startPreview until this callback is triggered.
User ID of the remote user sending the video streams.
Width (pixels) of the video stream.
Height (pixels) of the video stream.
Time elapsed (ms) from the local user calling joinChannel until this
callback is triggered.
User ID of the remote user or local user (0) whose video size or rotation changes.
New width (pixels) of the video.
New height (pixels) of the video.
New rotation of the video [0 to 360).
Whether the virtual background is successfully enabled:
true: The virtual background is successfully enabled.false: The virtual background is not successfully enabled.The reason why the virtual background is not successfully enabled or the message that confirms success. See VirtualBackgroundSourceStateReason.
Warning code.
Generated using TypeDoc