ktvn/com.github.benpollarduk.ktvn.audio/VolumeManager

VolumeManager

class VolumeManager

Provides a class for managing volumes.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun calculateMusicVolume(): Double

Calculate music volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun calculateSoundEffectVolume(): Double

Calculate sound effect volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun calculateVoiceVolume(character: Character?): Double

Calculate voice volume for a specified character. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun configure(configuration: VolumeManagerConfiguration)

Configure this volume manager from a configuration.

Link copied to clipboard
fun getCharacterVoiceVolume(character: Character): Double

Get the character voice volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun getMasterVolume(): Double

Get the master volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun getMusicVolume(): Double

Get the music volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun getOtherVoiceVolume(): Double

Get the other voice volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun getSoundEffectVolume(): Double

Get the sound effect volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun getVoiceVolume(): Double

Get the global voice volume. The volume is returned using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun setCharacterVoiceVolume(character: Character, volume: Double)

Set a character voice volume to the specified volume. The volume is specified using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun setMasterVolume(volume: Double)

Set the master volume to the specified volume. The volume is specified using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun setMusicVolume(volume: Double)

Set the music volume to the specified volume. The volume is specified using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun setOtherVoiceVolume(volume: Double)

Set the other voice volume to the specified volume. The volume is specified using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun setSoundEffectVolume(volume: Double)

Set the sound effect volume to the specified volume. The volume is specified using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun setVoiceVolume(volume: Double)

Set the global voice volume to the specified volume. The volume is specified using a normalised value between 0.0 (silence) and 1.0 (no attenuation).

Link copied to clipboard
fun toConfiguration(): VolumeManagerConfiguration

Create a VolumeManagerConfiguration from this volume manager.