Most of these functions are here to remove the need to create a new request for information that is already tracked by the mod, like the recording status for example.

bool IsConnected()

Returns true if the client is connected to OBS, ready to send requests and receive events.

bool IsReplayBufferActive()

Returns true if the replay buffer is active.

bool IsRecordingActive()

Returns true if recording is active.

bool IsStreamActive()

Returns true if streaming is active.

void Connect()

Forces the mod to open a websocket connection. If it was already connected, the old connection is killed and a new one is initiated.

void Disconnect()

Forces the mod to close the websocket connection. The mod will not attempt to reconnect by itself.

void HapticFeedback(float intensity, float duration)

Execute a haptic impulse on both controllers. Can be used to implement your own haptic feedback for various events.

• those that return a specific response return a predefined structure that is specific to the request type. If the request fails, they return null.
• the other ones return a boolean: true if successful, false if failed.

RequestResponse.GetReplayBufferStatus GetReplayBufferStatus()

Fetches the current status of the replay buffer.

public class GetReplayBufferStatus
{
    public bool outputActive { Get; Set; }
}

RequestResponse.GetRecordStatus GetRecordStatus()

Fetches the current recording status.

public class GetRecordStatus
{
    public bool outputActive { Get; Set; }
    public bool outputPaused { Get; Set; }
    public string outputTimecode { Get; Set; }
    public int outputDuration { Get; Set; }
    public long outputBytes { Get; Set; }
}

RequestResponse.GetStreamStatus GetStreamStatus()

Fetches the current streaming status.

public class GetStreamStatus
{
    public bool outputActive { Get; Set; }
    public bool outputReconnecting { Get; Set; }
    public string outputTimecode { Get; Set; }
    public int outputDuration { Get; Set; }
    public float outputCongestion { Get; Set; }
    public long outputBytes { Get; Set; }
    public int outputSkippedFrames { Get; Set; }
    public int outputTotalFrames { Get; Set; }
}

RequestResponse.GetVersion GetVersion()

Fetches the version of OBS and the negociated protocol parameters.

public class GetVersion
{
    public string obsVersion { Get; Set; }
    public string obsWebSocketVersion { Get; Set; }
    public int rpcVersion { Get; Set; }
    public string[] availableRequests { Get; Set; }
    public string[] supportedImageFormats { Get; Set; }
    public string platform { Get; Set; }
    public string platformDescription { Get; Set; }
}

bool StartStream()

Starts the stream.

bool StopStream()

Stops the stream.

bool StartReplayBuffer()

Starts the replay buffer.

bool StopReplayBuffer()

Stops the replay buffer.

bool SaveReplayBuffer()

Saves the replay buffer.

RequestResponse.GetLastReplayBufferReplay GetLastReplayBufferReplay()

Gets the name of the file that the replay buffer was saved to last time.

public class GetLastReplayBufferReplay
{
    public string savedReplayPath { Get; Set; }
}

bool StartRecord()

Starts recording.

RequestResponse.StopRecord StopRecord()

Stops recording.

public class StopRecord
{
    public string outputPath { Get; Set; }
}

RequestResponse.ToggleRecord ToggleRecord()

Toggles the recording status. Stops it if it was running, starts it if it wasn't. Doesn't do anything if it's in the "stopping" state.

public class ToggleRecord
{
    public bool outputActive { Get; Set; }
}

bool PauseRecord()

Pauses recording.

bool ResumeRecord()

Resumes recording.

bool SplitRecordFile()

Splits the current file being recorded into a new file.

RequestResponse.GetRecordDirectory GetRecordDirectory()

Gets the current directory that recording is saved to.

public class GetRecordDirectory
{
    public string recordDirectory { Get; Set; }
}

bool SetRecordDirectory(string recordDirectory)

Sets a new directory to write recording files to.

string SendRequest(string requestType, object parameters)

Generic request function that can be used for requests that are not in the list above. The parameters object needs to be constructed specifically for the request type. The returned string is the extracted responseData json, it needs to be parsed differently depending on the request type. It may be null if the request type does not have a response in the API.

To see the full list of requests and their parameters, check the official documentation.

string SendRequest(string requestType)

Same as the previous one but for requests that do not require any parameters.

public static event Action onConnect;
public static event Action onDisconnect;
public static event Action<OBS_Control_API.Event> onEvent; //generic type OBS_Msg_Types.Event
public static event Action<string> onReplayBufferSaved; // savedReplayPath
public static event Action onReplayBufferStarted;
public static event Action onReplayBufferStopped;
public static event Action<string> onRecordingStarted;  // outputPath
public static event Action<string> onRecordingStopping; // outputPath
public static event Action<string> onRecordingStopped;  // outputPath
public static event Action onRecordingPaused;
public static event Action onRecordingResumed;
public static event Action onStreamStarted;
public static event Action onStreamStopped;
public static event Action<string> onRecordFileChanged; //newOutputPath

Note that onConnect is triggered after the client is connected and identified, ie when the mod is ready to send requests and receive events. If the client connects but fails to authenticate, the event will not trigger.

The event onEvent is a generic one that is triggered on all events that are received from You can use this if the event you want to suscribe to isn't on the list. The class has a simple structure:

• object eventData that depends on the event and needs to be parsed
• int eventIntent the EventSubscription value (why the event was received)
• string eventType the type of event that was received

To see the full list of events and their parameters, check the official documentation.