A stack system for 2D audio sources. More...

Inheritance diagram for Hydrogen.Core.AudioStack:

Public Member Functions
string	Add (AudioClip clip)
	Add/Load an AudioStackItem More...

string	Add (AudioClip clip, bool createDuplicate)
	Add/Load an AudioStackItem More...

string	Add (AudioStackItem item)
	Add/Load an AudioStackItem More...

string	Add (AudioStackItem item, bool createDuplicate)
	Add/Load an AudioStackItem More...

bool	IsLoaded (AudioClip clip)
	Determines whether an AudioClip is currently loaded and managed by the AudioStack. More...

bool	IsLoaded (AudioStackItem item)
	Determines whether an AudioStackItem is currently loaded and managed by the AudioStack. More...

bool	IsLoaded (string key)
	Determines whether there is something loaded in the AudioStack based on the reference key. More...

bool	IsPlaying (AudioClip clip)
	Determines whether an AudioClip is playing. More...

bool	IsPlaying (AudioStackItem item)
	Determines whether an AudioStackItem is playing. More...

bool	IsPlaying (string key)
	Determines whether an AudioStackItem is playing by reference to the specified key. More...

void	Remove (AudioClip clip)
	Removes the specified AudioClip and its associated AudioStackItem from the AudioStack. More...

void	Remove (AudioStackItem item)
	Removes the specified AudioStackItem from the AudioStack. More...

void	Remove (string key)
	Remove the AudioStackItem associated to the specified key in the AudioStack. More...

Public Attributes
int	MaximumSources = 20
	Maximum number of sources to have in total (Stack + Playing). More...

int	MinimumSources = 10
	Minimum number of sources to have in total (Stack + Playing). More...

bool	UsePriorities
	Should the stack look at the priority of the existing Audio Stack Items playing, and if the stack is full stop the lowest and use it's newly available source to play the new item. More...

Protected Member Functions
virtual void	Awake ()
	Unity's Awake Event More...

virtual void	Update ()
	Unity's Update Event More...

Properties
Dictionary< string, AudioStackItem >	LoadedItems `[get]`
	Gets all currently loaded AudioStackItems. More...

int	SourcesCount `[get]`
	The number of currently used AudioSources. More...

Detailed Description

A stack system for 2D audio sources.

This should NEVER be used for 3D audio sources.

Definition at line 40 of file AudioStack.cs.

Member Function Documentation

string Hydrogen.Core.AudioStack.Add ( AudioClip clip )

Add/Load an AudioStackItem

Parameters

clip	An AudioClip to be used to create a new AudioStackItem from.

Definition at line 89 of file AudioStack.cs.

                 {
                         return Add (new AudioStackItem (clip), false);
                 }

string Hydrogen.Core.AudioStack.Add	(	AudioClip	clip,
		bool	createDuplicate
	)

Add/Load an AudioStackItem

Parameters

clip	An AudioClip to be used to create a new AudioStackItem from.
createDuplicate	Create a duplicate entry if need be.

Definition at line 99 of file AudioStack.cs.

                 {
                         return Add (new AudioStackItem (clip), createDuplicate);
                 }

string Hydrogen.Core.AudioStack.Add ( AudioStackItem item )

Add/Load an AudioStackItem

Parameters

item	An AudioStackItem.

Definition at line 108 of file AudioStack.cs.

                 {
                         return Add (item, false);
                 }

string Hydrogen.Core.AudioStack.Add	(	AudioStackItem	item,
		bool	createDuplicate
	)

Add/Load an AudioStackItem

Parameters

item	An AudioStackItem.
createDuplicate	Create a duplicate entry if need be.

