Class LiveVideoCompositorSettings

Namespace

VisioForge.Core.LiveVideoCompositorV2

Assembly

VisioForge.Core.dll

Contains configuration settings for the Live Video Compositor. This class defines all the parameters needed to initialize and configure a live video compositing session, including video dimensions, frame rate, audio settings, and output destinations.

public class LiveVideoCompositorSettings

Inheritance

object

LiveVideoCompositorSettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Remarks

The settings control both video and audio parameters for the compositor, as well as specify the mixer type and output targets. Video parameters are immutable once set through the constructor, while audio settings and output destinations can be modified after initialization.

Constructors

LiveVideoCompositorSettings(int, int, VideoFrameRate)

Initializes a new instance of the VisioForge.Core.LiveVideoCompositorV2.LiveVideoCompositorSettings class with the specified video dimensions and frame rate.

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

Parameters

width int

The width of the output video in pixels.

height int

The height of the output video in pixels.

frameRate VideoFrameRate

The frame rate for the output video.

Remarks

The constructor sets the video parameters which are immutable after initialization. The mixer type is automatically set to OpenGL for cross-platform compatibility. Audio settings are initialized to default values but can be modified after construction.

Properties

AudioChannels

Gets or sets the number of audio channels.

public int AudioChannels { get; set; }

Property Value

int

AudioEnabled

Gets or sets a value indicating whether audio stream processing is enabled in the compositor.

public bool AudioEnabled { get; set; }

Property Value

bool

AudioFormat

Gets or sets the audio sample format for the compositor's audio output.

public AudioFormatX AudioFormat { get; set; }

Property Value

AudioFormatX

AudioOutput

Gets or sets the audio renderer block for audio playback.

public AudioRendererBlock AudioOutput { get; set; }

Property Value

AudioRendererBlock

AudioSampleRate

Gets or sets the audio sample rate in Hz.

public int AudioSampleRate { get; set; }

Property Value

int

MixerType

Gets or sets the type of video mixer to use for compositing.

public LVCMixerType MixerType { get; set; }

Property Value

LVCMixerType

VideoFrameRate

Gets the frame rate for the output video.

public VideoFrameRate VideoFrameRate { get; }

Property Value

VideoFrameRate

VideoHeight

Gets the height of the output video in pixels.

public int VideoHeight { get; }

Property Value

int

VideoView

Gets or sets the video view control for direct rendering output.

public IVideoView VideoView { get; set; }

Property Value

IVideoView

VideoWidth

Gets the width of the output video in pixels.

public int VideoWidth { get; }

Property Value

int