Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Group

Hierarchy

Index

Constructors

Properties

Accessors

Other Methods

Utility Methods

Constructors

constructor

Properties

analyser

analyser: Analyser

Euphony analyser for visualization

Readonly input

input: AudioNode

Underlying WebAudio node used for input to the Euphony node

Readonly output

output: AudioNode

Underlying WebAudio node used for output from the Euphony node

Accessors

sources

volume

  • get volume(): number
  • set volume(volume: number): void

  • Volume of the controller, scale 0.0 to 1.0

    Returns number

  • Volume of the controller, scale 0.0 to 1.0

    Parameters

    • volume: number

    Returns void

Other Methods

pause

  • pause(delay?: number): void

  • Shcedules the audio to be paused for each member in the group, including those of other connected groups recursively. Playback can then be resumed by calling Group.play

    Note: It is recommended to allow some amount of scheduling time to prevent audio glitches

    Parameters

    • delay: number = 0.1

      Amount of time in seconds before the audio is paused

    Returns void

play

  • play(delay?: number): void

  • Shcedules the audio to be played for each member in the group, including those of other connected groups recursively.

    Note: It is recommended to allow some amount of scheduling time to prevent audio glitches

    Parameters

    • delay: number = 0.1

      Amount of time in seconds before the audio is paused

    Returns void

stop

  • stop(delay?: number): void

  • Shcedules the audio to be stopped for each member in the group, including those of other connected groups recursively. If played again by calling Group.play the previous time will not be remembered

    Note: It is recommended to allow some amount of scheduling time to prevent audio glitches

    Parameters

    • delay: number = 0.1

      Amount of time in seconds before the audio is paused

    Returns void

sync

  • sync(_length?: number): void

  • Synchronizes all members of a group to the length of the maximum buffer, including those of other connected sub-groups recursively.

    Parameters

    • Optional _length: number

      Forces the buffers to be synced to this value. This is only used for the recursion and does not need to be set

    Returns void

updateFrequencyAll

  • updateFrequencyAll(): void

  • Convenience function for updating the frequency data of all sources in a group, including the group and sub-groups See Analyser.updateFrequency

    Returns void

updateWaveformAll

  • updateWaveformAll(): void

  • Convenience function for updating the waveform data of all sources in a group, including the group and sub-groups See Analyser.updateWaveform

    Returns void

Utility Methods

connect

  • Function for connecting a Euphony node to another Euphony node or a WebAudio node

    Parameters

    • destination: EuphonyNode | AudioNode

      The destionation to connect to, either a Euphony node or base WebAudio node

    Returns void

Generated using TypeDoc