Struct AVAudio3DMixingRenderingAlgorithm 

#[repr(transparent)]
pub struct AVAudio3DMixingRenderingAlgorithm(pub NSInteger);

Available on crate feature AVAudioMixing only.

Types of rendering algorithms available per input bus of the environment node

The rendering algorithms differ in terms of quality and cpu cost. AVAudio3DMixingRenderingAlgorithmEqualPowerPanning is the simplest panning algorithm and also the least expensive computationally.

When rendering to multi-channel hardware, audio data will only be rendered to channels 1 & 2 with all rendering algorithms except AVAudio3DMixingRenderingAlgorithmSoundField and AVAudio3DMixingRenderingAlgorithmAuto.

AVAudio3DMixingRenderingAlgorithmEqualPowerPanning EqualPowerPanning merely pans the data of the mixer bus into a stereo field. This algorithm is analogous to the pan knob found on a mixing board channel strip.

AVAudio3DMixingRenderingAlgorithmSphericalHead SphericalHead is designed to emulate 3 dimensional space in headphones by simulating inter-aural time delays and other spatial cues. SphericalHead is slightly less CPU intensive than the HRTF algorithm.

AVAudio3DMixingRenderingAlgorithmHRTF HRTF (Head Related Transfer Function) is a high quality algorithm using filtering to emulate 3 dimensional space in headphones. HRTF is a cpu intensive algorithm.

AVAudio3DMixingRenderingAlgorithmHRTFHQ Higher quality HRTF rendering algorithm compared to AVAudio3DMixingRenderingAlgorithmHRTF. Improvements have been made to the overall frequency response and localization of sources in a 3D space.

AVAudio3DMixingRenderingAlgorithmSoundField SoundField is designed for rendering to multi channel hardware. The mixer takes data being rendered with SoundField and distributes it amongst all the output channels with a weighting toward the location in which the sound derives. It is very effective for ambient sounds, which may derive from a specific location in space, yet should be heard through the listener’s entire space.

AVAudio3DMixingRenderingAlgorithmStereoPassThrough StereoPassThrough should be used when no localization is desired for the source data. Setting this algorithm tells the mixer to pass the input channels to output without localization. If the input and output AudioChannelLayouts differ, mixing is done according to the kAudioFormatProperty_MatrixMixMap property of the layouts.

AVAudio3DMixingRenderingAlgorithmAuto Automatically pick the highest-quality rendering algorithm available for current playback hardware. The algorithm may not be identical to other existing algorithms and may change in the future as new algorithms are developed. When using Manual Rendering modes or wired output, it may be necessary to manually set the AVAudioEnvironmentNode’s output type. Multi-channel rendering requires setting a channel layout on the AVAudioEnvironmentNode’s output.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl AVAudio3DMixingRenderingAlgorithm

pub const EqualPowerPanning: Self

pub const SphericalHead: Self

pub const HRTF: Self

pub const SoundField: Self

pub const StereoPassThrough: Self

pub const HRTFHQ: Self

pub const Auto: Self

Trait Implementations

impl Clone for AVAudio3DMixingRenderingAlgorithm

fn clone(&self) -> AVAudio3DMixingRenderingAlgorithm

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AVAudio3DMixingRenderingAlgorithm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for AVAudio3DMixingRenderingAlgorithm

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for AVAudio3DMixingRenderingAlgorithm

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AVAudio3DMixingRenderingAlgorithm

fn cmp(&self, other: &AVAudio3DMixingRenderingAlgorithm) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AVAudio3DMixingRenderingAlgorithm

fn eq(&self, other: &AVAudio3DMixingRenderingAlgorithm) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AVAudio3DMixingRenderingAlgorithm

fn partial_cmp( &self, other: &AVAudio3DMixingRenderingAlgorithm, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for AVAudio3DMixingRenderingAlgorithm

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for AVAudio3DMixingRenderingAlgorithm

impl Eq for AVAudio3DMixingRenderingAlgorithm

impl StructuralPartialEq for AVAudio3DMixingRenderingAlgorithm