<?xml version="1.0"?>
<doc>
    <assembly>
        <name>package.carsonk.daw</name>
    </assembly>
    <members>
        <member name="P:DAW.DawInstrument.Name">
            <summary>
            The name of the instrument
            </summary>
        </member>
        <member name="M:DAW.DawInstrument.Play(System.Single,System.Single,System.Single)">
            <summary>
            Play a note at the given frequency for the given length
            </summary>
            <param name="frequency">The frequency of the sound (in Hz)</param>
            <param name="length">The length of the sound (in seconds)</param>
            <param name="volume">The volume of the sound (0-1)</param>
        </member>
        <member name="M:DAW.Instruments.SimpleOscillator.Play(System.Single,System.Single,System.Single)">
            <summary>
            Play a note at the given frequency for the given length
            </summary>
            <param name="frequency">The frequency of the sound (in Hz)</param>
            <param name="length">The length of the sound (in seconds)</param>
        </member>
        <member name="F:DAW.Dropdown.DropdownIndicator">
            <summary>
            The icon of an arrow pointing down on the right of the element.
            </summary>
        </member>
        <member name="P:DAW.Dropdown.ValueChanged">
            <summary>
            Called when the value has been changed,
            </summary>
        </member>
        <member name="P:DAW.Dropdown.BuildOptions">
            <summary>
            Called just before opening, allows options to be dynamic
            </summary>
        </member>
        <member name="P:DAW.Dropdown.Options">
            <summary>
            The options to show on click. You can edit these directly via this property.
            </summary>
        </member>
        <member name="P:DAW.Dropdown.Value">
            <summary>
            The current string value. This is useful to have if Selected is null.
            </summary>
        </member>
        <member name="P:DAW.Dropdown.Selected">
            <summary>
            The currently selected option.
            </summary>
        </member>
        <member name="M:DAW.Dropdown.PopulateOptionsFromType(System.Type)">
            <summary>
            Given the type, populate options. This is useful if you're an enum type.
            </summary>
        </member>
        <member name="M:DAW.Dropdown.Open">
            <summary>
            Open the dropdown.
            </summary>
        </member>
        <member name="M:DAW.Dropdown.Select(Sandbox.UI.Option,System.Boolean)">
            <summary>
            Select an option.
            </summary>
        </member>
        <member name="M:DAW.Dropdown.Select(System.String,System.Boolean)">
            <summary>
            Select an option by value string.
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.Max">
            <summary>
            The right side of the slider.
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.Min">
            <summary>
            The left side of the slider.
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.ResetValue">
            <summary>
            The value to reset to when right clicked
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.Step">
            <summary>
            If set to 1, value will be rounded to 1's
            If set to 10, value will be rounded to 10's
            If set to 0.1, value will be rounded to 0.1's
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.ShowRange">
            <summary>
            Show the range values above the slider
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.ShowValueTooltip">
            <summary>
            When changing the value show the tooltip
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.ShowTextEntry">
            <summary>
            When changing the value show the tooltip
            </summary>
        </member>
        <member name="P:DAW.KnobSlider.NumberFormat">
            <summary>
            How to display numbers in this control
            </summary>
        </member>
        <member name="M:DAW.KnobSlider.ScreenPosToValue(Vector2)">
            <summary>
            Convert a screen position to a value. The value is clamped, but not snapped.
            </summary>
        </member>
        <member name="M:DAW.KnobSlider.OnMouseMove(Sandbox.UI.MousePanelEvent)">
            <summary>
            If we move the mouse while we're being pressed then set the value
            </summary>
        </member>
        <member name="M:DAW.KnobSlider.OnMouseDown(Sandbox.UI.MousePanelEvent)">
            <summary>
            On mouse press jump to that position
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.Max">
            <summary>
            The right side of the slider.
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.Min">
            <summary>
            The left side of the slider.
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.Step">
            <summary>
            If set to 1, value will be rounded to 1's
            If set to 10, value will be rounded to 10's
            If set to 0.1, value will be rounded to 0.1's
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.ShowRange">
            <summary>
            Show the range values above the slider
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.ShowValueTooltip">
            <summary>
            When changing the value show the tooltip
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.ShowTextEntry">
            <summary>
            When changing the value show the tooltip
            </summary>
        </member>
        <member name="P:DAW.NumberSlider.NumberFormat">
            <summary>
            How to display numbers in this control
            </summary>
        </member>
        <member name="M:DAW.NumberSlider.ScreenPosToValue(Vector2)">
            <summary>
            Convert a screen position to a value. The value is clamped, but not snapped.
            </summary>
        </member>
        <member name="M:DAW.NumberSlider.OnMouseMove(Sandbox.UI.MousePanelEvent)">
            <summary>
            If we move the mouse while we're being pressed then set the value
            </summary>
        </member>
        <member name="M:DAW.NumberSlider.OnMouseDown(Sandbox.UI.MousePanelEvent)">
            <summary>
            On mouse press jump to that position
            </summary>
        </member>
        <member name="P:SFXR.SFXREnvelope.Attack">
            <summary>
            Time the sound takes to reach its peak amplitude
            (Default: 0)
            </summary>
        </member>
        <member name="P:SFXR.SFXREnvelope.Decay">
            <summary>
            The time taken for the sound to fade to the sustain level
            </summary>
        </member>
        <member name="P:SFXR.SFXREnvelope.Sustain">
            <summary>
            The level maintained until release is triggered
            (Default: 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXREnvelope.SustainTime">
            <summary>
            The time taken for the sound to fade to zero after the sustain
            (Default: 0.3)
            </summary>
        </member>
        <member name="P:SFXR.SFXREnvelope.Release">
            <summary>
            The time taken for the sound to fade to zero after the release
            (Default: 0.4)
            </summary>
        </member>
        <member name="M:SFXR.SFXREnvelope.GetAmplitude(System.Single)">
            <summary>
            Returns the amplitude of the envelope at a given time
            </summary>
            <param name="time">Time in seconds</param>
            <returns>Amplitude of the envelope at the given time</returns>
        </member>
        <member name="P:SFXR.SFXRHighPass.Cutoff">
            <summary>
            Cutoff value of the high-pass filter
            (Default: 0, Range: 0 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRHighPass.Sweep">
            <summary>
            Amount by which the high-pass cutoff frequency is increased or decreased over time
            (Default: 0, Range: -1 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRHighPass.Resonance">
            <summary>
            Controls the high-pass filter's resonance (peak)
            (Default: 0, Range: 0 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRLowPass.Cutoff">
            <summary>
            Cutoff value of the low-pass filter
            (Default: 1, Range: 0 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRLowPass.Sweep">
            <summary>
            Amount by which the low-pass cutoff frequency is increased or decreased over time
            (Default: 0, Range: -1 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRLowPass.Resonance">
            <summary>
            Controls the low-pass filter's resonance (peak)
            (Default: 0, Range: 0 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRVibrato.Depth">
            <summary>
            Amount by which the frequency is changed
            (Default: 0, Range: 0 - 1)
            </summary>
        </member>
        <member name="P:SFXR.SFXRVibrato.Speed">
            <summary>
            Frequency of the vibrato in Hz
            (Default: 0, Range: 0 - 100)
            </summary>
        </member>
        <member name="M:SFXR.SFXR.GetWaveformSample(SFXR.Waveform,System.Single,System.Single)">
            <summary>
            Gets the sample of a waveform at a given time and frequency
            </summary>
            <param name="waveform">The waveform</param>
            <param name="t">Time in seconds</param>
            <param name="frequency">Frequency in Hz</param>
            <returns>Sample of the waveform at the given time and frequency</returns>
        </member>
        <member name="M:SFXR.SFXR.GetSquareWaveSample(System.Single,System.Single)">
            <summary>
            Gets the sample of a square waveform at a given time and frequency
            </summary>
            <param name="t">Time in seconds</param>
            <param name="frequency">Frequency in Hz</param>
            <returns>Sample of the square waveform at the given time and frequency</returns>
        </member>
        <member name="M:SFXR.SFXR.GetSawtoothWaveSample(System.Single,System.Single)">
            <summary>
            Gets the sample of a sawtooth waveform at a given time and frequency
            </summary>
            <param name="t">Time in seconds</param>
            <param name="frequency">Frequency in Hz</param>
            <returns>Sample of the sawtooth waveform at the given time and frequency</returns>
        </member>
        <member name="M:SFXR.SFXR.GetSineWaveSample(System.Single,System.Single)">
            <summary>
            Gets the sample of a sine waveform at a given time and frequency
            </summary>
            <param name="t">Time in seconds</param>
            <param name="frequency">Frequency in Hz</param>
            <returns>Sample of the sine waveform at the given time and frequency</returns>
        </member>
        <member name="M:SFXR.SFXR.GetNoiseWaveSample(System.Single,System.Single)">
            <summary>
            Gets the sample of a noise waveform at a given time and frequency
            </summary>
            <param name="t">Time in seconds</param>
            <param name="frequency">Frequency in Hz</param>
            <returns>Sample of the noise waveform at the given time and frequency</returns>
        </member>
        <member name="P:SFXR.SFXRComponent.Waveform">
            <summary>
            The base Waveform
            (Default: Square)
            </summary>
        </member>
        <member name="P:SFXR.SFXRComponent.SampleRate">
            <summary>
            The sample rate of the sound
            </summary>
        </member>
        <member name="P:SFXR.SFXRComponent.BitDepth">
            <summary>
            The bit depth of the sound
            </summary>
        </member>
        <member name="P:SFXR.SFXRComponent.Length">
            <summary>
            The length of the sound in seconds
            </summary>
        </member>
        <member name="P:SFXR.SFXRComponent.MasterVolume">
            <summary>
            The volume of the sound
            (Default: 0.5)
            </summary>
        </member>
        <member name="P:SFXR.SFXRComponent.Seed">
            <summary>
            The random seed
            </summary>
        </member>
        <member name="M:SFXR.SFXRComponent.PlaySound">
            <summary>
            Plays the sound defined by the component
            </summary>
            <returns>The sound handle of the sound. This can be used to change position, pitch, ect</returns>
        </member>
        <member name="M:SFXR.SFXRComponent.TriggerNotePress(System.Single,System.Single)">
            <summary>
            Plays the sound defined by the component (Via a frequency trigger. This will play indefinitely until released)
            </summary>
            <param name="frequency">The frequency of the sound</param>
            <param name="volume">The volume of the trigger </param>
        </member>
        <member name="M:SFXR.SFXRComponent.TriggerNoteRelease(System.Single)">
            <summary>
            Releases a note playing at the given frequency
            </summary>
            <param name="frequency">The frequency of the sound</param>
        </member>
        <member name="M:SFXR.SFXRComponent.TriggerReleaseAll">
            <summary>
            Releases all notes playing
            </summary>
        </member>
        <member name="M:SFXR.SFXRComponent.Generate(System.Int32)">
            <summary>
            Generates a sound stream from the component
            </summary>
            <param name="sampleCount">How many samples the stream should be filled with</param>
            <returns></returns>
        </member>
        <member name="M:SFXR.SFXRComponent.Generate(System.Int32,System.Collections.Generic.List{SFXR.SFXREffect})">
            <summary>
            Generates a sound stream from the component with the given effects
            </summary>
            <param name="sampleCount">The number of samples</param>
            <param name="effects">A list of the effects to apply</param>
            <returns></returns>
        </member>
        <member name="M:SFXR.SFXRComponent.Randomize">
            <summary>
            Randomizes the component's parameters
            </summary>
        </member>
        <member name="M:SFXR.SFXRComponent.Mutate(System.Single)">
            <summary>
            Mutates the component's parameters slightly
            </summary>
        </member>
        <member name="M:SFXR.SFXREffect.Apply(System.Int16[],SFXR.SFXRComponent)">
            <summary>
            Applies the effect to a sample
            </summary>
            <param name="samples">Samples to apply the effect to</param>
            <param name="sound">Sound applying the effect to</param>
            <returns>Sample with the effect applied</returns>
        </member>
        <member name="M:SFXR.SFXREffect.Sanitize">
            <summary>
            Sanitizes the effect's parameters
            </summary>
        </member>
        <member name="P:SFXR.SFXRFrequency.Start">
            <summary>
            Base tone of the sound, before sliding
            (Default: 400, Range: 0 - 3000)
            </summary>
        </member>
        <member name="P:SFXR.SFXRFrequency.Slide">
            <summary>
            Amount by which the frequency is increased or decreased over time
            (Default: 0, Range: -3000 - 3000)
            </summary>
        </member>
        <member name="P:SFXR.SFXRFrequency.DeltaSlide">
            <summary>
            Amount by which the slide is increased or decreased over time
            (Default: 0, Range: -3000 - 3000)
            </summary>
        </member>
        <member name="M:SFXR.SFXRFrequency.GetFrequency(System.Single)">
            <summary>
            Gets the frequency at a given time
            </summary>
            <param name="time"></param>
            <returns>The frequency in Hz</returns>
        </member>
    </members>
</doc>
