diff --git a/libraries/common/src/main/java/androidx/media3/common/Player.java b/libraries/common/src/main/java/androidx/media3/common/Player.java index 793f30bbb5..3a631280ca 100644 --- a/libraries/common/src/main/java/androidx/media3/common/Player.java +++ b/libraries/common/src/main/java/androidx/media3/common/Player.java @@ -3319,6 +3319,9 @@ public interface Player { *
For devices with {@link DeviceInfo#PLAYBACK_TYPE_REMOTE remote playback}, the volume of the * remote device is returned. * + *
Note that this method returns the volume of the device. To check the current stream volume, + * use {@link getVolume()}. + * *
This method must only be called if {@link #COMMAND_GET_DEVICE_VOLUME} is {@linkplain * #getAvailableCommands() available}. */ @@ -3328,6 +3331,9 @@ public interface Player { /** * Gets whether the device is muted or not. * + *
Note that this method returns the mute state of the device. To check if the current stream + * is muted, use {@code getVolume() == 0}. + * *
This method must only be called if {@link #COMMAND_GET_DEVICE_VOLUME} is {@linkplain * #getAvailableCommands() available}. */ @@ -3342,6 +3348,9 @@ public interface Player { /** * Sets the volume of the device with volume flags. * + *
Note that this method affects the device volume. To change the volume of the current stream + * only, use {@link #setVolume}. + * *
This method must only be called if {@link #COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS} is * {@linkplain #getAvailableCommands() available}. * @@ -3362,6 +3371,9 @@ public interface Player { *
The {@link #getDeviceVolume()} device volume cannot be increased above {@link * DeviceInfo#maxVolume}, if defined. * + *
Note that this method affects the device volume. To change the volume of the current stream + * only, use {@link #setVolume}. + * *
This method must only be called if {@link #COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS} is * {@linkplain #getAvailableCommands() available}. * @@ -3381,6 +3393,9 @@ public interface Player { *
The {@link #getDeviceVolume()} device volume cannot be decreased below {@link * DeviceInfo#minVolume}. * + *
Note that this method affects the device volume. To change the volume of the current stream + * only, use {@link #setVolume}. + * *
This method must only be called if {@link #COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS} is * {@linkplain #getAvailableCommands() available}. * @@ -3397,6 +3412,9 @@ public interface Player { /** * Sets the mute state of the device. * + *
Note that this method affects the device volume. To mute just the current stream, use {@code + * setVolume(0)} instead. + * *
This method must only be called if {@link #COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS} is * {@linkplain #getAvailableCommands() available}. *