 | AudioManager Class |
Allows to play & pool sounds and group them into AudioSources. Handles background music.
Inheritance HierarchyNamespace: Kit
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0
SyntaxThe AudioManager type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | IsMusicPlaying | Returns whether a background music is playing. |
| MusicFadeSpeed | Gets or sets how fast to fade the background music. |
| MusicManager | Handler for music since we're always fading it. |
| MusicSource | The AudioSource for background music. |
| SoundSource | The AudioSource for general sounds group. |
| UISource | The AudioSource for UI sounds group. |
Methods| Name | Description | |
|---|---|---|
 | CreateGroup | Create a new AudioSource for a sound group. |
| GetAllGroups | Returns all AudioSources. |
| GetGroup | Get the AudioSource for a group. |
| GetOrCreateGroup | Get the AudioSource for a group and create a new one for it if it doesn't exist. |
| Initialize | Initializes the manager and creates audio groups for general sounds, UI and music. |
| LoadGroupVolume | Returns the volume saved in the settings for a group. |
| PauseMusic | Pause the background music. |
| Play(AudioSource) | Spawn an AudioSource and pool it after the sound ends. |
| Play(String, AudioClip) | Play an audio with a group's AudioSource. Create the group if it doesn't exist. |
| Play(AudioSource, Vector3) | Spawn an AudioSource and pool it after the sound ends. |
| Play(AudioClip, Boolean, Boolean) | Play an audio with a dedicated AudioSource and destroy it after it ends (if it's not looping). |
| Play(AudioSource, Transform, Boolean) | Spawn an AudioSource and pool it after the sound ends. |
| Play(AudioSource, Transform, Vector3) | Spawn an AudioSource and pool it after the sound ends. |
| Play(AudioClip, Transform, Boolean, Boolean) | Play an audio with a dedicated AudioSource and destroy it after it ends (if it's not looping). |
| Play(AudioClip, Vector3, Boolean, Boolean) | Play an audio with a dedicated AudioSource and destroy it after it ends (if it's not looping). |
| Play(AudioClip, Transform, Vector3, Boolean, Boolean) | Play an audio with a dedicated AudioSource and destroy it after it ends (if it's not looping). |
| PlayMusic | Play the background music. |
| PlayMusic(AudioClip) | Set and play background music. |
| PlaySound(IReadOnlyListAudioClip) | Play a random audio from a list. |
| PlaySound(AudioClip) | Play an audio with the general sounds group. |
| PlayUI | Play an audio with the UI sounds group. |
| RemoveGroup | Destroy the AudioSource for a group. |
| SaveGroupVolume(String) | Saves the current volume of a group in settings. |
| SaveGroupVolume(String, Single) | Saves the volume of a group in settings. |
| StopMusic | Stop the background music. |
Fields| Name | Description | |
|---|---|---|
 | DefaultMusicVolume | Default volume level to use for the background music. |
| MusicGroup | The group name to use for background music. |
| SoundGroup | The group name to use for general sounds. |
| UIGroup | The group name to use for UI sounds. |
See Also