XSound - v4.2.0
    Preparing search index...

    Interface Oscillator

    This private class is entity for oscillator.

    interface Oscillator {
        get INPUT(): OscillatorNode;
        get OUTPUT(): GainNode;
        activate(): Oscillator;
        deactivate(): Oscillator;
        get(): OscillatorNode;
        param(params: "state"): boolean;
        param(params: "type"): OscillatorType | OscillatorCustomType;
        param(params: "octave"): number;
        param(params: "fine"): number;
        param(params: "volume"): number;
        param(params: OscillatorParams): Oscillator;
        params(): Required<OscillatorParams>;
        ready(output: AudioNode): void;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number): void;
    }

    Implements

    Index

    Accessors

    INPUT OUTPUT

    Methods

    activate deactivate get param params ready start state stop

    Accessors

    Methods

    • This method gets or sets parameters for oscillator.

      Parameters

      • params: "state"

        This argument is string if getter. Otherwise, setter.

      Returns boolean

      Return value is parameter for oscillator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for oscillator.

      Parameters

      • params: "type"

        This argument is string if getter. Otherwise, setter.

      Returns OscillatorType | OscillatorCustomType

      Return value is parameter for oscillator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for oscillator.

      Parameters

      • params: "octave"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for oscillator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for oscillator.

      Parameters

      • params: "fine"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for oscillator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for oscillator.

      Parameters

      • params: "volume"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for oscillator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for oscillator.

      Parameters

      Returns Oscillator

      Return value is parameter for oscillator if getter. Otherwise, return value is for method chain.

    • This method connects AudioNodes.

      Parameters

      • output: AudioNode

        This argument is instance of AudioNode as output.

      Returns void

    • This method starts sound.

      Parameters

      • OptionalstartTime: number

        This argument is start time.

      Returns void

    • This method stops sound.

      Parameters

      • OptionalstopTime: number

        This argument is stop time.

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods