MediaControllerCompat.PlaybackInfo

public static final class MediaControllerCompat.PlaybackInfo
extends Object

java.lang.Object
   ↳ android.support.v4.media.session.MediaControllerCompat.PlaybackInfo


Holds information about the way volume 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.

Public methods

AudioAttributesCompat getAudioAttributes()

Get the audio attributes for this session.

int getAudioStream()

This method is deprecated. Use getAudioAttributes() instead.

int getCurrentVolume()

Gets the current volume for this session.

int getMaxVolume()

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

int getPlaybackType()

Gets the type of volume handling, either local or remote.

int getVolumeControl()

Gets the type of volume control that can be used.

Inherited methods

Constants

PLAYBACK_TYPE_LOCAL

public static final int PLAYBACK_TYPE_LOCAL

The session uses local playback.

Constant Value: 1 (0x00000001)

PLAYBACK_TYPE_REMOTE

public static final int PLAYBACK_TYPE_REMOTE

The session uses remote playback.

Constant Value: 2 (0x00000002)

Public methods

getAudioAttributes

public AudioAttributesCompat getAudioAttributes ()

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

Returns
AudioAttributesCompat The attributes for this session.

getAudioStream

public int getAudioStream ()

This method is deprecated.
Use getAudioAttributes() instead.

Gets the stream this is currently controlling volume on. When the volume type is PLAYBACK_TYPE_REMOTE this value does not have meaning and should be ignored.

Returns
int The stream this session is playing on.

getCurrentVolume

public int getCurrentVolume ()

Gets the current volume for this session.

Returns
int The current volume where this session is playing.

getMaxVolume

public int getMaxVolume ()

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

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

getPlaybackType

public int getPlaybackType ()

Gets the type of volume handling, either local or remote. One of:

Returns
int The type of volume handling this session is using.

getVolumeControl

public int getVolumeControl ()

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