This is the base manager class for audio being played in a 3D environment. More...

#include <soundscapemanager.h>

Inheritance diagram for Mezzanine::Audio::SoundScapeManager:

Collaboration diagram for Mezzanine::Audio::SoundScapeManager:

Public Member Functions
	SoundScapeManager (World *Creator)
	Class constructor.

	SoundScapeManager (World *Creator, XML::Node &XMLNode)
	XML constructor. More...

virtual	~SoundScapeManager ()
	Class destructor.

virtual SoundProxy *	CreateAmbientSoundProxy (const Boole AddToWorld)
	Creates a blank Ambient SoundProxy without a stream attached to it. More...

virtual SoundProxy *	CreateAmbientSoundProxy (Resource::DataStreamPtr Stream, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Ambient SoundProxy from a custom stream that is encoded. More...

virtual SoundProxy *	CreateAmbientSoundProxy (Resource::DataStreamPtr Stream, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Ambient SoundProxy from a custom stream that is unencoded. More...

virtual SoundProxy *	CreateAmbientSoundProxy (const String &FileName, const String &Group, const Boole AddToWorld)
	Creates a new Ambient SoundProxy from a file. More...

virtual SoundProxy *	CreateAmbientSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Ambient SoundProxy from a memory buffer that is encoded. More...

virtual SoundProxy *	CreateAmbientSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Ambient SoundProxy from a memory buffer that is unencoded. More...

virtual SoundProxy *	CreateDialogSoundProxy (const Boole AddToWorld)
	Creates a blank Dialog SoundProxy without a stream attached to it. More...

virtual SoundProxy *	CreateDialogSoundProxy (Resource::DataStreamPtr Stream, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Dialog SoundProxy from a custom stream that is encoded. More...

virtual SoundProxy *	CreateDialogSoundProxy (Resource::DataStreamPtr Stream, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Dialog SoundProxy from a custom stream that is unencoded. More...

virtual SoundProxy *	CreateDialogSoundProxy (const String &FileName, const String &Group, const Boole AddToWorld)
	Creates a new Dialog SoundProxy from a file. More...

virtual SoundProxy *	CreateDialogSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Dialog SoundProxy from a memory buffer that is encoded. More...

virtual SoundProxy *	CreateDialogSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Dialog SoundProxy from a memory buffer that is unencoded. More...

virtual SoundProxy *	CreateEffectSoundProxy (const Boole AddToWorld)
	Creates a blank Effect SoundProxy without a stream attached to it. More...

virtual SoundProxy *	CreateEffectSoundProxy (Resource::DataStreamPtr Stream, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Effect SoundProxy from a custom stream that is encoded. More...

virtual SoundProxy *	CreateEffectSoundProxy (Resource::DataStreamPtr Stream, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Effect SoundProxy from a custom stream that is unencoded. More...

virtual SoundProxy *	CreateEffectSoundProxy (const String &FileName, const String &Group, const Boole AddToWorld)
	Creates a new Effect SoundProxy from a file. More...

virtual SoundProxy *	CreateEffectSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Effect SoundProxy from a memory buffer that is encoded. More...

virtual SoundProxy *	CreateEffectSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Effect SoundProxy from a memory buffer that is unencoded. More...

virtual iListener *	CreateListener ()=0
	Creates a new iListener. More...

virtual SoundProxy *	CreateMusicSoundProxy (const Boole AddToWorld)
	Creates a blank Music SoundProxy without a stream attached to it. More...

virtual SoundProxy *	CreateMusicSoundProxy (Resource::DataStreamPtr Stream, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Music SoundProxy from a custom stream that is encoded. More...

virtual SoundProxy *	CreateMusicSoundProxy (Resource::DataStreamPtr Stream, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Music SoundProxy from a custom stream that is unencoded. More...

virtual SoundProxy *	CreateMusicSoundProxy (const String &FileName, const String &Group, const Boole AddToWorld)
	Creates a new Music SoundProxy from a file. More...

virtual SoundProxy *	CreateMusicSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const Audio::Encoding Encode, const Boole AddToWorld)
	Creates a new Music SoundProxy from a memory buffer that is encoded. More...

virtual SoundProxy *	CreateMusicSoundProxy (const String &StreamName, Char8 *Buffer, const UInt32 Length, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)
	Creates a new Music SoundProxy from a memory buffer that is unencoded. More...

virtual SoundProxy *	CreateSoundProxy (const UInt16 Type, const Boole AddToWorld)=0
	Creates a blank SoundProxy without a stream attached to it. More...

virtual SoundProxy *	CreateSoundProxy (const UInt16 Type, Resource::DataStreamPtr Stream, const Audio::Encoding Encode, const Boole AddToWorld)=0
	Creates a new SoundProxy from a custom stream that is encoded. More...

virtual SoundProxy *	CreateSoundProxy (const UInt16 Type, Resource::DataStreamPtr Stream, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)=0
	Creates a new SoundProxy from a custom stream that is unencoded. More...

virtual SoundProxy *	CreateSoundProxy (const UInt16 Type, const String &FileName, const String &Group, const Boole AddToWorld)=0
	Creates a new SoundProxy from a file. More...

virtual SoundProxy *	CreateSoundProxy (const UInt16 Type, const String &StreamName, Char8 *Buffer, const UInt32 Length, const Audio::Encoding Encode, const Boole AddToWorld)=0
	Creates a new SoundProxy from a memory buffer that is encoded. More...

virtual SoundProxy *	CreateSoundProxy (const UInt16 Type, const String &StreamName, Char8 *Buffer, const UInt32 Length, const UInt32 Frequency, const Audio::BitConfig Config, const Boole AddToWorld)=0
	Creates a new SoundProxy from a memory buffer that is unencoded. More...

virtual void	Deinitialize ()=0
	Removes this manager from any necessary configuration so it can be safely disposed of. More...

virtual void	DestroyAllListeners ()=0
	Deletes all stored iListener instances.

virtual void	DestroyAllProxies ()=0
	Deletes all stored SoundProxy instances.

virtual void	DestroyListener (iListener *ToBeDestroyed)=0
	Deletes a iListener. More...

virtual void	DestroyProxy (SoundProxy *ToBeDestroyed)=0
	Deletes a SoundProxy. More...

virtual iBufferUpdate3DWorkUnit *	GetBufferUpdate3DWork ()=0
	Gets the work unit responsible for updating the buffers of soundproxies. More...

virtual ManagerType	GetInterfaceType () const
	This returns the type of this manager. More...

virtual iListener *	GetListener (const UInt32 Index) const =0
	Gets an iListener instance by index. More...

virtual UInt32	GetNumListeners () const =0
	Gets the number of iListener instances in this manager. More...

virtual UInt32	GetNumProxies () const =0
	Gets the number of SoundProxy instances in this manager. More...

virtual SoundProxy *	GetProxy (const UInt32 Index) const =0
	Gets an SoundProxy instance by index. More...

virtual SoundProxy *	GetProxy (const Mezzanine::ProxyType Type, UInt32 Which) const =0
	Gets the n-th proxy of the specified type. More...

virtual void	Initialize ()=0
	Configures this manager for use prior to entering the main loop. More...

virtual void	Pause (const UInt32 PL)=0
	Sets the pause state of this manager, or has no effect depending on the value passed in. More...

Public Member Functions inherited from Mezzanine::WorldManager
	WorldManager (World *Creator)
	Class constructor. More...

virtual	~WorldManager ()
	Class destructor.

virtual World *	GetWorld () const
	Gets the world this manager belongs to. More...

virtual Boole	IsPaused () const
	Gets whether or not this manager is currently paused. More...

Public Member Functions inherited from Mezzanine::ManagerBase
	ManagerBase ()
	Class constructor.

virtual	~ManagerBase ()
	Class destructor.

virtual String	GetImplementationTypeName () const =0
	This Allows any manager name to be sent to a stream. Primarily used for logging. More...

virtual String	GetInterfaceTypeAsString () const
	Gets a string of the interface type of this manager. More...

Boole	IsInitialized () const
	Gets whether or not this manager has been initialized. More...

Additional Inherited Members
Public Types inherited from Mezzanine::ManagerBase
enum	ManagerType { MT_Undefined = 0, MT_AudioManager = 1, MT_AnimationManager = 2, MT_CollisionShapeManager = 3, MT_CompositorManager = 4, MT_GraphicsManager = 5, MT_EventManager = 6, MT_InputManager = 7, MT_LogManager = 8, MT_MaterialManager = 9, MT_MeshManager = 10, MT_NetworkManager = 11, MT_ResourceManager = 12, MT_ScriptingManager = 13, MT_TextureManager = 14, MT_UIManager = 15, MT_ActorManager = 101, MT_AreaEffectManager = 102, MT_DebrisManager = 103, MT_PagingManager = 104, MT_PhysicsManager = 105, MT_SceneManager = 106, MT_SoundScapeManager = 107, MT_TerrainManager = 108, MT_VehicleManager = 109, MT_UserCreated = 512 }
	A listing of Manager Types. More...

Static Public Member Functions inherited from Mezzanine::ManagerBase
static String	GetTypeAsString (const ManagerType &ManagerType)
	Gets the string form of the type of manager. More...

static ManagerType	GetTypeFromString (const String &ManagerName)
	Gets the type of manager requested from a string. More...

Protected Attributes inherited from Mezzanine::WorldManager
Boole	OperationsPaused
	This stores whether or not processing for some or all objects in this manager has been paused. More...

World *	ParentWorld
	A pointer to the world that created this manager. More...

Protected Attributes inherited from Mezzanine::ManagerBase
Boole	Initialized
	Simple Boole indicating whether or not this manager has been initialized. More...

Entresol *	TheEntresol
	The actual pointer to the Entresol core class. More...

Detailed Description

This is the base manager class for audio being played in a 3D environment.

Definition at line 77 of file soundscapemanager.h.

Constructor & Destructor Documentation

Mezzanine::Audio::SoundScapeManager::SoundScapeManager	(	World *	Creator,
		XML::Node &	XMLNode
	)

XML constructor.

Parameters

XMLNode The node of the xml document to construct from.

Definition at line 53 of file soundscapemanager.cpp.

Member Function Documentation

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateAmbientSoundProxy ( const Boole AddToWorld )

virtual

Creates a blank Ambient SoundProxy without a stream attached to it.

Parameters

AddToWorld Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 72 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateAmbientSoundProxy	(	Resource::DataStreamPtr	Stream,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Ambient SoundProxy from a custom stream that is encoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 81 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateAmbientSoundProxy	(	Resource::DataStreamPtr	Stream,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Ambient SoundProxy from a custom stream that is unencoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 90 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateAmbientSoundProxy	(	const String &	FileName,
		const String &	Group,
		const Boole	AddToWorld
	)

virtual

Creates a new Ambient SoundProxy from a file.

Parameters

FileName	The name of the file to read audio data from.
Group	The resource group in which the file resides.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 99 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateAmbientSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Ambient SoundProxy from a memory buffer that is encoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 108 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateAmbientSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Ambient SoundProxy from a memory buffer that is unencoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 117 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateDialogSoundProxy ( const Boole AddToWorld )

virtual

Creates a blank Dialog SoundProxy without a stream attached to it.

Parameters

AddToWorld Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 74 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateDialogSoundProxy	(	Resource::DataStreamPtr	Stream,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Dialog SoundProxy from a custom stream that is encoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 83 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateDialogSoundProxy	(	Resource::DataStreamPtr	Stream,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Dialog SoundProxy from a custom stream that is unencoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 92 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateDialogSoundProxy	(	const String &	FileName,
		const String &	Group,
		const Boole	AddToWorld
	)

virtual

Creates a new Dialog SoundProxy from a file.

Parameters

FileName	The name of the file to read audio data from.
Group	The resource group in which the file resides.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 101 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateDialogSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Dialog SoundProxy from a memory buffer that is encoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name of the SoundProxy instance.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 110 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateDialogSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Dialog SoundProxy from a memory buffer that is unencoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 119 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateEffectSoundProxy ( const Boole AddToWorld )

virtual

Creates a blank Effect SoundProxy without a stream attached to it.

Parameters

AddToWorld Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 76 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateEffectSoundProxy	(	Resource::DataStreamPtr	Stream,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Effect SoundProxy from a custom stream that is encoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 85 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateEffectSoundProxy	(	Resource::DataStreamPtr	Stream,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Effect SoundProxy from a custom stream that is unencoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 94 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateEffectSoundProxy	(	const String &	FileName,
		const String &	Group,
		const Boole	AddToWorld
	)

virtual

Creates a new Effect SoundProxy from a file.

Parameters

FileName	The name of the file to read audio data from.
Group	The resource group in which the file resides.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 103 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateEffectSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Effect SoundProxy from a memory buffer that is encoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 112 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateEffectSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Effect SoundProxy from a memory buffer that is unencoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 121 of file soundscapemanager.cpp.

virtual iListener* Mezzanine::Audio::SoundScapeManager::CreateListener ( )

pure virtual

Creates a new iListener.

Returns: Returns a pointer to the iListener instance that was created.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateMusicSoundProxy ( const Boole AddToWorld )

virtual

Creates a blank Music SoundProxy without a stream attached to it.

Parameters

AddToWorld Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 78 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateMusicSoundProxy	(	Resource::DataStreamPtr	Stream,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Music SoundProxy from a custom stream that is encoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 87 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateMusicSoundProxy	(	Resource::DataStreamPtr	Stream,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Music SoundProxy from a custom stream that is unencoded.

Parameters

Stream	A Datastream containing the data to be streamed for this SoundProxy.
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 96 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateMusicSoundProxy	(	const String &	FileName,
		const String &	Group,
		const Boole	AddToWorld
	)

virtual

Creates a new Music SoundProxy from a file.

Parameters

FileName	The name of the file to read audio data from.
Group	The resource group in which the file resides.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 105 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateMusicSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

virtual

Creates a new Music SoundProxy from a memory buffer that is encoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 114 of file soundscapemanager.cpp.

SoundProxy * Mezzanine::Audio::SoundScapeManager::CreateMusicSoundProxy	(	const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

virtual

Creates a new Music SoundProxy from a memory buffer that is unencoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

Definition at line 123 of file soundscapemanager.cpp.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::CreateSoundProxy	(	const UInt16	Type,
		const Boole	AddToWorld
	)

pure virtual

Creates a blank SoundProxy without a stream attached to it.

Parameters

Type	A UInt16 that is the ID for the type of sound the created SoundProxy is to be categorized as.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::CreateSoundProxy	(	const UInt16	Type,
		Resource::DataStreamPtr	Stream,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

pure virtual

Creates a new SoundProxy from a custom stream that is encoded.

Parameters

Type	A UInt16 that is the ID for the type of sound the created SoundProxy is to be categorized as.
Stream	A Datastream containing the data to be streamed for this SoundProxy.
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::CreateSoundProxy	(	const UInt16	Type,
		Resource::DataStreamPtr	Stream,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

pure virtual

Creates a new SoundProxy from a custom stream that is unencoded.

Parameters

Type	A UInt16 that is the ID for the type of sound the created SoundProxy is to be categorized as.
Stream	A Datastream containing the data to be streamed for this SoundProxy.
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::CreateSoundProxy	(	const UInt16	Type,
		const String &	FileName,
		const String &	Group,
		const Boole	AddToWorld
	)

pure virtual

Creates a new SoundProxy from a file.

Parameters

Type	A UInt16 that is the ID for the type of sound the created SoundProxy is to be categorized as.
FileName	The name of the file to read audio data from.
Group	The resource group in which the file resides.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::CreateSoundProxy	(	const UInt16	Type,
		const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const Audio::Encoding	Encode,
		const Boole	AddToWorld
	)

pure virtual

Creates a new SoundProxy from a memory buffer that is encoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

Type	A UInt16 that is the ID for the type of sound the created SoundProxy is to be categorized as.
StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Encode	The encoding to be expected when decoding audio for this SoundProxy.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::CreateSoundProxy	(	const UInt16	Type,
		const String &	StreamName,
		Char8 *	Buffer,
		const UInt32	Length,
		const UInt32	Frequency,
		const Audio::BitConfig	Config,
		const Boole	AddToWorld
	)

pure virtual

Creates a new SoundProxy from a memory buffer that is unencoded.

Note: The buffer is copied and put into a memory stream. Thus safe for disposal afterward.

Parameters

Type	A UInt16 that is the ID for the type of sound the created SoundProxy is to be categorized as.
StreamName	The name to be given to the stream being created.
Buffer	A pointer to the buffer where the audio data is located.
Length	The length of the buffer provided to this method(in bytes).
Frequency	The frequency (or sample rate) of the audio data.
Config	The bit configuration of the audio data. Helps to determine sample size.
AddToWorld	Wether or not the new SoundProxy instance should be added to the world after it has been created.

Returns: Returns a pointer to the SoundProxy instance that was created.

virtual void Mezzanine::Audio::SoundScapeManager::Deinitialize ( )

pure virtual

Removes this manager from any necessary configuration so it can be safely disposed of.

Implements Mezzanine::ManagerBase.

virtual void Mezzanine::Audio::SoundScapeManager::DestroyListener ( iListener * ToBeDestroyed )

pure virtual

Deletes a iListener.

Parameters

ToBeDestroyed A pointer to the iListener you want deleted.

virtual void Mezzanine::Audio::SoundScapeManager::DestroyProxy ( SoundProxy * ToBeDestroyed )

pure virtual

Deletes a SoundProxy.

Parameters

ToBeDestroyed A pointer to the SoundProxy you want deleted.

virtual iBufferUpdate3DWorkUnit* Mezzanine::Audio::SoundScapeManager::GetBufferUpdate3DWork ( )

pure virtual

Gets the work unit responsible for updating the buffers of soundproxies.

Returns: Returns a pointer to the iBufferUpdate3DWorkUnit used by this manager.

ManagerBase::ManagerType Mezzanine::Audio::SoundScapeManager::GetInterfaceType ( ) const

virtual

This returns the type of this manager.

This is intended to make using and casting from Manager base easier. With this is is possible to cast from ManagerBase to the correct Manager Type.

Returns: This returns a ManagerTypeName to identify what this can be safely cast to.

Implements Mezzanine::ManagerBase.

Definition at line 129 of file soundscapemanager.cpp.

virtual iListener* Mezzanine::Audio::SoundScapeManager::GetListener ( const UInt32 Index ) const

pure virtual

Gets an iListener instance by index.

Parameters

Index The index of the iListener to be retrieved.

Returns: Returns a pointer to the iListener at the specified index.

virtual UInt32 Mezzanine::Audio::SoundScapeManager::GetNumListeners ( ) const

pure virtual

Gets the number of iListener instances in this manager.

Returns: Returns a UInt32 representing the number of iListener instances contained in this manager.

virtual UInt32 Mezzanine::Audio::SoundScapeManager::GetNumProxies ( ) const

pure virtual

Gets the number of SoundProxy instances in this manager.

Returns: Returns a UInt32 representing the number of SoundProxy instances contained in this manager.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::GetProxy ( const UInt32 Index ) const

pure virtual

Gets an SoundProxy instance by index.

Parameters

Index The index of the SoundProxy to be retrieved.

Returns: Returns a pointer to the SoundProxy at the specified index.

virtual SoundProxy* Mezzanine::Audio::SoundScapeManager::GetProxy	(	const Mezzanine::ProxyType	Type,
		UInt32	Which
	)		const

pure virtual

Gets the n-th proxy of the specified type.

Note: This manager only stores SoundProxy types. As such, specifying a type of proxy that isn't SoundProxy or derived from SoundProxy will always return NULL.

Parameters

Type	The type of proxy to retrieve.
Which	Which proxy of the specified type to retrieve.

Returns: Returns a pointer to the specified proxy, or NULL if there is no n-th proxy.

virtual void Mezzanine::Audio::SoundScapeManager::Initialize ( )

pure virtual

Configures this manager for use prior to entering the main loop.

Exceptions

If	this is called while no valid world is set, this will throw an "INVALID_STATE_EXCEPTION".

Reimplemented from Mezzanine::WorldManager.

virtual void Mezzanine::Audio::SoundScapeManager::Pause ( const UInt32 PL )

pure virtual

Sets the pause state of this manager, or has no effect depending on the value passed in.

Parameters

PL	A bitfield describing the pause level being assigned to the parent world of this manager.

Implements Mezzanine::WorldManager.

The documentation for this class was generated from the following files:

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Audio/soundscapemanager.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Audio/soundscapemanager.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation