MediaController.PlaybackInfo

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

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 volume control type associated to the session, as indicated by VolumeProvider.getVolumeControl().

String getVolumeControlId()

Get the routing controller ID for this session, as indicated by VolumeProvider.getVolumeControlId().

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

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 playback 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 volume control type associated to the session, as indicated by VolumeProvider.getVolumeControl().

Returns
int

getVolumeControlId

Added in API level 30
public String getVolumeControlId ()

Get the routing controller ID for this session, as indicated by VolumeProvider.getVolumeControlId(). Returns null if unset, or if getPlaybackType() is PLAYBACK_TYPE_LOCAL.

Returns
String

toString

Added in API level 21
public String toString ()

Returns a string representation of the object.

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