Sound Effects

Edit

Play Sound Effect #

Plays a selected sound file. Files must be in Vorbis codec in an .ogg container.

Plays a selected audio file using SAMMI’s sound effect system.

Supported file types:

  • .mp3
  • .wav
  • .m4a
  • .ogg
  • .mp4 (audio-only playback)
Box Name Type Description
Sound File Path String Select the file to play. Relative paths are allowed (e.g., sounds/airhorn.mp3).
Volume Level number Set the volume level in %
Save Sound ID String Sound Effect ID (you can select any name; it’s used for other sound effect commands like stop/volume/speed)

Examples:

Sound File Path Result
sounds/airhorn.mp3 Plays airhorn.mp3 at the selected volume.
sounds/cheer.ogg Plays cheer.ogg using the same sound system.

Notes:

  • If the selected file contains video (e.g., a full .mp4), only the audio track will be played.
  • Use a unique Save Sound ID to reference this sound for volume/stop/speed commands.


Edit

Stop Sound Effect #

Stops currently playing sound effect. Provide its ID that you set up in Play Sound Effect command.

Box Name Type Description
Sound ID String Sound Effect ID. Use all to stop all sound effects.


Edit

Sound Effect Change Volume #

Temporarily changes volume of your currently playing sound effect. Provide its ID that you set up in Play Sound Effect command.

Box Name Type Description
Sound ID String Sound Effect ID
Volume Number Volume % to change to
Duration (ms) Number How long the command will take to change the volume (0 is instant)


Edit

Sound Effect Change Speed #

Changes speed of your currently playing sound effect. Provide its ID that you set up in Play Sound Effect command.

Box Name Type Description
Sound ID String Sound Effect ID
Speed Number Speed % to change to