Enum ndk::audio::AudioUsage

source · [−]

#[repr(u32)]
pub enum AudioUsage {
Show 16 variants    Media,
    VoiceCommunication,
    VoiceCommunicationSignalling,
    Alarm,
    Notification,
    NotificationRingtone,
    NotificationEvent,
    AssistanceAccessibility,
    AssistanceNavigationGuidance,
    AssistanceSonification,
    Game,
    Assistant,
    SystemEmergency,
    SystemSafety,
    SystemVehicleStatus,
    SystemAnnouncement,
}

Available on crate features audio and api-level-28 only.

Expand description

The Usage attribute expresses “why” you are playing a sound, what is this sound used for. This information is used by certain platforms or routing policies to make more refined volume or routing decisions.

Note that these match the equivalent values in android.media.AudioAttributes in the Android Java API.

Variants

`Media`

Use this for streaming media, music performance, video, podcasts, etcetera.

`VoiceCommunication`

Use this for voice over IP, telephony, etcetera.

`VoiceCommunicationSignalling`

Use this for sounds associated with telephony such as busy tones, DTMF, etcetera.

`Alarm`

Use this to demand the users attention.

`Notification`

Use this for notifying the user when a message has arrived or some other background event has occured.

`NotificationRingtone`

Use this when the phone rings.

`NotificationEvent`

Use this to attract the users attention when, for example, the battery is low.

`AssistanceAccessibility`

Use this for screen readers, etcetera.

`AssistanceNavigationGuidance`

Use this for driving or navigation directions.

`AssistanceSonification`

Use this for user interface sounds, beeps, etcetera.

`Game`

Use this for game audio and sound effects.

`Assistant`

Use this for audio responses to user queries, audio instructions or help utterances.

`SystemEmergency`

Use this in case of playing sounds in an emergency. Privileged MODIFY_AUDIO_ROUTING permission required.

`SystemSafety`

Use this for safety sounds and alerts, for example backup camera obstacle detection. Privileged MODIFY_AUDIO_ROUTING permission required.

`SystemVehicleStatus`

Use this for vehicle status alerts and information, for example the check engine light. Privileged MODIFY_AUDIO_ROUTING permission required.

`SystemAnnouncement`

Use this for traffic announcements, etc. Privileged MODIFY_AUDIO_ROUTING permission required.

Trait Implementations

impl Clone for AudioUsage

fn clone(&self) -> AudioUsage

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for AudioUsage

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

Formats the value using the given formatter. Read more

impl From<AudioUsage> for u32

fn from(enum_value: AudioUsage) -> Self

Converts to this type from the input type.

impl PartialEq<AudioUsage> for AudioUsage

fn eq(&self, other: &AudioUsage) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TryFrom<u32> for AudioUsage

type Error = TryFromPrimitiveError<AudioUsage>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for AudioUsage

type Primitive = u32

const NAME: &'static str = _

fn try_from_primitive(
number: Self::Primitive
) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for AudioUsage

impl Eq for AudioUsage

impl StructuralEq for AudioUsage

impl StructuralPartialEq for AudioUsage

Auto Trait Implementations

impl RefUnwindSafe for AudioUsage

impl Send for AudioUsage

impl Sync for AudioUsage

impl Unpin for AudioUsage

impl UnwindSafe for AudioUsage

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.