Sound
The Sound Component controls playback of audio samples.
Each Sound Component contains "Slots" that are responsible for playing sounds. Each Slot can be assigned a different audio Asset, and can be played independently from the other Slots.
You can add a new Slot by clicking on the "ADD SLOT" button. You can remove a Slot by clicking on the bin icon in the header of each slot.
Component Properties
| Property | Description |
|---|---|
| Positional | If checked, the component will play back audio assets as if played from the location of the entity in 3D space. |
| Volume | The volume that will be multiplied with the volume of each Slot when playing an audio asset (0 to 1). |
| Pitch | The pitch that will be multiplied with the pitch of each Slot when playing an audio asset. A value of 1 means the audio is played back at the original pitch. |
| Ref Distance | Positional only. The reference distance for reducing volume as the sound source moves further from the listener. |
| Max Distance | Positional only. The maximum distance from the listener at which audio falloff stops. Note the volume of the audio is not necessarily 0 after this distance, but just doesn't fall off anymore. |
| Distance Model | Positional only. Determines which algorithm to use to reduce the volume of the sound as it moves away from the listener. Options: Linear, Exponential, Inverse. |
| Roll-off Factor | Positional only. The rate at which volume fall-off occurs. |
Slot Properties
| Property | Description |
|---|---|
| Name | The name of the Slot. This is the name that you will use to refer to this Slot in code. |
| Asset | The audio asset to play. |
| Start Time | The starting point of the sound in the audio asset, in seconds. You can use this if you don't want to play the entire audio asset but just a portion of it instead. |
| Duration | The duration of the sound to play starting from Start Time, in seconds. Leave empty to play until the end. E.g. you might have an audio asset with multiple sounds in it. To make this Slot play such a sound you can define its Start Time and Duration. |
| Auto Play | If checked, the Slot will be played on load. Otherwise, the Slot will need to be played using script. |
| Overlap | If checked, this Slot will play its sound without stopping first. Overlap should be used for one-shot sounds that need to be played repeatedly. Overlapping sounds do not stop when the Entity is destroyed, but only when they finish or when you manually stop them in script. |
| Loop | If checked, the Slot will loop continuously. Otherwise, it will be played once to completion. |
| Volume | The volume of the audio asset played back by the slot (0 to 1). |
| Pitch | The pitch at which the audio is played. A value of 1 means the audio is played back at the original pitch. |
See Also
- Audio Listener Component - Set the listener position for 3D audio
- Audio Assets - Learn more about audio assets
Scripting Interface
You can control a Sound Component's properties using a Script Component. The Sound Component's scripting interface is here.