OscillatorInput.OscillatorInput Class Reference

Oscillator properties for Script Engine. Read the documentation for more info.

Properties
bool	AutoStart [get, set]
	Start playback when loaded.
OscillatorType	OscillatorType [get, set]
	Oscillator type.
int	Frequency [get, set]
	Frequency in Hz.
int	GainDB [get, set]
	Gain in dB.
bool	Antialiasing [get, set]
	Antialiasing.
PlaybackState	PlaybackState [get]
	Playback state.
Command	StartCommand [get]
	Start playback.
Command	StopCommand [get]
Properties inherited from VindralEngineBaseTypes.VindralBaseClasses.AbstractInput
string	IconText [get, set]
	Hides and removes the input from the Audio Mixer view in the Composer GUI without disabling its audio.
bool	HideInAudioMixer [get, set]
	Hides and removes the input from the Audio Mixer view in the Composer GUI without disabling its audio.
bool	Invisible [get, set]
	An invisible input will not be rendered in any layer, in any scene.
DoNotRenderController	DoNotRenderController [get, set]
	Select how the 'Do no render input' setting should be controlled.
bool	DoNotRenderInput [get, set]
	This option will disable the internal render method of the input. This can reduce load in some use cases.
string	Tag [get, set]
	Tag input with a name. Tags can be used with Smart Search to search for tags.
int	Width [get, protected set]
	Input source width.
int	Height [get, protected set]
	Input source height.
Properties inherited from VindralEngineBaseTypes.VindralBaseClasses.AbstractAudioProcessing
float	InputTrimDb [get, set]
	Input trim (gain)
float	StereoGainDb [get, set]
	Gain (db)
float	Pan [get, set]
	Pan audio left or right. [min = -100, max = 100].
int	InputAudioDelayMs [get, set]
	Input audio delay (ms)
bool	Mute [get, set]
	Mute audio.
bool	Solo [get, set]
	Isolate the audio signal by muting all other sources. Only audible when Audio Preview in Composer is active.
bool	PFL [get, set]
	Routes the signal to monitoring outputs before the gain is applied. Also called Pre-fader-listening (PFL). Only audible when Audio Preview in Composer is active.
AudioMixerVuMeterPrePost	VuMeterConfiguration [get, set]
	Vu-meter configuration.
float	Send1Gain [get, set]
	Audio level sent to the auxiliary bus Send 1. [min = -100, max = 100].
AudioMixerPrePost	Send1PrePost [get, set]
	Defines whether the signal sent to Send 1 is taken before or after Send 1 Gain.
AudioStereoRemap	StereoRemap [get, set]
	Audio channel reassignment for the stereo output.
AudioRemap	AudioRemapLeft1 [get, set]
	Remap Left 1 to another audio channel.
AudioRemap	AudioRemapRight1 [get, set]
	Remap Right 1 to another audio channel.
AudioRemap	AudioRemapLeft2 [get, set]
	Remap Left 2 to another audio channel.
AudioRemap	AudioRemapRight2 [get, set]
	Remap Right 2 to another audio channel.
AudioRemap	AudioRemapLeft3 [get, set]
	Remap Left 3 to another audio channel.
AudioRemap	AudioRemapRight3 [get, set]
	Remap Right 3 to another audio channel.
AudioRemap	AudioRemapLeft4 [get, set]
	Remap Left 4 to another audio channel.
AudioRemap	AudioRemapRight4 [get, set]
	Remap Right 4 to another audio channel.
bool	UseGateFilter [get, set]
	Activate the audio gate filter.
float	GateThresholdDb [get, set]
	Threshold (dB). [min=-48, max=0, default=-24].
float	GateFilterGainReductionDb [get, set]
	Gain reduction (dB). [min=-36, max=0, default=-36].
float	GateFilterRatio [get, set]
	Ratio [min=1, max=20, default=4].
float	GateFilterAttack [get, set]
	Attack (ms). [min=1, max=200, default=20].
float	GateFilterRelease [get, set]
	Release (ms). [min=5, max=5000, default=250].
float	GateFilterKnee [get, set]
	Knee [min=1, max=8, default=2.8].
float	GateFilterMakeupGainDb [get, set]
	Gate makeup gain (dB). [min=0, max=24, default=0].
CompressorMode	GateFilterCompressorMode [get, set]
	Gate compressor mode.
CompressorLink	GateFilterCompressorLinkMode [get, set]
	Gate compressor link mode.
CompressorDetection	GateFilterCompressorDetectionMode [get, set]
	Gate Detection.
bool	UseLowCutFilter [get, set]
	Activate the Low Cut filter.
int	LowCutFilterOffFrequency [get, set]
	Cut-Off frequency (Hz). [min=20, max=200, default=80].
