Table of Contents

Class SceneItem

Namespace
VisioForge.Core.SceneSwitching
Assembly
VisioForge.Core.dll

Represents a source placement within a scene. Each scene item references a registered source and defines how it should appear (position, size, opacity, z-order, audio settings).

public class SceneItem

Inheritance

Inherited Members

Constructors

SceneItem(Guid, SceneItemTransform)

Initializes a new instance of the VisioForge.Core.SceneSwitching.SceneItem class.

public SceneItem(Guid sourceId, SceneItemTransform transform)

Parameters

sourceId Guid

The ID of the registered source.

transform SceneItemTransform

The visual transform properties.

SceneItem(Guid, Rect, uint, double)

Initializes a new instance of the VisioForge.Core.SceneSwitching.SceneItem class with individual parameters.

public SceneItem(Guid sourceId, Rect rectangle, uint zOrder, double opacity = 1)

Parameters

sourceId Guid

The ID of the registered source.

rectangle Rect

The position and size rectangle.

zOrder uint

The z-order value.

opacity double

The opacity value.

Properties

ID

Gets the unique identifier for this scene item.

public Guid ID { get; }

Property Value

Guid

KeepAspectRatio

Gets or sets a value indicating whether to keep aspect ratio.

public bool KeepAspectRatio { get; set; }

Property Value

bool

Muted

Gets or sets a value indicating whether this source's audio is muted in this scene.

public bool Muted { get; set; }

Property Value

bool

Opacity

Gets or sets the opacity. Range [0.0..1.0]. 0.0 = fully transparent, 1.0 = fully opaque.

public double Opacity { get; set; }

Property Value

double

Rectangle

Gets or sets the position and size rectangle within the compositor output.

public Rect Rectangle { get; set; }

Property Value

Rect

SourceID

Gets the ID of the registered source this item references.

public Guid SourceID { get; }

Property Value

Guid

SourceName

Gets the name of the referenced source (convenience accessor).

public string SourceName { get; }

Property Value

string

Visible

Gets or sets a value indicating whether this item is visible in the scene.

public bool Visible { get; set; }

Property Value

bool

Volume

Gets or sets the audio volume for this source in this scene. Range [0.0..1.0].

public double Volume { get; set; }

Property Value

double

ZOrder

Gets or sets the z-order (layer position). Higher values render on top.

public uint ZOrder { get; set; }

Property Value

uint

Methods

ToString()

Returns a string representation of this scene item.

public override string ToString()

Returns

string