Sound | miniSphere

Represents an audio clip optimized for streaming playback.

Hierarchy

Sound

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Sound(fileName: string): Sound

- Defined in lib.sphere.d.ts:1269
Construct a Sound that can be used to play back the given audio file. The sound can be used immediately, but playback may be silent until enough audio data has been buffered.

Parameters
- fileName: string
  
  SphereFS path of an audio file.
Returns Sound

Properties

fileName

fileName: string

length

length: number

Duration of this sound, in seconds.

pan

pan: number

playing

playing: boolean

true if the sound is currently playing; false otherwise.

position

position: number

repeat

repeat: boolean

speed

speed: number

volume

volume: number

Methods

pause

pause(): void

- Defined in lib.sphere.d.ts:1296
Pause playback of this sound. It can be resumed later by calling play() without a mixer.

Returns void

play

play(mixer?: Mixer): void

- Defined in lib.sphere.d.ts:1303
Play the sound on a given mixer. If the sound is paused and a mixer is not specified, resume playback from the paused position.

Parameters
- Optional mixer: Mixer
  
  The mixer used to play back the sound.
Returns void

stop

stop(): void

- Defined in lib.sphere.d.ts:1306
Stop playback of this sound.

Returns void

Static fromFile

fromFile(fileName: string): Promise<Sound>

- Defined in lib.sphere.d.ts:1269
Open an audio file in the background and construct a Sound that can be used to play it.

async

Parameters
- fileName: string
  
  SphereFS path of an audio file.
Returns Promise<Sound>

A promise for the newly constructed Sound.

Generated using TypeDoc