int	LowCutFilterOrder [get, set]
	"Filter order (3-20). [min=3, max=20, default=10]
bool	UseEqFilter [get, set]
	Activate the EQ filter.
bool	EqUseSoftClip [get, set]
	Use soft clipping on the EQ output.
int	Eq1Frequency [get, set]
	Eq1 Frequency (Hz)
float	Eq1Q [get, set]
	Eq1 Q value. [min=0.1, max=10, default=1].
int	Eq1Gain [get, set]
	Eq1 Gain (dB). [min=-36, max=36, default=0].
int	Eq2Frequency [get, set]
	Eq2 Frequency (Hz)
float	Eq2Q [get, set]
	Eq2 Q value. [min=0.1, max=10, default=1].
int	Eq2Gain [get, set]
	Eq2 Gain (dB). [min=-36, max=36, default=0].
int	Eq3Frequency [get, set]
	Eq3 Frequency (Hz)
float	Eq3Q [get, set]
	Eq3 Q value. [min=0.1, max=10, default=1].
int	Eq3Gain [get, set]
	Eq3 Gain (dB). [min=-36, max=36, default=0].
int	Eq4Frequency [get, set]
	Eq4 Frequency (Hz)
float	Eq4Q [get, set]
	Eq4 Q value. [min=0.1, max=10, default=1].
int	Eq4Gain [get, set]
	Eq4 Gain (dB). [min=-36, max=36, default=0].
int	Eq5Frequency [get, set]
	Eq5 Frequency (Hz)
float	Eq5Q [get, set]
	Eq5 Q value. [min=0.1, max=10, default=1].
int	Eq5Gain [get, set]
	Eq5 Gain (dB). [min=-36, max=36, default=0].
bool	UseCompressorFilter [get, set]
	Activate the Compressor filter.
float	CompressorThreshold [get, set]
	Threshold (dB) [min=-36, max=48, default=-12].
float	CompressorRatio [get, set]
	Ratio [min=1, max=20, default=4].
AudioCompressorDetectorMode	CompressorDetectorMode [get, set]
	Detection mode (Peak or RMS) [default=RMS].
float	CompressorMakeupGainDb [get, set]
	Makeup gain (dB) [min=0, max=36, default=3].
float	CompressorKneeWidthDb [get, set]
	Knee width (dB) [min=1, max=8, default=6].
float	CompressorAttackTimeMs [get, set]
	Attack time (ms) [min=1, max=200, default=5].
float	CompressorReleaseTimeMs [get, set]
	Release time (ms) [min=1, max=500, default=50].
float	CompressorRmsTimeMs [get, set]
	RMS window length (ms) [min=10, max=500, default=30].
float	CompressorLookAheadMs [get, set]
	RMS window length (ms) [min=1, max=10, default=5].
float	CompressorGainReductionMeter [get, set]
	Gain reduction (dB). Smoothed over 300 ms.
bool	UseLimiterFilter [get, set]
	Activate the Limiter filter.
float	LimiterCeilingDb [get, set]
	The absolute maximum output level (dB). Signals attempting to exceed this will be clamped.Default: -0.1 dB (Safe for digital)
float	LimiterReleaseTimeMs [get, set]
	How fast the limiter recovers gain after a peak (ms). 100ms. Lower values = louder but more distortion.
float	LimiterLookAheadMs [get, set]
	Lookahead time (ms). Essential for brickwall limiting. Default: 2.0ms.
float	LimiterGainReductionMeter [get, set]
	Gain reduction (dB). Smoothed over 300 ms.
Properties inherited from VindralEngineBaseTypes.VindralBaseClasses.AbstractAudioMetering
float	LeftPeakLevel [get]
	Left Peak Level - rounded to defined precision.
float	LeftPeakLevelFullPrecision [get]
	Left Peak Level - full precision, not rounded.
float	LeftPeakLevelRms [get]
	Left Peak Level RMS - rounded to defined precision.
float	LeftPeakLevelRmsAverage [get]
	Left Peak Level RMS Average - rounded to defined precision.
float	RightPeakLevelRmsAverage [get]
	Right Peak Level - rounded to defined precision.
float	RightPeakLevel [get]
	Right Peak Level - rounded to defined precision.
float	RightPeakLevelFullPrecision [get]
	Right Peak Level - full precision, not rounded.
float	RightPeakLevelRms [get]
	Right Peak Level RMS - rounded to defined precision.
float	StereoPeakLevel [get]
	Stereo Peak Level - rounded to defined precision.
float	PeakLevel [get]
	Peak Level.
bool	StereoLevelWarning [get]
	Stereo Level Warning.

Property Documentation

StopCommand

Command OscillatorInput.OscillatorInput.StopCommand

get

Stop playback