ktvn/com.github.benpollarduk.ktvn.audio

Package-level declarations

Types

fun interface AudioListener

Provides an interface for listeners to audio events.

FileSoundEffect

data class FileSoundEffect(var path: String) : SoundEffect

A sound effect from a file at a specified path.

data class FileTrack(var path: String, val loop: Boolean = true) : Track

A track from a file at a specified path. When loop is set true the track should be looped on playback.

class NoAudio : Track

No audio.

ResourceSoundEffect

data class ResourceSoundEffect(var key: String) : SoundEffect

A sound effect from a resource, identified by a key.

data class ResourceTrack(var key: String, val loop: Boolean = true) : Track

A track from a resource, identified by a key. When loop is set true the track should be looped on playback.

interface SoundEffect

Provides an interface for sound effects.

SoundEffectPlayer

class SoundEffectPlayer(adapter: AudioAdapter)

Provides a class for playing sound effects. An adapter must be specified.

SoundPlaybackResult

data class SoundPlaybackResult(val wasSuccessful: Boolean, val detail: String)

Provides a result for sound playback. Success can be indicated with wasSuccessful and any additional detail specified with detail.

class SoundPlayer

Provides a simple class for playing sounds.

interface Track

Provides an interface for audio tracks.

class VolumeManager

Provides a class for managing volumes.

VolumeManagerConfiguration

data class VolumeManagerConfiguration(var masterVolume: Double, var musicVolume: Double, var soundEffectVolume: Double, var voiceVolume: Double, var characterVoiceVolumes: Map<String, Double>, var otherVoiceVolume: Double)

Provides a configuration for a VolumeManager.