Table of Contents

Method CallVendorRequest

Namespace
OBSStudioClient
Assembly
OBSClient.dll

CallVendorRequest(string, string, JsonElement?, CancellationToken)

Call a request registered to a vendor.

public Task<CallVendorResponse> CallVendorRequest(string vendorName, string requestType, JsonElement? requestData = null, CancellationToken cancellationToken = default)

Parameters

vendorName string

Name of the vendor to use.

requestType string

The request type to call.

requestData JsonElement?

Object containing appropriate request data. If omitted: {}.

cancellationToken CancellationToken

A token that ends the wait for the response, which makes the method throw an OperationCanceledException. A request that was already sent is not undone: OBS Studio may still carry it out.

Returns

Task<CallVendorResponse>

A CallVendorResponse with the response data.

Remarks

A vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket. If a plugin or script implements vendor requests or events, documentation is expected to be provided with them.