AMCue Class Reference

A managed sound source controlled by time and/or events. More...

#import <AMCue.h>

Inheritance diagram for AMCue:

List of all members.

Public Member Functions
(id)	- init
	Creates a new cue object.
(void)	- addChunk:
	Adds a chunk to the cue.
(void)	- removeChunkAtIndex:
	Removes the chunk at the given index from the cue.
(NSArray *)	- getChunks
	Returns the internal array of chunks.
(NSArray *)	- getInstances
	Returns the internal array of instances.
(NSMutableArray **)	- getFMODChannelGroups
	Returns the internal array pointer of FMOD channel groups.
(AMCueInstance *)	- getCueInstanceWithParentUID:
	Returns the internal cue instance corresponding to the given parent UID.
Protected Attributes
UID	uid
NSMutableArray *	instances
NSMutableDictionary *	controls
NSMutableArray *	chunks
NSMutableArray *	channelGroups
Properties
AMTime *	dur
	The duration of the cue.
AMTime *	quantize
	The quantization value of the cue.
int	loopCount
	Number of times the cue will loop and play the content of its audio source.
int	priority
	The priority of the cue, between 0 and 100.
AMRetriggerType	restartOnRetrigger
	Defines the behavior of the cue when a start request is trigerred while it is already playing.
BOOL	stream
	Defines how the audio elements of the cue will use the memory.

---

Detailed Description

A managed sound source controlled by time and/or events.

It is a container for one or more audio chunks.

---

Member Function Documentation

- (void) addChunk:

(AMChunk *)

_chunk

Adds a chunk to the cue.

Parameters:

chunk

The AMChunk object to add.

- (NSArray *) getChunks

Returns the internal array of chunks.

FOR INTERNAL USAGE ONLY.

Returns:

The internal array of chunks.

- (AMCueInstance *) getCueInstanceWithParentUID:

(UID)

_parentUID

Returns the internal cue instance corresponding to the given parent UID.

FOR INTERNAL USAGE ONLY.

Returns:

The internal cue instance corresponding to the given parent UID.

- (NSMutableArray **) getFMODChannelGroups

Returns the internal array pointer of FMOD channel groups.

FOR INTERNAL USAGE ONLY.

Returns:

the internal array pointer of FMOD channel groups.

- (NSArray *) getInstances

Returns the internal array of instances.

FOR INTERNAL USAGE ONLY.

Returns:

The internal array of instances.

- (id) init

Creates a new cue object.

Returns:

The created cue object.

- (void) removeChunkAtIndex:

(int)

_idx

Removes the chunk at the given index from the cue.

The function is ignored if the index is invalid.

Parameters:

idx

The index of the chunk object to remove.

---

Property Documentation

- (int) loopCount [read, write, assign]

Number of times the cue will loop and play the content of its audio source.

If set to -1, the cue will repeat indefinitely.

- (BOOL) stream [read, write, assign]

Defines how the audio elements of the cue will use the memory.

Note that streaming activation will also limit the cue to 1 instance at a time.

---

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

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