client/su.plo.voice.api.client.config/ClientConfig/Voice/Volumes

Volumes

interface Volumes

Per-line volume and mute settings.

Each entry is keyed by a line name. Per-player volumes are stored under the "source_<playerId>" line name; the player* methods are shorthands that build this key for you, so e.g. getPlayerVolume is equivalent to getVolume("source_" + playerId).

Functions

abstract fun getMute(lineName: String): BooleanConfigEntry

Returns the mute entry for the given line, creating it with the default value if absent.

abstract fun getPlayerMute(playerId: UUID): BooleanConfigEntry

Returns the mute entry for the given player, creating it with the default value if absent.

getPlayerVolume

abstract fun getPlayerVolume(playerId: UUID): DoubleConfigEntry

Returns the volume entry for the given player, creating it with the default value if absent.

abstract fun getVolume(lineName: String): DoubleConfigEntry

Returns the volume entry for the given line, creating it with the default value if absent.

abstract fun hasVolume(lineName: String): Boolean

Returns true if a volume entry exists for the given line.

abstract fun setMute(lineName: String, muted: Boolean)

Mutes or unmutes the given line.

abstract fun setPlayerMute(playerId: UUID, muted: Boolean)

Mutes or unmutes the given player.

setPlayerVolume

abstract fun setPlayerVolume(playerId: UUID, volume: Double)

Sets the volume for the given player.

abstract fun setVolume(lineName: String, volume: Double)

Sets the volume for the given line.