SoundProfile

ERROR_DUPLICATE

static val ERROR_DUPLICATE: Int

Error code for creating a profile with existing profile type and name.

Value: 2

ERROR_INVALID_ARGUMENT

static val ERROR_INVALID_ARGUMENT: Int

Error code for invalid argument.

Value: 3

ERROR_NOT_ALLOWLISTED

static val ERROR_NOT_ALLOWLISTED: Int

Error code for the case when an operation requires an allowlist but the caller is not in the list.

Value: 4

ERROR_NO_PERMISSION

static val ERROR_NO_PERMISSION: Int

Error code for missing necessary permission to handle the profiles.

Value: 1

ERROR_UNKNOWN

static val ERROR_UNKNOWN: Int

Error code for unknown errors.

Value: 0

NAME_DEFAULT

static val NAME_DEFAULT: String

Name for the default sound profile.

This profile represents the system's baseline configuration and is used when no specific profile is selected.

Value: "default"

NAME_MOVIE

static val NAME_MOVIE: String

Name for the movie sound profile.

This profile is typically optimized for cinematic content, often enhancing surround sound effects and dialogue clarity.

Value: "movie"

NAME_MUSIC

static val NAME_MUSIC: String

Name for the music sound profile.

This profile is typically optimized for music playback, prioritizing audio fidelity and instrumental balance.

Value: "music"

NAME_NEWS

static val NAME_NEWS: String

Name for the news sound profile.

This profile is typically optimized for news broadcasts, prioritizing speech intelligibility and vocal clarity.

Value: "news"

NAME_SPORTS

static val NAME_SPORTS: String

Name for the sports sound profile.

This profile is typically optimized for sporting events, emphasizing commentary and crowd atmosphere.

Value: "sports"

NAME_STANDARD

static val NAME_STANDARD: String

Name for the standard sound profile.

This profile is typically optimized for general listening conditions and standard content types.

Value: "standard"

NAME_USER

static val NAME_USER: String

Name for the user-defined sound profile.

This profile represents custom settings configured by the user.

Value: "user"

NAME_VIVID

static val NAME_VIVID: String

Name for the vivid sound profile.

This profile typically emphasizes sound dynamics and distinct characteristics to create a more exciting audio experience.

Value: "vivid"

TYPE_APPLICATION

static val TYPE_APPLICATION: Int

Application profile type.

A profile of application type is managed by the package returned by getPackageName().

Value: 2

TYPE_SYSTEM

static val TYPE_SYSTEM: Int

System profile type.

A profile of system type is managed by the system, and readable to the package returned by getPackageName().

Value: 1

describeContents

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

getInputId

fun getInputId(): String?

Gets the input ID if the profile is for a TV input.

getName

fun getName(): String

Gets the profile name.

getPackageName

fun getPackageName(): String?

Gets the package name of this profile.

The package name defines the user of a profile. Only this specific package and system app can access to this profile.

getParameters

fun getParameters(): PersistableBundle

Gets the parameters of this profile.

The keys of commonly used parameters can be found in MediaQualityContract.SoundQuality.

getProfileId

fun getProfileId(): String?

Gets profile ID.

A profile ID is a globally unique ID generated and assigned by the system. For profile objects retrieved from system (e.g MediaQualityManager.getAvailableSoundProfiles) this profile ID is non-null; For profiles built locally with Builder, it's null.

getProfileType

fun getProfileType(): Int

Gets profile type.

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<SoundProfile!>