Enum Reference

This page documents every public UENUM (BlueprintType) in the plugin. All of these are usable from both C++ and Blueprint. Related types are documented in the Struct Reference. Events that carry these enums are listed in Events.

Connection & Requests

EOBSConnectionState

Connection state of the OBS WebSocket client.

Value	Meaning
`Disconnected`	Not connected to OBS.
`Connecting`	TCP/WebSocket connection in progress.
`Authenticating`	Connected, performing the Hello/Identify authentication handshake.
`Connected`	Fully connected and identified. Requests can be sent.

EOBSOutputState

State of a streaming/recording/virtual-cam/replay-buffer output, carried by output state-change events.

Value	Meaning
`Unknown`	State could not be determined.
`Starting`	Output is starting.
`Started`	Output is active.
`Stopping`	Output is stopping.
`Stopped`	Output is inactive.
`Reconnecting`	Stream output lost connection and is reconnecting.
`Reconnected`	Stream output reconnected successfully.
`Paused`	Recording output is paused.
`Resumed`	Recording output resumed from pause.

EOBSRequestBatchExecutionType

Determines how OBS processes the requests in a batch (see Request Batching).

Value	Underlying	Meaning
`None`	255	Not a request batch (internal use).
`SerialRealtime`	0	Processed serially, immediately as they arrive (default).
`SerialFrame`	1	Processed serially, all at the end of the current frame.
`Parallel`	2	Processed in parallel with no guaranteed order.

Scenes & Scene Items

EOBSBoundsType

Bounding-box behaviour for a scene item transform, controlling how a source is scaled to fit its bounds.

Value	Meaning
`None`	No bounding box.
`Stretch`	Stretch to bounds, ignoring aspect ratio.
`ScaleInner`	Scale to fit inside the bounds (may letterbox).
`ScaleOuter`	Scale to fill the bounds (may crop).
`ScaleToWidth`	Scale to the width of the bounds.
`ScaleToHeight`	Scale to the height of the bounds.
`MaxOnly`	Limit to a maximum size only (no upscaling).

EOBSBlendMode

How a scene item is composited over the sources beneath it.

Value	Meaning
`Normal`	Normal blending (default).
`Additive`	Additive blending (brightens).
`Subtract`	Subtractive blending (darkens).
`Screen`	Screen blending.
`Multiply`	Multiply blending.
`Lighten`	Lighten blending.
`Darken`	Darken blending.

Audio

EOBSMonitorType

Audio monitoring mode for an OBS input.

Value	Display Name	Meaning
`None`	None	No monitoring.
`MonitorOnly`	Monitor Only	Monitor through the configured device, but do not send to output.
`MonitorAndOutput`	Monitor and Output	Monitor and also send to the stream/recording output.

Media Inputs

EOBSMediaInputAction

Action to perform on a media input (Media Source, VLC Source, etc.). Maps to the OBS ObsMediaInputAction enum.

Value	Meaning
`None`	No action.
`Play`	Play the media.
`Pause`	Pause the media.
`Stop`	Stop the media (resets to the beginning).
`Restart`	Restart the media from the beginning.
`Next`	Go to the next media item (playlists).
`Previous`	Go to the previous media item (playlists).

EOBSMediaState

Playback state of a media input.

Value	Meaning
`Unknown`	Unknown state.
`None`	No media loaded.
`Playing`	Media is playing.
`Paused`	Media is paused.
`Stopped`	Media is stopped.
`Buffering`	Media is buffering.
`Ended`	Media has finished.
`Error`	Media encountered an error.
`Opening`	Media is opening.

Configuration

EOBSDataRealm

Realm for OBS persistent-data slots (GetPersistentData/SetPersistentData). See Persistent Data.

Value	Display Name	Meaning
`Global`	Global	Persists across all of OBS, regardless of the active profile.
`Profile`	Profile	Scoped to the currently active OBS profile.

Trigger Volume (Gameplay)

These types power the Trigger Volume automation actor.

EOBSTriggerActionType

The action a trigger executes when it fires.

Value	Meaning
`SwitchScene`	Switch to a specific OBS scene.
`StartRecording`	Start recording.
`StopRecording`	Stop recording.
`ToggleRecording`	Toggle recording state.
`PauseRecording`	Pause recording.
`ResumeRecording`	Resume recording.
`StartStreaming`	Start streaming.
`StopStreaming`	Stop streaming.
`ToggleStreaming`	Toggle streaming state.
`StartVirtualCam`	Start the virtual camera.
`StopVirtualCam`	Stop the virtual camera.
`ToggleVirtualCam`	Toggle the virtual camera.
`StartReplayBuffer`	Start the replay buffer.
`StopReplayBuffer`	Stop the replay buffer.
`SaveReplayBuffer`	Save the replay buffer to a file.
`SetInputMute`	Mute or unmute an audio input.
`SetInputVolume`	Set the volume of an audio input.
`ToggleInputMute`	Toggle an audio input’s mute state.
`SetSceneItemEnabled`	Show or hide a source (scene item) within a scene.
`SetSourceFilterEnabled`	Enable or disable a filter on a source.
`TriggerHotkeyByName`	Trigger an OBS hotkey by its registered name.
`TriggerMediaInputAction`	Play / pause / stop / restart a media source.

EOBSTriggerShape

Collision shape of a trigger volume.

Value	Meaning
`Box`	Box collision.
`Sphere`	Sphere collision.

EOBSTriggerEvent

When the trigger fires relative to actor overlap.

