AMSound Class Reference
The most basic audio element object of the hierarchy. More...
#import <AMSound.h>
Public Member Functions | |
| (id) | - initWithParent:parentCue:src: |
| Creates a new sound object. | |
| (void) | - setActive |
| Sets the sound as the active one in its parent chunk. | |
| (FMOD::Sound *) | - getFMODSound |
| Returns the internal FMOD sound object. | |
| (AMCue *) | - getParentCue |
| Returns the parent cue the sound belongs to. | |
| (NSArray *) | - getInstances |
| Returns the instances of the sound. | |
Protected Attributes | |
| UID | uid |
| id | parent |
| AMCue * | parentCue |
| int | remainingLoops |
| NSMutableArray * | instances |
| NSMutableDictionary * | controls |
| FMOD::Sound * | snd |
Properties | |
| int | loopCount |
| Number of times the sound will loop and play the content of its audio source. | |
| int | pickPriority |
| The probability of this sound to be picked betwwen all sounds of the chunk if the chunk pick mode is set to random. | |
| NSString * | src |
| The sound source of the sound. | |
Detailed Description
The most basic audio element object of the hierarchy.It can be viewed as a container for a defined atomic sound.
Member Function Documentation
| - FMOD: |
Returns the internal FMOD sound object.
FOR INTERNAL USAGE ONLY.
- Returns:
- The internal FMOD sound object.
| - (NSArray *) getInstances |
Returns the instances of the sound.
FOR INTERNAL USE ONLY.
- Returns:
- The instances of the sound.
| - (AMCue *) getParentCue |
Returns the parent cue the sound belongs to.
FOR INTERNAL USE ONLY.
- Returns:
- The parent cue the sound belongs to.
| - (id) initWithParent: | (id) | _parent | ||
| parentCue: | (AMCue *) | _parentCue | ||
| src: | (NSString *) | _src | ||
Creates a new sound object.
- Parameters:
-
parent The parent object of the sound. parentCue The parent cue object of this sound. src The sound source for the sound.
- Returns:
- The created sound object.
| - (void) setActive |
Sets the sound as the active one in its parent chunk.
Has no effects on currently playing instances of the chunk.
Property Documentation
- (int) loopCount [read, write, assign] |
Number of times the sound will loop and play the content of its audio source.
If set to -1, the sound will repeat indefinitely.
- (int) pickPriority [read, write, assign] |
The probability of this sound to be picked betwwen all sounds of the chunk if the chunk pick mode is set to random.
Probability is defined as relative to other sounds, and must be positive.
The documentation for this class was generated from the following files:
- /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/audio/elements/AMSound.h
- /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/audio/elements/AMSound.mm
