Table of Contents

Class VirtualCameraSinkSettings

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

Settings for the Virtual Camera sink block that streams video and audio to the VisioForge Virtual Camera via shared memory.

public class VirtualCameraSinkSettings : IVideoCaptureXBaseOutput, IXBaseOutput, IMediaBlockSettings, IOutputVideoProcessor, IOutputAudioProcessor

Inheritance

Implements

Inherited Members

Properties

AudioBitsPerSample

Gets or sets the audio bits per sample (typically 16).

public int AudioBitsPerSample { get; set; }

Property Value

int

AudioChannels

Gets or sets the number of audio channels (1=mono, 2=stereo).

public int AudioChannels { get; set; }

Property Value

int

AudioSampleRate

Gets or sets the audio sample rate in Hz.

public int AudioSampleRate { get; set; }

Property Value

int

AudioStreamName

Gets or sets the shared memory stream name for audio. Must match the virtual audio card source filter configuration.

public string AudioStreamName { get; set; }

Property Value

string

CustomAudioProcessor

Gets or sets the custom audio processor block.

public MediaBlock CustomAudioProcessor { get; set; }

Property Value

MediaBlock

CustomVideoProcessor

Gets or sets the custom video processor block.

public MediaBlock CustomVideoProcessor { get; set; }

Property Value

MediaBlock

FrameRate

Gets or sets the target frame rate.

public double FrameRate { get; set; }

Property Value

double

Height

Gets or sets the video frame height in pixels.

public int Height { get; set; }

Property Value

int

VideoStreamName

Gets or sets the shared memory stream name for video. Must match the virtual camera source filter configuration.

public string VideoStreamName { get; set; }

Property Value

string

Width

Gets or sets the video frame width in pixels. Must be an even number (YUY2 requirement).

public int Width { get; set; }

Property Value

int

Methods

CreateBlock()

Creates the media block instance for Virtual Camera sink.

public MediaBlock CreateBlock()

Returns

MediaBlock

A new instance of VisioForge.Core.MediaBlocks.Sinks.VirtualCameraSinkBlock configured with these settings.

GetAudioEncoders()

Gets the available audio encoders. Not implemented for Virtual Camera as it uses raw audio.

public Tuple<string, Type>[] GetAudioEncoders()

Returns

Tuple<string, Type>[]

Exceptions

NotImplementedException

This method is not implemented for Virtual Camera sink.

GetFilename()

Gets the virtual camera stream name (treated as filename for interface compatibility).

public string GetFilename()

Returns

string

The video stream name.

GetVideoEncoders()

Gets the available video encoders. Not implemented for Virtual Camera as it uses raw video.

public Tuple<string, Type>[] GetVideoEncoders()

Returns

Tuple<string, Type>[]

Exceptions

NotImplementedException

This method is not implemented for Virtual Camera sink.

SetFilename(string)

Sets the virtual camera stream name (treated as filename for interface compatibility).

public void SetFilename(string filename)

Parameters

filename string

The video stream name.