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

構造体リファレンス

このページでは、プラグイン内のすべての公開 USTRUCT (BlueprintType) を解説します。列挙型フィールドの詳細は Enum リファレンスを参照してください。これらの構造体を配信するイベントはイベントにまとめられています。

一部の構造体には C++ 専用のヘルパーメンバー（JSON 文字列フィールドのミラーとなる TSharedPtr<FJsonObject> や InitFromJson/ToJson ヘルパーなど）も含まれています。これらは注記されていますが、Blueprint からは参照できません。

コア: リクエストとバッチ

FOBSRequestResult

OBS WebSocket の単一リクエストの結果。

フィールド	型	説明
`bSuccess`	`bool`	リクエストが成功したかどうか。
`StatusCode`	`int32`	OBS リクエストのステータスコード。
`Comment`	`FString`	OBS からのステータスコメントまたはエラーテキスト。

FOBSBatchRequest

OBS 向けに構築中のバッチ内の単一リクエスト。

フィールド	型	説明
`RequestType`	`FString`	リクエストタイプ（例: `"SetCurrentProgramScene"`）。
`RequestId`	`FString`	バッチ内でのオプションのリクエスト ID。
`RequestDataJson`	`FString`	JSON 文字列としてのリクエストデータ（Blueprint 向け）。
`RequestData`	`TSharedPtr<FJsonObject>`	C++ 専用のパース済みリクエストデータ。

FOBSBatchRequestResult

バッチレスポンス内の 1 件のリクエスト結果。

フィールド	型	説明
`RequestType`	`FString`	リクエストタイプ。
`RequestId`	`FString`	指定されていた場合のリクエスト ID。
`RequestStatus`	`FOBSRequestResult`	リクエストごとの成否・コード・コメント。
`ResponseData`	`TSharedPtr<FJsonObject>`	C++ 専用のレスポンスデータ。

FOBSBatchResult

バッチ操作全体の結果。

フィールド	型	説明
`RequestId`	`FString`	バッチリクエスト ID。
`bAllSucceeded`	`bool`	バッチ内のすべてのリクエストが成功したかどうか。
`Results`	`TArray<FOBSBatchRequestResult>`	リクエストごとの結果。

出力

FOBSStreamStatus

配信出力のステータス。

フィールド	型	説明
`bOutputActive`	`bool`	配信がアクティブかどうか。
`bOutputReconnecting`	`bool`	現在再接続中かどうか。
`OutputTimecode`	`FString`	現在の配信タイムコード。
`OutputBytes`	`int64`	送信済み合計バイト数。
`OutputSkippedFrames`	`int32`	出力でスキップされたフレーム数。
`OutputTotalFrames`	`int32`	配信された合計フレーム数。

FOBSRecordStatus

録画出力のステータス。

フィールド	型	説明
`bOutputActive`	`bool`	録画がアクティブかどうか。
`bOutputPaused`	`bool`	録画が一時停止中かどうか。
`OutputTimecode`	`FString`	現在の録画タイムコード。
`OutputBytes`	`int64`	書き込み済み合計バイト数。

FOBSVirtualCamStatus

仮想カメラ出力のステータス。

フィールド	型	説明
`bOutputActive`	`bool`	仮想カメラがアクティブかどうか。

FOBSReplayBufferStatus

リプレイバッファのステータス。

フィールド	型	説明
`bOutputActive`	`bool`	リプレイバッファがアクティブかどうか。

FOBSReplayBufferSavedInfo

保存されたリプレイバッファクリップに関する情報。

フィールド	型	説明
`SavedReplayPath`	`FString`	保存されたリプレイファイルへのパス。

FOBSOutput

汎用 OBS 出力の説明。

フィールド	型	説明
`OutputName`	`FString`	出力の名前。
`OutputKind`	`FString`	出力の種類・タイプ。
`OutputWidth`	`int32`	出力幅（ピクセル）。
`OutputHeight`	`int32`	出力高さ（ピクセル）。
`bOutputActive`	`bool`	出力がアクティブかどうか。
`OutputFlags`	`FString`	出力の機能フラグ。

FOBSOutputStatus

汎用 OBS 出力の詳細なステータス。

