AudioCategory Class

ClockStone Audio Toolkit

AudioCategory Class

An audio category represents a set of AudioItems. Categories allow to change the volume of all containing audio items.
Inheritance Hierarchy
SystemObject  (Default Namespace)AudioCategory

Namespace:  (Default Namespace)
Assembly:  AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)
Syntax
C#
[SerializableAttribute]
public class AudioCategory

The AudioCategory type exposes the following members.

Constructors
  NameDescription
Public methodAudioCategory
Instantiates an AudioCategory
Top
Properties
  NameDescription
Public propertyaudioController
The AudioController the category belongs to
Public propertyisFadeOutComplete
return true if the category has completely faded out
Public propertyisFadingIn
return true if the category is currently fading in
Public propertyisFadingOut
return true if the category is currently fading out
Public propertyparentCategory
If a parent category is specified, the category inherits the volume of its parent.
Public propertyVolume
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.
Public propertyVolumeTotal
The volume factor applied to all audio items in the category (including a possible parentCategory and fade out/in)
Top
Methods
  NameDescription
Public methodFadeIn
Starts a fade-in of the audio category.
Public methodFadeOut
Starts a fade-out of the audio category.
Public methodGetAudioMixerGroup
Retrieves the AudioMixerGroup associated with this category. AudioMixerGroupa are inherited by the parent category.
Public methodGetAudioObjectPrefab
Retrieves the AudioObjectPrefab associated with this category. AudioObjectPrefabs are inherited by the parent category.
Public methodUnloadAllAudioClips
Unloads all AudioClips specified in the subitems from memory.
Top
Fields
  NameDescription
Public fieldAudioItems
Define your AudioItems using Unity inspector.
Public fieldaudioMixerGroup
Allows to assign the category to a Unity 5 Audio Mixer Group
Public fieldAudioObjectPrefab
Allows to define a specific audio object prefab for this category. If none is defined, the default prefab as set by AudioObjectPrefab is taken.
Public fieldName
The name of category ( = categoryID )
Top
See Also