Enum AudioRenderUsage

#[repr(u32)]
pub enum AudioRenderUsage {
    Background = 0,
    Media = 1,
    Interruption = 2,
    SystemAgent = 3,
    Communication = 4,
}

Usage annotating the purpose of the stream being used to render audio. An AudioRenderer’s usage cannot be changed after creation. The AudioRenderUsage is used by audio policy to dictate how audio streams interact with each other.

Variants

Background = 0

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

Media = 1

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

Interruption = 2

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

SystemAgent = 3

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

Communication = 4

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

Implementations

impl AudioRenderUsage

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

pub const fn into_primitive(self) -> u32

pub fn is_unknown(&self) -> bool

👎Deprecated: Strict enums should not use is_unknown

Trait Implementations

impl Clone for AudioRenderUsage

fn clone(&self) -> AudioRenderUsage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioRenderUsage

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<AudioRenderUsage, D> for AudioRenderUsage

fn new_empty() -> Self

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<()>

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

impl<D: ResourceDialect> Encode<AudioRenderUsage, D> for AudioRenderUsage

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

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

impl Hash for AudioRenderUsage

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 AudioRenderUsage

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

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

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

type Owned = AudioRenderUsage

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 AudioRenderUsage

type Borrowed<'a> = AudioRenderUsage

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: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

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

impl Copy for AudioRenderUsage

impl Eq for AudioRenderUsage

impl StructuralPartialEq for AudioRenderUsage