`MotionVoice`

interface

One playing of a sound: turned, panned, sped, moved, stopped, or crossed over to another sound. Read it with its properties, change it with its methods.

Name	`MotionVoice`
Kind	interface
Script reaches it as	`MotionSound.play()`
Since	0.3

Syntax

interface MotionVoice { … }

Properties

Name	Type	Description
`id`property	`readonly number`	Its number.
`playing`property	`readonly boolean`	Whether it's still playing (as of the last frame).
`volume`property	`readonly number`	Its volume, 0 to 2.
`pan`property	`readonly number`	Its pan, -1 left to 1 right.
`rate`property	`readonly number`	Its speed, 0.25 to 4 (faster is higher).
`position`property	`readonly number`	Where it is in its sound, seconds (as of the last frame).
`ended`property	`readonly Promise<void>`	A promise of its ending: played out, or stopped.

Methods

Signature	Description
`stop(options?: { fadeOut?: number }): void`method	Stops it, at once or fading out.
`setVolume(volume: number): void`method	Turns it up or down.
`setPan(pan: number): void`method	Pans it.
`setRate(rate: number): void`method	Plays it faster (and higher) or slower.
`seek(seconds: number): void`method	Moves it to a place in its sound.
`crossfadeTo(other: MotionSound, seconds: number): MotionVoice`method	Fades this voice out as another sound fades in, over seconds.

MotionVoice

Syntax

Properties

Methods

Notes from the community

`MotionVoice`