フィールド	型	説明
`OutputName`	`FString`	出力の名前。
`bOutputActive`	`bool`	出力がアクティブかどうか。
`bOutputReconnecting`	`bool`	出力が再接続中かどうか。
`OutputTimecode`	`FString`	現在のタイムコード。
`OutputDuration`	`int64`	経過時間（ミリ秒）。
`OutputCongestion`	`float`	輻輳係数（0 から 1）。
`OutputBytes`	`int64`	合計バイト数。
`OutputSkippedFrames`	`int64`	スキップされたフレーム数。
`OutputTotalFrames`	`int64`	合計フレーム数。

シーンとシーンアイテム

FOBSScene

単一の OBS シーン。

フィールド	型	説明
`SceneName`	`FString`	シーン名。
`SceneUuid`	`FString`	シーンの UUID。
`SceneIndex`	`int32`	シーンリスト内でのシーンの位置。

FOBSSceneItem

シーンアイテム（シーン内に配置されたソース）。

フィールド	型	説明
`SourceName`	`FString`	基となるソースの名前。
`SourceUuid`	`FString`	ソースの UUID。
`SceneItemId`	`int32`	数値のシーンアイテム ID（OBS がアイテムを識別するために使用）。
`SceneItemIndex`	`int32`	シーン内の Z オーダーインデックス。
`bSceneItemEnabled`	`bool`	アイテムが表示状態かどうか。
`bSceneItemLocked`	`bool`	アイテムがロックされているかどうか。
`InputKind`	`FString`	入力の種類・ソースの種類。
`BlendMode`	`EOBSBlendMode`	コンポジットのブレンドモード。

FOBSSceneWithItems

シーンとそのすべてのシーンアイテムをまとめた構造体。

フィールド	型	説明
`SceneName`	`FString`	シーン名。
`SceneUuid`	`FString`	シーンの UUID。
`SceneIndex`	`int32`	シーンリスト内での位置。
`SceneItems`	`TArray<FOBSSceneItem>`	シーンのアイテム一覧。

FOBSSceneItemTransform

シーンアイテムの完全なトランスフォーム（位置、回転、スケール、アライメント、バウンド、クロップ）。読み取り専用の計算済みフィールドは GetSceneItemTransform によって設定されます。

フィールド	型	説明
`PositionX`	`float`	X 位置（ピクセル）。
`PositionY`	`float`	Y 位置（ピクセル）。
`Rotation`	`float`	回転角度（0 から 360 度）。
`ScaleX`	`float`	水平方向のスケール倍率（1.0 = 100%）。
`ScaleY`	`float`	垂直方向のスケール倍率（1.0 = 100%）。
`Alignment`	`int32`	アライメントのビットフラグ（0=Center、1=Left、2=Right、4=Top、8=Bottom）。
`BoundsType`	`EOBSBoundsType`	バウンディングボックスの動作。
`BoundsWidth`	`float`	バウンディングボックスの幅。
`BoundsHeight`	`float`	バウンディングボックスの高さ。
`BoundsAlignment`	`int32`	バウンド内のアライメント（同一ビットフラグ）。
`CropLeft`	`int32`	左からクロップするピクセル数。
`CropRight`	`int32`	右からクロップするピクセル数。
`CropTop`	`int32`	上からクロップするピクセル数。
`CropBottom`	`int32`	下からクロップするピクセル数。
`SourceWidth`	`float`	ソースのネイティブ幅（読み取り専用）。
`SourceHeight`	`float`	ソースのネイティブ高さ（読み取り専用）。
`Width`	`float`	スケーリング後の計算済み幅（読み取り専用）。
`Height`	`float`	スケーリング後の計算済み高さ（読み取り専用）。

FOBSCreateSceneResult

シーン作成の結果。

フィールド	型	説明
`bSuccess`	`bool`	シーンが作成されたかどうか。
`SceneUuid`	`FString`	新しいシーンの UUID。
`ErrorMessage`	`FString`	失敗時のエラーテキスト。

FOBSSourceActiveState

ソースがプログラムまたは UI に表示されているかどうか。

フィールド	型	説明
`bVideoActive`	`bool`	プログラムに表示中。
`bVideoShowing`	`bool`	UI（プレビュー、プロジェクター、プロパティ）に表示中。

