AudioAttributes

Kotlin |Java

public final 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
`public final class AudioAttributes.AudioAttributesV21` This class is deprecated. Use `android.media.AudioAttributes`.
`public final class AudioAttributes.Builder` Builder for `AudioAttributes`.

Nested types

public final class AudioAttributes.AudioAttributesV21

This class is deprecated.

Use android.media.AudioAttributes.

public final class AudioAttributes.Builder

Builder for AudioAttributes.

Constants
`static final 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 fields
`final int`	`@C.AudioAllowedCapturePolicy allowedCapturePolicy` The `C.AudioAllowedCapturePolicy`.
`final int`	`@C.AudioContentType contentType` The `C.AudioContentType`.
`final int`	`@C.AudioFlags flags` The `C.AudioFlags`.
`final boolean`	`@UnstableApi hapticChannelsMuted` Whether haptic channels are muted.
`final boolean`	`@UnstableApi isContentSpatialized` Whether the content is spatialized.
`@Nullable AudioAttributes`	`platformAudioAttributes`
`final int`	`@C.SpatializationBehavior spatializationBehavior` The `C.SpatializationBehavior`.
`final int`	`@C.AudioUsage usage` The `C.AudioUsage`.

Public methods
`boolean`	`equals(@Nullable Object obj)`
`static AudioAttributes`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `AudioAttributes` from a `Bundle`.
`static AudioAttributes`	`fromPlatformAudioAttributes(AudioAttributes audioAttributes)` Creates a new instance from the provided `android.media.AudioAttributes`.
`AudioAttributes.AudioAttributesV21`	`getAudioAttributesV21()` This method is deprecated. Use `getPlatformAudioAttributes`
`AudioAttributes`	`getPlatformAudioAttributes()` Returns a `android.media.AudioAttributes` from this instance.
`int`	`@UnstableApi @C.StreamType getStreamType()` Returns the `C.StreamType` corresponding to these audio attributes.
`int`	`hashCode()`
`Bundle`	`@UnstableApi toBundle()`

Constants

DEFAULT

public static final 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 fields

allowedCapturePolicy

@C.AudioAllowedCapturePolicy
public final int allowedCapturePolicy

The C.AudioAllowedCapturePolicy.

contentType

@C.AudioContentType
public final int contentType

The C.AudioContentType.

flags

@C.AudioFlags
public final int flags

The C.AudioFlags.

hapticChannelsMuted

@UnstableApi
public final boolean hapticChannelsMuted

Whether haptic channels are muted.

isContentSpatialized

@UnstableApi
public final boolean isContentSpatialized

Whether the content is spatialized.

platformAudioAttributes

public @Nullable AudioAttributes platformAudioAttributes

spatializationBehavior

@C.SpatializationBehavior
public final int spatializationBehavior

The C.SpatializationBehavior.

usage

@C.AudioUsage
public final int usage

The C.AudioUsage.

Public methods

equals

public boolean equals(@Nullable Object obj)

fromBundle

@UnstableApi
public static AudioAttributes fromBundle(Bundle bundle)

Restores a AudioAttributes from a Bundle.

fromPlatformAudioAttributes

public static AudioAttributes fromPlatformAudioAttributes(AudioAttributes audioAttributes)

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

getAudioAttributesV21

public AudioAttributes.AudioAttributesV21 getAudioAttributesV21()

getPlatformAudioAttributes

public AudioAttributes getPlatformAudioAttributes()

Returns a android.media.AudioAttributes from this instance.

Some fields are ignored if the corresponding android.media.AudioAttributes.Builder setter is not available on the current API level.

getStreamType

@UnstableApi
@C.StreamType
public int getStreamType()

Returns the C.StreamType corresponding to these audio attributes.

hashCode

public int hashCode()

toBundle

@UnstableApi
public Bundle toBundle()