AudioAttributes

Kotlin |Java

class AudioAttributes

Attributes for audio playback, which configure the underlying platform android.media.AudioTrack.

To set the audio attributes, create an instance using the Builder and either pass it to the player or send a message of type Renderer#MSG_SET_AUDIO_ATTRIBUTES to the audio renderers.

This class is based on android.media.AudioAttributes, but can be used on all supported API versions.

Summary

Nested types
`class AudioAttributes.AudioAttributesV21` This class is deprecated. Use `android.media.AudioAttributes`.
`class AudioAttributes.Builder` Builder for `AudioAttributes`.

Nested types

class AudioAttributes.AudioAttributesV21

This class is deprecated.

Use android.media.AudioAttributes.

class AudioAttributes.Builder

Builder for AudioAttributes.

Constants
`const AudioAttributes!`	`DEFAULT` The default audio attributes, where the content type is `AUDIO_CONTENT_TYPE_UNKNOWN`, usage is `USAGE_MEDIA`, capture policy is `ALLOW_CAPTURE_BY_ALL` and no flags are set.

Public functions
`Boolean`	`equals(obj: Any?)`
`java-static AudioAttributes!`	`@UnstableApi fromBundle(bundle: Bundle!)` Restores a `AudioAttributes` from a `Bundle`.
`java-static AudioAttributes!`	`fromPlatformAudioAttributes(audioAttributes: AudioAttributes!)` Creates a new instance from the provided `android.media.AudioAttributes`.
`AudioAttributes.AudioAttributesV21!`	`getAudioAttributesV21()` This function is deprecated. Use `getPlatformAudioAttributes`
`Int`	`@UnstableApi @C.StreamType getStreamType()` Returns the `C.StreamType` corresponding to these audio attributes.
`Int`	`hashCode()`
`Bundle!`	`@UnstableApi toBundle()`

Public properties
`Int`	`@C.AudioAllowedCapturePolicy allowedCapturePolicy` The `C.AudioAllowedCapturePolicy`.
`Int`	`@C.AudioContentType contentType` The `C.AudioContentType`.
`Int`	`@C.AudioFlags flags` The `C.AudioFlags`.
`Boolean`	`@UnstableApi hapticChannelsMuted` Whether haptic channels are muted.
`Boolean`	`@UnstableApi isContentSpatialized` Whether the content is spatialized.
`AudioAttributes?`	`platformAudioAttributes`
`Int`	`@C.SpatializationBehavior spatializationBehavior` The `C.SpatializationBehavior`.
`Int`	`@C.AudioUsage usage` The `C.AudioUsage`.

Constants

DEFAULT

const val DEFAULT: AudioAttributes!

The default audio attributes, where the content type is AUDIO_CONTENT_TYPE_UNKNOWN, usage is USAGE_MEDIA, capture policy is ALLOW_CAPTURE_BY_ALL and no flags are set.

Public functions

equals

fun equals(obj: Any?): Boolean

fromBundle

@UnstableApi
java-static fun fromBundle(bundle: Bundle!): AudioAttributes!

Restores a AudioAttributes from a Bundle.

fromPlatformAudioAttributes

java-static fun fromPlatformAudioAttributes(audioAttributes: AudioAttributes!): AudioAttributes!

Creates a new instance from the provided android.media.AudioAttributes.

getAudioAttributesV21

fun getAudioAttributesV21(): AudioAttributes.AudioAttributesV21!

getStreamType

@UnstableApi
@C.StreamType
fun getStreamType(): Int

Returns the C.StreamType corresponding to these audio attributes.

hashCode

fun hashCode(): Int

toBundle

@UnstableApi
fun toBundle(): Bundle!

Public properties

allowedCapturePolicy

@C.AudioAllowedCapturePolicy
val allowedCapturePolicy: Int

The C.AudioAllowedCapturePolicy.

contentType

@C.AudioContentType
val contentType: Int

The C.AudioContentType.

flags

@C.AudioFlags
val flags: Int

The C.AudioFlags.

hapticChannelsMuted

@UnstableApi
val hapticChannelsMuted: Boolean

Whether haptic channels are muted.

isContentSpatialized

@UnstableApi
val isContentSpatialized: Boolean

Whether the content is spatialized.

platformAudioAttributes

val platformAudioAttributes: AudioAttributes?

spatializationBehavior

@C.SpatializationBehavior
val spatializationBehavior: Int

The C.SpatializationBehavior.

usage

@C.AudioUsage
val usage: Int

The C.AudioUsage.