Sound Effects

Edit

Play Sound Effect #

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 %
Audio Device String Optional. Leave empty for the current default device. Select a device from the dropdown, use default, primary, or standard for the default device, or type a full/partial Windows playback device name. Advanced users may also enter a numeric output device index.
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.
  • Audio Device routing uses SAMMI’s DLL playback path. For .ogg/Vorbis files, leave Audio Device empty.
  • 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.

This also works for sound effects played on a specific Audio Device; use the Sound ID saved by Play Sound Effect.

Box Name Type Description
Sound ID String Sound Effect ID. If you use a variable, enter the variable name as the ID, not the variable’s value. 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.

This works the same for sound effects played on a specific Audio Device; use the Sound ID saved by Play Sound Effect.

Box Name Type Description
Sound ID String Sound Effect ID. If you use a variable, enter the variable name as the ID, not the variable’s value.
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.

This works the same for sound effects played on a specific Audio Device. SAMMI adjusts the playback speed while keeping the original pitch as stable as possible.

Box Name Type Description
Sound ID String Sound Effect ID. If you use a variable, enter the variable name as the ID, not the variable’s value.
Speed Number Speed % to change to