FOBSSceneTransitionOverride

シーンごとのトランジションの上書き。

フィールド	型	説明
`TransitionName`	`FString`	上書き後のトランジション名（なしの場合は空文字列）。
`TransitionDuration`	`int32`	上書き後の時間（ミリ秒。なしの場合は -1）。
`bHasOverride`	`bool`	上書きが設定されているかどうか。

FOBSSceneItemSource

シーンアイテムの基となるソースを識別する構造体。

フィールド	型	説明
`SourceName`	`FString`	ソース名。
`SourceUuid`	`FString`	ソースの UUID。

音声

FOBSAudioTracks

高度な音声ルーティング用の音声トラックごとの有効状態（トラック 1 から 6）。C++ では InitFromJson、ToJson、IsTrackEnabled、SetTrackEnabled ヘルパーが提供されています。

フィールド	型	説明
`bTrack1`	`bool`	トラック 1 が有効（デフォルト true）。
`bTrack2`	`bool`	トラック 2 が有効。
`bTrack3`	`bool`	トラック 3 が有効。
`bTrack4`	`bool`	トラック 4 が有効。
`bTrack5`	`bool`	トラック 5 が有効。
`bTrack6`	`bool`	トラック 6 が有効。

FOBSInput

音声プロパティを含む OBS 入力ソース。

フィールド	型	説明
`InputName`	`FString`	入力名。
`InputUuid`	`FString`	入力の UUID。
`InputKind`	`FString`	入力の種類・タイプ。
`VolumeDb`	`float`	デシベル単位の音量（0 = ユニティ）。
`VolumeMul`	`float`	倍率としての音量（1.0 = ユニティ）。
`bMuted`	`bool`	入力がミュートされているかどうか。
`bAudioInfoLoaded`	`bool`	音量・ミュート情報が取得済みかどうか。
`Balance`	`float`	ステレオバランス（0 = 左、0.5 = 中央、1 = 右）。
`SyncOffsetMs`	`int32`	音声の同期オフセット（ミリ秒。負の値もあり得る）。
`MonitorType`	`EOBSMonitorType`	音声モニタリング種別。
`AudioTracks`	`FOBSAudioTracks`	トラックルーティング（1 から 6）。
`bAdvancedAudioInfoLoaded`	`bool`	高度な音声情報が取得済みかどうか。

FOBSSpecialInputs

OBS で設定されているデフォルト音声デバイスの名前（空になる場合もあります）。

フィールド	型	説明
`Desktop1`	`FString`	Desktop Audio 入力。
`Desktop2`	`FString`	Desktop Audio 2 入力。
`Mic1`	`FString`	Mic/Auxiliary Audio 入力。
`Mic2`	`FString`	Mic/Auxiliary Audio 2 入力。
`Mic3`	`FString`	Mic/Auxiliary Audio 3 入力。
`Mic4`	`FString`	Mic/Auxiliary Audio 4 入力。

FOBSAudioChannelLevel

高頻度の InputVolumeMeters イベントから得られるチャンネルごとの音声レベル。OBS は線形倍率（0 から 1）で送信し、dB フィールドはその値から導出されます。

フィールド	型	説明
`MagnitudeMul`	`float`	平滑化されたマグニチュード、線形倍率（0 から 1）。
`PeakMul`	`float`	減衰するピーク値、線形倍率（0 から 1）。
`InputPeakMul`	`float`	瞬間的な入力ピーク値、線形倍率（0 から 1）。
`MagnitudeDb`	`float`	デシベル単位のマグニチュード（`MagnitudeMul` から導出）。
`PeakDb`	`float`	デシベル単位のピーク値（`PeakMul` から導出）。

FOBSInputVolumeMeter

InputVolumeMeters イベント内の単一入力に対する音量メーターの読み取り値。PeakDb/MagnitudeDb は最も大きいチャンネルの値を要約したものです。

フィールド	型	説明
`InputName`	`FString`	入力名。
`InputUuid`	`FString`	入力の UUID。
`Channels`	`TArray<FOBSAudioChannelLevel>`	チャンネルごとのレベル。
`PeakDb`	`float`	最も大きいチャンネルのピーク値（デシベル）。
`MagnitudeDb`	`float`	最も大きいチャンネルのマグニチュード（デシベル）。

