Class: AudioClipPlayer

sound.AudioClipPlayer(options)

new AudioClipPlayer(options)

This class handles the playback of an audio clip, e.g. a microphone recording.

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
psychoJS module:core.PsychoJS the PsychoJS instance
audioClip Object the module:sound.AudioClip
startTime number <optional>
 0 start of playback (in seconds)
stopTime number <optional>
 -1 end of playback (in seconds)
stereo boolean <optional>
 true whether or not to play the sound or track in stereo
volume number <optional>
 1.0 volume of the sound (must be between 0 and 1.0)
loops number <optional>
 0 how many times to repeat the track or tone after it has played *
Source:

Extends

  • SoundPlayer

Methods

(static) accept(sound) → {Object|undefined}

Determine whether this player can play the given sound.
Parameters:
Name Type Description
sound module:sound.Sound the sound object, which should be an AudioClip
Source:
Returns:
an instance of AudioClipPlayer if sound is an AudioClip or undefined otherwise
Type
Object | undefined

getDuration() → {number}

Get the duration of the AudioClip, in seconds.
Source:
Returns:
the duration of the clip, in seconds
Type
number

play(loops, fadeDurationopt)

Start playing the sound.
Parameters:
Name Type Attributes Default Description
loops number how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped.
fadeDuration number <optional>
 17 how long should the fading in last in ms
Source:

setDuration(duration_s)

Set the duration of the audio clip.
Parameters:
Name Type Description
duration_s number the duration of the clip in seconds
Source:

setLoops(loops)

Set the number of loops.
Parameters:
Name Type Description
loops number how many times to repeat the clip after it has played once. If loops == -1, the clip will repeat indefinitely until stopped.
Source:

setVolume(volume, muteopt)

Set the volume of the playback.
Parameters:
Name Type Attributes Default Description
volume number the volume of the playback (must be between 0.0 and 1.0)
mute boolean <optional>
 false whether or not to mute the playback
Source:

stop(fadeDurationopt)

Stop playing the sound immediately.
Parameters:
Name Type Attributes Default Description
fadeDuration number <optional>
 17 how long the fading out should last, in ms
Source: