API Docs for: 2.7.1
Show:

Trigger Class

Extends BaseSound
Module: Models

A model which triggers a single or multiple audio sources with multiple voices (polyphony).

Constructor

Trigger

(
  • [context]
  • [sources]
  • [onLoadProgress]
  • [onLoadComplete]
  • [onAudioStart]
  • [onAudioEnd]
)

Parameters:

  • [context] AudioContext optional

    AudioContext to be used.

  • [sources] Array/String/AudioBuffer/File optional

    Single or Array of either URLs or AudioBuffers or File Object of the audio source.

  • [onLoadProgress] Function optional

    Callback when the audio file is being downloaded.

  • [onLoadComplete] Function optional

    Callback when all sources have finished loading.

  • [onAudioStart] Function optional

    Callback when the audio is about to start playing.

  • [onAudioEnd] Function optional

    Callback when the audio has finished playing.

Methods

connect

(
  • destination
  • [output]
  • [input]
)

Inherited from BaseSound:

If the parameter output is an AudioNode, it connects to the releaseGainNode. If the output is a BaseSound, it will connect BaseSound's releaseGainNode to the output's inputNode.

Parameters:

  • destination AudioNode

    AudioNode to connect to.

  • [output] Number optional

    Index describing which output of the AudioNode from which to connect.

  • [input] Number optional

    Index describing which input of the destination AudioNode to connect to.

disconnect

(
  • [outputIndex]
)

Inherited from BaseSound:

Disconnects the Sound from the AudioNode Chain.

Parameters:

  • [outputIndex] Number optional

    Index describing which output of the AudioNode to disconnect.

listParams

(
  • [paramArray]
)

Inherited from BaseSound:

List all SPAudioParams this Sound exposes

Parameters:

  • [paramArray] Array optional

    Array of all the SPAudioParams this Sound exposes.

pause

()

Inherited from BaseSound

Pauses playing all voices.

play

()

Inherited from BaseSound

Triggers a single voice immediately.

release

(
  • [when]
  • [fadeTime]
  • [resetOnRelease]
)

Inherited from BaseSound:

Linearly ramp down the gain of the audio in time (seconds) to 0.

Parameters:

  • [when] Number optional

    Time (in seconds) at which the Envelope will release.

  • [fadeTime] Number optional

    Amount of time (seconds) it takes for linear ramp down to happen.

  • [resetOnRelease] Boolean optional

    Boolean to define if release stops (resets) the playback or just pauses it.

setOutputEffect

(
  • effect
)

Inherited from BaseSound:

Adds an sound effect to the output of this model, and connects the output of the effect to the Audio Destination

Parameters:

  • effect Object

    An Sound Effect of type BaseEffect to be appended to the output of this Sound.

setSources

(
  • sources
  • [onLoadProgress]
  • [onLoadComplete]
)

Inherited from BaseSound

Reinitializes the model and sets it's sources.

Parameters:

  • sources Array/AudioBuffer/String/File

    Single or Array of either URLs or AudioBuffers of sources.

  • [onLoadProgress] Function optional

    Callback when the audio file is being downloaded.

  • [onLoadComplete] Function optional

    Callback when all sources have finished loading.

start

(
  • when
  • [offset]
  • [duration]
  • [attackDuration]
)

Inherited from BaseSound

Triggers a single voice at the given time

Parameters:

  • when Number

    The delay in seconds before playing the model

  • [offset] Number optional

    The starting position of the playhead

  • [duration] Number optional

    Duration of the portion (in seconds) to be played

  • [attackDuration] Number optional

    Duration (in seconds) of attack ramp of the envelope.

stop

()

Inherited from BaseSound

Stops playing all voices.

toggle

()

Pauses if currently playing. Otherwise starts playing.

Properties

audioContext

AudioContext

Inherited from BaseSound:

Web Audio API's AudioContext. If the context passed to the constructor is an AudioContext, a new one is created here.

destinations

Array

Inherited from BaseSound:

Set of nodes the output of this sound is currently connected to.

eventRand

SPAudioParam

Enable randomness in the order of sources which are triggered.

Default: false

inputNode

Object

Inherited from BaseSound:

The input node that the output node will be connected to.
Set this value to null if no connection can be made on the input node

Default: null

isInitialized

Boolean

Inherited from BaseSound:

If Sound is currently initialized.

Default: false

isPlaying

Boolean

Inherited from BaseSound:

If Sound is currently playing.

Default: false

maxSources

Number

Inherited from BaseSound:

Maximum number of sources that can be given to this Sound

Default: 0

minSources

Number

Inherited from BaseSound:

Minimum number of sources that can be given to this Sound

Default: 0

modelName

String

Inherited from BaseSound:

String name of the model.

Default: "Model"

numberOfInputs

Number

Inherited from BaseSound:

Number of inputs

Default: 0

numberOfOutputs

Number

Inherited from BaseSound:

Number of outputs

Default: 0

onAudioEnd

Function

Inherited from BaseSound:

Callback for the audio is about to stop playing.

Default: null

onAudioStart

Function

Inherited from BaseSound:

Callback for when the audio is about to start playing.

Default: null

onLoadComplete

Function

Inherited from BaseSound:

Callback for when loading of audio files is done and the the model is initalized.

Default: null

onLoadProgress

Function

Inherited from BaseSound:

Callback for handling progress events thrown during loading of audio files.

Default: null

pitchRand

SPAudioParam

Maximum value for random pitch shift of the triggered voices in semitones.

Default: 0.0

pitchShift

SPAudioParam

Pitch shift of the triggered voices in semitones.

Default: 0.0

releaseGainNode

GainNode final

Inherited from BaseSound:

Release Gain Node

Default: Internal GainNode