Class SoundModuleAbstract

constructor

• new SoundModule(context: AudioContext): SoundModule

  Parameters

  • context: AudioContext

    This argument is in order to use Web Audio API.

  Returns SoundModule

Static ReadonlyNUMBER_OF_INPUTS

Static ReadonlyNUMBER_OF_OUTPUTS

AbstractINPUT

• get INPUT(): null | GainNode | AudioWorkletNode

  Connector for input.

  Returns null | GainNode | AudioWorkletNode

AbstractOUTPUT

• get OUTPUT(): GainNode

  Connector for output.

  Returns GainNode

audioDestination

• audioDestination(): SoundModule

  This method switches destination over to AudioDestinationNode.

  Returns SoundModule

  Return value is for method chain.

connect

• connect(source: AudioNode): void

  This method connects AudioNodes.

  Parameters

  • source: AudioNode

    This argument is AudioNode as sound source.

  Returns void

demix

• demix(): SoundModule

  This method is invoked on demixing.

  Returns SoundModule

  Return value is for method chain.

disconnect

• disconnect(): void

  This method disconnects instance of AudioWorkletNode as sound source.

  Returns void

edit

• edit(modules: Connectable[]): Connectable[]

  This method edits module to use and module connection order.

  Parameters

  • modules: Connectable[]

    This argument is edited modules.

  Returns Connectable[]

  Return value is previous modules.

install

• install<ExtendedEffector extends Effector>(
      effector: new (context: AudioContext) => ExtendedEffector,
  ): ExtendedEffector

  This method installs customized effector.

  Type Parameters

  • ExtendedEffector extends Effector

  Parameters

  • effector: new (context: AudioContext) => ExtendedEffector

    This argument is subclass that extends Effector class.

  Returns ExtendedEffector

  Return value is instance of customized effector (that extends Effector class).

mix

• mix(): SoundModule

  This method is invoked on mixing.

  Returns SoundModule

  Return value is for method chain.

off

• off(stopTime?: number): SoundModule

  This method stops effectors.

  Parameters

  • OptionalstopTime: number

    This argument is used for scheduling parameter.

  Returns SoundModule

  Return value is for method chain.

on

• on(startTime?: number): SoundModule

  This method starts effectors.

  Parameters

  • OptionalstartTime: number

    This argument is used for scheduling parameter.

  Returns SoundModule

  Return value is for method chain.

params

• params(): Required<SoundModuleParams>

  This method gets effector's parameters as associative array.

  Returns Required<SoundModuleParams>

setSinkId

• setSinkId(
      sinkId: string,
      successCallback?: () => void,
      errorCallback?: (error: Error) => void,
  ): SoundModule

  This method enables to use multiple output devices.

  Parameters

  • sinkId: string

    This argument is string as output device ID.
  • OptionalsuccessCallback: () => void

    This argument is invoked on success.
  • OptionalerrorCallback: (error: Error) => void

    This argument is invoked on failure.

  Returns SoundModule

  Return value is for method chain.

streamDestination

• streamDestination(): SoundModule

  This method switches destination over to MediaStreamAudioDestinationNode.

  Returns SoundModule

  Return value is for method chain.

suspend

• suspend(): SoundModule

  This method stops analyser, recorder and onaudioprocess event.

  Returns SoundModule

  Return value is for method chain.

toJSON

• toJSON(): string

  This method gets effector's parameters as JSON.

  Returns string