Struct AVAudioEnvironmentDistanceAttenuationModel 

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

Available on crate feature AVAudioEnvironmentNode only.

Types of distance attenuation models

Distance attenuation is the natural attenuation of sound when traveling from the source to the listener. The different attenuation models listed below describe the drop-off in gain as the source moves away from the listener.

AVAudioEnvironmentDistanceAttenuationModelExponential distanceGain = (distance / referenceDistance) ^ (-rolloffFactor)

AVAudioEnvironmentDistanceAttenuationModelInverse distanceGain = referenceDistance / (referenceDistance + rolloffFactor * (distance – referenceDistance))

AVAudioEnvironmentDistanceAttenuationModelLinear distanceGain = (1 – rolloffFactor * (distance – referenceDistance) / (maximumDistance – referenceDistance))

With all the distance models, if the formula can not be evaluated then the source will not be attenuated. For example, if a linear model is being used with referenceDistance equal to maximumDistance, then the gain equation will have a divide-by-zero error in it. In this case, there is no attenuation for that source.

All the values for distance are specified in meters.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl AVAudioEnvironmentDistanceAttenuationModel

pub const Exponential: Self

pub const Inverse: Self

pub const Linear: Self

Trait Implementations

impl Clone for AVAudioEnvironmentDistanceAttenuationModel

fn clone(&self) -> AVAudioEnvironmentDistanceAttenuationModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AVAudioEnvironmentDistanceAttenuationModel

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

Formats the value using the given formatter.

impl Encode for AVAudioEnvironmentDistanceAttenuationModel

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for AVAudioEnvironmentDistanceAttenuationModel

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 AVAudioEnvironmentDistanceAttenuationModel

fn cmp(&self, other: &AVAudioEnvironmentDistanceAttenuationModel) -> 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 AVAudioEnvironmentDistanceAttenuationModel

fn eq(&self, other: &AVAudioEnvironmentDistanceAttenuationModel) -> 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 AVAudioEnvironmentDistanceAttenuationModel

fn partial_cmp( &self, other: &AVAudioEnvironmentDistanceAttenuationModel, ) -> 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 AVAudioEnvironmentDistanceAttenuationModel

const ENCODING_REF: Encoding

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

impl Copy for AVAudioEnvironmentDistanceAttenuationModel

impl Eq for AVAudioEnvironmentDistanceAttenuationModel

impl StructuralPartialEq for AVAudioEnvironmentDistanceAttenuationModel