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

AudioPool

class AudioPool(startPool: List<AudioWrapper>)

Represents a pool of audio tracks that can be managed together.

Parameters

pool

The list of AudioWrapper instances in the pool.

Constructors

constructor(startPool: List<AudioWrapper>)

Types

object Companion

Properties

val pool: MutableList<AudioWrapper>

Functions

fun changeBalance(balance: Float)

Changes the balance of all audio tracks in the pool by the specified amount.

changeMasterVolume

fun changeMasterVolume(volume: Float)

Changes the master volume of all audio tracks in the pool by the specified amount.

Destroys the audio pool by closing all audio clips.

fun getAudioTrack(id: String): AudioWrapper?

Gets the audio track with the specified ID.

fun getBalance(): Float?

Gets the balance of the first audio track in the pool.

getBalanceRange

fun getBalanceRange(): Pair<Float, Float>?

Gets the balance range (min and max) of the first audio track in the pool.

getMasterVolume

fun getMasterVolume(): Float?

Gets the master volume of the first audio track in the pool.

getMasterVolumeRange

fun getMasterVolumeRange(): Pair<Float, Float>?

Gets the master volume range (min and max) of the first audio track in the pool.

getPlayingAudios

fun getPlayingAudios(): List<String>

Retrieves the IDs of all currently playing audio tracks in the pool.

fun isPlaying(id: String): Boolean

Checks if the audio track with the specified ID is currently playing.

fun isPoolMuted(): Boolean

Checks if all audio tracks in the pool are muted.

fun isPoolStopped(): Boolean

Checks if all audio tracks in the pool are stopped.

fun merge(other: AudioPool)

Merges this AudioPool with another AudioPool. New audio tracks from the other pool are added to this pool. Duplicate audio tracks (by ID) from the new pool are not added. Tracks from this pool take precedence in case of ID conflicts. Old tracks that do not exist in the other pool are destroyed and removed from this pool.

fun mute(mute: Boolean)

Mutes or unmutes all audio tracks in the pool.

fun pause(id: String)

Pauses the audio track with the specified ID.

Pauses all audio tracks in the pool.

fun play(id: String)

Plays the audio track with the specified ID.

Plays all audio tracks in the pool.

fun resetBalance()

Resets the balance of all audio tracks in the pool to the default value.

resetMasterVolume

fun resetMasterVolume()

Resets the master volume of all audio tracks in the pool to the default value.

fun setBalance(balance: Float)

Sets the balance of all audio tracks in the pool to the specified value.

setMasterVolume

fun setMasterVolume(volume: Float)

Sets the master volume of all audio tracks in the pool to the specified value.

fun stop(id: String)

Stops the audio track with the specified ID.

Stops all audio tracks in the pool.

whileNotFinished

fun whileNotFinished(func: () -> Unit = {})

Executes a function while any audio track in the pool is still playing.

fun whileNotFinished(id: String, func: () -> Unit = {})

Executes a function while the audio track with the specified ID is still playing.

whileNotFinishedAsync

suspend fun whileNotFinishedAsync(func: suspend () -> Unit)

Executes a suspend function while any audio track in the pool is still playing.

suspend fun whileNotFinishedAsync(id: String, func: suspend () -> Unit)

Executes a suspend function while the audio track with the specified ID is still playing.