Method SendRequestBatchAsync

Namespace

OBSStudioClient

Assembly

OBSClient.dll

SendRequestBatchAsync(RequestBatchMessage, int?, CancellationToken)

Sends a Batch Request.

public Task<RequestResponseMessage[]> SendRequestBatchAsync(RequestBatchMessage requestBatchMessage, int? timeOutInMilliseconds = null, CancellationToken cancellationToken = default)

Parameters

requestBatchMessage RequestBatchMessage

The RequestBatchMessage to send.

timeOutInMilliseconds int?

The timeout for the request. (Defauls to RequestTimeout.)

cancellationToken CancellationToken

A token that ends the wait for the responses, which makes the method throw an OperationCanceledException. A batch that was already sent is not undone: OBS Studio may still run it.

Returns

Task<RequestResponseMessage[]>

The responses for the individual requests.

Remarks

Since batch requests typically take more time than individual request, you have the opportunity here to override the default timeout for this specific call.