Class

Sample

Sample(filename)

Constructor

# new Sample(filename)

Load a WAV-file.
Parameters:
Name Type Description
filename string

Members

number

# bits

Sound resolution.
string

# filename

Name of the WAV.
number

# frequency

Sound frequency.
number

# length

Sound length.
bool

# stereo

mono/stereo indicator.

Methods

# Get(sample) → {number}

Get sample data.
Parameters:
Name Type Description
sample number index to return.
The sample value at that position. The sample data are always in unsigned format.
number

# Play(volume, panning, loop) → {number}

Play the WAV.
Parameters:
Name Type Description
volume number between 0-255.
panning number between (left) 0-255 (right).
loop boolean true := sample will loop, false := sample will only be played once.
used voice number or null if not played.
number

# Stop()

Stop playing.