Definition at line 118 of file AudioStack.cs.

                 {
                         if (IsLoaded (item.Key) && !createDuplicate) {
 
                                 // Update any settings we need too
                                 _loadedItems [item.Key].Fade = item.Fade;
                                 _loadedItems [item.Key].Loop = item.Loop;
                                 _loadedItems [item.Key].PlayOnLoad = item.PlayOnLoad;
 
                                 _loadedItems [item.Key].FadeInSpeed = item.FadeInSpeed;
                                 _loadedItems [item.Key].FadeOutSpeed = item.FadeOutSpeed;
                                 _loadedItems [item.Key].Persistant = item.Persistant;
                                 _loadedItems [item.Key].TargetVolume = item.TargetVolume;
                                 _loadedItems [item.Key].StartVolume = item.StartVolume;
                                 _loadedItems [item.Key].RemoveAfterFadeOut = item.RemoveAfterFadeOut;
                                 _loadedItems [item.Key].Priority = item.Priority;
 
                                 if (_loadedItems [item.Key].Source != null) {
                                         _loadedItems [item.Key].Source.priority = item.Priority;
                                 }
 
                         } else {
 
                                 // If we do not have enough sources, we should make one, if we can.
                                 if (_audioSources.Count <= 0 && _loadedItems.Count < MaximumSources) {
                                         var source = _poolObject.AddComponent<AudioSource> ();
 
                                         // Make sure we dont have any fun little hickups
                                         source.playOnAwake = false;
 
                                         _audioSources.Push (source);
                                 }
 
                                 // Let's rock this playing of one
                                 if (_audioSources.Count > 0) {
 
                                         // Create a slightly different key if need be
                                         // You should never be starting the exact same sound twice in the same frame, 
                                         // thus we can just use the this simple addition
                                         if (createDuplicate && IsLoaded (item.Key)) {
                                                 item.Key = item.Key + Time.time + item.GetHashCode ();
                                         }
 
                                         // Use this stack for callback
                                         // TODO: Don't like this
                                         item.Stack = this;
 
                                         item.Source = _audioSources.Pop () as AudioSource;
                                         // Update Our Source
                                         item.Source.clip = item.Clip;
                                         item.Source.volume = item.StartVolume;
                                         item.Source.loop = item.Loop;
                                         item.Source.priority = item.Priority;
 
                                         // Auto Play Stuff
                                         if (item.PlayOnLoad) {
                                                 item.Source.Play ();
                                         }
 
                                         _loadedItems.Add (item.Key, item);
 
                                 } else if (_audioSources.Count <= 0 && UsePriorities) {
 
                                         // Find our sucker to replace.
                                         //TODO: Maybe we can search for how long a track has already played
                                         AudioStackItem replaceItem = item;
                                         foreach (string s in _loadedItems.Keys.ToList()) {
                                                 if (_loadedItems [s].Priority < replaceItem.Priority &&
                                                     !_loadedItems [s].Loop) {
                                                         replaceItem = _loadedItems [s];
                                                 }
                                         }
 
                                         // Did any thing qualify?
                                         if (replaceItem != item) {
                                                 Remove (replaceItem);
                                                 Add (item);
                                         } else {
                                                 Debug.Log ("No available Audio Sources from the AudioStack to use, even when prioritized.");
                                         }
                                 } else {
                                         Debug.Log ("No available Audio Sources from the AudioStack to use.");
                                 }
                         }
 
                         return item.Key;
                 }

virtual void Hydrogen.Core.AudioStack.Awake ( )

protectedvirtual

Unity's Awake Event

Reimplemented in hAudioStack.

Definition at line 317 of file AudioStack.cs.

                 {
                         // Create our stack
                         _audioSources = new Stack (MinimumSources);
                         // Create our holder GameObject
                         _poolObject = new GameObject ();
                         // Create our lookup
                         _loadedItems = new Dictionary<string, AudioStackItem> ();
 
                         // Assign our new friend as our child
                         _poolObject.transform.parent = gameObject.transform;
                         _poolObject.name = "Audio Pool";
 
                         // Create the AudioSources and associate them to their respective arrays.
                         for (int x = 0; x < MinimumSources; x++) {
 
                                 var source = _poolObject.AddComponent<AudioSource> ();
 
                                 // Make sure we dont have any fun little hickups
                                 source.playOnAwake = false;
 
                                 _audioSources.Push (source);
                         }
                 }

bool Hydrogen.Core.AudioStack.IsLoaded ( AudioClip clip )

Determines whether an AudioClip is currently loaded and managed by the AudioStack.

Returns: Is the AudioClip present in the AudioStack?

Parameters

clip	An AudioClip.

Definition at line 211 of file AudioStack.cs.

                 {
                         return clip != null && _loadedItems.ContainsKey (clip.name);
                 }

bool Hydrogen.Core.AudioStack.IsLoaded ( AudioStackItem item )

Determines whether an AudioStackItem is currently loaded and managed by the AudioStack.

Returns: Is the AudioStackItem present in the AudioStack?

Parameters

item	An AudioStackItem.

Definition at line 221 of file AudioStack.cs.

                 {
                         return item != null && IsLoaded (item.Key);
                 }

