universal-volume/com.navideck.universal_volume/UniversalVolume

UniversalVolume

class UniversalVolume

UniversalVolume is a singleton class that manages media volume. It supports popular and also exotic Android devices that may use non-standard volume APIs. UniversalVolume manages media volume AudioManager.STREAM_MUSIC only. Make sure to call initialize function before using any other function. Use UniversalVolume.instance to access the singleton instance and call any methods on it.

See also

UniversalVolume.initialize

UniversalVolume.Companion.instance

Constructors

UniversalVolume

constructor()

Types

object Companion

Properties

val maxVolume: Int?

Returns the maximum volume as an integer.

val minVolume: Int?

Returns the minimum volume as an integer.

val volume: Int?

Returns the current volume as an integer between 0 and maxVolume. The maxVolume depends on each device.

volumeInPercentage

val volumeInPercentage: Double

Returns the current volume as a double between 0 and 1. The range is the same for all devices.

Functions

addVolumeChangeListener

fun addVolumeChangeListener(listener: VolumeChangeListener)

Adds a listener to the list of volume change listeners.

Disposes the UniversalVolume instance.

fun initialize(context: Context)

Initializes the UniversalVolume instance with the given context.

removeVolumeChangeListener

fun removeVolumeChangeListener(listener: VolumeChangeListener)

Removes a listener from the list of volume change listeners.

fun setVolume(volume: Int, showVolumeBar: Boolean = false): Boolean

Sets the volume to the given volume value. If showVolumeBar is true, shows the volume bar.

setVolumeToPercentage

fun setVolumeToPercentage(percentage: Double, showVolumeBar: Boolean = false): Boolean

Sets the volume to the given percentage value. If showVolumeBar is true, shows the volume bar.