Class VirtualAudioSourceSettings

Virtual audio source settings.

Inheritance
object
VirtualAudioSourceSettings
Implements
Inherited Members
Namespace: VisioForge.Core.Types.X.Sources
Assembly: VisioForge.Core.dll
Syntax
public class VirtualAudioSourceSettings : IVideoCaptureBaseAudioSourceSettings

Constructors

VirtualAudioSourceSettings(VirtualAudioSourceSettingsWave, int, int, AudioFormatX)

Initializes a new instance of the VirtualAudioSourceSettings class.

Declaration
public VirtualAudioSourceSettings(VirtualAudioSourceSettingsWave wave = VirtualAudioSourceSettingsWave.Ticks, int sampleRate = 48000, int channels = 2, AudioFormatX format = AudioFormatX.S16)
Parameters
Type Name Description
VirtualAudioSourceSettingsWave wave
int sampleRate

The sample rate.
int channels

The channels.
AudioFormatX format

The format.

Properties

ApplyTickRamp

Apply ramp to tick samples.

Declaration
public bool ApplyTickRamp { get; set; }
Property Value
Type Description
bool
Remarks

Default value: false

CanActivatePull

Can activate in pull mode.

Declaration
public bool CanActivatePull { get; set; }
Property Value
Type Description
bool
Remarks

Default value: false.

CanActivatePush

Can activate in push mode.

Declaration
public bool CanActivatePush { get; set; }
Property Value
Type Description
bool
Remarks

Default value: true.

Channels

Gets or sets the channels.

Declaration
public int Channels { get; set; }
Property Value
Type Description
int

The channels.

Format

Gets or sets the format.

Declaration
public AudioFormatX Format { get; set; }
Property Value
Type Description
AudioFormatX

The format.

Frequency

Frequency of test signal. The sample rate needs to be at least 2 times higher.

Declaration
public double Frequency { get; set; }
Property Value
Type Description
double
Remarks

Default value: 440.

IsLive

Gets or sets a value indicating whether this instance is live.

Declaration
public bool IsLive { get; set; }
Property Value
Type Description
bool

true if this instance is live; otherwise, false.

MarkerTickPeriod

Make every Nth tick a marker tick (= a tick with different volume). Only used if wave = ticks. 0 = no marker ticks.

Declaration
public uint MarkerTickPeriod { get; set; }
Property Value
Type Description
uint
Remarks

Flags: Read / Write Default value: 0

MarkerTickVolume

Volume of marker ticks. Only used if wave = ticks and marker-tick-period is set to a nonzero value.

Declaration
public double MarkerTickVolume { get; set; }
Property Value
Type Description
double
Remarks

Flags: Read / Write Default value: 1

SampleRate

Gets or sets the sample rate.

Declaration
public int SampleRate { get; set; }
Property Value
Type Description
int

The sample rate.

SamplesPerBuffer

Number of samples in each outgoing buffer

Declaration
public int SamplesPerBuffer { get; set; }
Property Value
Type Description
int
Remarks

Default value: 1024.

SinePeriodsPerTick

Number of sine wave periods in one tick. Only used if wave = ticks.

Declaration
public uint SinePeriodsPerTick { get; set; }
Property Value
Type Description
uint
Remarks

Default value: 10.

TickInterval

Distance between start of current and start of next tick.

Declaration
public TimeSpan TickInterval { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Default value: 1 second.

TimestampOffset

An offset added to timestamps set on buffers.

Declaration
public TimeSpan TimestampOffset { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Default value: 0.

Volume

Volume of test signal.

Declaration
public double Volume { get; set; }
Property Value
Type Description
double
Remarks

Default value: 0.8.

Wave

Oscillator waveform.

Declaration
public VirtualAudioSourceSettingsWave Wave { get; set; }
Property Value
Type Description
VirtualAudioSourceSettingsWave
Remarks

Default value: sine (0).

Implements

IVideoCaptureBaseAudioSourceSettings