LOCAL_VIDEO_STREAM_ERROR

Local video state error codes.

Enumerator

LOCAL_VIDEO_STREAM_ERROR_OK
0: The local video is normal.
LOCAL_VIDEO_STREAM_ERROR_FAILURE
1: No specified reason for the local video failure.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION
2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel.
Deprecated:
This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY
3: The local video capturing device is in use. Remind the user to check whether another application occupies the camera.
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE
4: The local video capture fails. Remind your user to check whether the video capture device is working properly, whether the camera is occupied by another application, or try to rejoin the channel.
LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE
5: The local video encoding fails.
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_INBACKGROUND
6: (iOS only) The app is in the background. Remind the user that video capture cannot be performed normally when the app is in the background.
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS
7: (iOS only) The current application window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Remind the user that the application cannot capture video properly when the app is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND
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.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED
9:(macOS only) The video capture device currently in use is disconnected (such as being unplugged).
LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID
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.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED
11: (macOS only) The shared window is minimized when you call startScreenCaptureByWindowId to share a window. The SDK cannot share a minimized window. You can cancel the minimization of this window at the application layer, for example by maximizing this window.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED

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:
  • When the local user closes the shared window, the SDK reports this error code.
  • 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.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED
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.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_FAILURE
21: (Windows only) The screen has not captured any data available for window sharing.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_NO_PERMISSION
22: (Windows and macOS only) No permission for screen capture.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_PAUSED
23: (Windows only) Screen capture has been paused. Common scenarios reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_RESUMED
24: (Windows only) Screen capture has resumed from paused state.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_HIDDEN
25: (Windows only) The window for the current screen capture is hidden and not visible on the current screen.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN
26: (Windows only) The window for screen capture has been restored from hidden state.
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED
27: (Windows only) The window for screen capture has been restored from minimized state.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_SYSTEM_PRESSURE
101: The current video capture device is unavailable due to excessive system pressure.