using System;
namespace Agora.Rtc
{
///
///
/// IRtcEngineEventHandlerThe SDK uses the interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
///
///
public abstract class IRtcEngineEventHandler
{
///
///
/// Occurs when a user joins a channel.
/// This callback notifies the application that a user joins a specified channel.
///
///
/// The connection information. See RtcConnection .
///
/// The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.
///
public virtual void OnJoinChannelSuccess(RtcConnection connection, int elapsed) { }
///
///
/// Occurs when a user rejoins the channel.
/// When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.
///
///
/// The connection information. See RtcConnection .
///
/// Time elapsed (ms) from the local user calling the JoinChannel [1/2] or JoinChannel [2/2] method until this callback is triggered.
///
public virtual void OnRejoinChannelSuccess(RtcConnection connection, int elapsed) { }
///
///
/// Reports the proxy connection state.
/// 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 [1/2] until this callback is triggered.
///
///
/// The channel name.
///
/// The user ID.
///
/// The proxy type connected. See CLOUD_PROXY_TYPE .
///
/// Reserved for future use.
///
/// The time elapsed (ms) from the user calling JoinChannel [1/2] until this callback is triggered.
///
public virtual void OnProxyConnected(string channel, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed) { }
///
///
/// Reports an error during SDK runtime.
/// 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.
///
///
/// Error code. See ERROR_CODE_TYPE .
///
/// The error message.
///
public virtual void OnError(int err, string msg) { }
///
///
/// Reports the statistics of the audio stream from each remote user.
/// Deprecated:Please use OnRemoteAudioStats instead.The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple users/hosts sending audio streams, the SDK triggers this callback as many times.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID of the remote user sending the audio stream.
///
/// Audio quality of the user.
/// QUALITY_UNKNOWN(0): The quality is unknown.
/// QUALITY_EXCELLENT(1): The quality is excellent.
/// QUALITY_GOOD(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.
/// QUALITY_POOR(3): Users can feel the communication is slightly impaired.
/// QUALITY_BAD(4): Users cannot communicate smoothly.
/// QUALITY_VBAD(5): The quality is so bad that users can barely communicate.
/// QUALITY_DOWN(6): The network is down, and users cannot communicate at all.
/// See QUALITY_TYPE .
///
/// 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.
///
/// The packet loss rate (%) of the audio packet sent from the remote user.
///
public virtual void OnAudioQuality(RtcConnection connection, uint remoteUid, int quality, UInt16 delay, UInt16 lost) { }
///
///
/// Reports the last mile network probe result.
/// The SDK triggers this callback within 30 seconds after the app calls StartLastmileProbeTest .
///
///
/// The uplink and downlink last-mile network probe test result. See LastmileProbeResult .
///
public virtual void OnLastmileProbeResult(LastmileProbeResult result) { }
///
///
/// Reports the volume information of users.
/// 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 for mute, the SDK continues to report the volume indication of the local user.20 seconds after a remote user whose volume is one of the three highest in the channel stops publishing the audio stream, the callback excludes this user's information; 20 seconds after all remote users stop publishing audio streams, the SDK stops triggering the callback for remote users.
///
///
/// The connection information. See RtcConnection .
///
/// 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 sending a stream at the moment.
///
/// 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.
///
/// The volume of the speaker. The value ranges between 0 (lowest volume) and 255 (highest volume).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 the remote users (up to three) whose instantaneous volume are the highest.
///
public virtual void OnAudioVolumeIndication(RtcConnection connection, AudioVolumeInfo[] speakers, uint speakerNumber, int totalVolume) { }
///
///
/// Occurs when a user leaves a channel.
/// This callback notifies the app that the user leaves the channel by calling LeaveChannel [1/2]
///
///
/// The connection information. See RtcConnection .
///
/// The statistics of the call. See RtcStats .
///
public virtual void OnLeaveChannel(RtcConnection connection, RtcStats stats) { }
///
///
/// Reports the statistics of the current call.
/// The SDK triggers this callback once every two seconds after the user joins the channel.
///
///
/// The connection information. See RtcConnection .
///
/// Statistics of the RTC engine. See RtcStats .
///
public virtual void OnRtcStats(RtcConnection connection, RtcStats stats) { }
///
///
/// 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.This method is for Windows and macOS only.
///
///
/// The device ID.
///
/// The evice type. See MEDIA_DEVICE_TYPE .
///
/// The device state.On macOS:0: The device is ready for use.8: The device is not connected.On Windows: see MEDIA_DEVICE_STATE_TYPE .
///
public virtual void OnAudioDeviceStateChanged(string deviceId, MEDIA_DEVICE_TYPE deviceType, MEDIA_DEVICE_STATE_TYPE deviceState) { }
[Obsolete("This method is deprecated, use onAudioMixingStateChanged instead")]
///
///
/// Occurs when the playback of the local music file finishes.
/// Deprecated:Please 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 StartAudioMixing [2/2] fails, the error code WARN_AUDIO_MIXING_OPEN_ERROR is returned.
///
///
public virtual void OnAudioMixingFinished() { }
///
///
/// Occurs when the playback of the local music file finishes.
/// This callback occurs when the local audio effect file finishes playing.
///
///
/// The audio effect ID. The ID of each audio effect file is unique.
///
public virtual void OnAudioEffectFinished(int soundId) { }
///
/// @ignore
///
public virtual void OnVideoDeviceStateChanged(string deviceId, MEDIA_DEVICE_TYPE deviceType, MEDIA_DEVICE_STATE_TYPE deviceState) { }
///
/// @ignore
///
public virtual void OnMediaDeviceChanged(MEDIA_DEVICE_TYPE deviceType) { }
///
///
/// Reports the last mile network quality of each user in the channel.
/// 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.txQuality is UNKNOWNrxQuality is UNKNOWN
///
///
/// The connection information. See RtcConnection .
///
/// The user ID. The network quality of the user with this user ID is reported.
///
/// 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 may be inadequate for resolutions higher than 1280 × 720.
/// QUALITY_UNKNOWN(0): The quality is unknown.
/// QUALITY_EXCELLENT(1): The quality is excellent.
/// QUALITY_GOOD(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.
/// QUALITY_POOR(3): Users can feel the communication is slightly impaired.
/// QUALITY_BAD(4): Users cannot communicate smoothly.
/// QUALITY_VBAD(5): The quality is so bad that users can barely communicate.
/// QUALITY_DOWN(6): The network is down, and users cannot communicate at all.
/// See QUALITY_TYPE .
///
/// Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network.
/// QUALITY_UNKNOWN(0): The quality is unknown.
/// QUALITY_EXCELLENT(1): The quality is excellent.
/// QUALITY_GOOD(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.
/// QUALITY_POOR(3): Users can feel the communication is slightly impaired.
/// QUALITY_BAD(4): Users cannot communicate smoothly.
/// QUALITY_VBAD(5): The quality is so bad that users can barely communicate.
/// QUALITY_DOWN(6): The network is down, and users cannot communicate at all.
/// See QUALITY_TYPE .
///
public virtual void OnNetworkQuality(RtcConnection connection, uint remoteUid, int txQuality, int rxQuality) { }
///
/// @ignore
///
public virtual void OnIntraRequestReceived(RtcConnection connection) { }
///
///
/// Occurs when the uplink network information changes.
/// The SDK triggers this callback when the uplink network information changes.This callback only applies to scenarios where you push externally encoded video data in H.264 format to the SDK.
///
///
/// The uplink network information. See UplinkNetworkInfo .
///
public virtual void OnUplinkNetworkInfoUpdated(UplinkNetworkInfo info) { }
///
/// @ignore
///
public virtual void OnDownlinkNetworkInfoUpdated(DownlinkNetworkInfo info) { }
///
///
/// Reports the last-mile network quality of the local user.
/// 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 once StartLastmileProbeTest is called and reports the last-mile network conditions of the local user.
///
///
/// The last-mile network quality.
/// QUALITY_UNKNOWN(0): The quality is unknown.
/// QUALITY_EXCELLENT(1): The quality is excellent.
/// QUALITY_GOOD(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.
/// QUALITY_POOR(3): Users can feel the communication is slightly impaired.
/// QUALITY_BAD(4): Users cannot communicate smoothly.
/// QUALITY_VBAD(5): The quality is so bad that users can barely communicate.
/// QUALITY_DOWN(6): The network is down, and users cannot communicate at all.
/// See QUALITY_TYPE .
///
public virtual void OnLastmileQuality(int quality) { }
///
///
/// Occurs when the first local video frame is displayed on the local video view.
/// The SDK triggers this callback when the first local video frame is displayed on the local video view.
///
///
/// The connection information. See RtcConnection .
///
/// The width (px) of the first local video frame.
///
/// The height (px) of the first local video frame.
///
/// Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback. If you call StartPreview [1/2] JoinChannel [2/2], then this parameter is the time elapsed from calling the StartPreview [1/2]
///
public virtual void OnFirstLocalVideoFrame(RtcConnection connection, int width, int height, int elapsed) { }
///
///
/// Occurs when the first video frame is published.
/// The SDK triggers this callback under one of the following circumstances: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 connection information. See RtcConnection .
///
/// Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.
///
public virtual void OnFirstLocalVideoFramePublished(RtcConnection connection, int elapsed) { }
///
/// @ignore
///
public virtual void OnVideoSourceFrameSizeChanged(RtcConnection connection, VIDEO_SOURCE_TYPE sourceType, int width, int height) { }
///
///
/// Occurs when the first remote video frame is received and decoded.
/// The SDK triggers this callback under one of the following circumstances: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.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user sending the video stream.
///
/// The width (px) of the video stream.
///
/// The height (px) of the video stream.
///
/// The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.
///
public virtual void OnFirstRemoteVideoDecoded(RtcConnection connection, uint remoteUid, int width, int height, int elapsed) { }
///
///
/// Occurs when the video size or rotation of a specified user changes.
///
///
/// The connection information. See RtcConnection .
///
/// The capture type of the custom video source. See VIDEO_SOURCE_TYPE .
///
/// 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).
///
/// The width (pixels) of the video stream.
///
/// The height (pixels) of the video stream.
///
/// The rotation information. The value range is [0,360).
///
public virtual void OnVideoSizeChanged(RtcConnection connection, VIDEO_SOURCE_TYPE sourceType, uint uid, int width, int height, int rotation) { }
///
///
/// Reports the result of video content moderation.
/// After calling enableContentInspect to enable the video content moderation, and setting the type parameter in ContentInspectConfig toCONTENT_INSPECT_MODERATION, the SDK triggers the onContentInspectResult callback and reports the result of video content moderation.
///
///
/// The results of video content moderation. See CONTENT_INSPECT_RESULT .
///
public virtual void OnContentInspectResult(CONTENT_INSPECT_RESULT result) { }
///
///
/// Reports the result of taking a video snapshot.
/// 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 that snapshot.
///
///
/// The channel name.
///
/// The user ID. 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 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.-3: Calling the takeSnapshot method too frequently.
///
public virtual void OnSnapshotTaken(RtcConnection connection, uint uid, string filePath, int width, int height, int errCode) { }
///
///
/// Occurs when the local video stream state changes.
/// 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.The SDK triggers the OnLocalVideoStateChanged callback with the state code of 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.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.For some device models, the SDK does not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment.
///
///
/// The state of the local video, see LOCAL_VIDEO_STREAM_STATE .
///
/// The detailed error information, see LOCAL_VIDEO_STREAM_ERROR .
///
public virtual void OnLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode) { }
public virtual void OnLocalVideoStateChanged(RtcConnection connection, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode) { }
///
///
/// Occurs when the remote video stream state changes.
/// This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user whose video state changes.
///
/// The state of the remote video, see REMOTE_VIDEO_STATE .
///
/// The reason for the remote video state change, see REMOTE_VIDEO_STATE_REASON .
///
/// Time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.
///
public virtual void OnRemoteVideoStateChanged(RtcConnection connection, uint remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { }
///
///
/// Occurs when the renderer receives the first frame of the remote video.
///
///
/// The ID of the remote user sending the video stream.
///
/// The connection information. See RtcConnection .
///
/// The width (px) of the video stream.
///
/// The height (px) of the video stream.
///
/// The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.
///
public virtual void OnFirstRemoteVideoFrame(RtcConnection connection, uint remoteUid, int width, int height, int elapsed) { }
///
///
/// Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) joins the channel.
/// 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.The SDK triggers this callback under one of the following circumstances:A remote user/host joins the channel by calling the JoinChannel [2/2] method.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.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the user or host who joins the channel.
///
/// Time delay (ms) from the local user calling JoinChannel [2/2] until this callback is triggered.
///
public virtual void OnUserJoined(RtcConnection connection, uint remoteUid, int elapsed) { }
///
///
/// Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel.
/// There are two reasons for users to become offline: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.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the user who leaves the channel or goes offline.
///
/// Reasons why the user goes offline: USER_OFFLINE_REASON_TYPE .
///
public virtual void OnUserOffline(RtcConnection connection, uint remoteUid, USER_OFFLINE_REASON_TYPE reason) { }
[Obsolete("Use onRemoteAudioStateChanged instead of")]
///
///
/// Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) stops/resumes sending the audio stream.
/// This method is about to be deprecated. Agora recommends you using OnRemoteAudioStateChanged instead.The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the MuteLocalAudioStream method.This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID.
///
/// Whether the remote user's audio stream is muted/unmuted:true: User's audio stream is muted.false: User's audio stream is unmuted.
///
public virtual void OnUserMuteAudio(RtcConnection connection, uint remoteUid, bool muted) { }
[Obsolete("Use onRemoteVideoStateChanged instead of")]
///
///
/// Occurs when a remote user stops/resumes publishing the video stream.
/// This method is about to be deprecated. Agora recommends you using OnRemoteVideoStateChanged instead.When a remote user calls MuteLocalVideoStream to stop or resume publishing the video stream, the SDK triggers this callback to report the state of the remote user's publishing stream to the local user.This callback can be inaccurate when the number of users (in the communication profile) or hosts (in the live streaming profile) in a channel exceeds 17.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID of the remote user.
///
/// 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.
///
public virtual void OnUserMuteVideo(RtcConnection connection, uint remoteUid, bool muted) { }
[Obsolete("Use onRemoteVideoStateChanged instead of")]
///
///
/// Occurs when a remote user enables/disables the video module.
/// This method is about to be deprecated. Agora recommends you using OnRemoteVideoStateChanged instead.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.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID of the remote user.
///
/// true: Enable.false: Disable.
///
public virtual void OnUserEnableVideo(RtcConnection connection, uint remoteUid, bool enabled) { }
[Obsolete("Use onRemoteVideoStateChanged instead of")]
///
///
/// Occurs when a specific remote user enables/disables the local video capturing function.
/// The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the EnableLocalVideo method.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID of the remote user.
///
/// Whether the specified remote user enables/disables the local video capturing function:true: Enable. Other users in the channel can see the video of this remote user.false: Disable. 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.
///
public virtual void OnUserEnableLocalVideo(RtcConnection connection, uint remoteUid, bool enabled) { }
///
/// @ignore
///
public virtual void OnUserStateChanged(RtcConnection connection, uint remoteUid, uint state) { }
///
///
/// Occurs when a method is executed by the SDK.
///
///
/// The error code returned by the SDK when the method call fails. If the SDK returns 0, then the method call is successful.
///
/// The method executed by the SDK.
///
/// The result of the method call.
///
public virtual void OnApiCallExecuted(int err, string api, string result) { }
///
///
/// Reports the statistics of the local audio stream.
/// The SDK triggers this callback once every two seconds.
///
///
/// The connection information. See RtcConnection .
///
/// Local audio statistics. See LocalAudioStats .
///
public virtual void OnLocalAudioStats(RtcConnection connection, LocalAudioStats stats) { }
///
///
/// Reports the statistics of the audio stream sent by each remote users.
/// The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times.
///
///
/// The connection information. See RtcConnection .
///
/// Statistics of the received remote audio stream. See RemoteAudioStats .
///
public virtual void OnRemoteAudioStats(RtcConnection connection, RemoteAudioStats stats) { }
///
///
/// Reports the statistics of the local video stream.
/// The SDK triggers this callback once every two seconds to report the statistics of the local video stream.
///
///
/// The connection information. See RtcConnection .
///
/// The statistics of the local video stream. See LocalVideoStats .
///
public virtual void OnLocalVideoStats(RtcConnection connection, LocalVideoStats stats) { }
///
///
/// Reports the statistics of the video stream sent by each remote users.
/// 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.
///
///
/// The connection information. See RtcConnection .
///
/// Statistics of the remote video stream.
///
public virtual void OnRemoteVideoStats(RtcConnection connection, RemoteVideoStats stats) { }
///
///
/// Occurs when the camera turns on and is ready to capture the video.
/// Deprecated:Please 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.
///
///
public virtual void OnCameraReady() { }
///
///
/// Occurs when the camera focus area changes.
/// This method is for Android and iOS only.
///
///
/// The x-coordinate of the changed focus area.
///
/// The y-coordinate of the changed focus area.
///
/// The width of the focus area that changes.
///
/// The height of the focus area that changes.
///
public virtual void OnCameraFocusAreaChanged(int x, int y, int width, int height) { }
///
///
/// Occurs when the camera exposure area changes.
///
///
/// The x coordinate of the changed camera exposure area.
///
/// The y coordinate of the changed camera exposure area.
///
/// The width of the changed camera exposure area.
///
/// The height of the changed exposure area.
///
public virtual void OnCameraExposureAreaChanged(int x, int y, int width, int height) { }
///
///
/// Reports the face detection result of the local user.
/// Once you enable face detection by calling EnableFaceDetection (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 rtriggered 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.
///
///
/// The width (px) of the video image captured by the local camera.
///
/// The height (px) of the video image captured by the local camera.
///
/// The information of the detected human face: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.
///
/// The distance between the human face and the device screen (cm).
///
/// The number of faces detected. If the value is 0, it means that no human face is detected.
///
public virtual void OnFacePositionChanged(int imageWidth, int imageHeight, Rectangle vecRectangle, int[] vecDistance, int numFaces) { }
///
///
/// Occurs when the video stops playing.
/// 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.
///
///
public virtual void OnVideoStopped() { }
///
///
/// Occurs when the playback state of the music file changes.
/// This callback occurs when the playback state of the music file changes, and reports the current state and error code.
///
///
/// The playback state of the music file. See AUDIO_MIXING_STATE_TYPE .
///
/// Error code. See AUDIO_MIXING_REASON_TYPE .
///
public virtual void OnAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) { }
///
/// @ignore
///
public virtual void OnRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_ERROR_TYPE errorCode) { }
///
///
/// Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
/// The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the JoinChannel [2/2] method, regardless of whether it is in the channel. If the SDK fails to rejoin the channel within 20 minutes after disconnecting, the SDK will stop trying to reconnect.
///
///
/// The connection information. See RtcConnection .
///
public virtual void OnConnectionLost(RtcConnection connection) { }
///
///
/// Occurs when the connection between the SDK and the server is interrupted.
/// Deprecated:Use OnConnectionStateChanged instead.The SDK triggers this callback when it loses connection with the server for more than four seconds after the connection is established. After triggering this callback, the SDK tries to reconnect to the server. You can use this callback to implement pop-up reminders. The difference between this callback and OnConnectionLost is: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.If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel.
///
///
/// The connection information. See RtcConnection .
///
public virtual void OnConnectionInterrupted(RtcConnection connection) { }
///
///
/// Occurs when the connection is banned by the Agora server.
/// Deprecated:Please use OnConnectionStateChanged instead.
///
///
/// The connection information. See RtcConnection .
///
public virtual void OnConnectionBanned(RtcConnection connection) { }
///
///
/// Occurs when the local user receives the data stream from the remote user.
/// The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the SendStreamMessage method.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user sending the message.
///
/// The stream ID of the received message.
///
/// received data.
///
/// The data length (byte).
///
/// The time when the data stream is sent.
///
public virtual void OnStreamMessage(RtcConnection connection, uint remoteUid, int streamId, byte[] data, uint length, UInt64 sentTs) { }
///
///
/// Occurs when the local user does not receive the data stream from the remote user.
/// 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.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user sending the message.
///
/// The stream ID of the received message.
///
/// The error code.
///
/// The number of lost messages.
///
/// Number of incoming cached messages when the data stream is interrupted.
///
public virtual void OnStreamMessageError(RtcConnection connection, uint remoteUid, int streamId, int code, int missed, int cached) { }
///
///
/// Occurs when the token expires.
/// When the token expires during a call, the SDK triggers this callback to remind the app to renew the token.Once you receive this callback, generate a new token on your app server, and call JoinChannel [2/2] to rejoin the channel.
///
///
/// The connection information. See RtcConnection .
///
public virtual void OnRequestToken(RtcConnection connection) { }
///
///
/// Occurs when the token expires in 30 seconds.
/// 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, generate a new token on your server, and call RenewToken to pass the new token to the SDK.
///
///
/// The connection information. See RtcConnection .
///
/// The token that expires in 30 seconds.
///
public virtual void OnTokenPrivilegeWillExpire(RtcConnection connection, string token) { }
///
///
/// Occurs when the first audio frame is published.
/// The SDK triggers this callback under one of the following circumstances: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.
///
///
/// The connection information. See RtcConnection .
///
/// Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.
///
public virtual void OnFirstLocalAudioFramePublished(RtcConnection connection, int elapsed) { }
///
///
/// Occurs when the first audio frame sent by a specified remote user is received.
/// Deprecated:Use OnRemoteAudioStateChanged instead.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user sending the audio frames.
///
/// The time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.
///
public virtual void OnFirstRemoteAudioFrame(RtcConnection connection, uint userId, int elapsed) { }
///
///
/// Occurs when the SDK decodes the first remote audio frame for playback.
/// Deprecated:Use OnRemoteAudioStateChanged instead.The SDK triggers this callback under one of the following circumstances:The remote user joins the channel and sends the audio stream.The remote user stops sending the audio stream and re-sends it after 15 seconds, and the possible reasons include:The remote user leaves the channel.The remote user is offline.The remote user calls MuteLocalAudioStream to stop sending the video stream.The remote user calls DisableAudio to disable video.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID of the remote user.
///
/// The time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.
///
public virtual void OnFirstRemoteAudioDecoded(RtcConnection connection, uint uid, int elapsed) { }
///
///
/// Occurs when the local audio stream state changes.
/// 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.When the state is LOCAL_AUDIO_STREAM_STATE_FAILED (3), you can view the error information in the error parameter.
///
///
/// The connection information. See RtcConnection .
///
/// The state of the local audio. See LOCAL_AUDIO_STREAM_STATE .
///
/// Local audio state error codes. See LOCAL_AUDIO_STREAM_ERROR .
///
public virtual void OnLocalAudioStateChanged(RtcConnection connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) { }
///
///
/// Occurs when the remote audio state changes.
/// 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.This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user whose audio state changes.
///
/// The state of the remote audio. See REMOTE_AUDIO_STATE .
///
/// The reason of the remote audio state change. See REMOTE_AUDIO_STATE_REASON .
///
/// Time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.
///
public virtual void OnRemoteAudioStateChanged(RtcConnection connection, uint remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { }
///
///
/// Occurs when the most active remote speaker is detected.
/// After a successful call of EnableAudioVolumeIndication , the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, who is detected as the loudest for the most times, is the most active user.When the number of users is no less than two and an active remote speaker exists, the SDK triggers this callback and reports the uid of the most active remote speaker.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.
///
///
/// The connection information. See RtcConnection .
///
/// The user ID of the most active remote speaker.
///
public virtual void OnActiveSpeaker(RtcConnection connection, uint uid) { }
///
///
/// Occurs when the user role switches in the interactive live streaming.
/// The SDK triggers this callback when the local user switches the user role by calling SetClientRole [1/2]
///
///
/// The connection information. See RtcConnection .
///
/// Role that the user switches from: CLIENT_ROLE_BROADCASTER(1): Host.CLIENT_ROLE_AUDIENCE(2): Audience. CLIENT_ROLE_TYPE .
///
/// Role that the user switches to: CLIENT_ROLE_BROADCASTER(1): Host.CLIENT_ROLE_AUDIENCE(2): Audience. CLIENT_ROLE_TYPE .
///
public virtual void OnClientRoleChanged(RtcConnection connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) { }
///
///
/// Occurs when the user role switch fails in the interactive live streaming.
/// In the live broadcasting channel profile, when the local user calls SetClientRole [1/2] to switch their 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.
///
///
/// The connection information. See RtcConnection .
///
/// The reason for a user role switch failure. See CLIENT_ROLE_CHANGE_FAILED_REASON .
///
/// Current user role. See CLIENT_ROLE_TYPE .
///
public virtual void OnClientRoleChangeFailed(RtcConnection connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) { }
///
/// @ignore
///
public virtual void OnAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) { }
///
///
/// Occurs when the media push state changes.
/// When the media push state 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.
///
///
/// The URL address where the state of the media push changes.
///
/// The current state of the media push. See RTMP_STREAM_PUBLISH_STATE .
///
/// The detailed error information for the media push. See RTMP_STREAM_PUBLISH_ERROR_TYPE .
///
public virtual void OnRtmpStreamingStateChanged(string url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) { }
///
///
/// Reports events during the media push.
///
///
/// The URL of media push.
///
/// The event code of media push. See RTMP_STREAMING_EVENT .
///
public virtual void OnRtmpStreamingEvent(string url, RTMP_STREAMING_EVENT eventCode) { }
///
///
/// Occurs when the publisher's transcoding is updated.
/// When the LiveTranscoding class in the setLiveTranscoding method updates, the SDK triggers the OnTranscodingUpdated callback to report the update information.If you call the setLiveTranscoding method to set the LiveTranscoding class for the first time, the SDK does not trigger this callback.
///
///
public virtual void OnTranscodingUpdated() { }
///
///
/// Occurs when the local audio route changes.
/// This method is for Android, iOS and macOS only.
///
///
/// The current audio routing. See AudioRoute .
///
public virtual void OnAudioRoutingChanged(int routing) { }
///
///
/// Occurs when the state of the media stream relay changes.
/// The SDK returns the state of the current media relay with any error message.
///
///
/// The state code. See CHANNEL_MEDIA_RELAY_STATE .
///
/// The error code of the channel media relay. See CHANNEL_MEDIA_RELAY_ERROR .
///
public virtual void OnChannelMediaRelayStateChanged(int state, int code) { }
///
///
/// Reports events during the media stream relay.
///
///
/// The event code of channel media relay. See CHANNEL_MEDIA_RELAY_EVENT .
///
public virtual void OnChannelMediaRelayEvent(int code) { }
///
/// @ignore
///
public virtual void OnLocalPublishFallbackToAudioOnly(bool isFallbackOrRecover) { }
///
/// @ignore
///
public virtual void OnRemoteSubscribeFallbackToAudioOnly(uint uid, bool isFallbackOrRecover) { }
///
///
/// Reports the transport-layer statistics of each remote audio stream.
/// Deprecated:Please use OnRemoteAudioStats instead.This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds after the local user receives an audio 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.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user sending the audio packets.
///
/// The network delay (ms) from the sender to the receiver.
///
/// The packet loss rate (%) of the audio packet sent from the remote user.
///
/// The bitrate of the received audio (Kbps).
///
public virtual void OnRemoteAudioTransportStats(RtcConnection connection, uint remoteUid, UInt16 delay, UInt16 lost, UInt16 rxKBitRate) { }
///
///
/// Reports the transport-layer statistics of each remote video stream.
/// Deprecated:This callback is deprecated; use OnRemoteVideoStats instead.This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds 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.
///
///
/// The connection information. See RtcConnection .
///
/// The ID of the remote user sending the video packets.
///
/// The network delay (ms) from the sender to the receiver.
///
/// The packet loss rate (%) of the video packet sent from the remote user.
///
/// The bitrate of the received video (Kbps).
///
public virtual void OnRemoteVideoTransportStats(RtcConnection connection, uint remoteUid, UInt16 delay, UInt16 lost, UInt16 rxKBitRate) { }
///
///
/// Occurs when the network connection state changes.
/// When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.
///
///
/// The current connection state. For details, see CONNECTION_STATE_TYPE .
///
/// The reason for a connection state change. For details, see CONNECTION_CHANGED_REASON_TYPE .
///
public virtual void OnConnectionStateChanged(RtcConnection connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { }
///
/// @ignore
///
public virtual void OnWlAccMessage(RtcConnection connection, WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, string wlAccMsg) { }
///
/// @ignore
///
public virtual void OnWlAccStats(RtcConnection connection, WlAccStats currentStats, WlAccStats averageStats) { }
///
///
/// Occurs when the local network type changes.
/// 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.
///
///
/// The connection information. See RtcConnection .
///
/// Network types: See NETWORK_TYPE .
///
public virtual void OnNetworkTypeChanged(RtcConnection connection, NETWORK_TYPE type) { }
///
///
/// Reports the built-in encryption errors.
/// 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.
///
///
/// The connection information. See RtcConnection .
///
/// For details about the error type, see ENCRYPTION_ERROR_TYPE .
///
public virtual void OnEncryptionError(RtcConnection connection, ENCRYPTION_ERROR_TYPE errorType) { }
///
/// @ignore
///
public virtual void OnUploadLogResult(RtcConnection connection, string requestId, bool success, UPLOAD_ERROR_REASON reason) { }
///
/// @ignore
///
public virtual void OnUserAccountUpdated(RtcConnection connection, uint remoteUid, string userAccount) { }
///
///
/// Occurs when the SDK cannot get the device permission.
/// When the SDK fails to get the device permission, the SDK triggers this callback to report which device permission cannot be got.This method is for Android and iOS only.
///
///
/// The type of the device permission. See PERMISSION_TYPE .
///
public virtual void OnPermissionError(PERMISSION_TYPE permissionType) { }
///
///
/// Occurs when the local user registers a user account.
/// 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.
///
///
/// The ID of the local user.
///
/// The user account of the local user.
///
public virtual void OnLocalUserRegistered(uint uid, string userAccount) { }
///
///
/// 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, and triggers this callback on the local client.
///
///
/// The user ID of the remote user.
///
/// The UserInfo object that contains the user ID and user account of the remote user. See UserInfo for details.
///
public virtual void OnUserInfoUpdated(uint uid, UserInfo info) { }
///
///
/// Occurs when the audio subscribing state changes.
///
///
/// The channel name.
///
/// The user ID of the remote user.
///
/// The previous subscribing status, see STREAM_SUBSCRIBE_STATE for details.
///
/// The current subscribing status, see STREAM_SUBSCRIBE_STATE for details.
///
/// The time elapsed (ms) from the previous state to the current state.
///
public virtual void OnAudioSubscribeStateChanged(string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { }
///
///
/// Occurs when the video subscribing state changes.
///
///
/// The channel name.
///
/// The ID of the remote user.
///
/// The previous subscribing status, see STREAM_SUBSCRIBE_STATE for details.
///
/// The current subscribing status, see STREAM_SUBSCRIBE_STATE for details.
///
/// The time elapsed (ms) from the previous state to the current state.
///
public virtual void OnVideoSubscribeStateChanged(string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { }
///
///
/// Occurs when the audio publishing state changes.
///
///
/// The channel name.
///
/// The previous subscribing status. See STREAM_PUBLISH_STATE .
///
/// The current subscribing status. See STREAM_PUBLISH_STATE.
///
/// The time elapsed (ms) from the previous state to the current state.
///
public virtual void OnAudioPublishStateChanged(string channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { }
///
///
/// Occurs when the video publishing state changes.
///
///
/// The channel name.
///
/// The capture type of the custom video source. See VIDEO_SOURCE_TYPE .
///
/// For the previous publishing state, see STREAM_PUBLISH_STATE .
///
/// For the current publishing state, see STREAM_PUBLISH_STATE.
///
/// The time elapsed (ms) from the previous state to the current state.
///
public virtual void OnVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, string channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { }
///
///
/// The event callback of the extension.
/// To listen for events while the extension is running, you need to register this callback.
///
///
/// The value of the extension key.
///
/// The key of the extension.
///
/// The name of the extension provider.
///
/// The name of the extension.
///
public virtual void OnExtensionEvent(string provider, string extension, string key, string value) { }
///
///
/// Occurs when the extension is enabled.
/// After a successful call of EnableExtension (true), the extension triggers this callback.
///
///
/// The name of the extension provider.
///
/// The name of the extension.
///
public virtual void OnExtensionStarted(string provider, string extension) { }
///
///
/// Occurs when the extension is disabled.
/// After a successful call of EnableExtension (false), this callback is triggered.
///
///
/// The name of the extension.
///
/// The name of the extension provider.
///
public virtual void OnExtensionStopped(string provider, string extension) { }
///
///
/// Occurs when the extension runs incorrectly.
/// When calling EnableExtension (true) fails or the extension runs in error, the extension triggers this callback and reports the error code and reason.
///
///
/// The name of the extension provider.
///
/// The name of the extension.
///
/// Error code. For details, see the extension documentation provided by the extension provider.
///
/// Reason. For details, see the extension documentation provided by the extension provider.
///
public virtual void OnExtensionError(string provider, string extension, int error, string message) { }
///
/// @ignore
///
public virtual void OnDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_ERROR error, string message) { }
///
/// @ignore
///
public virtual void OnDirectCdnStreamingStats(DirectCdnStreamingStats stats) { }
};
}