Oscillator
Oscillator input properties for Script Engine. Generates a continuous audio test tone — sine, square, triangle, sawtooth, or white noise — at a configurable frequency, level, and channel count. Useful as a reference signal for level calibration, system testing, alignment, mixing rehearsals, or as a placeholder audio source while a project is being built. The signal can start automatically when the project loads.
| Property | Type | Access | Description |
|---|---|---|---|
ShowAdvancedOptions |
bool |
get/set |
Show or hide the input's advanced settings in the editor UI. [default=false]. |
AutoStart |
bool |
get/set |
Whether the oscillator starts producing audio as soon as the project loads. [default=true]. When true, the input begins playing immediately on load (equivalent to running StartCommand). Disable to require an explicit start, useful when the tone should only begin on operator action or via a script trigger. |
OscillatorType |
OscillatorType |
get/set |
Which waveform to generate. [default=Sine]. Sine is a clean, pure tone — the standard reference signal. Square and Sawtooth have a brighter, buzzier character with rich harmonic content. Triangle sits between sine and square — softer than square but with a touch more bite than sine. WhiteNoise outputs random noise across all frequencies and is useful for system tuning or masking. |
Frequency |
int |
get/set |
Pitch of the tone, in Hz. [min=20, max=20000, default=1000]. 1000 Hz is the standard EBU/SMPTE reference tone used for level alignment. 440 Hz is musical A4 (the tuning pitch). The full range covers the audible band — 20 Hz is the lowest, 20 000 Hz the highest. Ignored when OscillatorType is WhiteNoise, which has no fixed pitch. |
GainDB |
int |
get/set |
Output level of the tone, in decibels. [min=-60, max=24, default=-6]. 0 dB is full level. Negative values lower the volume; positive values boost it. −20 dB is the common EBU/SMPTE alignment level, and −6 dB leaves comfortable headroom against clipping. Be careful with positive values — anything above 0 dB risks distortion in downstream stages. |
Channels |
int |
get/set |
How many audio channels to produce. [min=1, max=8, default=2]. 1 is mono, 2 is stereo, and higher values are useful for surround or multi-language productions. The same tone is sent to every channel, so this mainly controls how many channels show up downstream — set this to match the channel count expected by the rest of the audio chain. |
Antialiasing |
bool |
get/set |
Smooth out unwanted high-frequency noise on the generated tone. [default=false]. Square, Triangle, and Sawtooth waves can produce a slightly harsh, buzzy "stair-step" sound at high frequencies. Enabling this option cleans that up for a more natural result. No audible effect on Sine or WhiteNoise. Costs slightly more processing time. |
PlaybackState |
PlaybackState |
get |
Current playback state of the oscillator (read-only). Reflects whether the input is Stopped or Running. Driven by StartCommand / StopCommand (or AutoStart at load time). Read this from a script to decide whether the tone is live; the value also drives the running indicator and the enabled state of the Start/Stop buttons. |
StartCommand |
Command |
get |
Start generating the tone. |
StopCommand |
Command |
get |
Stop generating the tone. |
Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.
See also: Oscillator in Inputs — user-facing introduction, screenshots, and section summaries.