Difference between revisions of "Sound.init"

From MiniScript Wiki
Jump to navigation Jump to search
m (Added arguments table and "See also" sections)
 
Line 19: Line 19:
 
=== Usage Notes ===
 
=== Usage Notes ===
 
Call this on a new Sound object, or to reset a previous one.
 
Call this on a new Sound object, or to reset a previous one.
 +
 +
The frequency and envelope arguments may be either a single value, applied to the entire sound; or a list of values, in which case the frequency or amplitude will interpolate evenly over those values over the duration of the sound.
  
 
== Example ==
 
== Example ==

Latest revision as of 18:42, 20 January 2024

Sound.init synthesizes a sound from various parameters, including look-up tables that represent one cycle of the waveform and the volume envelope.

Arguments

Parameter Name Type Default Value Meaning
duration number 1 length of the sound in seconds
frequency number 440 number of repeats of the waveform per second
envelope [number] [1] volume (0 to 1) over the duration of the sound
waveform [number] [-1, 1] wave value over an audio cycle

Usage Notes

Call this on a new Sound object, or to reset a previous one.

The frequency and envelope arguments may be either a single value, applied to the entire sound; or a list of values, in which case the frequency or amplitude will interpolate evenly over those values over the duration of the sound.

Example

pew = new Sound
pew.init 0.3, [8000,100], [1,0]
pew.play

Example 2:

hitSnd = new Sound
hitSnd.init 1, 100, [1,0], Sound.noiseWave
hitSnd.play

See also: Sound.duration; Sound.freq; Sound.envelope; Sound.waveform