Table of Contents

Class OverlayManagerDecklinkVideo

Namespace
VisioForge.Core.Types.X.VideoEffects
Assembly
VisioForge.Core.dll

Decklink video overlay element that captures video from Decklink devices in the overlay manager.

public class OverlayManagerDecklinkVideo : IOverlayManagerElement, IDisposable

Inheritance

Implements

Inherited Members

Constructors

OverlayManagerDecklinkVideo(DecklinkVideoSourceSettings, int, int, int, int)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.OverlayManagerDecklinkVideo class.

public OverlayManagerDecklinkVideo(DecklinkVideoSourceSettings settings, int x, int y, int width, int height)

Parameters

settings DecklinkVideoSourceSettings

The Decklink video source settings.

x int

The X position.

y int

The Y position.

width int

The width.

height int

The height.

Properties

AudioOutput

Gets or sets the audio output device for playback. When provided, audio streams from the Decklink device will be played through this device. If null, audio will be discarded.

public AudioOutputDeviceInfo AudioOutput { get; set; }

Property Value

AudioOutputDeviceInfo

AudioOutput_Mute

Gets or sets whether the audio output is muted. Only effective when AudioOutput is configured.

public bool AudioOutput_Mute { get; set; }

Property Value

bool

AudioOutput_Volume

Gets or sets the audio output volume (0.0 to 1.0+, where values above 1.0 provide amplification). Only effective when AudioOutput is configured.

public double AudioOutput_Volume { get; set; }

Property Value

double

Cache

Gets or sets the cached image surface for rendering.

public object Cache { get; set; }

Property Value

object

DecklinkSettings

Gets or sets the Decklink video source settings.

public DecklinkVideoSourceSettings DecklinkSettings { get; set; }

Property Value

DecklinkVideoSourceSettings

Enabled

Gets or sets whether the overlay is enabled.

public bool Enabled { get; set; }

Property Value

bool

EndTime

Gets or sets the end time for the overlay visibility.

public TimeSpan EndTime { get; set; }

Property Value

TimeSpan

Height

Gets or sets the height of the overlay.

public int Height { get; set; }

Property Value

int

Lock

Gets the lock object for thread synchronization.

public object Lock { get; }

Property Value

object

Name

Gets or sets the name of the element.

public string Name { get; set; }

Property Value

string

Opacity

Gets or sets the opacity of the overlay (0.0 to 1.0).

public double Opacity { get; set; }

Property Value

double

Rotation

Gets or sets the rotation angle in degrees.

public double Rotation { get; set; }

Property Value

double

Shadow

Gets or sets the shadow settings for the overlay.

public OverlayManagerShadowSettings Shadow { get; set; }

Property Value

OverlayManagerShadowSettings

StartTime

Gets or sets the start time for the overlay visibility.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StretchMode

Gets or sets the stretch mode for the video.

public OverlayManagerImageStretchMode StretchMode { get; set; }

Property Value

OverlayManagerImageStretchMode

VideoRendererSettings

Gets or sets the video renderer settings. Used when VideoView is provided.

public VideoRendererSettingsX VideoRendererSettings { get; set; }

Property Value

VideoRendererSettingsX

VideoView

Gets or sets the video view for optional video rendering. If provided, the video will be rendered to this view in addition to being available as an overlay.

public IVideoView VideoView { get; set; }

Property Value

IVideoView

Width

Gets or sets the width of the overlay.

public int Width { get; set; }

Property Value

int

X

Gets or sets the X position of the overlay.

public int X { get; set; }

Property Value

int

Y

Gets or sets the Y position of the overlay.

public int Y { get; set; }

Property Value

int

ZIndex

Gets or sets the Z-index for layering.

public int ZIndex { get; set; }

Property Value

int

Methods

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Initialize(bool)

Initializes the Decklink video overlay and starts capture.

public bool Initialize(bool autoStart = true)

Parameters

autoStart bool

If true, starts playing immediately. If false, only preloads.

Returns

bool

true if successful; otherwise, false.

Pause()

Pauses video capture.

public void Pause()

Play()

Starts or resumes video capture.

public void Play()

Stop()

Stops video capture.

public void Stop()

See Also