Method GetAllAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetAllAsync(CancellationToken)
Asks OBS Studio for every output that it has: its own, and those that plugins add.
public Task<IReadOnlyList<Output>> GetAllAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A request that was not sent yet is not sent.
Returns
- Task<IReadOnlyList<Output>>
The outputs, each with the name that Named(string) takes, its kind (
rtmp_output,virtualcam_output...), whether it runs, its size and its flags (what it can do: video, audio, encoded...).
Remarks
The list holds the four outputs of this collection too, under the names that OBS Studio gave them (they differ between its simple and advanced output mode), and OBS Studio does not say which of the outputs of the list is which: it says the kind of an output, and a plugin can make outputs of the same kind. The answer is a snapshot of the moment that OBS Studio answered.
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).