この翻訳は最新の英語版より遅れている場合があります。英語版を表示

列挙型リファレンス

このページでは、プラグイン内のすべての公開 UENUM（BlueprintType）を説明します。これらはすべて C++ と Blueprint の両方から使用できます。関連する型は Struct リファレンスに記載されています。これらの列挙型を持つイベントはイベントに一覧があります。

接続とリクエスト

EOBSConnectionState

OBS WebSocket クライアントの接続状態。

値	意味
`Disconnected`	OBS に接続されていない。
`Connecting`	TCP/WebSocket 接続処理中。
`Authenticating`	接続済み。Hello/Identify 認証ハンドシェイクを実行中。
`Connected`	完全に接続・識別済み。リクエストを送信できる。

EOBSOutputState

配信・録画・仮想カメラ・リプレイバッファの出力状態。出力状態変化イベントによって通知される。

値	意味
`Unknown`	状態を判定できない。
`Starting`	出力が開始中。
`Started`	出力がアクティブ。
`Stopping`	出力が停止中。
`Stopped`	出力が非アクティブ。
`Reconnecting`	配信出力が接続を失い、再接続中。
`Reconnected`	配信出力が正常に再接続した。
`Paused`	録画出力が一時停止中。
`Resumed`	録画出力が一時停止から再開した。

EOBSRequestBatchExecutionType

OBS がバッチ内のリクエストをどのように処理するかを決定する（リクエストのバッチ処理参照）。

値	基底値	意味
`None`	255	バッチリクエストではない（内部使用）。
`SerialRealtime`	0	到着次第、逐次処理する（デフォルト）。
`SerialFrame`	1	現在のフレーム末尾にまとめて逐次処理する。
`Parallel`	2	順序を保証せず並列処理する。

シーンとシーンアイテム

EOBSBoundsType

シーンアイテムのトランスフォームにおけるバウンディングボックスの動作。ソースをバウンドに合わせてどのようにスケールするかを制御する。

値	意味
`None`	バウンディングボックスなし。
`Stretch`	アスペクト比を無視してバウンドに引き伸ばす。
`ScaleInner`	バウンド内に収まるようにスケールする（レターボックスが生じる場合がある）。
`ScaleOuter`	バウンドを埋めるようにスケールする（クロップされる場合がある）。
`ScaleToWidth`	バウンドの幅に合わせてスケールする。
`ScaleToHeight`	バウンドの高さに合わせてスケールする。
`MaxOnly`	最大サイズのみに制限する（アップスケールなし）。

EOBSBlendMode

シーンアイテムをその下のソースに対してどのように合成するか。

値	意味
`Normal`	通常のブレンド（デフォルト）。
`Additive`	加算ブレンド（明るくなる）。
`Subtract`	減算ブレンド（暗くなる）。
`Screen`	スクリーンブレンド。
`Multiply`	乗算ブレンド。
`Lighten`	比較（明）ブレンド。
`Darken`	比較（暗）ブレンド。

音声

EOBSMonitorType

OBS 入力の音声モニタリングモード。

値	表示名	意味
`None`	None	モニタリングなし。
`MonitorOnly`	Monitor Only	設定済みデバイスでモニタリングするが、出力には送らない。
`MonitorAndOutput`	Monitor and Output	モニタリングしながら配信・録画出力にも送る。

メディア入力

EOBSMediaInputAction

メディア入力（メディアソース、VLC ソースなど）に対して実行するアクション。OBS の ObsMediaInputAction 列挙型に対応する。

値	意味
`None`	アクションなし。
`Play`	メディアを再生する。
`Pause`	メディアを一時停止する。
`Stop`	メディアを停止する（先頭に戻る）。
`Restart`	メディアを先頭から再開する。
`Next`	次のメディアアイテムに進む（プレイリスト）。
`Previous`	前のメディアアイテムに戻る（プレイリスト）。

EOBSMediaState

メディア入力の再生状態。

値	意味
`Unknown`	不明な状態。
`None`	メディアが読み込まれていない。
`Playing`	メディアが再生中。
`Paused`	メディアが一時停止中。
`Stopped`	メディアが停止している。
`Buffering`	メディアがバッファリング中。
`Ended`	メディアの再生が終了した。
`Error`	メディアでエラーが発生した。
`Opening`	メディアを開いている。

設定

EOBSDataRealm

OBS の永続データスロット（GetPersistentData/SetPersistentData）のレルム。永続データ参照。

値	表示名	意味
`Global`	Global	アクティブなプロファイルに関わらず、OBS 全体で永続する。
`Profile`	Profile	現在アクティブな OBS プロファイルにスコープされる。

Trigger Volume（ゲームプレイ）

これらの型は Trigger Volume オートメーションアクタを動かす。

EOBSTriggerActionType

トリガーが発火したときに実行するアクション。

値	意味
`SwitchScene`	特定の OBS シーンに切り替える。
`StartRecording`	録画を開始する。
`StopRecording`	録画を停止する。
`ToggleRecording`	録画状態を切り替える。
`PauseRecording`	録画を一時停止する。
`ResumeRecording`	録画を再開する。
`StartStreaming`	配信を開始する。
`StopStreaming`	配信を停止する。
`ToggleStreaming`	配信状態を切り替える。
`StartVirtualCam`	仮想カメラを開始する。
`StopVirtualCam`	仮想カメラを停止する。
`ToggleVirtualCam`	仮想カメラを切り替える。
`StartReplayBuffer`	リプレイバッファを開始する。
`StopReplayBuffer`	リプレイバッファを停止する。
`SaveReplayBuffer`	リプレイバッファをファイルに保存する。
`SetInputMute`	音声入力をミュートまたはミュート解除する。
`SetInputVolume`	音声入力の音量を設定する。
`ToggleInputMute`	音声入力のミュート状態を切り替える。
`SetSceneItemEnabled`	シーン内のソース（シーンアイテム）を表示または非表示にする。
`SetSourceFilterEnabled`	ソースのフィルターを有効化または無効化する。
`TriggerHotkeyByName`	登録名で OBS ホットキーをトリガーする。
`TriggerMediaInputAction`	メディアソースを再生・一時停止・停止・再開する。

