AgoraLocalVideoStreamError Constants Reference

Declared in AgoraEnumerates.h

AgoraLocalVideoStreamError

The detailed error information of the local video.

Constants

AgoraLocalVideoStreamErrorOK

0: The local video is normal.

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorFailure

1: No specified reason for the local video failure.

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorDeviceNoPermission

2: No permission to use the local video device.

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorDeviceBusy

3: The local video capturer is in use.

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorCaptureFailure

4: The local video capture fails. Check whether the capturer is working properly.

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorEncodeFailure

5: The local video encoding fails.

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorCaptureInBackGround

6: (iOS only) The application is in the background.

Available in v3.3.0

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorCaptureMultipleForegroundApps

7: (iOS only) The application is running in Slide Over, Split View, or Picture in Picture mode.

Available in v3.3.0

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorCaptureNoDeviceFound

8: The SDK cannot find the local video capture device.

Available in v3.4.0

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorCaptureDeviceDisconnected

9: (macOS only) The external camera currently in use is disconnected (such as being unplugged).

Available in v3.5.0

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorScreenCaptureWindowMinimized

11: (macOS only) The shared window is minimized when you call startScreenCaptureByWindowId to share a window.

Available in v3.1.0

Declared In AgoraEnumerates.h.

AgoraLocalVideoStreamErrorScreenCaptureWindowClosed

12: (macOS 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 for 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 exis full-screen mode, the SDK reports this error code.
  • The local user watches web video or reads 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.
  • Available in v3.2.0

    Declared In AgoraEnumerates.h.

    Declared In

    AgoraEnumerates.h