LocalVideoStreamError enum

Local video state error codes.

Inheritance

Constructors

LocalVideoStreamError()
const

Values

OK → const LocalVideoStreamError

0: The local video is normal.

Failure → const LocalVideoStreamError

1: No specified reason for the local video failure.

DeviceNoPermission → const LocalVideoStreamError

2: No permission to use the local video capturing device.

DeviceBusy → const LocalVideoStreamError

3: The local video capturing device is in use.

CaptureFailure → const LocalVideoStreamError

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

EncodeFailure → const LocalVideoStreamError

5: The local video encoding fails.

CaptureInBackground → const LocalVideoStreamError

6: The local video capturing device not available due to app did enter background.

CaptureMultipleForegroundApps → const LocalVideoStreamError

7: The local video capturing device not available because the app is running in a multi-app layout (generally on the pad).

DeviceNotFound → const LocalVideoStreamError

Since v3.4.0 8: Fails to find a local video capture device.

LocalVideoStreamErrorCaptureDeviceDisconnected → const LocalVideoStreamError

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

ScreenCaptureWindowMinmized → const LocalVideoStreamError

11: When calling startScreenCaptureByWindowId to share the window, the shared window is in a minimized state.

ScreenCaptureWindowClosed → const LocalVideoStreamError

Since v3.2.0 12: 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 cpp of the slides. After the user exits 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.

LocalVideoStreamErrorDeviceInvalidId → const LocalVideoStreamError

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.

LocalVideoStreamErrorScreenCaptureWindowOccluded → const LocalVideoStreamError

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.

LocalVideoStreamErrorExtensionCaptureStarted → const LocalVideoStreamError

13: (iOS only) The screen sharing extension process starts.

LocalVideoStreamErrorExtensionCaptureStoped → const LocalVideoStreamError

14: (iOS only) The screen sharing extension process ends.

LocalVideoStreamErrorExtensionCaptureDisconnected → const LocalVideoStreamError

15: (iOS only) The screen sharing extension process quits unexpectedly.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<LocalVideoStreamError>
A constant List of the values in this enum, in order of their declaration.