Skip to content

Desuq Cafe

文档菜单

此翻译可能落后于最新的英文版本。 查看英文版

枚举参考

本页记录插件中所有公开的 UENUMBlueprintType)。所有这些枚举均可在 C++ 和 Blueprint 中使用。相关类型请参阅 结构体参考。携带这些枚举的事件列于 事件 页面。

连接与请求

EOBSConnectionState

OBS WebSocket 客户端的连接状态。

含义
Disconnected未连接到 OBS。
ConnectingTCP/WebSocket 连接进行中。
Authenticating已连接,正在执行 Hello/Identify 身份验证握手。
Connected已完全连接并完成标识。可以发送请求。

EOBSOutputState

推流、录制、虚拟摄像头及 Replay Buffer 输出的状态,由输出状态变更事件携带。

含义
Unknown无法确定状态。
Starting输出正在启动。
Started输出处于活动状态。
Stopping输出正在停止。
Stopped输出处于非活动状态。
Reconnecting推流输出连接中断,正在重连。
Reconnected推流输出已成功重连。
Paused录制输出已暂停。
Resumed录制输出已从暂停恢复。

EOBSRequestBatchExecutionType

决定 OBS 如何处理批处理请求中的各项请求(参见 请求批处理)。

底层值含义
None255非批处理请求(内部使用)。
SerialRealtime0串行处理,接收后立即执行(默认)。
SerialFrame1串行处理,全部在当前帧结束时执行。
Parallel2并行处理,不保证执行顺序。

场景与场景项目

EOBSBoundsType

场景项目变换的边界框行为,控制来源如何缩放以适应其边界框。

含义
None无边界框。
Stretch拉伸至边界框,忽略宽高比。
ScaleInner缩放以适应边界框内部(可能出现黑边)。
ScaleOuter缩放以填充边界框(可能被裁剪)。
ScaleToWidth缩放至边界框宽度。
ScaleToHeight缩放至边界框高度。
MaxOnly仅限制最大尺寸(不放大)。

EOBSBlendMode

场景项目与其下方来源的合成方式。

含义
Normal正常混合(默认)。
Additive叠加混合(提亮)。
Subtract相减混合(变暗)。
Screen滤色混合。
Multiply正片叠底混合。
Lighten变亮混合。
Darken变暗混合。

音频

EOBSMonitorType

OBS 输入的音频监听模式。

显示名称含义
NoneNone不监听。
MonitorOnlyMonitor Only通过已配置的设备监听,但不发送到输出。
MonitorAndOutputMonitor and Output同时监听并发送到推流/录制输出。

媒体输入

EOBSMediaInputAction

对媒体输入(媒体源、VLC Source 等)执行的动作。映射到 OBS 的 ObsMediaInputAction 枚举。

含义
None无动作。
Play播放媒体。
Pause暂停媒体。
Stop停止媒体(重置到开头)。
Restart从头重新播放媒体。
Next跳转到下一个媒体项目(播放列表)。
Previous跳转到上一个媒体项目(播放列表)。

EOBSMediaState

媒体输入的播放状态。

含义
Unknown未知状态。
None未加载媒体。
Playing媒体正在播放。
Paused媒体已暂停。
Stopped媒体已停止。
Buffering媒体正在缓冲。
Ended媒体已播放完毕。
Error媒体遇到错误。
Opening媒体正在打开。

配置

EOBSDataRealm

OBS 持久化数据槽的范围(GetPersistentData/SetPersistentData)。参见 持久化数据

显示名称含义
GlobalGlobal在所有 OBS 范围内持久化,与当前活动的配置文件无关。
ProfileProfile限定于当前活动的 OBS 配置文件。

Trigger Volume(游戏玩法)

以下类型驱动 Trigger Volume 自动化 Actor。

EOBSTriggerActionType

触发器触发时执行的动作。

含义
SwitchScene切换到指定的 OBS 场景。
StartRecording开始录制。
StopRecording停止录制。
ToggleRecording切换录制状态。
PauseRecording暂停录制。
ResumeRecording恢复录制。
StartStreaming开始推流。
StopStreaming停止推流。
ToggleStreaming切换推流状态。
StartVirtualCam启动虚拟摄像头。
StopVirtualCam停止虚拟摄像头。
ToggleVirtualCam切换虚拟摄像头。
StartReplayBuffer启动 Replay Buffer。
StopReplayBuffer停止 Replay Buffer。
SaveReplayBuffer将 Replay Buffer 保存到文件。
SetInputMute静音或取消静音一个音频输入。
SetInputVolume设置音频输入的音量。
ToggleInputMute切换音频输入的静音状态。
SetSceneItemEnabled在场景中显示或隐藏一个来源(场景项目)。
SetSourceFilterEnabled启用或禁用来源上的一个滤镜。
TriggerHotkeyByName通过已注册的名称触发 OBS 热键。
TriggerMediaInputAction播放/暂停/停止/重新播放媒体源。

EOBSTriggerShape

触发器体积的碰撞形状。

含义
Box盒体碰撞。
Sphere球体碰撞。

EOBSTriggerEvent

触发器相对于 Actor 重叠的触发时机。

