AMMix2DControl Class Reference

Allows to control the 2D mix parameters, such as volume and panorama. More...

#import <AMMix2DControl.h>

Inheritance diagram for AMMix2DControl:

AMControl

List of all members.

Public Member Functions

(void) - applySettingsToInstance:
 Apply the 2D parameters to the given audio object instance.

Properties

int volume
 The output volume of the audio track.
BOOL mute
 The mute status of the audio tracks.
int pan
 The panning of the audio track.


Detailed Description

Allows to control the 2D mix parameters, such as volume and panorama.

Member Function Documentation

- (void) applySettingsToInstance: (id)  _instance  

Apply the 2D parameters to the given audio object instance.

Parameters:
instance A CueInstance or SoundInstance object on which you want to apply these 2D parameters.


Property Documentation

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

The mute status of the audio tracks.

Default value is NO.

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

The panning of the audio track.

The value must be between -100 and 100, 0 being the middle, -100 full left and 100 full right. Default value is 0.

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

The output volume of the audio track.

Value must be between 0 and 100. Default value is 100;


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