AudioCategory Members

Audio Toolkit

previous page next page
Collapse image Expand Image Copy image CopyHover image

The AudioCategory type exposes the following members.

Constructors

  Name Description
Public method AudioCategory
Instantiates an AudioCategory

Methods

  Name Description
Public method GetAudioMixerGroup
Retrieves the AudioMixerGroup associated with this category. AudioMixerGroupa are inherited by the parent category.
Public method GetAudioObjectPrefab
Retrieves the AudioObjectPrefab associated with this category. AudioObjectPrefabs are inherited by the parent category.
Public method UnloadAllAudioClips
Unloads all AudioClips specified in the subitems from memory.

Fields

  Name Description
Public field AudioItems
Define your AudioItems using Unity inspector.
Public field audioMixerGroup
Allows to assign the category to a Unity 5 Audio Mixer Group
Public field 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.
Public field Name
The name of category ( = categoryID )

Properties

  Name Description
Public property audioController
The AudioController the category belongs to
Public property parentCategory
If a parent category is specified, the category inherits the volume of its parent.
Public property 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.
Public property VolumeTotal
The volume factor applied to all audio items in the category (including a possible parentCategory)

See Also

previous page start next page