MusicController

class MusicController

Play, choose, fade-in/out and generally manage music track playback.

Main methods: chooseTrack, pause, resume, setModList, isPlaying, gracefulShutdown

Constructors

MusicController

fun MusicController()

Types

Companion

object Companion

ControllerState

private enum ControllerState : Enum<MusicController.ControllerState>

Functions

chooseFile

private fun chooseFile(prefix: String, suffix: String, flags: EnumSet<MusicTrackChooserFlags>): FileHandle?

Choose adequate entry from getAllMusicFiles

chooseTrack

fun chooseTrack(prefix: String = "", suffix: String = "Ambient", flags: EnumSet<MusicTrackChooserFlags> = EnumSet.noneOf(MusicTrackChooserFlags::class.java)): Boolean

Chooses and plays a music track using an adaptable approach - for details see the wiki. Called without parameters it will choose a new ambient music track and start playing it with fade-in/out. Will do nothing when no music files exist or the master volume is zero.

fun chooseTrack(prefix: String = "", suffixes: List<String>, flags: EnumSet<MusicTrackChooserFlags> = EnumSet.noneOf(MusicTrackChooserFlags::class.java)): Boolean

Variant of chooseTrack that tries several moods (suffixes) until a match is chosen

clearCurrent

private fun clearCurrent()

currentlyPlaying

private fun currentlyPlaying(): String

downloadDefaultFile

fun downloadDefaultFile()

equals

open operator fun equals(other: Any?): Boolean

fadeoutToSilence

fun fadeoutToSilence(duration: Float = 4.0f)

Fade out then shutdown with a given duration in seconds

fireOnChange

private fun fireOnChange()

private fun fireOnChange(trackLabel: String)

getAllMusicFiles

private fun getAllMusicFiles(): Sequence<FileHandle>

Get sequence of all existing music files

getMusicFolders

private fun getMusicFolders(): Sequence<FileHandle>

Get sequence of potential music locations

gracefulShutdown

fun gracefulShutdown()

Soft shutdown of music playback, with fadeout

hashCode

open fun hashCode(): Int

isMusicAvailable

fun isMusicAvailable(): Boolean

Determines whether any music tracks are available for the options menu

isPlaying

fun isPlaying(): Boolean

musicTimerTask

private fun musicTimerTask()

onChange

fun onChange(listener: (String) -> Unit?)

Registers a callback that will be called with the new track name every time it changes. The track name will be prettified ("Modname: Track" instead of "mods/Modname/music/Track.ogg").

pause

fun pause(speedFactor: Float = 1f)

Pause playback with fade-out

resume

fun resume(speedFactor: Float = 1f)

Resume playback with fade-in - from a pause will resume where playback left off, otherwise it will start a new ambient track choice.

setModList

fun setModList(newMods: HashSet<String>)

This tells the music controller about active mods - all are allowed to provide tracks

setVolume

fun setVolume(volume: Float)

Update playback volume, to be called from options popup