Value	Meaning
`OnEnter`	Fire when an actor enters the volume.
`OnExit`	Fire when an actor exits the volume.
`Both`	Fire on both enter and exit (uses separate action arrays).

EOBSAudioConditionMode

Whether an audio-threshold condition passes when the input is talking or idle.

Value	Meaning
`Talking`	Passes only while the input is talking (mic-active, above threshold).
`Idle`	Passes only while the input is idle (not mic-active).

EOBSVisibilityConditionMode

Whether a source-visibility condition passes when the scene item is visible or hidden.

Value	Meaning
`Visible`	Passes only while the scene item is enabled (visible).
`Hidden`	Passes only while the scene item is disabled (hidden).

EOBSOutputStateRequirement

Tri-state requirement for an output (recording/streaming) condition. Replaces an older pair of mutually-contradictory booleans so “must be on” and “must be off” can never both be set.

Value	Display Name	Meaning
`Any`	Any (no condition)	No gating on this output.
`Required`	Required (must be active)	The output must be active.
`Disallowed`	Disallowed (must be inactive)	The output must be inactive.

EOBSTriggerVolumeStyle

Visual style applied to a trigger volume’s styled mesh (separate from the debug-draw outline).

Value	Display Name	Meaning
`None`	None (debug draw only)	No styled mesh, debug draw only.
`Glow`	Fresnel Glow	Preset Fresnel-glow material.
`Hologram`	Hologram	Preset hologram material.
`Pulse`	Pulse	Preset pulsing material.
`Custom`	Custom Material	Use the user-assigned custom material.

Component

EOBSComponentFeature

Feature bits used by the OBS Controller component’s feature picker. Each value selects a group of Details-panel sections (and, where applicable, opts into the relevant event traffic). See the OBS Component guide.

Value	Feature group
`Scenes`	Scene list and scene switching.
`RecordingStreaming`	Recording and streaming controls.
`Audio`	Audio inputs (volume/mute).
`Media`	Media input playback.
`TransitionsStudio`	Transitions and Studio Mode.
`SceneTransforms`	Scene-item transforms (opts into the high-volume transform event stream).
`Filters`	Source filters.
`Screenshots`	Source screenshots.
`AdvancedOutputs`	Virtual camera, replay buffer, generic outputs.
`SourcesConfig`	Source settings and OBS configuration.
`MAX`	Sentinel for iteration (hidden).

Sequencer

These types drive the OBS Sequencer integration. The full action list (with parameters per action) is enumerated in Sequencer Actions.

EOBSSequencerActionCategory

Category used to group OBS Sequencer actions in the editor UI.

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

EOBSSequencerTriggerType

How an action fires relative to its Sequencer section bounds.

Value	Meaning
`Instant`	Fires once when the playhead enters the section start (e.g. Save Replay Buffer).
`State`	Fires on section enter, optionally reverting on section exit (e.g. Switch Scene).
`Toggle`	Fires different actions at section start versus end (e.g. Start Record at start, Stop Record at end).

EOBSTargetPickerType

What kind of name picker the editor shows for an action’s TargetName field. This is an editor metadata enum and is not BlueprintType.

Value	Meaning
`None`	No picker.
`Scene`	Scene-name picker.
`Input`	Input-name picker.
`Transition`	Transition-name picker.
`Filter`	Filter-name picker.
`Source`	Source-name picker.
`SceneItem`	Scene-item picker.
`MediaInput`	Media-input picker.

EOBSSequencerAction

The complete set of OBS actions available in Sequencer. Each value’s parameters and trigger type are defined in the action registry and documented in Sequencer Actions. Grouped by category:

Category	Actions
Recording	`StartRecord`, `StopRecord`, `PauseRecord`, `ResumeRecord`, `ToggleRecordPause`, `SplitRecordFile`, `CreateRecordChapter`
Streaming	`StartStream`, `StopStream`, `ToggleStream`, `SendStreamCaption`
Scenes	`SwitchScene`, `SetSceneItemEnabled` (Set Source Visibility)
Scene Items	`SetSceneItemPosition`, `SetSceneItemScale`, `SetSceneItemRotation`, `SetSceneItemCrop`
Audio	`MuteInput`, `UnmuteInput`, `ToggleInputMute`, `SetVolume`
Replay Buffer	`StartReplayBuffer`, `StopReplayBuffer`, `ToggleReplayBuffer`, `SaveReplayBuffer`
Virtual Camera	`StartVirtualCam`, `StopVirtualCam`, `ToggleVirtualCam`
Transitions	`SetCurrentTransition`, `SetTransitionDuration`
Sources	`SetTextSourceText`, `SetBrowserSourceUrl`, `SetImageSourceFile`, `SetMediaSourceFile`, `SetColorSourceColor`
Filters	`SetSourceFilterEnabled`, `SetSourceFilterSetting`
Media Inputs	`TriggerMediaInputAction`, `SetMediaInputCursor`
Studio Mode	`SetStudioModeEnabled`, `SetCurrentPreviewScene`, `TriggerStudioModeTransition`
Screenshots	`SaveSourceScreenshot`

The enum also defines None (default, no action) and MAX (hidden sentinel for iteration).

EOBSMediaSyncExitBehavior

Behaviour applied to a media input when the playhead leaves an OBS Media Sync section (see Sequencer Tracks).

Value	Meaning
`Pause`	Pause the media at the current position.
`Stop`	Stop the media (resets to the beginning).
`Continue`	Let the media keep playing.