Android APIs
public abstract class

VolumeProvider

extends Object
java.lang.Object
   ↳ android.media.VolumeProvider

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. The provider must call setCurrentVolume(int) each time the volume being provided changes.

You can set a volume provider on a session by calling setPlaybackToRemote(VolumeProvider).

Summary

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
VolumeProvider(int volumeControl, int maxVolume, int currentVolume)
Create a new volume provider for handling volume events.
Public Methods
final int getCurrentVolume()
Gets the current volume.
final int getMaxVolume()
Get the maximum volume this provider allows.
final int getVolumeControl()
Get the volume control type that this volume provider uses.
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.
final void setCurrentVolume(int currentVolume)
Notify the system that the current volume has been changed.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int VOLUME_CONTROL_ABSOLUTE

Added in API level 21

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

Added in API level 21

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

Added in API level 21

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 VolumeProvider (int volumeControl, int maxVolume, int currentVolume)

Added in API level 21

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

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

Public Methods

public final int getCurrentVolume ()

Added in API level 21

Gets the current volume. This will be the last value set by setCurrentVolume(int).

Returns
  • The current volume.

public final int getMaxVolume ()

Added in API level 21

Get the maximum volume this provider allows.

Returns
  • The max allowed volume.

public final int getVolumeControl ()

Added in API level 21

Get the volume control type that this volume provider uses.

Returns
  • The volume control type for this volume provider

public void onAdjustVolume (int direction)

Added in API level 21

Override to handle requests to adjust the volume of the current output. Direction will be one of ADJUST_LOWER, ADJUST_RAISE, ADJUST_SAME. After the volume has been modified setCurrentVolume(int) must be called to notify the system.

Parameters
direction The direction to change the volume in.

public void onSetVolumeTo (int volume)

Added in API level 21

Override to handle requests to set the volume of the current output. After the volume has been modified setCurrentVolume(int) must be called to notify the system.

Parameters
volume The volume to set the output to.

public final void setCurrentVolume (int currentVolume)

Added in API level 21

Notify the system that the current volume has been changed. This must be called every time the volume changes to ensure it is displayed properly.

Parameters
currentVolume The current volume on the output.