LocalVideoStreamReason
Reasons for local video state changes.
Enumerator
- LocalVideoStreamReasonOk
- 0: The local video is normal.
- LocalVideoStreamReasonFailure
- 1: No specified reason for the local video failure.
- LocalVideoStreamReasonDeviceNoPermission
- 2: No permission to use the local video capturing device. Prompt the user to grant permissions and rejoin the channel.
- Deprecated:
- This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
- LocalVideoStreamReasonDeviceBusy
- 3: The local video capturing device is in use. Prompt the user to check if the camera is being used by another app, or try to rejoin the channel.
- LocalVideoStreamReasonCaptureFailure
- 4: The local video capture fails. Prompt the user to check whether the video capture device is working properly, whether the camera is used by another app, or try to rejoin the channel.
- LocalVideoStreamReasonCodecNotSupport
- 5: The local video encoding fails.
- LocalVideoStreamReasonDeviceNotFound
- 8: Fails to find a local video capture device. Remind the user to check whether the camera is connected to the device properly or the camera is working properly, and then to rejoin the channel.
- LocalVideoStreamReasonDeviceDisconnected
- 9: (macOS only) The video capture device currently in use is disconnected (such as being unplugged).
- LocalVideoStreamReasonDeviceInvalidId
- 10: (macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
- LocalVideoStreamReasonScreenCaptureWindowMinimized
- 11: (macOS and Windows only) The shared window is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
- LocalVideoStreamReasonScreenCaptureWindowClosed
-
12: (macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing.
Common scenarios reporting this error code:- The local user closes the shared window.
- The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
- The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
- LocalVideoStreamReasonScreenCaptureWindowOccluded
- 13: (Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.
- LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized
- 27:The window for screen capture has been restored from the minimized state.
- LocalVideoStreamReasonDeviceSystemPressure
- 101: The current video capture device is unavailable due to excessive system pressure.