Table of Contents

Method GetMonitorsAsync

Namespace
OBSStudioClient.Model
Assembly
OBSClient.dll

GetMonitorsAsync(CancellationToken)

Asks OBS Studio for the monitors that it sees.

public Task<IReadOnlyList<Monitor>> GetMonitorsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token that ends the wait. A request that was not sent yet is not sent.

Returns

Task<IReadOnlyList<Monitor>>

The monitors, with the index that OpenVideoMixProjectorAsync(MixType, int?, string?, CancellationToken) and OpenProjectorAsync(int?, string?, CancellationToken) take.

Exceptions

ObsNotConnectedException

There is no connection to OBS Studio.

ObsNotReadyException

OBS Studio is changing its scene collection, or did so after the call.

TimeoutException

OBS Studio did not answer in time (WriteTimeout).