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. Remind 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. Remind the user to check whether another application occupies the camera.
- localVideoStreamReasonCaptureFailure
- 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.
- localVideoStreamReasonCodecNotSupport
- 5: The local video encoding fails.
- localVideoStreamReasonCaptureInbackground
- 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.
- localVideoStreamReasonCaptureMultipleForegroundApps
- 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.
- 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 windows is minimized when you call the startScreenCaptureByWindowId method 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.
- 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:- 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.
- 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.
- localVideoStreamReasonScreenCaptureNoPermission
- 22: (Windows and macOS only) No permission for screen capture.
- localVideoStreamReasonScreenCaptureAutoFallback
- 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to window blocking failure), resulting in decreased performance, but the screen sharing process itself was not affected.
- localVideoStreamReasonScreenCaptureWindowHidden
- 25: (Windows only) The window for the current screen capture is hidden and not visible on the current screen.
- localVideoStreamReasonScreenCaptureWindowRecoverFromHidden
- 26: (Windows only) The window for screen capture has been restored from hidden state.
- localVideoStreamReasonScreenCaptureWindowRecoverFromMinimized
- 27: (Windows only) The window for screen capture has been restored from minimized state.
- localVideoStreamReasonScreenCapturePaused
- 28: (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.
- localVideoStreamReasonScreenCaptureResumed
- 29: (Windows only) Screen capture has resumed from paused state.
- localVideoStreamReasonDeviceSystemPressure
- 101: The current video capture device is unavailable due to excessive system pressure.