Method GetTransformAsync
- Namespace
- OBSStudioClient.Model
- Assembly
- OBSClient.dll
GetTransformAsync(CancellationToken)
Asks OBS Studio for the transform of the scene item: where it is, how large it is shown, how it is rotated, cropped and bounded.
public Task<SceneItemTransform> GetTransformAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token that ends the wait. A request that was not sent yet is not sent.
Returns
- Task<SceneItemTransform>
The transform at the moment that OBS Studio answered. It can be turned into a change with ToUpdate().
Remarks
Transform is the same, as the model holds it, when the model was asked to follow the transforms (Transforms). The request is made in its turn, after the changes that were asked for before it (see SetEnabledAsync(bool, CancellationToken)).
Exceptions
- ObsRemovedException
The scene item, or its scene, was removed.
- 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).
- ObsResponseException
OBS Studio refused the request.