Method SetAudioTracksAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
SetAudioTracksAsync(ObsAudioTracks, CancellationToken)
Sets the audio tracks that the input is mixed into, and returns when the model shows it.
public Task SetAudioTracksAsync(ObsAudioTracks tracks, CancellationToken cancellationToken = default)Parameters
tracksObsAudioTracksThe tracks: exactly these, and no others. To change one track and keep the others, start from AudioTracks:
input.SetAudioTracksAsync(input.AudioTracks | ObsAudioTracks.Track2).cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
- Task
A task that completes when AudioTracks is
tracks.
Remarks
All six tracks are sent: the call is about the state that you give, and does not depend on what another change that is not shown yet will have made. See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.
Exceptions
- ArgumentOutOfRangeException
trackshas a bit that is none of the six tracks.- InvalidOperationException
The input has no audio (HasAudio).
- ObsRemovedException
The input was removed.
- ObsNotConnectedException
There is no connection to OBS Studio. Nothing was changed.
- ObsNotReadyException
OBS Studio is changing its scene collection, or did so after the call. Nothing was changed.
- ObsUnknownOutcomeException
OBS Studio did not answer in time, or the connection ended: it is not known whether it made the change.
- ObsNotConfirmedException
OBS Studio made the change, and the model does not show it: the events did not show it in time, and the model could not be read again in time. Do not send the change again.
- ObsResponseException
OBS Studio refused the change.