AMSoundManager Class Reference

The global sound manager. More...

#import <AMSoundManager.h>

List of all members.

Static Public Member Functions
(void)	+ createSoundManager
	Initialize the sound manager.
(void)	+ releaseSoundManager
	Destroy the sound manager and release all its resources.
(AMScheduler *)	+ getScheduler
	Gets the A2ML scheduler.
(void)	+ loadA2ML:error:
	Load the given A2ML file.
(NSNotificationCenter *)	+ getNotificationCenter
	Gets the notification center used for the internal event system.
(void)	+ addKeyID:forObject:
	Adds an unique string ID key for the corresponding object.
(void)	+ removeObjectForKeyID:
	Removes the string/object correspondence based on the specified string ID.
(id)	+ getObjectFromID:
	Gets the object corresponding to the provided string ID.
(void)	+ addKeyUID:forID:
	Adds an unique string ID key for the corresponding UID.
(void)	+ removeKeyUID:
	Removes the UID/string correspondance based on the specified UID.
(NSString *)	+ getIDFromKeyUID:
	Gets the ID string corresponding to the provided UID.
(BOOL)	+ checkID:
	Check if the provided string ID is already used.
(void)	+ addInstanceToReleasePool:
	Adds an object instance to the release pool so it will be automatically released when it's not needed anymore.
(void)	+ removeInstanceFromReleasePool:
	Removes an object instance from the release pool.
(NSSet *)	+ getControls
	Gets the name of the controls supported.
(AMControl *)	+ getControlWithName:
	Gets the control with the specified name.
(AMControl *)	+ createControlWithName:
	Gets the control with the specified name or creates it if it doesn't exist.
(FMOD::System *)	+ getFMODSystem
	Returns the internal FMOD system object.

---

Detailed Description

The global sound manager.

This class is meant to be used statically, and must not be instanciated.

---

Member Function Documentation

+ (void) addInstanceToReleasePool:

(AMInstance *)

_instance

Adds an object instance to the release pool so it will be automatically released when it's not needed anymore.

Parameters:

instance

The object instance to add to the release pool.

+ (void) addKeyID:		(NSString *)	_id
forObject:		(id)	_obj

Adds an unique string ID key for the corresponding object.

Parameters:

	id	The string key for the provided object, must be unique.
	obj	The object to match with a unique string.

+ (void) addKeyUID:		(UID)	_uid
forID:		(NSString *)	_id

Adds an unique string ID key for the corresponding UID.

Parameters:

	uid	The UID key to match with a unique string.
	id	The string for the provided UID, must be unique.

+ (BOOL) checkID:

(NSString *)

_id

Check if the provided string ID is already used.

Parameters:

id

The string ID to check.

Returns:

NO if the ID is already taken, YES otherwise.

+ (AMControl *) createControlWithName:

(NSString *)

_name

Gets the control with the specified name or creates it if it doesn't exist.

Parameters:

name

The name of the control to get or create. Should be one of the constant control names defined in the AMControl class.

Returns:

The desired control, or nil if it is not supported by the sound manager.

+ (NSSet *) getControls

Gets the name of the controls supported.

Returns:

An NSSet object containing the names of the controls as NSString objects.

+ (AMControl *) getControlWithName:

(NSString *)

_name

Gets the control with the specified name.

Parameters:

name

The name of the control to get. Should be one of the constant control names defined in the AMControl class.

Returns:

The desired control, or nil if it does not exist.

+ FMOD:

Returns the internal FMOD system object.

FOR INTERNAL USAGE ONLY.

Returns:

The internal FMOD system object.

+ (NSString *) getIDFromKeyUID:

(UID)

_uid

Gets the ID string corresponding to the provided UID.

Parameters:

uid

The the UID of the ID string you want to retrieve.

Returns:

The ID string for the corresponding UID if it was found, or nil.

+ (NSNotificationCenter *) getNotificationCenter

Gets the notification center used for the internal event system.

Returns:

The internal NSNotificationCenter object used for events.

+ (id) getObjectFromID:

(NSString *)

_id

Gets the object corresponding to the provided string ID.

Parameters:

id

The string key of the UID you want to retrieve.

Returns:

The object if the string ID match was found, or nil if no match was found.

+ (AMScheduler *) getScheduler

Gets the A2ML scheduler.

Returns:

The internal A2ML scheduler.

+ (void) loadA2ML:		(NSString *)	_path
error:		(NSError **)	_error

Load the given A2ML file.

Parameters:

	path	The path of the A2ML file you want to load.
	error	If loading failed at some point, gets the NSError describing the problem.

+ (void) removeInstanceFromReleasePool:

(AMInstance *)

_instance

Removes an object instance from the release pool.

Parameters:

instance

The object instance to remove from the release pool.

+ (void) removeKeyUID:

(UID)

_uid

Removes the UID/string correspondance based on the specified UID.

Parameters:

uid

The UID key of the correspondence to remove.

+ (void) removeObjectForKeyID:

(NSString *)

_id

Removes the string/object correspondence based on the specified string ID.

Parameters:

id

The string key of the correspondence to remove.

---

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

• /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/audio/AMSoundManager.h
• /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/audio/AMSoundManager.mm