API reference

This reference is generated from the XML documentation in the source of the library. The documentation of the requests, the responses and the events comes from the obs-websocket protocol definition, so it says what the protocol says.

Start here

Type	What it is
ObsClient	The client: the connection, every request, every event.
RequestBatchMessage	Builds a request batch.
EventSubscriptions	Chooses the events to receive.
SceneRef, InputRef, SourceRef	A scene, an input or a source, by name or by UUID.
SceneItemTransformUpdate	A change to part of the transform of a scene item.
ObsResponseException, ObsClientException	What a failed request throws.

Namespaces

Namespace	Contains
OBSStudioClient	ObsClient, and the arguments of its ConnectionClosed event.
OBSStudioClient.Classes	The objects of the protocol: scenes, inputs, scene items, canvases, filters, transitions, monitors, and the references (SceneRef, InputRef, SourceRef).
OBSStudioClient.Enums	The enumerations: ConnectionState, EventSubscriptions, RequestStatusCode, RequestBatchExecutionType, ObsOutputState, and more.
OBSStudioClient.Events	The arguments of the events of OBS Studio.
OBSStudioClient.Exceptions	ObsClientException and ObsResponseException.
OBSStudioClient.Messages	RequestBatchMessage, and the messages that are exchanged with OBS Studio.
OBSStudioClient.Responses	The responses that requests return.
OBSStudioClient.Interfaces	The interfaces of messages and responses.

Looking for a request?

Every request of the protocol is a method of ObsClient with the name of the request, for example GetSceneList and SetCurrentProgramScene. Use the search box at the top of the page, or open ObsClient and look through its methods. The articles explain the concepts, and the test app lets you try a request by hand.