Sample | miniSphere

Represents an audio clip optimized for regular, repeated playback.

Hierarchy

Sample

Index

Constructors

constructor

Properties

fileName

Methods

Constructors

constructor

new Sample(fileName: string): Sample

- Defined in lib.sphere.d.ts:1051
Construct a new sample from the contents of an audio file. The sample can be used immediately; playback will be silent until the file is fully loaded.

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

Properties

fileName

fileName: string

Full, canonical SphereFS path of the audio file used for this sample.

Methods

play

play(mixer: Mixer, options?: SoundOptions): void

- Defined in lib.sphere.d.ts:1068
Play a new instance of this sample on a given mixer.

Parameters
- mixer: Mixer
  
  The mixer used to play back the sample.
- Optional options: SoundOptions
  
  Playback options.
Returns void

stopAll

stopAll(): void

- Defined in lib.sphere.d.ts:1071
Stop playback of all currently playing instances of this sample.

Returns void

Static fromFile

fromFile(fileName: string): Promise<Sample>

- Defined in lib.sphere.d.ts:1051
Load an audio file in the background and construct a new sample from its contents.

async

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

A promise for the newly constructed Sample.

Generated using TypeDoc