Android APIs
public abstract class

VolumeProviderCompat

extends Object
java.lang.Object
   ↳ android.support.v4.media.VolumeProviderCompat

Class Overview

Handles requests to adjust or set the volume on a session. This is also used to push volume updates back to the session after a request has been handled. You can set a volume provider on a session by calling setPlaybackToRemote(VolumeProviderCompat).

Summary

Nested Classes
class VolumeProviderCompat.Callback Listens for changes to the volume. 
Constants
int VOLUME_CONTROL_ABSOLUTE The volume control uses an absolute value.
int VOLUME_CONTROL_FIXED The volume is fixed and can not be modified.
int VOLUME_CONTROL_RELATIVE The volume control uses relative adjustment via onAdjustVolume(int).
Public Constructors
VolumeProviderCompat(int volumeControl, int maxVolume, int currentVolume)
Create a new volume provider for handling volume events.
Public Methods
final int getCurrentVolume()
Get the current volume of the provider.
final int getMaxVolume()
Get the maximum volume this provider allows.
final int getVolumeControl()
Get the volume control type that this volume provider uses.
Object getVolumeProvider()
Gets the underlying framework VolumeProvider object.
void onAdjustVolume(int direction)
Override to handle requests to adjust the volume of the current output.
void onSetVolumeTo(int volume)
Override to handle requests to set the volume of the current output.
void setCallback(VolumeProviderCompat.Callback callback)
Sets a callback to receive volume changes.
final void setCurrentVolume(int currentVolume)
Set the current volume and notify the system that the volume has been changed.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int VOLUME_CONTROL_ABSOLUTE

The volume control uses an absolute value. It may be adjusted using onAdjustVolume(int) or set directly using onSetVolumeTo(int).

Constant Value: 2 (0x00000002)

public static final int VOLUME_CONTROL_FIXED

The volume is fixed and can not be modified. Requests to change volume should be ignored.

Constant Value: 0 (0x00000000)

public static final int VOLUME_CONTROL_RELATIVE

The volume control uses relative adjustment via onAdjustVolume(int). Attempts to set the volume to a specific value should be ignored.

Constant Value: 1 (0x00000001)

Public Constructors

public VolumeProviderCompat (int volumeControl, int maxVolume, int currentVolume)

Create a new volume provider for handling volume events. You must specify the type of volume control and the maximum volume that can be used.

Parameters
volumeControl The method for controlling volume that is used by this provider.
maxVolume The maximum allowed volume.
currentVolume The current volume.

Public Methods

public final int getCurrentVolume ()

Get the current volume of the provider.

Returns
  • The current volume.

public final int getMaxVolume ()

Get the maximum volume this provider allows.

Returns
  • The max allowed volume.

public final int getVolumeControl ()

Get the volume control type that this volume provider uses.

Returns
  • The volume control type for this volume provider

public Object getVolumeProvider ()

Gets the underlying framework VolumeProvider object.

This method is only supported on API 21+.

Returns

public void onAdjustVolume (int direction)

Override to handle requests to adjust the volume of the current output.

Parameters
direction The direction to adjust the volume in.

public void onSetVolumeTo (int volume)

Override to handle requests to set the volume of the current output.

Parameters
volume The volume to set the output to.

public void setCallback (VolumeProviderCompat.Callback callback)

Sets a callback to receive volume changes.

Used internally by the support library.

public final void setCurrentVolume (int currentVolume)

Set the current volume and notify the system that the volume has been changed.

Parameters
currentVolume The current volume of the output.