設定

FOBSVideoSettings

OBS のキャンバスおよび出力の解像度・フレームレート設定。GetFPS() ヘルパーが提供されています。

フィールド	型	説明
`FpsNumerator`	`int32`	FPS の分子（例: 60、または 29.97 の場合は 30000）。
`FpsDenominator`	`int32`	FPS の分母（例: 1、または 29.97 の場合は 1001）。
`BaseWidth`	`int32`	ベース（キャンバス）幅（ピクセル）。
`BaseHeight`	`int32`	ベース（キャンバス）高さ（ピクセル）。
`OutputWidth`	`int32`	出力（スケール後）幅（ピクセル）。
`OutputHeight`	`int32`	出力（スケール後）高さ（ピクセル）。

FOBSProfileParameter

プロファイルパラメーターの値とそのデフォルト値。

フィールド	型	説明
`ParameterValue`	`FString`	現在の値。
`DefaultParameterValue`	`FString`	デフォルト値。

FOBSStreamServiceSettings

配信先の設定。InitFromJson/ToJson および C++ 専用の RawSettings ミラーが提供されています。

フィールド	型	説明
`StreamServiceType`	`FString`	サービスタイプ（`"rtmp_custom"`、`"rtmp_common"`）。
`Server`	`FString`	サーバー URL（`rtmp_custom` 用）。
`Key`	`FString`	ストリームキー。
`Service`	`FString`	`rtmp_common` 用のサービス名（例: “Twitch”）。
`bUseAuth`	`bool`	認証を使用するかどうか。
`Username`	`FString`	認証ユーザー名。
`Password`	`FString`	パスワード。
`RawSettings`	`TSharedPtr<FJsonObject>`	C++ 専用の高度な用途向け生設定。

トランジション

FOBSTransition

OBS のシーントランジション。

フィールド	型	説明
`TransitionName`	`FString`	トランジション名。
`TransitionUuid`	`FString`	トランジションの UUID。
`TransitionKind`	`FString`	種類（例: `"fade_transition"`、`"cut_transition"`）。
`bTransitionConfigurable`	`bool`	設定可能かどうか。
`bTransitionFixed`	`bool`	固定時間（カットのように）かどうか。

FOBSCurrentTransitionInfo

現在のシーントランジションに関する詳細情報。

フィールド	型	説明
`TransitionName`	`FString`	現在のトランジション名。
`TransitionUuid`	`FString`	現在のトランジションの UUID。
`TransitionKind`	`FString`	トランジションの種類。
`TransitionDuration`	`int32`	トランジション時間（ミリ秒、固定でない場合）。
`bTransitionConfigurable`	`bool`	設定可能かどうか。
`bTransitionFixed`	`bool`	固定時間かどうか。
`TransitionSettingsJson`	`FString`	JSON 文字列としての設定（Blueprint 向け）。
`TransitionSettings`	`TSharedPtr<FJsonObject>`	C++ 専用のパース済み設定。

フィルター

FOBSSourceFilter

ソースに適用されたフィルター。

フィールド	型	説明
`FilterName`	`FString`	フィルター名。
`FilterIndex`	`int32`	ソースのフィルターチェーン内での位置。
`FilterKind`	`FString`	フィルターの種類（例: `"color_filter"`、`"chroma_key_filter"`）。
`bFilterEnabled`	`bool`	フィルターが有効かどうか。
`FilterSettingsJson`	`FString`	JSON 文字列としての設定（Blueprint 向け）。
`FilterSettings`	`TSharedPtr<FJsonObject>`	C++ 専用のパース済み設定。

FOBSFilterKind

利用可能なフィルターの種類。

フィールド	型	説明
`FilterKind`	`FString`	フィルターの種類の内部名・識別子。

スクリーンショット

FOBSScreenshotRequest

GetSourceScreenshot / SaveSourceScreenshot のパラメーター。

