reversi-utils/pt.isel.reversi.utils.audio.controls/FloatControlWrapper

FloatControlWrapper

abstract class FloatControlWrapper(clip: Clip, controlType: FloatControl.Type)

A wrapper class for managing FloatControl types in audio Clips.

Parameters

clip

The Clip containing the control.

controlType

The type of FloatControl to wrap.

Throws

IllegalArgumentException

if the specified control type is not supported by the Clip.

ClassCastException

if the control retrieved is not a FloatControl.

Inheritors

MasterVolumeControl

PanControl

BalanceControl

Constructors

FloatControlWrapper

constructor(clip: Clip, controlType: FloatControl.Type)

Creates a FloatControlWrapper for the specified control type.

Types

BalanceControl

class BalanceControl(clip: Clip) : FloatControlWrapper

MasterVolumeControl

class MasterVolumeControl(clip: Clip) : FloatControlWrapper

PanControl

class PanControl(clip: Clip) : FloatControlWrapper

Properties

control

protected val control: FloatControl

defaultValue

val defaultValue: Float

maximumValue

val maximumValue: Float

minimumValue

val minimumValue: Float

Functions

addValue

fun addValue(delta: Float)

Adds a delta to the current value of the control.

getValue

fun getValue(): Float

Retrieves the current value of the control.

resetValue

fun resetValue()

Resets the control to its default value.

updateValue

fun updateValue(value: Float)

Updates the value of the control.