Table of Contents

Class VideoMixerBaseSettings

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

Video Mixer base settings.

public class VideoMixerBaseSettings

Inheritance

Derived

Inherited Members

Constructors

VideoMixerBaseSettings(int, int, VideoFrameRate)

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

public VideoMixerBaseSettings(int width, int height, VideoFrameRate frameRate)

Parameters

width int

The width.

height int

The height.

frameRate VideoFrameRate

The frame rate.

VideoMixerBaseSettings(int, int, VideoFrameRate, List<VideoMixerStream>)

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

public VideoMixerBaseSettings(int width, int height, VideoFrameRate frameRate, List<VideoMixerStream> streams)

Parameters

width int

The width.

height int

The height.

frameRate VideoFrameRate

The frame rate.

streams List<VideoMixerStream>

The streams.

Properties

Background

Gets or sets the background.

public VideoMixerBackground Background { get; set; }

Property Value

VideoMixerBackground

FrameRate

Gets or sets the frame rate.

public VideoFrameRate FrameRate { get; set; }

Property Value

VideoFrameRate

Height

Gets or sets the height.

public int Height { get; set; }

Property Value

int

IgnoreInactivePads

Gets or sets a value indicating whether the underlying GstAggregator (compositor / d3d11compositor) should set ignore-inactive-pads=true.

public bool IgnoreInactivePads { get; set; }

Property Value

bool

Remarks

When true, the mixer skips sink pads that are inactive (have not received a buffer or have sent EOS) and continues mixing from the remaining active inputs. Required by consumers that handle multi-stream composition where one stream may end before the others (e.g. LiveVideoCompositor dynamic input add/remove).

When false (default), the property is not set and the GstAggregator default applies (wait for all sinks). Mirrors the VisioForge.Core.Types.X.AudioEffects.AudioMixerSettings.IgnoreInactivePads opt-in pattern.

Note: the OpenGL mixer (glvideomixer) is a GstBin wrapper and does not expose this property. Setting true on the GL path logs a warning and is silently a no-op.

Streams

Gets the streams.

public List<VideoMixerStream> Streams { get; }

Property Value

List<VideoMixerStream>

Width

Gets or sets the width.

public int Width { get; set; }

Property Value

int

Methods

AddStream(VideoMixerStream)

Adds the stream.

public void AddStream(VideoMixerStream stream)

Parameters

stream VideoMixerStream

The stream.

AddStream(Rect, uint)

Adds the stream.

public void AddStream(Rect rect, uint zorder)

Parameters

rect Rect

The rectangle.

zorder uint

Z-order.

ClearStreams()

Clears the streams.

public void ClearStreams()

GetStream(int)

Gets the stream.

public VideoMixerStream GetStream(int index)

Parameters

index int

The index.

Returns

VideoMixerStream

VideoMixerSettingsStream.

GetStreamCount()

Gets the stream count.

public int GetStreamCount()

Returns

int

System.Int32.

RemoveStream(VideoMixerStream)

Removes the stream.

public void RemoveStream(VideoMixerStream stream)

Parameters

stream VideoMixerStream

The stream.

RemoveStream(int)

Removes the stream.

public void RemoveStream(int index)

Parameters

index int

The stream index.

SetStream(int, VideoMixerStream)

Sets the stream.

public void SetStream(int index, VideoMixerStream stream)

Parameters

index int

The index.

stream VideoMixerStream

The stream.

SetStreams(List<VideoMixerStream>)

Sets the streams.

public void SetStreams(List<VideoMixerStream> streams)

Parameters

streams List<VideoMixerStream>

The streams.