Struct AVAudioSessionCategoryOptions 

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

Available on crate feature AVAudioSessionTypes only.

Customization of various aspects of a category’s behavior. Use with AVAudioSession/setCategory:mode:options:error:.

Applications must be prepared for changing category options to fail as behavior may change in future releases. If an application changes its category, it should reassert the options, since they are not sticky across category changes. Introduced in iOS 6.0 / watchOS 2.0 / tvOS 9.0.

See also Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl AVAudioSessionCategoryOptions

pub const MixWithOthers: Self

Controls whether other active audio apps will be interrupted or mixed with when your app’s audio session goes active. Details depend on the category.

• AVAudioSessionCategoryPlayAndRecord or AVAudioSessionCategoryMultiRoute: MixWithOthers defaults to false, but can be set to true, allowing other applications to play in the background while your app has both audio input and output enabled.

• AVAudioSessionCategoryPlayback: MixWithOthers defaults to false, but can be set to true, allowing other applications to play in the background. Your app will still be able to play regardless of the setting of the ringer switch.

• Other categories: MixWithOthers defaults to false and cannot be changed.

MixWithOthers is only valid with AVAudioSessionCategoryPlayAndRecord, AVAudioSessionCategoryPlayback, and AVAudioSessionCategoryMultiRoute.

pub const DuckOthers: Self

Controls whether or not other active audio apps will be ducked when when your app’s audio session goes active. An example of this is a workout app, which provides periodic updates to the user. It reduces the volume of any music currently being played while it provides its status.

Defaults to off. Note that the other audio will be ducked for as long as the current session is active. You will need to deactivate your audio session when you want to restore full volume playback (un-duck) other sessions.

Setting this option will also make your session mixable with others (AVAudioSessionCategoryOptionMixWithOthers will be set).

DuckOthers is only valid with AVAudioSessionCategoryAmbient, AVAudioSessionCategoryPlayAndRecord, AVAudioSessionCategoryPlayback, and AVAudioSessionCategoryMultiRoute.

pub const AllowBluetooth: Self

👎Deprecated

Deprecated - please see AVAudioSessionCategoryOptionAllowBluetoothHFP

pub const AllowBluetoothHFP: Self

Allows an application to change the default behavior of some audio session categories with regard to whether Bluetooth Hands-Free Profile (HFP) devices are available for routing. The exact behavior depends on the category.

• AVAudioSessionCategoryPlayAndRecord: AllowBluetoothHFP defaults to false, but can be set to true, allowing a paired bluetooth HFP device to appear as an available route for input, while playing through the category-appropriate output.

• AVAudioSessionCategoryRecord: AllowBluetoothHFP defaults to false, but can be set to true, allowing a paired Bluetooth HFP device to appear as an available route for input.

• Other categories: AllowBluetoothHFP defaults to false and cannot be changed. Enabling Bluetooth for input in these categories is not allowed.

pub const DefaultToSpeaker: Self

Allows an application to change the default behavior of some audio session categories with regard to the audio route. The exact behavior depends on the category.

• AVAudioSessionCategoryPlayAndRecord: DefaultToSpeaker will default to false, but can be set to true, routing to Speaker (instead of Receiver) when no other audio route is connected.

• Other categories: DefaultToSpeaker is always false and cannot be changed.

pub const InterruptSpokenAudioAndMixWithOthers: Self

When a session with InterruptSpokenAudioAndMixWithOthers set goes active, then if there is another playing app whose session mode is AVAudioSessionModeSpokenAudio (for podcast playback in the background, for example), then the spoken-audio session will be interrupted. A good use of this is for a navigation app that provides prompts to its user: it pauses any spoken audio currently being played while it plays the prompt.

InterruptSpokenAudioAndMixWithOthers defaults to off. Note that the other app’s audio will be paused for as long as the current session is active. You will need to deactivate your audio session to allow the other session to resume playback. Setting this option will also make your category mixable with others (AVAudioSessionCategoryOptionMixWithOthers will be set). If you want other non-spoken audio apps to duck their audio when your app’s session goes active, also set AVAudioSessionCategoryOptionDuckOthers.

Only valid with AVAudioSessionCategoryPlayAndRecord, AVAudioSessionCategoryPlayback, and AVAudioSessionCategoryMultiRoute.

pub const AllowBluetoothA2DP: Self

Allows an application to change the default behavior of some audio session categories with regard to whether Bluetooth Advanced Audio Distribution Profile (A2DP) devices are available for routing. The exact behavior depends on the category.

• AVAudioSessionCategoryPlayAndRecord: AllowBluetoothA2DP defaults to false, but can be set to true, allowing a paired Bluetooth A2DP device to appear as an available route for output, while recording through the category-appropriate input.

• AVAudioSessionCategoryMultiRoute and AVAudioSessionCategoryRecord: AllowBluetoothA2DP is false, and cannot be set to true.

• Other categories: AllowBluetoothA2DP is always implicitly true and cannot be changed; Bluetooth A2DP ports are always supported in output-only categories.

Setting both AVAudioSessionCategoryOptionAllowBluetoothHFP and AVAudioSessionCategoryOptionAllowBluetoothA2DP is allowed. In cases where a single Bluetooth device supports both HFP and A2DP, the HFP ports will be given a higher priority for routing. For HFP and A2DP ports on separate hardware devices, the last-in wins rule applies.

pub const AllowAirPlay: Self

