Struct AVAudioSessionIOType

#[repr(transparent)]
pub struct AVAudioSessionIOType(pub NSUInteger);

Available on crate feature AVAudioSessionTypes only.

Values to be used by setAggregatedIOPreference:error: method.

Starting in iOS 10, applications that use AVCaptureSession on iPads and iPhones that support taking Live Photos, will have non-aggregated audio I/O unless the app opts out by setting its AVAudioSessionIOType to Aggregated. Non-aggregated audio I/O means that separate threads will be used to service audio I/O for input and output directions.

Note that in cases where the I/O is not aggregated, the sample rate and IO buffer duration properties will map to the output audio device. In this scenario, the input and output audio hardware may be running at different sample rates and with different IO buffer durations. If your app requires input and output audio to be presented in the same realtime I/O callback, or requires that input and output audio have the same sample rate or IO buffer duration, or if your app requires the ability to set a preferred sample rate or IO buffer duration for audio input, set the AVAudioSessionIOType to Aggregated.

Apps that don’t use AVCaptureSession and use AVAudioSessionCategoryPlayAndRecord will continue to have aggregated audio I/O, as in previous versions of iOS.

The default value. If your app does not use AVCaptureSession or does not have any specific requirement for aggregating input and output audio in the same realtime I/O callback, use this value. Note that if your app does not use AVCaptureSession, it will get aggregated I/O when using AVAudioSessionCategoryPlayAndRecord.

If your app does utilize AVCaptureSession, use of this value will allow AVCaptureSession to start recording without glitching already running output audio and will allow the system to utilize power-saving optimizations.

Use this value if your session uses AVAudioSessionCategoryPlayAndRecord and requires input and output audio to be presented in the same realtime I/O callback. For example, if your app will be using a RemoteIO with both input and output enabled.

Note that your session’s preference to use aggregated IO will not be honored if it specifies AVAudioSessionCategoryOptionMixWithOthers AND another app’s audio session was already active with non-mixable, non-aggregated input/output.

Added in iOS 10.0. Not applicable on watchos, tvos, macos.

See also Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl AVAudioSessionIOType

pub const NotSpecified: Self

pub const Aggregated: Self

Trait Implementations

impl Clone for AVAudioSessionIOType

fn clone(&self) -> AVAudioSessionIOType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AVAudioSessionIOType

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

Formats the value using the given formatter.

impl Encode for AVAudioSessionIOType

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for AVAudioSessionIOType

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 AVAudioSessionIOType

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

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

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

const ENCODING_REF: Encoding

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

impl Copy for AVAudioSessionIOType

impl Eq for AVAudioSessionIOType

impl StructuralPartialEq for AVAudioSessionIOType