Difference between revisions of "Sound.init"
Jump to navigation
Jump to search
m (→Example) |
SpatialPlays (talk | contribs) m (Added arguments table and "See also" sections) |
||
| Line 1: | Line 1: | ||
<c>[[Sound]].init</c> synthesizes a sound from various parameters, including look-up tables | <c>[[Sound]].init</c> synthesizes a sound from various parameters, including look-up tables | ||
that represent one cycle of the waveform and the volume envelope. | that represent one cycle of the waveform and the volume envelope. | ||
| + | |||
| + | === Arguments === | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! 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 === | === 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
== Example == | == Example == | ||
| Line 19: | Line 30: | ||
hitSnd.init 1, 100, [1,0], Sound.noiseWave | hitSnd.init 1, 100, [1,0], Sound.noiseWave | ||
hitSnd.play</ms> | hitSnd.play</ms> | ||
| + | |||
| + | See also: <c>[[Sound.duration]]</c>; <c>[[Sound.freq]]</c>; <c>[[Sound.envelope]]</c>; <c>[[Sound.waveform]]</c> | ||
[[Category:Mini Micro]] | [[Category:Mini Micro]] | ||
Revision as of 00:38, 30 April 2020
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.
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
