Enum AudioRenderUsage2

pub enum AudioRenderUsage2 {
    Background,
    Media,
    Interruption,
    SystemAgent,
    Communication,
    Accessibility,
    // some variants omitted
}

Usage annotating the purpose of the stream being used to render audio. An AudioRenderer’s usage cannot be changed after creation. The AudioRenderUsage2 value is used by audio policy to dictate how audio streams interact with each other. This enum expands the original (strict) enum |AudioRenderUsage| with additional stream types.

Variants

Background

Stream is intended to be used for ambient or background sound. Streams that can be interrupted without consequence should use this.

Media

Stream is intended to be used for normal functionality. Streams that are part of normal functionality should use this.

Interruption

Stream is intended to interrupt any ongoing function of the device. Streams that are used for interruptions like notifications should use this.

SystemAgent

Stream is for interaction with a system agent. This should be used in response to a user initiated trigger.

Communication

Stream is intended to be used for some form of real time user to user communication. Voice/Video chat should use this.

Accessibility

Stream is intended to be used for accessibility or other non-system- agent speech output, such as screen reader TTS.

Implementations

impl AudioRenderUsage2

pub fn from_primitive(prim: u32) -> Option<AudioRenderUsage2>

pub fn from_primitive_allow_unknown(prim: u32) -> AudioRenderUsage2

pub fn unknown() -> AudioRenderUsage2

pub const fn into_primitive(self) -> u32

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Clone for AudioRenderUsage2

fn clone(&self) -> AudioRenderUsage2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioRenderUsage2

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

Formats the value using the given formatter.

impl<D> Decode<AudioRenderUsage2, D> for AudioRenderUsage2

where D: ResourceDialect,

fn new_empty() -> AudioRenderUsage2

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl<D> Encode<AudioRenderUsage2, D> for AudioRenderUsage2

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Hash for AudioRenderUsage2

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 AudioRenderUsage2

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

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

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

type Owned = AudioRenderUsage2

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for AudioRenderUsage2

type Borrowed<'a> = AudioRenderUsage2

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<AudioRenderUsage2 as TypeMarker>::Owned, ) -> <AudioRenderUsage2 as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for AudioRenderUsage2

impl Eq for AudioRenderUsage2

impl StructuralPartialEq for AudioRenderUsage2