LocalVideoStreamReason
Reason for local video state change.
Enumerations
- LocalVideoStreamReasonOk
- 0: Local video state is normal.
- LocalVideoStreamReasonFailure
- 1: Unknown error.
- LocalVideoStreamReasonDeviceNoPermission
- 2: No permission to start the local video capture device. Prompt the user to enable device permissions and rejoin the channel.
Note: Deprecated: This enumeration is deprecated. Use onPermissionError callback with
Camerainstead. - LocalVideoStreamReasonDeviceBusy
- 3: The local video capture device is in use. Prompt the user to check if the camera is occupied by another app or try rejoining the channel.
- LocalVideoStreamReasonCaptureFailure
- 4: Failed to capture local video. Prompt the user to check if the video capture device is working properly, whether the camera is occupied by another app, or try rejoining the channel.
- LocalVideoStreamReasonCodecNotSupport
- 5: Failed to encode local video.
- LocalVideoStreamReasonDeviceNotFound
- 8: Cannot find the local video capture device. Check if the camera is properly connected and functioning or try rejoining the channel.
- LocalVideoStreamReasonDeviceDisconnected
- 9: The video capture device currently in use has been disconnected (e.g., unplugged).
- LocalVideoStreamReasonDeviceInvalidId
- 10: The SDK cannot find the video device in the device list. Check whether the video device ID is valid.
- LocalVideoStreamReasonScreenCaptureWindowMinimized
- 11: When calling startScreenCaptureByWindowId to share a window, the window is minimized. The SDK cannot share minimized windows. Prompt the user to restore the window.
- LocalVideoStreamReasonScreenCaptureWindowClosed
- 12: The window shared by window ID is closed, or the fullscreen window shared by window ID has exited fullscreen. After exiting fullscreen, remote users will not be able to see the shared window. To avoid showing a black screen to remote users, it is recommended to end the sharing session immediately.
Common scenarios reporting this error code:
- The local user closes the shared window.
- The local user plays a slideshow and shares the slideshow in presentation mode. When the presentation ends, the SDK reports this error code.
- The local user views a web video or document in fullscreen and shares it. When exiting fullscreen, the SDK reports this error code.
- LocalVideoStreamReasonScreenCaptureWindowOccluded
- 13: (Windows only) The window to be shared is occluded by other windows. The occluded part will be blacked out by the SDK during sharing.
- LocalVideoStreamReasonScreenCaptureFailure
- 21: (Windows and Android only) The currently captured window has no data.
- LocalVideoStreamReasonScreenCaptureNoPermission
- 22: No permission to capture the screen.
- LocalVideoStreamReasonScreenCaptureAutoFallback
- 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to failure to block the window), causing the screen sharing strategy to downgrade. The screen sharing process itself is not affected.
Note: During screen sharing, if blocking the specified window fails due to device driver issues, the SDK reports this event and automatically falls back to sharing the entire screen. If your use case requires blocking specific windows to protect privacy, listen for this event and implement additional privacy protection mechanisms when triggered.
- LocalVideoStreamReasonScreenCaptureWindowHidden
- 25: (Windows only) The window currently being captured is hidden and not visible on the current screen.
- LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden
- 26: (Windows only) The window being captured has recovered from a hidden state.
- LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized
- 27: The window being captured has recovered from a minimized state.
- LocalVideoStreamReasonScreenCapturePaused
- 28: (Windows only) Screen capture is paused. Common scenario: the screen may have switched to a secure desktop, such as a UAC dialog or Winlogon desktop.
- LocalVideoStreamReasonScreenCaptureResumed
- 29: (Windows only) Screen capture has resumed from a paused state.
- LocalVideoStreamReasonScreenCaptureDisplayDisconnected
- 30: The display being captured is disconnected. When receiving this state, prompt the user that screen sharing is paused and restart screen sharing.
- LocalVideoStreamReasonScreenCaptureExcludeWindowFailed
- 34: (Windows only) Some windows in the exclusion list failed to be excluded during screen sharing.
- LocalVideoStreamReasonDeviceSystemPressure
- 101: The current video capture device is unavailable due to high system pressure.