LOCAL_VIDEO_STREAM_REASON
Reason for local video state changes.
Enumerations
- LOCAL_VIDEO_STREAM_REASON_OK
- (0): Local video is functioning normally.
- LOCAL_VIDEO_STREAM_REASON_FAILURE
- (1): An unspecified error occurred in the local video.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION
- (2): No permission to use the local video capture device. Prompt the user to grant permission and rejoin the channel.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY
- (3): The local video capture device is occupied. Prompt the user to check whether the camera is being used by another application or try rejoining the channel.
- LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE
- (4): Failed to capture local video. Prompt the user to check whether the video capture device is working properly, whether the camera is being used by another application, or try rejoining the channel.
- LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT
- (5): Local video encoding failed.
- LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND
- (6): (iOS only) The app is in the background. Prompt the user that video cannot be captured properly while the app is in the background.
- LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS
- (7): (iOS only) The app window is in Slide Over, Split View, or Picture-in-Picture mode, and the camera is being used by another app. Prompt the user that in these modes, if the camera is occupied by another app, video capture may not work properly.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND
- (8): No local video capture device found. Prompt the user to check whether the camera is properly connected or functioning, and rejoin the channel.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED
- (9): (macOS and Windows only) The current video capture device has been disconnected (e.g., unplugged).
- LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID
- (10): (macOS and Windows only) The SDK cannot find the video device in the device list. Check whether the video device ID is valid.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT
- (14): (Android only) Video capture was interrupted. Possible reasons include: the camera is occupied by another app; the app switched to the background. You can use a foreground service notification to inform the OS to continue capturing video when the app is in the background.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR
- (15): (Android only) A fatal error occurred in the video capture device. Prompt the user to turn off and restart the camera to restore functionality. If the issue persists, check for hardware failure.
- LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE
- (101): The current video capture device is unavailable due to high system pressure.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED
- (11): (macOS and Windows only) The shared window is minimized when calling startScreenCaptureByWindowId. The SDK cannot share a minimized window. Prompt the user to restore the window.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED
- (12): (macOS and Windows only) The shared window is closed, or a fullscreen window exited fullscreen mode. After exiting fullscreen, remote users will not see the shared window. To avoid showing a black screen to remote users, it is recommended to stop screen sharing immediately. Common scenarios include: the local user closes the shared window; the user shares a slideshow window after entering fullscreen, and exits fullscreen triggering this error; the user watches a web video or document in fullscreen and shares the window, exiting fullscreen triggers this error.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED
- (13): (Windows only) The shared window is occluded by another window. The SDK blacks out the occluded area.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED
- (20): Local screen sharing window is not supported.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE
- (21): (Windows and Android only) The currently captured window has no data.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION
- (22): (Windows and macOS only) No screen sharing permission.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK
- (24): (Windows only) An exception occurred during screen sharing (possibly due to failure in occluding a window), leading to performance degradation, but the screen sharing process itself is not affected.
Note: During screen sharing, if occluding a specific 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 occluding specific windows for privacy, it is recommended to listen for this event and implement additional privacy protection mechanisms when triggered.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN
- (25): (Windows only) The currently shared window is hidden and not visible on the screen.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN
- (26): (Windows only) The shared window has recovered from a hidden state.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED
- (27): (macOS and Windows only) The shared window has recovered from a minimized state.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED
- (28): (Windows only) Screen sharing is paused. Common scenarios include switching to a secure desktop, such as a UAC dialog or Winlogon desktop.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED
- (29): (Windows only) Screen sharing has resumed from a paused state.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED
- (30): (Windows and macOS only) The display used for screen sharing has been disconnected, and screen sharing is paused. Prompt the user to restart screen sharing.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_STOPPED_BY_USER
- (31): (HarmonyOS only) Screen sharing was stopped by the user.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_INTERRUPTED_BY_OTHER
- (32): (HarmonyOS only) Screen sharing was interrupted by another screen sharing session.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_STOPPED_BY_CALL
- (33): (HarmonyOS only) Screen sharing was stopped due to a SIM call.
- LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_EXCLUDE_WINDOW_FAILED
- (34): (Windows only) Failed to exclude some windows in the exclusion list during screen sharing.