Allows an application to change the default behavior of some audio session categories with regard to showing AirPlay devices as available routes. This option applies to various categories in the same way as AVAudioSessionCategoryOptionAllowBluetoothA2DP; see above for details. Only valid with AVAudioSessionCategoryPlayAndRecord.

pub const OverrideMutedMicrophoneInterruption: Self

Some devices include a privacy feature that mutes the built-in microphone at a hardware level under certain conditions e.g. when the Smart Folio of an iPad is closed. The default behavior is to interrupt the session using the built-in microphone when that microphone is muted in hardware. This option allows an application to opt out of the default behavior if it is using a category that supports both input and output, such as AVAudioSessionCategoryPlayAndRecord, and wants to allow its session to stay activated even when the microphone has been muted. The result would be that playback continues as normal, and microphone sample buffers would continue to be produced but all microphone samples would have a value of zero.

This may be useful if an application knows that it wants to allow playback to continue and recording/monitoring a muted microphone will not lead to a poor user experience. Attempting to use this option with a session category that doesn’t support the use of audio input will result in an error.

• Note Under the default policy, a session will be interrupted if it is running input at the time when the microphone is muted in hardware. Similarly, attempting to start input when the microphone is muted will fail.
• Note This option has no relation to the recordPermission property, which indicates whether or not the user has granted permission to use microphone input.

pub const BluetoothHighQualityRecording: Self

When this option is specified with a category that supports both input and output, the session will enable full-bandwidth audio in both input & output directions, if the Bluetooth route supports it (e.g. certain AirPods models). It is currently compatible only with mode AVAudioSessionModeDefault.

• Support for this can be queried on input ports via the BluetoothMicrophone interface on a port, via its member highQualityRecording.isSupported.

• Active sessions can see if full-bandwidth Bluetooth audio was successfully enabled by querying the BluetoothMicrophone interface of the input port of the current route for: highQualityRecording.isEnabled.

• When this option is provided alone, it will be enabled if the route supports it, otherwise the option will be ignored. This option may be combined with AVAudioSessionCategoryOptionAllowBluetoothHFP, in which case HFP will be used as a fallback if the route does not support this AVAudioSessionCategoryOptionBluetoothHighQualityRecording option.

• Note This option may increase input latency when enabled and is therefore not recommended for real-time communication usage.

• Note Apps using AVAudioSessionCategoryOptionBluetoothHighQualityRecording may want to consider setting AVAudioSession/setPrefersNoInterruptionsFromSystemAlerts:error: while recording, to avoid the recording session being interrupted by an incoming call ringtone.

impl AVAudioSessionCategoryOptions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> NSUInteger

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: NSUInteger) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: NSUInteger) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: NSUInteger) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl AVAudioSessionCategoryOptions

pub const fn iter(&self) -> Iter<AVAudioSessionCategoryOptions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<AVAudioSessionCategoryOptions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for AVAudioSessionCategoryOptions

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

Formats the value using the given formatter.

impl BitAnd for AVAudioSessionCategoryOptions

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

The bitwise and (&) of the bits in two flags values.

type Output = AVAudioSessionCategoryOptions

The resulting type after applying the & operator.

impl BitAndAssign for AVAudioSessionCategoryOptions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for AVAudioSessionCategoryOptions

fn bitor(self, other: AVAudioSessionCategoryOptions) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = AVAudioSessionCategoryOptions

The resulting type after applying the | operator.

impl BitOrAssign for AVAudioSessionCategoryOptions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for AVAudioSessionCategoryOptions

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = AVAudioSessionCategoryOptions

The resulting type after applying the ^ operator.

impl BitXorAssign for AVAudioSessionCategoryOptions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for AVAudioSessionCategoryOptions

fn clone(&self) -> AVAudioSessionCategoryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AVAudioSessionCategoryOptions

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

Formats the value using the given formatter.

impl Encode for AVAudioSessionCategoryOptions

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Extend<AVAudioSessionCategoryOptions> for AVAudioSessionCategoryOptions

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for AVAudioSessionCategoryOptions

const FLAGS: &'static [Flag<AVAudioSessionCategoryOptions>]

The set of defined flags.

type Bits = usize

The underlying bits type.

fn bits(&self) -> NSUInteger

Get the underlying bits value.

fn from_bits_retain(bits: NSUInteger) -> AVAudioSessionCategoryOptions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<AVAudioSessionCategoryOptions> for AVAudioSessionCategoryOptions

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for AVAudioSessionCategoryOptions

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 IntoIterator for AVAudioSessionCategoryOptions

type Item = AVAudioSessionCategoryOptions

The type of the elements being iterated over.

type IntoIter = Iter<AVAudioSessionCategoryOptions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for AVAudioSessionCategoryOptions

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

Formats the value using the given formatter.

impl Not for AVAudioSessionCategoryOptions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = AVAudioSessionCategoryOptions

The resulting type after applying the ! operator.

impl Octal for AVAudioSessionCategoryOptions

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

Formats the value using the given formatter.

impl Ord for AVAudioSessionCategoryOptions

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

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

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

const ENCODING_REF: Encoding

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

impl Sub for AVAudioSessionCategoryOptions

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = AVAudioSessionCategoryOptions

The resulting type after applying the - operator.

impl SubAssign for AVAudioSessionCategoryOptions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for AVAudioSessionCategoryOptions

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

Formats the value using the given formatter.

impl Copy for AVAudioSessionCategoryOptions

impl Eq for AVAudioSessionCategoryOptions

impl StructuralPartialEq for AVAudioSessionCategoryOptions