Struct AVAudioSessionPromptStyle 

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

Available on crate feature AVAudioSessionTypes only.

The prompt style is a hint to sessions that use AVAudioSessionModeVoicePrompt to modify the type of prompt they play in response to other audio activity on the system, such as Siri or phone calls. Sessions that issue voice prompts are encouraged to pay attention to changes in the prompt style and modify their prompts in response. Apple encourages the use of non-verbal prompts when the Short style is requested.

Indicates that another session is actively using microphone input and would be negatively impacted by having prompts play at that time. For example if Siri is recognizing speech, having navigation or exercise prompts play, could interfere with its ability to accurately recognize the user’s speech. Client sessions should refrain from playing any prompts while the prompt style is None.

Indicates one of three states: Siri is active but not recording, voicemail playback is active, or voice call is active. Short, non-verbal versions of prompts should be used.

Indicates that normal (long, verbal) versions of prompts may be used.

See also Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl AVAudioSessionPromptStyle

pub const None: Self

pub const Short: Self

pub const Normal: Self

Trait Implementations

impl Clone for AVAudioSessionPromptStyle

fn clone(&self) -> AVAudioSessionPromptStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AVAudioSessionPromptStyle

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

Formats the value using the given formatter.

impl Encode for AVAudioSessionPromptStyle

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for AVAudioSessionPromptStyle

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 AVAudioSessionPromptStyle

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

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

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

const ENCODING_REF: Encoding

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

impl Copy for AVAudioSessionPromptStyle

impl Eq for AVAudioSessionPromptStyle

impl StructuralPartialEq for AVAudioSessionPromptStyle