LocalVideoStreamReason enum

本地视频状态改变原因。

Inheritance

• Object
• Enum
• LocalVideoStreamReason

Available extensions

• EnumName

Annotations

• @JsonEnum.new(alwaysCreate: true)

Values

localVideoStreamReasonOk → const LocalVideoStreamReason

0：本地视频状态正常。

localVideoStreamReasonFailure → const LocalVideoStreamReason

1：出错原因不明确。

localVideoStreamReasonDeviceNoPermission → const LocalVideoStreamReason

2：没有权限启动本地视频采集设备。请提示用户开启设备权限后再重新加入频道。 弃用：该枚举已废弃。请改用 onPermissionError 回调中的 camera 。

localVideoStreamReasonDeviceBusy → const LocalVideoStreamReason

3：本地视频采集设备正在使用中。请提示用户检查摄像头是否被其他 App 占用，或者尝试重新加入频道。

localVideoStreamReasonCaptureFailure → const LocalVideoStreamReason

4：本地视频采集失败。请提示用户检查视频采集设备是否正常工作，检查摄像头是否被其他 App 占用，或者尝试重新加入频道。

localVideoStreamReasonCodecNotSupport → const LocalVideoStreamReason

5：本地视频编码失败。

localVideoStreamReasonCaptureInbackground → const LocalVideoStreamReason

6：（仅适用于 iOS）App 处于后台。请提示用户 App 处于后台时，无法正常进行视频采集。

localVideoStreamReasonCaptureMultipleForegroundApps → const LocalVideoStreamReason

7：（仅适用于 iOS）当前 App 窗口处于侧拉、分屏、画中画模式，且其他 App 正占用摄像头。请提示用户当 App 窗口处于侧拉、分屏、画中画模式，且其他 App 正占用摄像头时，无法正常进行视频采集。

localVideoStreamReasonDeviceNotFound → const LocalVideoStreamReason

8：找不到本地视频采集设备。需检查摄像头是否与设备正常连接、摄像头是否正常工作，或者尝试重新加入频道。

localVideoStreamReasonDeviceDisconnected → const LocalVideoStreamReason

9：（仅适用于 macOS 和 Windows）当前正在使用的视频采集设备已经断开连接（例如，被拔出）。

localVideoStreamReasonDeviceInvalidId → const LocalVideoStreamReason

10：（仅适用于 macOS 和 Windows）SDK 无法在视频设备列表中找到该视频设备。请检查视频设备 ID 是否有效。

localVideoStreamReasonDeviceInterrupt → const LocalVideoStreamReason

14:（仅适用于 Android）视频采集中断。可能的原因是： 摄像头被其他 App 占用。请提示用户检查摄像头是否被其他 App 占用。 当前 App 已被切换到后台。可以使用前台服务通知操作系统，确保 App 在切换到后台时仍可采集视频。详见为什么部分 Android 版本应用锁屏或切后台后采集音视频无效？。

localVideoStreamReasonDeviceFatalError → const LocalVideoStreamReason

15:（仅适用于 Android）视频采集设备出错。请提示用户关闭并重新启动摄像头以恢复功能，如果该操作不能解决问题，请检查摄像头是否出现硬件故障。

localVideoStreamReasonDeviceSystemPressure → const LocalVideoStreamReason

101：由于系统压力过大，导致当前视频采集设备不可用。

localVideoStreamReasonScreenCaptureWindowMinimized → const LocalVideoStreamReason

11：（仅适用于 macOS 和 Windows）调用 startScreenCaptureByWindowId 方法共享窗口时，共享窗口处于最小化的状态。SDK 无法共享被最小化的窗口。请提示用户将共享窗口取消最小化。

localVideoStreamReasonScreenCaptureWindowClosed → const LocalVideoStreamReason

12：（仅适用于 macOS 和 Windows）通过窗口 ID 共享的窗口已关闭，或通过窗口 ID 共享的全屏窗口已退出全屏。退出全屏模式后，远端用户将无法看到共享的窗口。为避免远端用户看到黑屏，建议你立即结束本次共享。 报告该错误码的常见场景： 本地用户关闭共享的窗口。 本地用户先播放映幻灯片，然后共享放映中的幻灯片。结束放映时，SDK 会报告该错误码。 本地用户先全屏观看网页视频或网页文档，然后共享网页视频或网页文档。结束全屏时，SDK 会报告该错误码。

localVideoStreamReasonScreenCaptureWindowOccluded → const LocalVideoStreamReason

13:（仅适用于 Windows）待共享的窗口被其他窗口遮挡住，被遮挡住的部分在共享时会被 SDK 涂黑。

localVideoStreamReasonScreenCaptureWindowNotSupported → const LocalVideoStreamReason

@nodoc

localVideoStreamReasonScreenCaptureFailure → const LocalVideoStreamReason

21：（仅适用于 Windows 和 Android）当前采集的窗口无数据。

localVideoStreamReasonScreenCaptureNoPermission → const LocalVideoStreamReason

22：（仅适用于 Windows 和 macOS）不具备采集屏幕的权限。

localVideoStreamReasonScreenCaptureAutoFallback → const LocalVideoStreamReason

24：（仅适用于 Windows）屏幕共享过程中发生意外错误（可能由于窗口屏蔽失败），导致屏幕共享策略降级，但屏幕共享过程本身没有受到影响。 屏幕共享过程中，由于设备本身驱动等问题导致屏蔽指定窗口失败时，SDK 也会报告该事件并自动回退到共享整个屏幕。如果你的应用场景需要屏蔽特定窗口以保护隐私，建议监听此事件并在事件触发时添加额外的隐私保护机制。

localVideoStreamReasonScreenCaptureWindowHidden → const LocalVideoStreamReason

25：（仅适用于 Windows）当前屏幕采集的窗口处于隐藏状态，并且在当前屏幕上不可见。

localVideoStreamReasonScreenCaptureWindowRecoverFromHidden → const LocalVideoStreamReason

26：（仅适用于 Windows）进行屏幕采集的窗口已经从隐藏状态中恢复。

localVideoStreamReasonScreenCaptureWindowRecoverFromMinimized → const LocalVideoStreamReason

27：（仅适用于 macOS 和 Windows）进行屏幕采集的窗口已经从最小化状态恢复正常。

localVideoStreamReasonScreenCapturePaused → const LocalVideoStreamReason

28：（仅适用于 Windows）屏幕采集已暂停。报告该错误码的常见场景：当前屏幕可能已切换到安全桌面，例如 UAC 对话框或者 Winlogon 桌面。

localVideoStreamReasonScreenCaptureResumed → const LocalVideoStreamReason

29：（仅适用于 Windows）屏幕采集已从暂停状态中恢复。

localVideoStreamReasonScreenCaptureDisplayDisconnected → const LocalVideoStreamReason

30：（仅适用于 Windows 和 macOS）进行屏幕采集的显示器已断开连接。当收到该状态时，请提示用户当前屏幕共享已暂停并重启屏幕共享。

localVideoStreamReasonScreenCaptureStoppedByUser → const LocalVideoStreamReason

@nodoc

localVideoStreamReasonScreenCaptureInterruptedByOther → const LocalVideoStreamReason

@nodoc

localVideoStreamReasonScreenCaptureStoppedByCall → const LocalVideoStreamReason

@nodoc

localVideoStreamReasonScreenCaptureExcludeWindowFailed → const LocalVideoStreamReason

@nodoc

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.