Sound Command (AGI)

AGI Sound Command

 

 

Description

The sound command plays a loaded sound resource.

sound SOUND_NUM is played. fDONE_FLAG is reset when the command is issued, and set when the sound finishes playing or is stopped with the stop.sound command.

The sound must be loaded before it is played. This can be done with the load.sound command.

Syntax

Starts playback of a SOUND resource. n. When finished, flag is set to 1.

sound(SOUND_NUM,fDONE_FLAG);

Remarks

The sound must be loaded with the load.sound command before it can be played.

The flag fDONE is cleared before the sound starts. When the sound stops playing (by reaching the end of the resource, or by issuing the stop.sound command) fDONE is set to TRUE.

If a sound is currently being played, it will stop, and its done flag will be set before this sound is played.

Example

Code:

load.sound(22);
sound(22, f99);

Technical Information

Required interpreter version	Bytecode Value
Available in all AGI versions	0x63

Sources

• WinAGI Help File

See Also

• Sound Resource (AGI)
• AGI Sound Commands
  • sound
  • load.sound
  • stop.sound
  • discard.sound
• AGI Specifications: Chapter 4 - The Logic Language stop.sound
• AGI Commands
• AGI Command Reference