hAudioStack Class Reference

A drop in implementation of the Hydrogen.Core.AudioStack. This simply makes the class an accessible singleton with some very simple additional functionality. More...

Inheritance diagram for hAudioStack:

Static Public Member Functions
static bool	Exists ()
	Does an Audio Stack already exist? More...

Public Attributes
bool	Persistent = true
	Should this Audio Stack survive scene switches? More...
Public Attributes inherited from Hydrogen.Core.AudioStack
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
override void	Awake ()
	Unity's Awake Event More...
Protected Member Functions inherited from Hydrogen.Core.AudioStack
virtual void	Update ()
	Unity's Update Event More...

Properties
static hAudioStack	Instance [get]
	Gets the Audio Stack instance, creating one if none is found. More...
Properties inherited from Hydrogen.Core.AudioStack
Dictionary< string, AudioStackItem >	LoadedItems [get]
	Gets all currently loaded AudioStackItems. More...
int	SourcesCount [get]
	The number of currently used AudioSources. More...

Additional Inherited Members
Public Member Functions inherited from Hydrogen.Core.AudioStack
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...

Detailed Description

A drop in implementation of the Hydrogen.Core.AudioStack. This simply makes the class an accessible singleton with some very simple additional functionality.

Definition at line 36 of file hAudioStack.cs.

Member Function Documentation

override void hAudioStack.Awake ( )

protectedvirtual

Unity's Awake Event

Reimplemented from Hydrogen.Core.AudioStack.

Definition at line 94 of file hAudioStack.cs.

        {   
                // Make sure to do the Audio Stack normal initialization
                base.Awake ();

                // Should this gameObject be kept around :) I think so.
                if (Persistent)
                        DontDestroyOnLoad (gameObject);

        }

static bool hAudioStack.Exists ( )

static

Does an Audio Stack already exist?

Definition at line 86 of file hAudioStack.cs.

        {
                return _staticInstance != null;
        }

Member Data Documentation

bool hAudioStack.Persistent = true

Should this Audio Stack survive scene switches?

Definition at line 41 of file hAudioStack.cs.

Property Documentation

hAudioStack hAudioStack.Instance

staticget

Gets the Audio Stack instance, creating one if none is found.

The Audio Stack.

Definition at line 63 of file hAudioStack.cs.