Class: TrackPlayer

sound.TrackPlayer(options)

new TrackPlayer(options)

This class handles the playback of sound tracks.

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
psychoJS module:core.PsychoJS the PsychoJS instance
howl Object the sound object (see https://howlerjs.com/)
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:
To Do:
  • stopTime is currently not implemented (tracks will play from startTime to finish)
  • stereo is currently not implemented

Extends

  • SoundPlayer

Methods

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

Determine whether this player can play the given sound.
Parameters:
Type Description
module:sound.Sound the sound
Source:
Returns:
an instance of TrackPlayer that can play the given sound or undefined otherwise
Type
Object | undefined

getDuration() → {number}

Get the duration of the sound, in seconds.
Source:
Returns:
the duration of the track, in seconds
Type
number

play(loops)

Start playing the sound.
Parameters:
Name Type 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.
Source:

setLoops(loops)

Set the number of loops.
Parameters:
Name Type 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.
Source:

setVolume(volume, muteopt)

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

stop()

Stop playing the sound immediately.
Source: