ClockStone Audio Toolkit for Unity - Documentation
AudioCategory Class |
An audio category represents a set of AudioItems. Categories allow to change the volume of all containing audio items.
Inheritance HierarchyNamespace: (Default Namespace)
Assembly: AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)
SyntaxC#
[SerializableAttribute] public class AudioCategory
The AudioCategory type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AudioCategory |
Instantiates an AudioCategory
|
Properties| Name | Description | |
|---|---|---|
 | audioController |
The AudioController the category belongs to
|
| isFadeOutComplete |
return true if the category has completely faded out
|
| isFadingIn |
return true if the category is currently fading in
|
| isFadingOut |
return true if the category is currently fading out
|
| parentCategory |
If a parent category is specified, the category inherits the volume of its parent.
|
| Volume |
The volume factor applied to all audio items in the category (NOT including a possible parentCategory)
If you change the volume by script the change will be applied to all
playing audios immediately.
|
| VolumeTotal |
The volume factor applied to all audio items in the category (including a possible parentCategory and fade out/in)
|
Methods| Name | Description | |
|---|---|---|
| FadeIn |
Starts a fade-in of the audio category.
|
| FadeOut |
Starts a fade-out of the audio category.
|
| GetAudioMixerGroup |
Retrieves the AudioMixerGroup associated with this category. AudioMixerGroupa are inherited by the parent category.
|
| GetAudioObjectPrefab |
Retrieves the AudioObjectPrefab associated with this category. AudioObjectPrefabs are inherited by the parent category.
|
| UnloadAllAudioClips |
Unloads all AudioClips specified in the subitems from memory.
|
Fields| Name | Description | |
|---|---|---|
 | AudioItems |
Define your AudioItems using Unity inspector.
|
| audioMixerGroup |
Allows to assign the category to a Unity 5 Audio Mixer Group
|
| AudioObjectPrefab |
Allows to define a specific audio object prefab for this category. If none is defined,
the default prefab as set by AudioObjectPrefab is taken.
|
| Name |
The name of category ( = categoryID )
|
See Also