Added in API level 36

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

SoundProfile

---

Kotlin |Java

public final class SoundProfile
extends Object implements Parcelable

java.lang.Object
↳	android.media.quality.SoundProfile

---

Profile for sound quality.

Summary

Nested classes
class	SoundProfile.Builder A builder for SoundProfile

Constants
int	ERROR_DUPLICATE Error code for creating a profile with existing profile type and name.
int	ERROR_INVALID_ARGUMENT Error code for invalid argument.
int	ERROR_NOT_ALLOWLISTED Error code for the case when an operation requires an allowlist but the caller is not in the list.
int	ERROR_NO_PERMISSION Error code for missing necessary permission to handle the profiles.
int	ERROR_UNKNOWN Error code for unknown errors.
int	TYPE_APPLICATION Application profile type.
int	TYPE_SYSTEM System profile type.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<SoundProfile>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
String	getInputId() Gets the input ID if the profile is for a TV input.
String	getName() Gets the profile name.
String	getPackageName() Gets the package name of this profile.
PersistableBundle	getParameters() Gets the parameters of this profile.
String	getProfileId() Gets profile ID.
int	getProfileType() Gets profile type.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

ERROR_DUPLICATE

Added in API level 36

public static final int ERROR_DUPLICATE

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

See also:

• getProfileType()
• getName()

Constant Value: 2 (0x00000002)

ERROR_INVALID_ARGUMENT

Added in API level 36

public static final int ERROR_INVALID_ARGUMENT

Error code for invalid argument.

Constant Value: 3 (0x00000003)

ERROR_NOT_ALLOWLISTED

Added in API level 36

public static final int ERROR_NOT_ALLOWLISTED

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

See also:

• ERROR(/android.media.quality.MediaQualityManager#getSoundProfileAllowList())

Constant Value: 4 (0x00000004)

ERROR_NO_PERMISSION

Added in API level 36

public static final int ERROR_NO_PERMISSION

Error code for missing necessary permission to handle the profiles.

Constant Value: 1 (0x00000001)

ERROR_UNKNOWN

Added in API level 36

public static final int ERROR_UNKNOWN

Error code for unknown errors.

Constant Value: 0 (0x00000000)

TYPE_APPLICATION

Added in API level 36

public static final int TYPE_APPLICATION

Application profile type.

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

Constant Value: 2 (0x00000002)

TYPE_SYSTEM

Added in API level 36

public static final int TYPE_SYSTEM

System profile type.

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

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 36

public static final Creator<SoundProfile> CREATOR

Public methods

describeContents

Added in API level 36

public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getInputId

Added in API level 36

public String getInputId ()

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

Returns
String	the corresponding TV input ID; null if the profile is not associated with a TV input.

See also:

• TvInputInfo.getId()

getName

Added in API level 36

public String getName ()

Gets the profile name.

Returns
String

getPackageName

Added in API level 36

public String getPackageName ()

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.

Returns
String	the package name; null if the profile is built locally using Builder and the package is not set.

getParameters

Added in API level 36

public PersistableBundle getParameters ()

Gets the parameters of this profile.

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

Returns
PersistableBundle	The profile parameters. Empty bundle if parameters are not included in a query.

getProfileId

Added in API level 36

public String getProfileId ()

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.

Returns
String	the unique profile ID; null if the profile is built locally with Builder.

getProfileType

Added in API level 36

public int getProfileType ()

Gets profile type.

Returns
int	Value is TYPE_SYSTEM, or TYPE_APPLICATION

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES