ObjectAL
 All Classes Functions Variables Properties Pages
Protected Attributes | Properties | List of all members
ALListener Class Reference

The listener represents the user who is listening to sounds in 3D space. More...

#import <ALListener.h>

Inheritance diagram for ALListener:
<OALSuspendManager> <OALSuspendListener>

Protected Attributes

OALSuspendHandlersuspendHandler
 Handles suspending and interrupting for this object. More...
 

Properties

ALContextcontext
 The context this listener belongs to (WEAK reference). More...
 
bool muted
 Causes this listener to stop hearing sound. More...
 
float gain
 Gain (volume), affecting every sound this listener hears (0.0 = no sound, 1.0 = max volume). More...
 
ALOrientation orientation
 Orientation (up: x, y, z, at: x, y, z). More...
 
ALPoint position
 Position (x, y, z). More...
 
ALVector velocity
 Velocity (x, y, z). More...
 
bool reverbOn
 Turns on reverb. More...
 
float globalReverbLevel
 The global reverb level (from -40.0db to 40.0db). More...
 
int reverbRoomType
 The room type to simulate for reverb. More...
 
float reverbEQGain
 The equalizer gain for reverb. More...
 
float reverbEQBandwidth
 The equalizer bandwidth for reverb. More...
 
float reverbEQFrequency
 The equalizer frequency for reverb. More...
 
- Properties inherited from <OALSuspendManager>
bool suspended
 If YES, this object is suspended. More...
 
- Properties inherited from <OALSuspendListener>
bool manuallySuspended
 Set to YES to manually suspend. More...
 
bool interrupted
 If YES, this object is interrupted. More...
 

Additional Inherited Members

- Instance Methods inherited from <OALSuspendManager>
(void) - addSuspendListener:
 Add a listener that will receive manual suspend and interrupt events. More...
 
(void) - removeSuspendListener:
 Remove a registered listener. More...
 

Detailed Description

The listener represents the user who is listening to sounds in 3D space.

This object controls his position, orientation, and velocity, as well as providing a master gain.
A context contains one and only one listener.

Member Data Documentation

- (OALSuspendHandler*) suspendHandler
protected

Handles suspending and interrupting for this object.

Property Documentation

- (ALContext*) context
readnonatomicassign

The context this listener belongs to (WEAK reference).

- (float) gain
readwritenonatomicassign

Gain (volume), affecting every sound this listener hears (0.0 = no sound, 1.0 = max volume).

Only valid if this listener's context is the current context.

- (float) globalReverbLevel
readwritenonatomicassign

The global reverb level (from -40.0db to 40.0db).

(iOS 5.0+)

- (bool) muted
readwritenonatomicassign

Causes this listener to stop hearing sound.

It's called "muted" rather than "deaf" to give a consistent name with other mute functions.

- (ALOrientation) orientation
readwritenonatomicassign

Orientation (up: x, y, z, at: x, y, z).

Only valid if this listener's context is the current context.

- (ALPoint) position
readwritenonatomicassign

Position (x, y, z).

Only valid if this listener's context is the current context.

- (float) reverbEQBandwidth
readwritenonatomicassign

The equalizer bandwidth for reverb.

(iOS 5.0+)

- (float) reverbEQFrequency
readwritenonatomicassign

The equalizer frequency for reverb.

(iOS 5.0+)

- (float) reverbEQGain
readwritenonatomicassign

The equalizer gain for reverb.

(iOS 5.0+)

- (bool) reverbOn
readwritenonatomicassign

Turns on reverb.

(iOS 5.0+)

- (int) reverbRoomType
readwritenonatomicassign

The room type to simulate for reverb.

(iOS 5.0+)

Allowed room types:

ALC_ASA_REVERB_ROOM_TYPE_SmallRoom ALC_ASA_REVERB_ROOM_TYPE_MediumRoom ALC_ASA_REVERB_ROOM_TYPE_LargeRoom ALC_ASA_REVERB_ROOM_TYPE_MediumHall ALC_ASA_REVERB_ROOM_TYPE_LargeHall ALC_ASA_REVERB_ROOM_TYPE_Plate ALC_ASA_REVERB_ROOM_TYPE_MediumChamber ALC_ASA_REVERB_ROOM_TYPE_LargeChamber ALC_ASA_REVERB_ROOM_TYPE_Cathedral ALC_ASA_REVERB_ROOM_TYPE_LargeRoom2 ALC_ASA_REVERB_ROOM_TYPE_MediumHall2 ALC_ASA_REVERB_ROOM_TYPE_MediumHall3 ALC_ASA_REVERB_ROOM_TYPE_LargeHall2

- (ALVector) velocity
readwritenonatomicassign

Velocity (x, y, z).

Only valid if this listener's context is the current context.


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