Struct AVAudioSessionRouteSharingPolicy 

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

Available on crate feature AVAudioSessionTypes only.

Starting in iOS 11, tvOS 11, and watchOS 5, the route sharing policy allows a session to specify that its output audio should be routed somewhere other than the default system output, when appropriate alternative routes are available.

Follow normal rules for routing audio output.

Route output to the shared long-form audio output. A session whose primary use case is as a music or podcast player may use this value to play to the same output as the built-in Music (iOS), Podcasts, or iTunes (macOS) applications. Typically applications that use this policy will also want sign up for remote control events as documented in “Event Handling Guide for UIKit Apps” and will want to utilize MediaPlayer framework’s MPNowPlayingInfoCenter class. All applications on the system that use the long-form audio route sharing policy will have their audio routed to the same location. Apps running on watchOS using this policy will also be able to play audio in the background, as long as an eligible audio route can be activated. Apps running on watchOS using this policy must use -activateWithOptions:completionHandler: instead of -setActive:withOptions:error: in order to ensure that the user will be given the opportunity to pick an appropriate audio route in cases where the system is unable to automatically pick the route.

Deprecated. Replaced by AVAudioSessionRouteSharingPolicyLongFormAudio.

Applications should not attempt to set this value directly. On iOS, this value will be set by the system in cases where route picker UI is used to direct video to a wireless route.

Route output to the shared long-form video output. A session whose primary use case is as a movie or other long-form video content player may use this value to play to the same output as other long-form video content applications such as the built-in TV (iOS) application. Applications that use this policy will also want to also set the AVInitialRouteSharingPolicy key in their Info.plist to “LongFormVideo”. All applications on the system that use the long-form video route sharing policy will have their audio and video routed to the same location (e.g. AppleTV when an AirPlay route is selected). Video content not using this route sharing policy will remain local to the playback device even when long form video content is being routed to AirPlay.

See also Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl AVAudioSessionRouteSharingPolicy

pub const Default: Self

pub const LongFormAudio: Self

pub const LongForm: Self

👎Deprecated

pub const Independent: Self

pub const LongFormVideo: Self

Trait Implementations

impl Clone for AVAudioSessionRouteSharingPolicy

fn clone(&self) -> AVAudioSessionRouteSharingPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AVAudioSessionRouteSharingPolicy

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

Formats the value using the given formatter.

impl Encode for AVAudioSessionRouteSharingPolicy

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for AVAudioSessionRouteSharingPolicy

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 AVAudioSessionRouteSharingPolicy

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

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

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

const ENCODING_REF: Encoding

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

impl Copy for AVAudioSessionRouteSharingPolicy

impl Eq for AVAudioSessionRouteSharingPolicy

impl StructuralPartialEq for AVAudioSessionRouteSharingPolicy