Method RenameAsync

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

RenameAsync(string, CancellationToken)

Gives the filter another name, and returns when the model shows it.

public Task RenameAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The new name: it can not be the name of another filter of the same source. The names are case sensitive.

cancellationToken CancellationToken

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

Returns

Task

A task that completes when Name is name.

Remarks

See SetEnabledAsync(bool, CancellationToken) for the order of changes and the wait.

Exceptions

ArgumentException

name is empty.

ObsNameInUseException

The source has a filter with that name already, also when it is this one. Nothing was changed.

ObsRemovedException

The filter was removed, or its source was destroyed (the filters of a source that OBS Studio removed and keeps alive can still be changed).

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.