reversi-utils/pt.isel.reversi.utils.audio/AudioModifier

AudioModifier

data class AudioModifier(val closeOnFinish: Boolean = false, val gotoStartOnStop: Boolean = true, val startPosition: Int? = null, val loop: Boolean = false, val loopStartPosition: Int? = null, val loopEndPosition: Int? = null)

Modifier for audio playback behavior.

Constructors

constructor(closeOnFinish: Boolean = false, gotoStartOnStop: Boolean = true, startPosition: Int? = null, loop: Boolean = false, loopStartPosition: Int? = null, loopEndPosition: Int? = null)

Properties

val closeOnFinish: Boolean

If true, the audio resource will be released when playback finishes.

gotoStartOnStop

val gotoStartOnStop: Boolean

If true, the audio playback position will reset to the start when stopped.

val loop: Boolean

If true, the audio will loop continuously.

loopEndPosition

val loopEndPosition: Int?

The position (in frames) to end looping at. If null, loops until the end of the audio.

loopStartPosition

val loopStartPosition: Int?

The position (in frames) to start looping from. If null, loops from the beginning.

val startPosition: Int?

The position (in frames) to start playback from. If null, starts from the beginning.

Functions

setStartPosition

fun setStartPosition(position: Int): AudioModifier

Creates a copy of this AudioModifier with the specified start position.

setToCloseOnFinish

fun setToCloseOnFinish(): AudioModifier

Creates a copy of this AudioModifier with closeOnFinish set to true.

fun setToLoop(startPosition: Int? = null, endPosition: Int? = null): AudioModifier

Creates a copy of this AudioModifier configured for looping playback.

setToLoopInfinitely

fun setToLoopInfinitely(): AudioModifier

Creates a copy of this AudioModifier configured for infinite looping playback.

setToNotGoToStartOnStop

fun setToNotGoToStartOnStop(): AudioModifier

Creates a copy of this AudioModifier with gotoStartOnStop set to false.