イベント
これらのイベントを購読することで、OBS の状態変化に反応できます。UInhyeongOBSSubsystem(および UInhyeongOBSComponent にミラー)上の BlueprintAssignable マルチキャストデリゲートとして公開されています。
ネイティブデリゲート: 下記の各 Blueprint イベントには、ラムダバインディングをサポートする
Nativeサフィックス付きの C++ 対応版があります(例:OnConnectedNative、OnCurrentSceneChangedNative、OnReplayBufferSavedNative)。シグネチャを含む完全なリストは Native Delegates を参照してください。OBS->OnConnectedNative.AddLambda([]() { /* ... */ });
ハンドラーレベル限定: 一部のイベントは Subsystem にミラーされず、ハンドラー側でバインドする必要があります。特にスクリーンショットイベント(
OnScreenshotCaptured/OnScreenshotSaved)はGetScreenshots()経由でバインドします(Subsystem もこの 2 つを再ブロードキャストします)。また、読み取り結果イベント(OnStreamServiceSettingsReceived、OnTransitionOverrideReceived、OnInputSettingsReceived、メディアイベントなど)はそれぞれのハンドラーから発火します。詳細は Handlers API を参照してください。
設定
| イベント | パラメーター | 意味 |
|---|---|---|
OnCurrentSceneCollectionChanging | (SceneCollectionName) | シーンコレクションを切り替えようとしている。 |
OnCurrentSceneCollectionChanged | (SceneCollectionName) | シーンコレクションが変更された。 |
OnSceneCollectionListChanged | () | シーンコレクション一覧が変更された。 |
OnCurrentProfileChanging | (ProfileName) | プロファイルを切り替えようとしている。 |
OnCurrentProfileChanged | (ProfileName) | プロファイルが変更された。 |
OnProfileListChanged | () | プロファイル一覧が変更された。 |
OnStreamServiceSettingsReceived | (Settings) | 配信サービス設定が取得された(ハンドラーレベル)。 |
接続
| イベント | パラメーター | 意味 |
|---|---|---|
OnConnected | () | OBS への接続と識別に成功した。 |
OnDisconnected | (Reason) | OBS から切断された。 |
OnConnectionError | (Error) | 接続に失敗した。 |
再接続
| イベント | パラメーター | 意味 |
|---|---|---|
OnReconnecting | (AttemptNumber) | 再接続の試行が開始された。 |
OnReconnectFailed | () | すべての再接続試行が失敗した。 |
シーン
| イベント | パラメーター | 意味 |
|---|---|---|
OnCurrentSceneChanged | (SceneName, SceneUuid) | アクティブなプログラムシーンが変更された。 |
OnSceneListUpdated | () | シーン一覧が更新された。 |
OnSceneCreated | (SceneName, SceneUuid, bIsGroup) | 新しいシーンが作成された。 |
OnSceneRemoved | (SceneName, SceneUuid, bIsGroup) | シーンが削除された。 |
OnSceneNameChanged | (SceneUuid, OldSceneName, NewSceneName) | シーンの名前が変更された。 |
OnTransitionOverrideReceived | (SceneName, Override) | シーントランジションの上書きデータが取得された(ハンドラーレベル)。 |
シーンアイテム
| イベント | パラメーター | 意味 |
|---|---|---|
OnSceneItemTransformChanged | (SceneName, SceneItemId, Transform) | シーンアイテムのトランスフォームが変更された(高頻度;オプトイン)。 |
OnSceneItemCreated | (SceneName, SourceName, SceneItemId, SceneItemIndex) | シーンにアイテムが追加された。 |
OnSceneItemRemoved | (SceneName, SourceName, SceneItemId) | シーンからアイテムが削除された。 |
OnSceneItemEnableStateChanged | (SceneName, SceneItemId, bEnabled) | アイテムの表示状態が切り替えられた。 |
OnSceneItemLockStateChanged | (SceneName, SceneItemId, bLocked) | アイテムのロック状態が切り替えられた。 |
OnSceneItemListReindexed | (SceneName) | シーン内のアイテムが並び替えられた(Z オーダーが変更された)。 |
出力
| イベント | パラメーター | 意味 |
|---|---|---|
OnStreamStateChanged | (bActive, State) | 配信の状態が変更された。 |
OnRecordStateChanged | (bActive, State) | 録画の状態が変更された。 |
OnVirtualCamStateChanged | (bActive, State) | 仮想カメラの状態が変更された。 |
OnReplayBufferStateChanged | (bActive, State) | リプレイバッファの状態が変更された。 |
OnReplayBufferSaved | (FilePath) | リプレイがファイルに保存された。 |
OnRecordFileChanged | (NewOutputPath) | 録画が新しいファイルへの書き込みを開始した(分割)。 |
OnRecordDirectoryReceived | (RecordDirectory) | 録画の保存先ディレクトリが取得された。 |
OnOutputListReceived | (Outputs) | 出力一覧が取得された。 |
OnOutputStatusReceived | (Status) | 出力のステータスが取得された。 |
音声 / 入力
| イベント | パラメーター | 意味 |
|---|---|---|
OnInputMuteStateChanged | (InputName, bMuted) | 入力のミュート状態が変更された。 |
OnInputVolumeChanged | (InputName, VolumeDb, VolumeMul) | 音量が変更された。 |
OnInputVolumeMeters | (Meters) | 入力ごとの高頻度な音声レベル(SetVolumeMetersEnabled によるオプトイン)。 |
OnInputActiveStateChanged | (InputName, bVideoActive) | 入力の映像アクティブ状態が変更された(SetInputActiveStateEventsEnabled によるオプトイン)。 |
OnMicActivityChanged | (InputName, bActive) | 監視中の入力で発話中とアイドルの間のデバウンスされた遷移が発生した。 |
OnInputAudioBalanceChanged | (InputName, InputUuid, Balance) | ステレオバランスが変更された。 |
OnInputAudioSyncOffsetChanged | (InputName, InputUuid, SyncOffsetMs) | 同期オフセットが変更された。 |
OnInputAudioTracksChanged | (InputName, InputUuid, AudioTracks) | トラックのルーティングが変更された。 |
OnInputAudioMonitorTypeChanged | (InputName, InputUuid, MonitorType) | モニタリング種別が変更された。 |
OnSpecialInputsReceived | (SpecialInputs) | デフォルトの音声デバイスが取得された。 |
OnInputSettingsChanged | (InputName, InputUuid) | 入力の設定が変更された(通知のみ)。 |
OnInputSettingsReceived | (InputName, InputKind, Settings) | 入力の設定データが取得された(全データ含む、ハンドラーレベル)。 |
OnInputListUpdated | () | 入力一覧が更新された。 |
OnInputCreated | (InputName, InputUuid, InputKind, UnversionedInputKind) | 新しい入力が作成された。 |
OnInputRemoved | (InputName, InputUuid) | 入力が削除された。 |
OnInputNameChanged | (InputUuid, OldInputName, NewInputName) | 入力の名前が変更された。 |
OnInputKindListReceived | (InputKinds) | 利用可能な入力の種類一覧が取得された。 |
Studio Mode
| イベント | パラメーター | 意味 |
|---|---|---|
OnStudioModeStateChanged | (bEnabled) | Studio Mode が有効化/無効化された。 |
OnCurrentPreviewSceneChanged | (SceneName, SceneUuid) | プレビューシーンが変更された。 |
トランジション
| イベント | パラメーター | 意味 |
|---|---|---|
OnCurrentTransitionChanged | (TransitionName) | アクティブなトランジションが変更された。 |
OnTransitionDurationChanged | (DurationMs) | トランジション時間が変更された。 |
OnTransitionStarted | (TransitionName) | シーントランジションが開始された。 |
OnTransitionEnded | (TransitionName) | シーントランジションが完了した。 |
OnTransitionVideoEnded | (TransitionName) | トランジションの映像が終了した(スティンガートランジションに有用)。 |
OnTransitionListUpdated | () | トランジション一覧が更新された。 |
フィルター
| イベント | パラメーター | 意味 |
|---|---|---|
OnSourceFilterCreated | (SourceName, FilterName, FilterKind, FilterIndex, bEnabled) | ソースにフィルターが追加された。 |
OnSourceFilterRemoved | (SourceName, FilterName) | ソースからフィルターが削除された。 |
OnSourceFilterNameChanged | (SourceName, OldName, NewName) | フィルターの名前が変更された。 |
OnSourceFilterSettingsChanged | (SourceName, FilterName) | フィルターの設定が変更された。 |
OnSourceFilterEnableStateChanged | (SourceName, FilterName, bEnabled) | フィルターが有効化/無効化された。 |
OnSourceFilterListReindexed | (SourceName) | ソース上のフィルターの順序が変更された。 |
スクリーンショット
ハンドラーレベル:
GetScreenshots()経由でバインドします。Subsystem もこの 2 つのイベントを再ブロードキャストします。
| イベント | パラメーター | 意味 |
|---|---|---|
OnScreenshotCaptured | (Result) | スクリーンショットがメモリにキャプチャされた(base64 データを含む)。 |
OnScreenshotSaved | (SourceName, FilePath) | OBS マシン上のファイルにスクリーンショットが保存された。 |
メディア
ハンドラーレベル:
GetMediaInputs()経由でバインドします。
| イベント | パラメーター | 意味 |
|---|---|---|
OnMediaInputPlaybackStarted | (InputName) | メディアの再生が開始された。 |
OnMediaInputPlaybackEnded | (InputName) | メディアの再生が終了した。 |
OnMediaInputActionTriggered | (InputName, Action) | メディアアクションがトリガーされた。 |
OnMediaInputStatusReceived | (Status) | メディアのステータスが取得された。 |
関連項目
- Subsystem API:これらのイベントが報告するデータの取得や状態変更を行うメソッド。
- Native Delegates:ラムダバインディング用の
Nativeサフィックス付き C++ 対応版。 - Handlers API:ハンドラーレベルのイベントと
GetXxx()アクセサー。