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

AudioWrapper

data class AudioWrapper(val id: String, val clip: Clip, val modifier: AudioModifier = AudioModifier())

A wrapper for an audio Clip, providing methods to control playback and audio properties.

Throws

IllegalArgumentException

if the clip cannot be opened.

Constructors

AudioWrapper

constructor(id: String, clip: Clip, modifier: AudioModifier = AudioModifier())

Creates an AudioWrapper with the specified id, clip, and modifier.

Types

Companion

object Companion

Properties

balanceControl

val balanceControl: FloatControlWrapper.BalanceControl

clip

private val clip: Clip

The Clip object representing the audio data.

val id: String

The identifier for the audio clip.

loopEnd

private val loopEnd: Int

loopStart

private val loopStart: Int

masterGainControl

val masterGainControl: FloatControlWrapper.MasterVolumeControl

modifier

val modifier: AudioModifier

The AudioModifier containing playback settings.

muteControl

val muteControl: BooleanControlWrapper.MuteControl

Functions

fun close()

Closes the audio clip, releasing any system resources associated with it.

isLoaded

fun isLoaded(): Boolean

isPlaying

fun isPlaying(): Boolean

Checks if the audio clip is currently playing.

pause

fun pause()

Pauses playback of the audio clip.

play

fun play()

Starts playback of the audio clip. If the clip is set to loop, it will loop continuously.

stop

fun stop()

Stops playback of the audio clip. Depending on the modifier settings, it may reset to the start position or close the clip.

AudioWrapper

See also

Throws

Constructors

Types

Properties

Functions