フィールド	型	説明
`SourceName`	`FString`	キャプチャするソース（入力またはシーン）。
`SourceUuid`	`FString`	ソースの UUID（名前の代替）。
`ImageFormat`	`FString`	画像フォーマット（`png`、`jpg`、`bmp`、`webp` など、デフォルトは `png`）。
`ImageWidth`	`int32`	スケール後の幅（-1 = ネイティブ）。
`ImageHeight`	`int32`	スケール後の高さ（-1 = ネイティブ）。
`ImageCompressionQuality`	`int32`	非可逆フォーマットの品質（0 から 100。-1 = OBS デフォルト）。
`ImageFilePath`	`FString`	OBS マシン上の絶対パス（Save のみ）。

FOBSScreenshotResult

GetSourceScreenshot の結果（Base64 画像データ）。

フィールド	型	説明
`bSuccess`	`bool`	キャプチャが成功したかどうか。
`ErrorMessage`	`FString`	失敗時のエラーテキスト。
`SourceName`	`FString`	キャプチャされたソース。
`ImageData`	`FString`	Base64 エンコードされた画像データ（data-URI プレフィックスを含み、サイズが大きくなる場合があります）。

FOBSScreenshotSavedResult

SaveSourceScreenshot の結果。

フィールド	型	説明
`bSuccess`	`bool`	保存が成功したかどうか。
`ErrorMessage`	`FString`	失敗時のエラーテキスト。
`SourceName`	`FString`	キャプチャされたソース。
`FilePath`	`FString`	スクリーンショットが保存された絶対パス。

全般

FOBSStats

GetStats から取得できる OBS のパフォーマンス・ランタイム統計。フレームカウンターは double 型です。これは、長時間セッションで int32 を超えうる JSON 数値として OBS が報告するためです。

フィールド	型	説明
`CpuUsage`	`double`	CPU 使用率（0 から 100%）。
`MemoryUsage`	`double`	OBS が使用しているメモリ（MB）。
`AvailableDiskSpace`	`double`	録画デバイスの空きディスク容量（MB）。
`ActiveFps`	`double`	現在のレンダースレッドの FPS。
`AverageFrameRenderTime`	`double`	平均フレームレンダリング時間（ミリ秒）。
`RenderSkippedFrames`	`double`	レンダースレッドでスキップされたフレーム数。
`RenderTotalFrames`	`double`	レンダースレッドが処理した合計フレーム数。
`OutputSkippedFrames`	`double`	出力スレッドでスキップされたフレーム数。
`OutputTotalFrames`	`double`	出力スレッドが配信した合計フレーム数。
`WebSocketSessionIncomingMessages`	`double`	このセッションの受信メッセージ合計数。
`WebSocketSessionOutgoingMessages`	`double`	このセッションの送信メッセージ合計数。

FOBSPropertyItem

GetInputPropertiesListPropertyItems から返される OBS の「リスト」プロパティ（例: キャプチャソースのデバイスドロップダウン）の 1 エントリ。

フィールド	型	説明
`ItemName`	`FString`	ドロップダウンに表示される人間が読めるラベル。
`bItemEnabled`	`bool`	アイテムが選択可能かどうか。
`ItemValue`	`FString`	アイテムの値（デバイス ID・パス。数値やブール値は文字列化されます）。

メディア入力

FOBSMediaInputStatus

メディア入力（Media Source、VLC Source など）のステータス。

フィールド	型	説明
`InputName`	`FString`	メディア入力名。
`MediaState`	`EOBSMediaState`	現在の再生状態。
`MediaDuration`	`int64`	合計時間（ミリ秒）。
`MediaCursor`	`int64`	現在のカーソル位置（ミリ秒）。

Trigger Volume（ゲームプレイ）

これらの構造体は Trigger Volume アクタを設定します。

FOBSTriggerAction

トリガー発火時に実行される単一のアクション。ほとんどのフィールドは特定の ActionType 値にのみ関連します（エディタの編集条件によってゲートされます）。

