Sounds

Calling this function immediately plays the music track specified by asset. The loop parameter controls whether the music track plays continuously, or stops when finished.

Only one music track can be played at a time. You can modify the currently playing music track by accessing elements of the music table, such as music.volume.

Do not call this function repeatedly in your draw loop. The music function is intended to be called once each time you wish to start playing music, or when you wish to change music tracks.

This variable controls the currently playing music track's volume. It ranges from 0.0 to 1.0.

This variable controls the currently playing music track's stereo panning. It ranges from -1.0 to 1.0.

This variable controls the seek position of the currently playing music track. It ranges from 0.0 (start of the track) to music.duration (end of the track).

This variable sets the paused state of the current music track.

This variable controls whether the music track is currently muted.

Read only. This variable returns the length of the current music track in seconds.

Read only. This variable returns the number of channels supported by the current track (usually 1 or 2).

Read only. This value returns the asset string of the currently playing music.

Stops the currently playing music track.

Calling this function immediately plays a sound effect, or a randomly generated sound with a type specified by name or encoded with the given parameters.

If using a sound asset (a sound from an asset pack) the sound function accepts the following optional parameters: volume, pitch, pan and loop. Please see the parameter table for an explanation of these.

sound() can use sfxr to randomly generate sounds of a given type. The name parameter is a string specifying the type of sound (see related items), and the seed parameter allows you to choose a particular random sound. Sounds with the same name and seed always sound the same. If no seed is specified the resulting sound will be a random sound of the specified type. If a parameterTable is passed in, those values are used to generate the sound.

Do not call this function repeatedly in your draw loop. The sound function is intended to be called when you wish to play a sound effect (on a game event such as the player getting hit).

This object represents a sound buffer containing arbitrary audio data. You may create soundbuffer objects using soundbuffer( data, format, freq ) where the data is uncompressed PCM audio and the format is one of FORMAT_MONO8, FORMAT_MONO16, FORMAT_STEREO8, or FORMAT_STEREO16.

Calling this function will set the maximum buffer size for sounds. Sounds are stored in a buffer so that they do not need to be recreated if reused. Sounds are removed from this buffer on a least recently used basis when the buffer is full and a new sound is added. For example, if the buffer is 2 megabytes (the default), and we add a sound that puts it over the limit, the sound we used the longest time ago is removed from the buffer and will have to be re-created if played again. Generating the sound data can take a considerable amount of time for longer sounds.Playing a sound at 0 volume counts as playing and can be used to keep a sound in the cache (and to pre-generate a sound in the setup function.) Calling this method with 0 for the size sets the buffer to no limit. This can cause Codea to crash if too many sounds are generated as it may run out of memory.Calling this with no parameters returns the max size and current size of the buffer.

Created when calling the sound command, represents a live sound currently playing. Can be controlled to alter the playing sound

Stops the sound if it is currently playing

Start the sound again from the beginning next time it is played

Fades the volume of the soundsource to the specified volume over the time specified by duration

Cancels the current fading action, if possible

Adjustes the pitch of the soundsource to the specified pitch over the time specified by duration

Cancels the current pitch change action, if possible

Adjustes the pan of the soundsource to pan over the time specified by duration

Cancels the current pan change action, if possible

Cancels all active actions on the soundsource, if possible

This constant specifies a jump sound. Similar to a character jumping in a platform game.

This constant specifies a hit sound. For example, when the enemy collides with the player.

This constant specifies a pickup sound. For example, collecting coins in a game.

This constant specifies a powerup sound. For example, collecting bonuses in a game.

This constant specifies a shooting sound. For example, firing a bullet in a game.

This constant specifies an explosion sound. For example, a space ship blowing up.

This constant specifies a generic "blit" sound.

This constant specifies a randomly generated sound. You can use this in conjunction with the seed value of the sound() function to find a sound that you like.

This specifices to use a white noise function as the waveform for this sound

This specifices to use a sawtooth function as the waveform for this sound

This specifices to use a sine wave function as the waveform for this sound

This specifices to use a square wave function as the waveform for this sound

This type represents a spoken utterance that can be played back using the speech.say() function. It consists of a string and other properties which determine the volume, speed and pitch of playback.

Multiple utterances can be queued for playback with the speech.say() function. The utterances will be separated by their respective preDelay and postDelay intervals.

Note that speech can be used to construct utterances to be used later, but it can also be used as a global table that can be configured for all future speech. See the two examples for both kinds of use.

This function can be used to speak a particular string or utterance. Calling this function multiple times will add more utterances to the queue to be spoken, it will not stop anything currently being spoken. Use speech.stop or speech.pause to control playback.

This function can be used to pause anything currently being spoken. Speech will pause after the next word by default. Pass a value of true to this function to pause speech immediately.

After speech is paused, it can be continued with the speech.continue() function.

This function can be used to stop anything currently being spoken. Speech will stop after the next word by default. Pass a value of true to this function to stop speech immediately.

Unlike speech.pause speech which has been stopped cannot be resumed with the speech.continue() function.

Use this function to resume speech which has been paused with speech.pause

Check this value to see if the speech synthesizer is currently speaking.

Check this value to see if the speech synthesizer is currently paused.

Set this value to control the pitch of speech playback with speech.say. This value ranges from 0.5 to 2.0, the default is 1.0.

Set this value to control the rate (speed) of speech playback with speech.say. This value ranges from 0.0 to 1.0, the default is 0.5.

Set this value to control the pre delay of speech played back with speech.say. Speech will be delayed by this amount prior to playback. Defaults to 0.0.

Set this value to control the post delay of speech played back with speech.say. A pause for this amount of time will occur after speech played back and before the next queued speech.

Set this value to control volume of speech played back with speech.say. This value can range between 0.0 and 1.0. It defaults to 1.0.

Use this function to start tracking input from the device microphone

Use this function to stop tracking input from the device microphone

Sample this value to determine the volume of sound coming into the microphone

Sample this value to determine the pitch of sound coming into the microphone