Method RenameAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
RenameAsync(string, CancellationToken)
Gives the input another name, and returns when the model shows it.
public Task RenameAsync(string name, CancellationToken cancellationToken = default)
Parameters
namestringThe new name: it can not be the name of another input, or of a scene, or of an input that was removed and that OBS Studio keeps alive (the name of any other source). The names are case sensitive.
cancellationTokenCancellationTokenA token that ends the wait. A change that was not sent yet is not sent.
Returns
Remarks
See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.
Exceptions
- ArgumentException
nameis empty.- ObsNameInUseException
The name is taken, also when it is the name that the input has already. Nothing was changed.
- 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. Do not send the change again.
- ObsResponseException
OBS Studio refused the change.