Audio Module
The DOTS Mode Audio Module supports a subset of the audio features in classic Unity Audio. This page provides common use cases, an example, and a reference of the Audio components.
Use Cases and Examples
This section demonstrates how to use the Audio module through common use cases and usage examples. If a use case or an example is similar to a topic in the Unity User Manual, a link is provided to the appropriate topic.
Simple Audio Source
Create an entity.
Add an AudioSource component.
Set the
clipproperty to an audio asset.Set the
volumeproperty to 1.Add an AudioSourceStart component to begin playback.
The AudioSource component
After exporting your project, the audio clip will play through once.
Alternatively, you can play an AudioClip via scripting in a DOTS Mode system using an entity's AudioSource.
Components
AudioClip
- Unity Reference: AudioClip
Defines a container for audio data. AudioClips are referenced and used by AudioSources to play sounds. An AudioClip represents a single audio resource that can play back on one or more AudioSource components.
| Property | Description |
|---|---|
| AudioClipStatus | The AudioClip load status. The AudioClipStatus enum defines the possible states. |
AudioSource
- Unity Reference: AudioSource
Plays back an audio clip in an EntityGroup. Controls the volume and audio clip properties (e.g. loop).
An AudioSource can play a single audio clip. Multiple AudioSources can exist in separate entities.
| Property | Description |
|---|---|
| clip | A DOTS Mode entity representing a reference to an audio clip (sound asset) to be played. |
| volume | Represents the audio clip playback volume between [0..1]. |
| loop | Determines if the audio clip should replay when it reaches the end. If true, the audio clip replays when it ends. |
| isPlaying | Determines if the audio clip is currently playing. If true, the audio clip is playing. |
AudioSourceStart
Begins the playback of an [AudioSource]. Attach this component to an entity with an AudioSource component to start playback the next time the AudioSystem updates.
AudioSourceStop
Stops the playback of an [AudioSource]. Attach this component to an entity with an AudioSource component to stop playback the next time the AudioSystem updates.
Systems
AudioSystem
An internal System that is automatically called to start and stop audio, load assets, and update isPlaying.
Enums
AudioClipStatus
Value describing the current load state of the audio data associated with an AudioClip.
| Value | Description |
|---|---|
| Unloaded | Value returned by AudioClip.status for an AudioClip that has no audio data loaded and where loading has not been initiated yet. |
| Loading | Value returned by AudioClip.status for an AudioClip that is currently loading audio data. |
| Loaded | Value returned by AudioClip.status for an AudioClip that has succeeded loading its audio data. |
| LoadError | Value returned by AudioClip.status for an AudioClip that has failed loading its audio data. |