|
@@ -12,31 +12,31 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Occurs when a user joins a channel.
|
|
|
- /// This callback notifies the application that a user joins a specified channel.
|
|
|
+ /// This Callback notifies the application that a user joins a specified channel.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnJoinChannelSuccess(RtcConnection connection, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this Callback upon reconnection.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> Time elapsed (ms) from the local user calling the JoinChannel [1/2] or JoinChannel [2/2] method until this callback is triggered.</param>
|
|
|
+ /// <param name="elapsed"> Time elapsed (ms) from the local user calling the JoinChannel [1/2] or JoinChannel [2/2] method until this Callback is triggered.</param>
|
|
|
///
|
|
|
public virtual void OnRejoinChannelSuccess(RtcConnection connection, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="channel"> The channel name.</param>
|
|
@@ -47,14 +47,14 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="localProxyIp"> Reserved for future use.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> The time elapsed (ms) from the user calling JoinChannel [1/2] until this callback is triggered.</param>
|
|
|
+ /// <param name="elapsed"> The time elapsed (ms) from the user calling JoinChannel [1/2] until this Callback is triggered.</param>
|
|
|
///
|
|
|
public virtual void OnProxyConnected(string channel, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="err"> Error code. See ERROR_CODE_TYPE .</param>
|
|
@@ -66,7 +66,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -92,7 +92,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Reports the last mile network probe result.
|
|
|
- /// The SDK triggers this callback within 30 seconds after the app calls StartLastmileProbeTest .
|
|
|
+ /// The SDK triggers this Callback within 30 seconds after the app calls StartLastmileProbeTest .
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="result"> The uplink and downlink last-mile network probe test result. See LastmileProbeResult .</param>
|
|
@@ -102,23 +102,23 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
- /// <param name="speakers"> The volume information of the users. See AudioVolumeInfo . An empty speakers array in the callback indicates that no remote user is in the channel or sending a stream at the moment.</param>
|
|
|
+ /// <param name="speakers"> The volume information of the users. See AudioVolumeInfo . An empty speakers array in the Callback indicates that no remote user is in the channel or sending a stream at the moment.</param>
|
|
|
///
|
|
|
- /// <param name="speakerNumber"> The total number of users.In the callback for the local user, if the local user is sending streams, the value of speakerNumber is 1.In the callback for remote users, the value range of speakerNumber is [0,3]. If the number of remote users who send streams is greater than or equal to three, the value of speakerNumber is 3.</param>
|
|
|
+ /// <param name="speakerNumber"> The total number of users.In the Callback for the local user, if the local user is sending streams, the value of speakerNumber is 1.In the Callback for remote users, the value range of speakerNumber is [0,3]. If the number of remote users who send streams is greater than or equal to three, the value of speakerNumber is 3.</param>
|
|
|
///
|
|
|
- /// <param name="totalVolume"> 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. </param>
|
|
|
+ /// <param name="totalVolume"> 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. </param>
|
|
|
///
|
|
|
public virtual void OnAudioVolumeIndication(RtcConnection connection, AudioVolumeInfo[] speakers, uint speakerNumber, int totalVolume) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Occurs when a user leaves a channel.
|
|
|
- /// This callback notifies the app that the user leaves the channel by calling LeaveChannel [1/2]
|
|
|
+ /// This Callback notifies the app that the user leaves the channel by calling LeaveChannel [1/2]
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -130,7 +130,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Reports the statistics of the current call.
|
|
|
- /// The SDK triggers this callback once every two seconds after the user joins the channel.
|
|
|
+ /// The SDK triggers this Callback once every two seconds after the user joins the channel.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -142,7 +142,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="deviceId"> The device ID.</param>
|
|
@@ -157,7 +157,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
public virtual void OnAudioMixingFinished() { }
|
|
@@ -165,7 +165,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Occurs when the playback of the local music file finishes.
|
|
|
- /// This callback occurs when the local audio effect file finishes playing.
|
|
|
+ /// This Callback occurs when the local audio effect file finishes playing.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="soundId"> The audio effect ID. The ID of each audio effect file is unique.</param>
|
|
@@ -185,7 +185,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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
|
|
|
+ /// 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
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -222,7 +222,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="info"> The uplink network information. See UplinkNetworkInfo .</param>
|
|
@@ -237,7 +237,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="quality"> The last-mile network quality.
|
|
@@ -255,7 +255,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback when the first local video frame is displayed on the local video view.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -264,19 +264,19 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="height"> The height (px) of the first local video frame.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> 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]</param>
|
|
|
+ /// <param name="elapsed"> 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]</param>
|
|
|
///
|
|
|
public virtual void OnFirstLocalVideoFrame(RtcConnection connection, int width, int height, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnFirstLocalVideoFramePublished(RtcConnection connection, int elapsed) { }
|
|
|
|
|
@@ -288,7 +288,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -299,7 +299,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="height"> The height (px) of the video stream.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnFirstRemoteVideoDecoded(RtcConnection connection, uint remoteUid, int width, int height, int elapsed) { }
|
|
|
|
|
@@ -325,7 +325,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="result"> The results of video content moderation. See CONTENT_INSPECT_RESULT .</param>
|
|
@@ -335,7 +335,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="channel"> The channel name.</param>
|
|
@@ -355,7 +355,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="state"> The state of the local video, see LOCAL_VIDEO_STREAM_STATE .</param>
|
|
@@ -368,7 +368,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -379,7 +379,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="reason"> The reason for the remote video state change, see REMOTE_VIDEO_STATE_REASON .</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> Time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> Time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnRemoteVideoStateChanged(RtcConnection connection, uint remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { }
|
|
|
|
|
@@ -396,21 +396,21 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="height"> The height (px) of the video stream.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> The time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnFirstRemoteVideoFrame(RtcConnection connection, uint remoteUid, int width, int height, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
/// <param name="remoteUid"> The ID of the user or host who joins the channel.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> Time delay (ms) from the local user calling JoinChannel [2/2] until this callback is triggered.</param>
|
|
|
+ /// <param name="elapsed"> Time delay (ms) from the local user calling JoinChannel [2/2] until this Callback is triggered.</param>
|
|
|
///
|
|
|
public virtual void OnUserJoined(RtcConnection connection, uint remoteUid, int elapsed) { }
|
|
|
|
|
@@ -432,7 +432,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -447,7 +447,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -462,7 +462,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -477,7 +477,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback when the remote user resumes or stops capturing the video stream by calling the EnableLocalVideo method.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -509,7 +509,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Reports the statistics of the local audio stream.
|
|
|
- /// The SDK triggers this callback once every two seconds.
|
|
|
+ /// The SDK triggers this Callback once every two seconds.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -521,7 +521,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback once every two seconds. If a channel includes multiple users, the SDK triggers this Callback as many times.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -533,7 +533,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback once every two seconds to report the statistics of the local video stream.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -545,7 +545,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -557,7 +557,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
public virtual void OnCameraReady() { }
|
|
@@ -596,7 +596,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="imageWidth"> The width (px) of the video image captured by the local camera.</param>
|
|
@@ -614,7 +614,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
public virtual void OnVideoStopped() { }
|
|
@@ -622,7 +622,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// This Callback occurs when the playback state of the music file changes, and reports the current state and error code.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="state"> The playback state of the music file. See AUDIO_MIXING_STATE_TYPE .</param>
|
|
@@ -639,7 +639,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -649,7 +649,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -669,7 +669,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback when the local user receives the stream message that the remote user sends by calling the SendStreamMessage method.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -689,7 +689,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback when the local user fails to receive the stream message that the remote user sends by calling the SendStreamMessage method.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -709,7 +709,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -719,7 +719,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -731,12 +731,12 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> Time elapsed (ms) from the local user calling JoinChannel [2/2] until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnFirstLocalAudioFramePublished(RtcConnection connection, int elapsed) { }
|
|
|
|
|
@@ -750,28 +750,28 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="userId"> The ID of the remote user sending the audio frames.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> The time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> The time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnFirstRemoteAudioFrame(RtcConnection connection, uint userId, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
|
///
|
|
|
/// <param name="uid"> The user ID of the remote user.</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> The time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> The time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnFirstRemoteAudioDecoded(RtcConnection connection, uint uid, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -785,7 +785,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -796,14 +796,14 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <param name="reason"> The reason of the remote audio state change. See REMOTE_AUDIO_STATE_REASON .</param>
|
|
|
///
|
|
|
- /// <param name="elapsed"> Time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this callback.</param>
|
|
|
+ /// <param name="elapsed"> Time elapsed (ms) from the local user calling the JoinChannel [2/2] method until the SDK triggers this Callback.</param>
|
|
|
///
|
|
|
public virtual void OnRemoteAudioStateChanged(RtcConnection connection, uint remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { }
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -815,7 +815,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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 SDK triggers this Callback when the local user switches the user role by calling SetClientRole [1/2]
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -829,7 +829,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -848,7 +848,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="url"> The URL address where the state of the media push changes.</param>
|
|
@@ -873,7 +873,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
public virtual void OnTranscodingUpdated() { }
|
|
@@ -922,7 +922,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -940,7 +940,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -958,7 +958,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// When the network connection state changes, the SDK triggers this Callback and reports the current connection state and the reason for the change.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="state"> The current connection state. For details, see CONNECTION_STATE_TYPE .</param>
|
|
@@ -980,7 +980,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -992,7 +992,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="connection"> The connection information. See RtcConnection .</param>
|
|
@@ -1014,7 +1014,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="permissionType"> The type of the device permission. See PERMISSION_TYPE .</param>
|
|
@@ -1024,7 +1024,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="uid"> The ID of the local user.</param>
|
|
@@ -1036,7 +1036,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// 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.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="uid"> The user ID of the remote user.</param>
|
|
@@ -1113,8 +1113,8 @@ namespace Agora.Rtc
|
|
|
|
|
|
///
|
|
|
/// <summary>
|
|
|
- /// The event callback of the extension.
|
|
|
- /// To listen for events while the extension is running, you need to register this callback.
|
|
|
+ /// The event Callback of the extension.
|
|
|
+ /// To listen for events while the extension is running, you need to register this Callback.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="value"> The value of the extension key.</param>
|
|
@@ -1130,7 +1130,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Occurs when the extension is enabled.
|
|
|
- /// After a successful call of EnableExtension (true), the extension triggers this callback.
|
|
|
+ /// After a successful call of EnableExtension (true), the extension triggers this Callback.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="provider"> The name of the extension provider.</param>
|
|
@@ -1142,7 +1142,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// Occurs when the extension is disabled.
|
|
|
- /// After a successful call of EnableExtension (false), this callback is triggered.
|
|
|
+ /// After a successful call of EnableExtension (false), this Callback is triggered.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="extension"> The name of the extension.</param>
|
|
@@ -1154,7 +1154,7 @@ namespace Agora.Rtc
|
|
|
///
|
|
|
/// <summary>
|
|
|
/// 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.
|
|
|
+ /// When calling EnableExtension (true) fails or the extension runs in error, the extension triggers this Callback and reports the error code and reason.
|
|
|
/// </summary>
|
|
|
///
|
|
|
/// <param name="provider"> The name of the extension provider.</param>
|