フィールド	型	説明
`ActionType`	`EOBSTriggerActionType`	実行するアクション。
`SceneName`	`FString`	シーン名（SwitchScene、または SetSceneItemEnabled でソースを含むシーン）。
`InputName`	`FString`	音声・メディアアクション用の入力名。
`SourceName`	`FString`	SetSceneItemEnabled / SetSourceFilterEnabled のソース。
`FilterName`	`FString`	SetSourceFilterEnabled のフィルター名。
`HotkeyName`	`FString`	TriggerHotkeyByName のホットキー名（例: `"OBSBasic.StartRecording"`）。
`MediaAction`	`EOBSMediaInputAction`	TriggerMediaInputAction のメディア操作。
`bMuted`	`bool`	SetInputMute のミュート（true）/ ミュート解除（false）。
`bEnabled`	`bool`	SetSceneItemEnabled / SetSourceFilterEnabled の有効状態。
`VolumeDb`	`float`	SetInputVolume の音量（dB。-100 から 26 にクランプ）。
`DelaySeconds`	`float`	アクション実行前のオプションの遅延時間（秒）。

FOBSAudioThresholdCondition

条件: OBS 入力が現在発話中かアイドル状態かどうか（デバウンス処理済みのマイクアクティビティ）。

フィールド	型	説明
`InputName`	`FString`	テスト対象の入力（空の場合は条件を無視）。
`Mode`	`EOBSAudioConditionMode`	発話中またはアイドルを要求。
`ThresholdDb`	`float`	自動登録された検出器のピーク dB しきい値（-100 から 0 にクランプ、デフォルト -40）。

FOBSSourceVisibleCondition

条件: 指定されたシーンアイテム（ソース）が現在表示中か非表示かどうか。ライブの bSceneItemEnabled キャッシュを参照します。キャッシュミスの場合は条件が失敗します。

フィールド	型	説明
`SceneName`	`FString`	ソースを含むシーン（空の場合は条件を無視）。
`SourceName`	`FString`	表示状態をテストするソース（空の場合は条件を無視）。
`Mode`	`EOBSVisibilityConditionMode`	表示中または非表示を要求。

FOBSTriggerConditions

トリガーを実行するためにすべて満たす必要がある条件（AND ロジック）。OBS への接続は常に必須であり、内部でチェックされます。

フィールド	型	説明
`RecordingRequirement`	`EOBSOutputStateRequirement`	録画状態によるゲート。
`StreamingRequirement`	`EOBSOutputStateRequirement`	配信状態によるゲート。
`RequiredCurrentScene`	`FString`	現在のシーンが一致する場合のみトリガー（空 = 任意）。
`ExcludedCurrentScene`	`FString`	現在のシーンが一致しない場合のみトリガー（空 = 無効）。
`AudioConditions`	`TArray<FOBSAudioThresholdCondition>`	音声しきい値条件。すべて満たす必要があります（空 = ゲートなし）。
`SourceVisibleConditions`	`TArray<FOBSSourceVisibleCondition>`	ソース表示状態条件。すべて満たす必要があります（空 = ゲートなし）。

シーケンサー

FOBSSequencerActionParams

OBS Sequencer アクションのパラメーター。必要なフィールドはアクションによって異なります。Sequencer アクションを参照してください。

フィールド	型	説明
`Action`	`EOBSSequencerAction`	実行するアクション。
`TargetName`	`FString`	主要ターゲット（シーン・入力・ソース名）。
`SecondaryTarget`	`FString`	副次ターゲット（フィルター名、シーンアイテム ID など）。
`StringValue`	`FString`	文字列値（テキスト、URL、ファイルパス、キャプション、設定名など）。
`NumericValue`	`float`	主要数値（X 座標、音量 dB、時間 ms など）。
`NumericValue2`	`float`	副次数値（Y 座標など）。
`NumericValue3`	`float`	第三数値（右クロップなど）。
`NumericValue4`	`float`	第四数値（下クロップなど）。
`BoolValue`	`bool`	ブール値（有効化・表示状態）。

ヘルパーメソッド: GetCategory()、GetTriggerType()、GetDisplayName()、IsValid(FText& OutError)。いずれもアクションレジストリを参照します。

FOBSSequencerActionMetadata

1 つのアクションのパラメーター、ラベル、範囲、トリガータイプ、ターゲットピッカータイプを記述するエディタ側のメタデータ。FOBSSequencerActionRegistry::GetMetadata によって返されます。BlueprintType ではないため、シーケンサー UI とバリデーションのみで使用されます。主要フィールドには Action、Category、TriggerType、DisplayName、Description、TargetPickerType、パラメーターごとの bRequires* フラグと対応する *Label テキスト、および数値の *Min/*Max 範囲が含まれます。