ALListener Class Reference
Inherits from | NSObject |
Conforms to | OALSuspendManager |
Declared in | ALListener.h |
Overview
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.
Tasks
-
context
property -
muted
property -
gain
property -
orientation
property -
position
property -
velocity
property -
reverbOn
property -
globalReverbLevel
property -
reverbRoomType
property -
reverbEQGain
property -
reverbEQBandwidth
property -
reverbEQFrequency
property -
+ listenerForContext:
-
– initWithContext:
Properties
context
The context this listener belongs to (WEAK reference).
@property (nonatomic, readonly, assign) ALContext *context
Declared In
ALListener.h
gain
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.
@property (nonatomic, readwrite, assign) float gain
Declared In
ALListener.h
globalReverbLevel
The global reverb level (from -40.0db to 40.0db). (iOS 5.0+)
@property (nonatomic, readwrite, assign) float globalReverbLevel
Declared In
ALListener.h
muted
Causes this listener to stop hearing sound. It’s called “muted” rather than “deaf” to give a consistent name with other mute functions.
@property (nonatomic, readwrite, assign) bool muted
Declared In
ALListener.h
orientation
Orientation (up: x, y, z, at: x, y, z). Only valid if this listener’s context is the current context.
@property (nonatomic, readwrite, assign) ALOrientation orientation
Declared In
ALListener.h
reverbEQBandwidth
The equalizer bandwidth for reverb. (iOS 5.0+)
@property (nonatomic, readwrite, assign) float reverbEQBandwidth
Declared In
ALListener.h
reverbEQFrequency
The equalizer frequency for reverb. (iOS 5.0+)
@property (nonatomic, readwrite, assign) float reverbEQFrequency
Declared In
ALListener.h
reverbEQGain
The equalizer gain for reverb. (iOS 5.0+)
@property (nonatomic, readwrite, assign) float reverbEQGain
Declared In
ALListener.h
reverbOn
Turns on reverb. (iOS 5.0+)
@property (nonatomic, readwrite, assign) bool reverbOn
Declared In
ALListener.h
reverbRoomType
The room type to simulate for reverb. (iOS 5.0+)
@property (nonatomic, readwrite, assign) int reverbRoomType
Discussion
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
Declared In
ALListener.h