含义
OnEnter当 Actor 进入体积时触发。
OnExit当 Actor 离开体积时触发。
Both进入和离开时均触发(使用独立的动作数组)。

EOBSAudioConditionMode

音频阈值条件在输入处于说话或静默状态时的通过方式。

含义
Talking仅在输入处于说话状态时通过(麦克风活跃,高于阈值)。
Idle仅在输入处于静默状态时通过(麦克风未活跃)。

EOBSVisibilityConditionMode

来源可见性条件在场景项目可见或隐藏时的通过方式。

含义
Visible仅在场景项目启用(可见)时通过。
Hidden仅在场景项目禁用(隐藏)时通过。

EOBSOutputStateRequirement

输出(录制/推流)条件的三态要求。替代了旧版一对相互矛盾的布尔值,使”必须开启”和”必须关闭”不再同时成立。

显示名称含义
AnyAny (no condition)不对此输出设置条件。
RequiredRequired (must be active)输出必须处于活动状态。
DisallowedDisallowed (must be inactive)输出必须处于非活动状态。

EOBSTriggerVolumeStyle

应用于触发器体积带样式的网格体的视觉样式(独立于调试绘制轮廓)。

显示名称含义
NoneNone (debug draw only)无带样式的网格体,仅调试绘制。
GlowFresnel Glow预设菲涅耳辉光材质。
HologramHologram预设全息材质。
PulsePulse预设脉冲材质。
CustomCustom Material使用用户自定义的材质。

Component

EOBSComponentFeature

OBS Controller 组件的 Feature Picker 所使用的功能位。每个值选择一组 Details 面板分段,并在适用的情况下订阅相关事件流。参见 OBS Component 指南。

功能组
Scenes场景列表与场景切换。
RecordingStreaming录制与推流控制。
Audio音频输入(音量/静音)。
Media媒体输入播放。
TransitionsStudio转场与 Studio Mode。
SceneTransforms场景项目变换(订阅高频变换事件流)。
Filters来源滤镜。
Screenshots来源截图。
AdvancedOutputs虚拟摄像头、Replay Buffer 及通用输出。
SourcesConfig来源设置与 OBS 配置。
MAX迭代哨兵(隐藏)。

Sequencer

以下类型驱动 OBS Sequencer 集成。完整动作列表(含每个动作的参数)请参阅 Sequencer 动作

EOBSSequencerActionCategory

用于在编辑器 UI 中对 OBS Sequencer 动作进行分组的类别。

None
Recording
Streaming
Scenes
SceneItems
Audio
ReplayBuffer
VirtualCamera
Transitions
Sources
Filters
MediaInputs
StudioMode
Screenshots

EOBSSequencerTriggerType

动作相对于其 Sequencer 分段边界的触发方式。

含义
Instant播放头进入分段开始处时触发一次(例如:保存 Replay Buffer)。
State进入分段时触发,可选择在退出分段时还原(例如:切换场景)。
Toggle在分段开始和结束处触发不同动作(例如:开始处开始录制,结束处停止录制)。

EOBSTargetPickerType

编辑器为动作的 TargetName 字段显示的名称选择器类型。这是一个编辑器元数据枚举,非 BlueprintType

含义
None无选择器。
Scene场景名称选择器。
Input输入名称选择器。
Transition转场名称选择器。
Filter滤镜名称选择器。
Source来源名称选择器。
SceneItem场景项目选择器。
MediaInput媒体输入选择器。

EOBSSequencerAction

Sequencer 中可用的完整 OBS 动作集合。每个值的参数和触发类型在动作注册表中定义,并记录于 Sequencer 动作。按类别分组:

类别动作
RecordingStartRecord, StopRecord, PauseRecord, ResumeRecord, ToggleRecordPause, SplitRecordFile, CreateRecordChapter
StreamingStartStream, StopStream, ToggleStream, SendStreamCaption
ScenesSwitchScene, SetSceneItemEnabled (Set Source Visibility)
Scene ItemsSetSceneItemPosition, SetSceneItemScale, SetSceneItemRotation, SetSceneItemCrop
AudioMuteInput, UnmuteInput, ToggleInputMute, SetVolume
Replay BufferStartReplayBuffer, StopReplayBuffer, ToggleReplayBuffer, SaveReplayBuffer
Virtual CameraStartVirtualCam, StopVirtualCam, ToggleVirtualCam
TransitionsSetCurrentTransition, SetTransitionDuration
SourcesSetTextSourceText, SetBrowserSourceUrl, SetImageSourceFile, SetMediaSourceFile, SetColorSourceColor
FiltersSetSourceFilterEnabled, SetSourceFilterSetting
Media InputsTriggerMediaInputAction, SetMediaInputCursor
Studio ModeSetStudioModeEnabled, SetCurrentPreviewScene, TriggerStudioModeTransition
ScreenshotsSaveSourceScreenshot

该枚举还定义了 None(默认,无动作)和 MAX(隐藏的迭代哨兵)。

EOBSMediaSyncExitBehavior

播放头离开 OBS Media Sync 分段时应用于媒体输入的行为(参见 Sequencer 轨道)。

含义
Pause在当前位置暂停媒体。
Stop停止媒体(重置到开头)。
Continue让媒体继续播放。