AMChunk Class Reference

An audio fragment embedding one ore more tracks that can be played in defined order or randomly. More...

#import <AMChunk.h>

Inheritance diagram for AMChunk:

< AMControllable > < AMControllableHierarchy > < AMPlayable > < AMInstanciable > < AMIdentifiable >

List of all members.

Public Member Functions

(id) - initWithParent:
 Creates a new chunk object.
(void) - addSound:
 Adds a sound to the chunk.
(void) - removeSoundAtIndex:
 Removes the sound at the given index from the chunk.
(void) - setActive:
 Sets the sound as active.
(NSArray *) - getSounds
 Returns the internal array of sounds.

Protected Attributes

UID uid
id parent
NSMutableArray * instances
NSMutableDictionary * controls
NSMutableArray * sounds

Properties

AMTimedur
 The duration of the chunk.
AMPickType pick
 Determines how the sounds are picked.
AMFadeInType fadeInType
 The fade in type for the chunk.
AMTimefadeInDur
 The fade in duration.
AMFadeOutType fadeOutType
 The fade out type for the transition with the next chunk.
AMTimefadeOutDur
 The duration of the fade out transition.
int activeSound
 The index of the current active sound.
int nextSound
 The index of the nexy active sound.


Detailed Description

An audio fragment embedding one ore more tracks that can be played in defined order or randomly.

Member Function Documentation

- (void) addSound: (AMSound *)  _sound  

Adds a sound to the chunk.

Parameters:
sound The AMSound object to add.

- (NSArray *) getSounds  

Returns the internal array of sounds.

FOR INTERNAL USAGE ONLY.

Returns:
The internal array of sounds.

- (id) initWithParent: (id)  _parent  

Creates a new chunk object.

Parameters:
parent The parent object of the chunk.
Returns:
The created chunk object.

- (void) removeSoundAtIndex: (int)  _idx  

Removes the sound at the given index from the chunk.

The function is ignored if the index is invalid.

Parameters:
idx The index of the sound object to remove.

- (void) setActive: (AMSound *)  _sound  

Sets the sound as active.

Has no effects on currently playing instances of the chunk.

Parameters:
sound The sound to set as active.


Property Documentation

- (AMFadeInType) fadeInType [read, write, assign]

The fade in type for the chunk.

If the previous chunk has set AM_FOT_CROSSFADE as it fade out type, the fade in properties for this chunk will be ignored.


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

Generated on Mon May 16 16:29:48 2011 for ARIA by  doxygen 1.5.9