LocalVideoStreamReason enum

Reason for local video state change.

Inheritance

• Object
• Enum
• LocalVideoStreamReason

Available extensions

• EnumName

Annotations

• @JsonEnum.new(alwaysCreate: true)

Values

localVideoStreamReasonOk → const LocalVideoStreamReason

0: Local video is in normal state.

localVideoStreamReasonFailure → const LocalVideoStreamReason

1: Unknown error.

localVideoStreamReasonDeviceNoPermission → const LocalVideoStreamReason

2: No permission to start the local video capture device. Prompt the user to enable device permissions and rejoin the channel. Deprecated: This enum is deprecated. Use onPermissionError callback with camera instead.

localVideoStreamReasonDeviceBusy → const LocalVideoStreamReason

3: The local video capture device is currently in use. Prompt the user to check if the camera is occupied by another app or try rejoining the channel.

localVideoStreamReasonCaptureFailure → const LocalVideoStreamReason

4: Failed to capture local video. Prompt the user to check if the video capture device is working properly, whether the camera is occupied by another app, or try rejoining the channel.

localVideoStreamReasonCodecNotSupport → const LocalVideoStreamReason

5: Failed to encode local video.

localVideoStreamReasonCaptureInbackground → const LocalVideoStreamReason

6: (iOS only) The app is in the background. Prompt the user that video capture cannot function properly while the app is in the background.

localVideoStreamReasonCaptureMultipleForegroundApps → const LocalVideoStreamReason

7: (iOS only) The current app window is in Slide Over, Split View, or Picture-in-Picture mode, and another app is using the camera. Prompt the user that video capture cannot function properly under these conditions.

localVideoStreamReasonDeviceNotFound → const LocalVideoStreamReason

8: Local video capture device not found. Check if the camera is properly connected and functioning, or try rejoining the channel.

localVideoStreamReasonDeviceDisconnected → const LocalVideoStreamReason

9: (macOS and Windows only) The video capture device in use has been disconnected (e.g., unplugged).

localVideoStreamReasonDeviceInvalidId → const LocalVideoStreamReason

10: (macOS and Windows only) The SDK cannot find the video device in the device list. Check if the video device ID is valid.

localVideoStreamReasonDeviceInterrupt → const LocalVideoStreamReason

14: (Android only) Video capture interrupted. Possible reasons: The camera is occupied by another app. Prompt the user to check if the camera is in use. The app has been sent to the background. Use a foreground service notification to ensure video capture continues in the background.

localVideoStreamReasonDeviceFatalError → const LocalVideoStreamReason

15: (Android only) Video capture device error. Prompt the user to turn the camera off and on again. If the issue persists, check for hardware failure.

localVideoStreamReasonDeviceSystemPressure → const LocalVideoStreamReason

101: The video capture device is unavailable due to excessive system pressure.

localVideoStreamReasonScreenCaptureWindowMinimized → const LocalVideoStreamReason

11: (macOS and Windows only) The window shared via startScreenCaptureByWindowId is minimized. The SDK cannot share minimized windows. Prompt the user to restore the window.

localVideoStreamReasonScreenCaptureWindowClosed → const LocalVideoStreamReason

12: (macOS and Windows only) The window shared by window ID has been closed, or a fullscreen window shared by ID has exited fullscreen. After exiting fullscreen, remote users will not see the shared window. To avoid black screens, it is recommended to end the sharing session immediately. Common scenarios for this error code: The local user closes the shared window. The local user plays a slideshow and shares it. When the slideshow ends, the SDK reports this error code. The local user views a web video or document in fullscreen, then shares it. When exiting fullscreen, the SDK reports this error code.

localVideoStreamReasonScreenCaptureWindowOccluded → const LocalVideoStreamReason

13: (Windows only) The window to be shared is occluded by another window. The occluded part will appear black in the shared content.

localVideoStreamReasonScreenCaptureWindowNotSupported → const LocalVideoStreamReason

@nodoc

localVideoStreamReasonScreenCaptureFailure → const LocalVideoStreamReason

21: (Windows and Android only) No data from the currently captured window.

localVideoStreamReasonScreenCaptureNoPermission → const LocalVideoStreamReason

22: (Windows and macOS only) No permission to capture the screen.

localVideoStreamReasonScreenCaptureAutoFallback → const LocalVideoStreamReason

24: (Windows only) An unexpected error occurred during screen sharing (possibly due to failure to block a window), causing the screen sharing strategy to fall back. The sharing process itself is not affected. During screen sharing, if the SDK fails to block a specific window due to driver or hardware issues, it will report this event and automatically fall back to sharing the entire screen. If your use case requires blocking specific windows for privacy, listen for this event and implement additional privacy protections when triggered.

localVideoStreamReasonScreenCaptureWindowHidden → const LocalVideoStreamReason

25: (Windows only) The window being captured is hidden and not visible on the current screen.

localVideoStreamReasonScreenCaptureWindowRecoverFromHidden → const LocalVideoStreamReason

26: (Windows only) The window being captured has recovered from a hidden state.

localVideoStreamReasonScreenCaptureWindowRecoverFromMinimized → const LocalVideoStreamReason

27: (macOS and Windows only) The window being captured has recovered from a minimized state.

localVideoStreamReasonScreenCapturePaused → const LocalVideoStreamReason

28: (Windows only) Screen capture is paused. Common scenario: the screen may have switched to a secure desktop, such as a UAC dialog or Winlogon desktop.

localVideoStreamReasonScreenCaptureResumed → const LocalVideoStreamReason

29: (Windows only) Screen capture has resumed from a paused state.

localVideoStreamReasonScreenCaptureDisplayDisconnected → const LocalVideoStreamReason

30: (Windows and macOS only) The display being captured has been disconnected. Prompt the user that screen sharing is paused and restart screen sharing.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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<LocalVideoStreamReason>

A constant List of the values in this enum, in order of their declaration.