bool Hydrogen.Core.AudioStack.IsLoaded ( string key )

Determines whether there is something loaded in the AudioStack based on the reference key.

Returns: Is something loaded and associate to the target key.

Parameters

key	Target Key.

Definition at line 231 of file AudioStack.cs.

                 {
                         return key != null && _loadedItems.ContainsKey (key);
                 }

bool Hydrogen.Core.AudioStack.IsPlaying ( AudioClip clip )

Determines whether an AudioClip is playing.

Returns: Is the AudioClip playing?

Must be playing through a managed AudioSource.

Parameters

clip	An AudioClip.

Definition at line 242 of file AudioStack.cs.

                 {   
                         return IsLoaded (clip.name) && _loadedItems [clip.name].Source.isPlaying;
                 }

bool Hydrogen.Core.AudioStack.IsPlaying ( AudioStackItem item )

Determines whether an AudioStackItem is playing.

Returns: Is the AudioStackItem playing?

Parameters

item	An AudioStackItem.

Definition at line 252 of file AudioStack.cs.

                 {
                         return item != null && item.Source != null && item.Source.isPlaying;
                 }

bool Hydrogen.Core.AudioStack.IsPlaying ( string key )

Determines whether an AudioStackItem is playing by reference to the specified key.

Returns: Is the AudioStackItem referenced by the specified key?

Parameters

key	Target Key.

Definition at line 262 of file AudioStack.cs.

                 {
                         return key != null && IsLoaded (key) && _loadedItems [key].Source.isPlaying;
                 }

void Hydrogen.Core.AudioStack.Remove ( AudioClip clip )

Removes the specified AudioClip and its associated AudioStackItem from the AudioStack.

Parameters

clip	An AudioClip.

Definition at line 271 of file AudioStack.cs.

                 {
                         if (IsLoaded (clip)) {
                                 Remove (_loadedItems [clip.name]);
                         }
                 }

void Hydrogen.Core.AudioStack.Remove ( AudioStackItem item )

Removes the specified AudioStackItem from the AudioStack.

Parameters

item	An AudioStackItem.

Definition at line 282 of file AudioStack.cs.

                 {
                         if (!IsLoaded (item))
                                 return;
 
                         // Make sure the item is stopped
                         item.Source.Stop ();
 
                         // Remove the clip association
                         item.Source.clip = null;
 
                         // Add the source back to the stack
                         _audioSources.Push (item.Source);
 
                         // Remove our item definition
                         _loadedItems.Remove (item.Key);
 
                         // Free Item
                         item = null;
                 }

void Hydrogen.Core.AudioStack.Remove ( string key )

Remove the AudioStackItem associated to the specified key in the AudioStack.

Parameters

key	Target Key.

Definition at line 307 of file AudioStack.cs.

                 {
                         if (IsLoaded (key)) {
                                 Remove (_loadedItems [key]);
                         }
                 }

virtual void Hydrogen.Core.AudioStack.Update ( )

protectedvirtual

Unity's Update Event

> This neeeds to be executed to handle processing the Audio Sources correctly.

Definition at line 348 of file AudioStack.cs.

                 {
                         foreach (string s in _loadedItems.Keys.ToList()) {
                                 _loadedItems [s].Process ();
                         }
                 }

Member Data Documentation

int Hydrogen.Core.AudioStack.MaximumSources = 20

Maximum number of sources to have in total (Stack + Playing).

Definition at line 45 of file AudioStack.cs.

int Hydrogen.Core.AudioStack.MinimumSources = 10

Minimum number of sources to have in total (Stack + Playing).

Definition at line 49 of file AudioStack.cs.

bool Hydrogen.Core.AudioStack.UsePriorities

Should the stack look at the priority of the existing Audio Stack Items playing, and if the stack is full stop the lowest and use it's newly available source to play the new item.

This will ignore any playing sources that are set to loop.

Definition at line 55 of file AudioStack.cs.

Property Documentation

Dictionary<string, AudioStackItem> Hydrogen.Core.AudioStack.LoadedItems

get

Gets all currently loaded AudioStackItems.

The loaded AudioStackItems with their associated keys.

Definition at line 73 of file AudioStack.cs.

int Hydrogen.Core.AudioStack.SourcesCount

get

The number of currently used AudioSources.

Used AudioSource Count.

Definition at line 81 of file AudioStack.cs.

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation