Added in API level 21

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

MediaController.PlaybackInfo

Kotlin |Java

public static final class MediaController.PlaybackInfo
extends Object implements Parcelable

java.lang.Object
↳	android.media.session.MediaController.PlaybackInfo

Holds information about the current playback and how audio is handled for this session.

Summary

Constants
`int`	`PLAYBACK_TYPE_LOCAL` The session uses local playback.
`int`	`PLAYBACK_TYPE_REMOTE` The session uses remote playback.

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<MediaController.PlaybackInfo>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`AudioAttributes`	`getAudioAttributes()` Get the audio attributes for this session.
`int`	`getCurrentVolume()` Get the current volume for this session.
`int`	`getMaxVolume()` Get the maximum volume that may be set for this session.
`int`	`getPlaybackType()` Get the type of playback which affects volume handling.
`int`	`getVolumeControl()` Get the type of volume control that can be used.
`String`	`getVolumeControlId()` Gets the volume control ID for this session.
`String`	`toString()` Returns a string representation of the object.
`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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

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

PLAYBACK_TYPE_LOCAL

Added in API level 21

public static final int PLAYBACK_TYPE_LOCAL

The session uses local playback.

Constant Value: 1 (0x00000001)

PLAYBACK_TYPE_REMOTE

Added in API level 21

public static final int PLAYBACK_TYPE_REMOTE

The session uses remote playback.

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 29

public static final Creator<MediaController.PlaybackInfo> CREATOR

Public methods

describeContents

Added in API level 29

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`

getAudioAttributes

Added in API level 21

public AudioAttributes getAudioAttributes ()

Get the audio attributes for this session. The attributes will affect volume handling for the session. When the volume type is PlaybackInfo#PLAYBACK_TYPE_REMOTE these may be ignored by the remote volume handler.

Returns
`AudioAttributes`	The attributes for this session.

getCurrentVolume

Added in API level 21

public int getCurrentVolume ()

Get the current volume for this session.

Returns
`int`	The current volume where this session is playing.

getMaxVolume

Added in API level 21

public int getMaxVolume ()

Get the maximum volume that may be set for this session.

Returns
`int`	The maximum allowed volume where this session is playing.

getPlaybackType

Added in API level 21

public int getPlaybackType ()

Get the type of playback which affects volume handling. One of:

Returns
`int`	The type of playback this session is using.

getVolumeControl

Added in API level 21

public int getVolumeControl ()

Get the type of volume control that can be used. One of:

Returns
`int`	The type of volume control that may be used with this session.

getVolumeControlId

Added in API level 30

public String getVolumeControlId ()

Gets the volume control ID for this session. It can be used to identify which volume provider is used by the session.

When the session starts to use remote volume handling, a volume provider should be set and it may set the volume control ID of the provider if the session wants to inform which volume provider is used. It can be null if the session didn't set the volume control ID or it uses local playback.

Returns
`String`	the volume control ID for this session or `null` if it uses local playback or not set.

See also:

VolumeProvider.getVolumeControlId()

toString

Added in API level 21

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 29

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.
`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