Class SceneItemTransformUpdate

Namespace

OBSStudioClient.Classes

Assembly

OBSClient.dll

Describes a change of the transform and crop of a scene item: only the members that are set are sent to OBS Studio, and OBS Studio leaves every other member as it is.

public sealed record SceneItemTransformUpdate : IEquatable<SceneItemTransformUpdate>

Inheritance

object

SceneItemTransformUpdate

Implements

IEquatable<SceneItemTransformUpdate>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Use this to move or scale an item without having to know (and send) the rest of its transform:

await client.SetSceneItemTransform("Scene", itemId, new SceneItemTransformUpdate { PositionX = 100 });

To derive a change from the current state, start from ToUpdate():

await client.SetSceneItemTransform("Scene", itemId, current.ToUpdate() with { ScaleX = 2, ScaleY = 2 });

A SceneItemTransform converts to an update implicitly. The members that OBS Studio calculates (width, height, source width and source height) are not part of an update. The bounds of a transform without bounds are left out of it, because OBS Studio refuses a bounds width or height below 1.

OBS Studio refuses an update without any member that is set.

Properties

Alignment

Gets the new alignment of the scene item, or null to leave it as it is.

BoundsAlignment

Gets the new alignment of the bounds, or null to leave it as it is.

BoundsHeight

Gets the new height of the bounds (at least 1), or null to leave it as it is.

BoundsType

Gets the new type of the bounds, or null to leave it as it is.

BoundsWidth

Gets the new width of the bounds (at least 1), or null to leave it as it is.

CropBottom

Gets the new bottom crop, or null to leave it as it is.

CropLeft

Gets the new left crop, or null to leave it as it is.

CropRight

Gets the new right crop, or null to leave it as it is.

CropToBounds

Gets whether the scene item is cropped to its bounds, or null to leave it as it is.

CropTop

Gets the new top crop, or null to leave it as it is.

IsEmpty

Gets a value that indicates whether no member is set, which OBS Studio refuses.

PositionX

Gets the new x position, or null to leave it as it is.

PositionY

Gets the new y position, or null to leave it as it is.

Rotation

Gets the new rotation in degrees, or null to leave it as it is.

ScaleX

Gets the new horizontal scale, or null to leave it as it is.

ScaleY

Gets the new vertical scale, or null to leave it as it is.

Methods

From(SceneItemTransform)

Creates the update that gives a scene item the given transform.

Operators

implicit operator SceneItemTransformUpdate(SceneItemTransform)

Converts a SceneItemTransform into the update that gives a scene item that transform.