EOBSTriggerShape

トリガーボリュームのコリジョン形状。

値	意味
`Box`	ボックスコリジョン。
`Sphere`	スフィアコリジョン。

EOBSTriggerEvent

アクタのオーバーラップに対してトリガーが発火するタイミング。

値	意味
`OnEnter`	アクタがボリュームに入ったときに発火する。
`OnExit`	アクタがボリュームから出たときに発火する。
`Both`	入場・退場の両方で発火する（それぞれ別のアクション配列を使用）。

EOBSAudioConditionMode

音声しきい値条件が、入力が発話中のときに成立するかアイドルのときに成立するか。

値	意味
`Talking`	入力が発話中（マイクアクティブ、しきい値超え）のときのみ成立する。
`Idle`	入力がアイドル（マイク非アクティブ）のときのみ成立する。

EOBSVisibilityConditionMode

ソース表示状態の条件が、シーンアイテムが表示中のときに成立するか非表示のときに成立するか。

値	意味
`Visible`	シーンアイテムが有効（表示）のときのみ成立する。
`Hidden`	シーンアイテムが無効（非表示）のときのみ成立する。

EOBSOutputStateRequirement

出力（録画・配信）条件に対する三値の要件。相互に矛盾しうる古いブール値のペアを置き換え、「必ずオン」と「必ずオフ」を同時に設定できないようにする。

値	表示名	意味
`Any`	Any (no condition)	この出力に対してゲーティングを行わない。
`Required`	Required (must be active)	出力がアクティブでなければならない。
`Disallowed`	Disallowed (must be inactive)	出力が非アクティブでなければならない。

EOBSTriggerVolumeStyle

トリガーボリュームのスタイル付きメッシュに適用されるビジュアルスタイル（デバッグ描画のアウトラインとは別）。

値	表示名	意味
`None`	None (debug draw only)	スタイル付きメッシュなし、デバッグ描画のみ。
`Glow`	Fresnel Glow	プリセットの Fresnel グローマテリアル。
`Hologram`	Hologram	プリセットのホログラムマテリアル。
`Pulse`	Pulse	プリセットのパルスマテリアル。
`Custom`	Custom Material	ユーザーが割り当てたカスタムマテリアルを使用する。

Component

EOBSComponentFeature

OBS Controller コンポーネントの機能ピッカーが使用する機能ビット。各値は詳細パネルのセクショングループを選択し、該当する場合は関連するイベントトラフィックにもオプトインする。OBS Component ガイドを参照。

値	機能グループ
`Scenes`	シーンリストとシーンの切り替え。
`RecordingStreaming`	録画と配信のコントロール。
`Audio`	音声入力（音量・ミュート）。
`Media`	メディア入力の再生。
`TransitionsStudio`	トランジションと Studio Mode。
`SceneTransforms`	シーンアイテムのトランスフォーム（高頻度のトランスフォームイベントストリームにオプトイン）。
`Filters`	ソースフィルター。
`Screenshots`	ソーススクリーンショット。
`AdvancedOutputs`	仮想カメラ、リプレイバッファ、汎用出力。
`SourcesConfig`	ソース設定と OBS の設定。
`MAX`	イテレーション用のセンチネル（非表示）。

シーケンサー

これらの型は OBS シーケンサーインテグレーションを動かす。アクションの完全な一覧（各アクションのパラメーター付き）はシーケンサーアクションに記載されている。

EOBSSequencerActionCategory

エディタ UI で OBS シーケンサーアクションをグループ化するために使用するカテゴリー。

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

EOBSSequencerTriggerType

シーケンサーのセクション境界に対してアクションがどのタイミングで発火するか。

値	意味
`Instant`	再生ヘッドがセクション開始点に入ったときに一度発火する（例：リプレイバッファの保存）。
`State`	セクション開始時に発火し、オプションでセクション終了時に復帰する（例：シーンの切り替え）。
`Toggle`	セクション開始と終了で異なるアクションを発火する（例：開始時に録画開始、終了時に録画停止）。

EOBSTargetPickerType

アクションの TargetName フィールドに対してエディタが表示する名前ピッカーの種類。これはエディタメタデータ用の列挙型であり、BlueprintType ではない。

値	意味
`None`	ピッカーなし。
`Scene`	シーン名ピッカー。
`Input`	入力名ピッカー。
`Transition`	トランジション名ピッカー。
`Filter`	フィルター名ピッカー。
`Source`	ソース名ピッカー。
`SceneItem`	シーンアイテムピッカー。
`MediaInput`	メディア入力ピッカー。

EOBSSequencerAction

シーケンサーで利用可能な OBS アクションの完全なセット。各値のパラメーターとトリガータイプはアクションレジストリで定義されており、シーケンサーアクションに記載されている。カテゴリー別の一覧：

カテゴリー	アクション
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`

この列挙型には None（デフォルト、アクションなし）と MAX（イテレーション用の非表示センチネル）も定義されている。

EOBSMediaSyncExitBehavior

再生ヘッドが OBS Media Sync セクションを離れたときにメディア入力に適用される動作（シーケンサートラック参照）。

値	意味
`Pause`	現在位置でメディアを一時停止する。
`Stop`	メディアを停止する（先頭に戻る）。
`Continue`	メディアの再生を続ける。