Class

AVAudioEnvironmentNode

A mixer node that simulates a 3D audio environment.

Declaration

@interface AVAudioEnvironmentNode : AVAudioNode

Overview

Any node that conforms to the AVAudioMixing protocol (for example, AVAudioPlayerNode) can act as a source in this environment.

The environment has an implicit “listener.” By controlling the listener’s position and orientation, the application controls the way the user experiences the virtual world. This node also defines properties for distance attenuation and reverberation that help characterize the environment.

Only inputs with a mono channel connection format to the environment node are spatialized. If the input is stereo, the audio is passed through without being spatialized. Inputs with connection formats of more than two channels aren't supported.

To set the environment node’s output to a multichannel format, use an AVAudioFormat that has one of the following Audio Channel Layout Tags:

Topics

Creating an Environment Node

- init

Initializes a new environment node.

Getting and Setting Environment Parameters

distanceAttenuationParameters

The distance attenuation parameters for the environment.

listenerAngularOrientation

The listener's angular orientation in the environment.

listenerVectorOrientation

The listener's vector orientation in the environment.

listenerPosition

The listener's position in the 3D environment.

reverbParameters

The reverb parameters for the environment.

outputVolume

The mixer's output volume.

Getting the Available Rendering Algorithms

applicableRenderingAlgorithms

An array of rendering algorithms applicable to the environment node.

Getting the Input Bus

nextAvailableInputBus

An unused input bus.

Instance Properties

Relationships

Inherits From

Conforms To

See Also

3D Environment Options

AVAudioEnvironmentDistanceAttenuationParameters

A class that specifies the attenuation distance, the gradual loss in audio intensity, and other characteristics.

AVAudioEnvironmentReverbParameters

A class that encapsulates the parameters that you use to control the reverb of the environment node class.

AVAudio3DMixing

A protocol defining 3D mixing properties.

AVAudio3DAngularOrientation

A structure representing the angular orientation of the listener in 3D space.

AVAudio3DPoint

A structure representing a point in 3D space.

AVAudio3DVectorOrientation

A structure representing two orthogonal vectors that describe the orientation of the listener in 3D space.

AVAudio3DVector

A structure representing a vector in 3D space.