AgoraVideoRemoteStateReason Constants Reference
Declared in | AgoraEnumerates.h |
---|
AgoraVideoRemoteStateReason
The reason for the remote video state change.
Definition
typedef NS_ENUM(NSUInteger, AgoraVideoRemoteStateReason ) {
AgoraVideoRemoteStateReasonInternal = 0,
AgoraVideoRemoteStateReasonNetworkCongestion = 1,
AgoraVideoRemoteStateReasonNetworkRecovery = 2,
AgoraVideoRemoteStateReasonLocalMuted = 3,
AgoraVideoRemoteStateReasonLocalUnmuted = 4,
AgoraVideoRemoteStateReasonRemoteMuted = 5,
AgoraVideoRemoteStateReasonRemoteUnmuted = 6,
AgoraVideoRemoteStateReasonRemoteOffline = 7,
AgoraVideoRemoteStateReasonAudioFallback = 8,
AgoraVideoRemoteStateReasonAudioFallbackRecovery = 9,
AgoraVideoRemoteStateReasonRemoteSDKInBackGround = 10,
};
Constants
AgoraVideoRemoteStateReasonInternal
-
0: The SDK reports this reason when the video state changes.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonNetworkCongestion
-
1: The remote user’s network is congested. If the network conditions are persistently poor, display a pop-up box in the application that says “The remote user’s network conditions are poor”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonNetworkRecovery
-
2: The remote user’s network conditions are restored from congested to normal. You can display a pop-up box in the application that says “The remote user’s network conditions have improved”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonLocalMuted
-
3: The local user stops receiving the remote video stream or disables the video module. You can close the window to render the remote user’s video and display a pop-up box in the application that says “You have stopped receiving video from the remote user”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonLocalUnmuted
-
4: The local user resumes receiving the remote video stream or enables the video module. You can restore the window to render the remote user’s video and display a pop-up box in the application that says “You have resumed receiving video from the remote user”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonRemoteMuted
-
5: The remote user stops sending the video stream or disables the video module. You can close the window to render the remote user’s video, use an icon in the list of users in the application user interface to show that the remote user has stopped sending video, and display a pop-up box in the application that says “The remote user has disabled the camera”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonRemoteUnmuted
-
6: The remote user resumes sending the video stream or enables the video module. You can restore the window to render the remote user’s video, use an icon in the list of users in the application user interface to show that the remote user has resumed sending video, and display a pop-up box in the application that says “The remote user has enabled the camera”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonRemoteOffline
-
7: The remote user leaves the channel. You can close the window to render the remote user’s video and remove the remote user from the user list in the application user interface.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonAudioFallback
-
8: The remote audio-and-video stream falls back to the audio-only stream due to poor network conditions. You can close the window to render the remote user’s video and display a pop-up box in the application that says “The remote user’s network conditions are poor”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonAudioFallbackRecovery
-
9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve. You can restore the window to render the remote user’s video and display a pop-up box in the application that says “The remote user’s network conditions are poor”.
Declared In
AgoraEnumerates.h
. AgoraVideoRemoteStateReasonRemoteSDKInBackGround
-
10: The SDK reports this error code to the local user when a remote user is using the iOS app and the app is in the background. In this case, the local user sees the remote user’s video stuck.
Declared In
AgoraEnumerates.h
.
Declared In
AgoraEnumerates.h