Skip to content

Development Usage

Mabel Amber edited this page May 3, 2025 · 2 revisions

Methods

Hooks

  1. OnConnected
  2. OnDisconnected
  3. OnRecordStateChanged
  4. OnReplayBufferSaved
  5. OnReplayBufferStateChanged
  6. OnStreamStateChanged
  7. OnSceneChanged
  8. OnSceneCreated
  9. OnSceneRemoved
  10. OnVirtualCamStateChanged

Scenes

  1. GetScenes

Returns a list of all scene names in the currently active OBS profile.

  1. SetScene

Sets the active scene through it's name.

  1. GetActiveScene

Gets the currently active scene's name.

Statuses

  1. Connected
  2. ReplayBufferActive
  3. StreamActive
  4. RecordActive
  5. RecordPaused
  6. VirtualCamActive

Recording

  1. StartRecording
  2. PauseRecording
  3. ResumeRecording
  4. StopRecording

Streaming

  1. StartStreaming
  2. StopStreaming

Replay Buffer

  1. StartReplayBuffer
  2. StopReplayBuffer
  3. SaveReplayBuffer

Hotkeys

  1. TriggerHotkeyByName

Executes a hotkey from it's name (e.g. "ReplayBuffer.Save")

Examples

OBSControl - BONELAB

https://thunderstore.io/c/bonelab/p/SoulWithMae/OBSControl/

https://github.com/WeatherElectric/OBSControl

Clone this wiki locally