A playing instance of a sound (or promise to play as soon as it loads). These can only be created through springroll.Sound.instance.play().
updateVolume
contextVol
Updates the volume of this SoundInstance.
contextVol
Number
The volume of the sound context that the sound belongs to. If omitted, the volume is automatically collected.
_fDur
The duration in milliseconds for the fade that this sound instance is performing.
_fTime
The current time in milliseconds for the fade that this sound instance is performing.
_startFunc
User's callback function for when the sound starts. This is only used if the sound wasn't loaded before play() was called.
_startParams
An array of relevant parameters passed to play(). This is only used if the sound wasn't loaded before play() was called.
curVol
The current sound volume (0 to 1). This is multiplied by the sound context's volume. Setting this won't take effect until updateVolume() is called.
isValid
An active SoundInstance should always be valid, but if you keep a reference after a sound stops it will no longer be valid (until the SoundInstance is reused for a new sound).
length
The length of the sound in milliseconds. This is 0 if it hasn't finished loading.
paused
If the sound is currently paused. Setting this has no effect - use pause() and resume().
position
The position of the sound playhead in milliseconds, or 0 if it hasn't started playing yet.
volume
The current sound volume (0 to 1). This is multiplied by the sound context's volume to get the actual sound volume.