client/su.plo.voice.api.client.audio.source/ClientAudioSource

ClientAudioSource

interface ClientAudioSource<S : SourceInfo> : AudioSource<S>

Represents a client-side audio source used for playing audio.

Properties

Gets or sets the timeout duration in milliseconds for closing this audio source. If the source remains inactive for this duration, it will be automatically closed.

effectiveVolume

abstract val effectiveVolume: Float

The effective gain last applied to the underlying source, folding in master, source and line volumes, occlusion, directional and distance gain.

source

abstract val source: AlSource

Gets or sets the source group to which this audio source belongs.

sourceInfo

abstract val sourceInfo: S

sourceLine

abstract val sourceLine: ClientSourceLine

The source line this audio source is currently assigned to, resolved from SourceInfo.getLineId.

Functions

canHear

abstract fun canHear(): Boolean

Checks if the audio source can be heard, meaning it is within reach and activated.

abstract suspend fun close()

Closes the audio source.

closeAsync

abstract fun closeAsync(): CompletableFuture<Void?>

Closes the audio source asynchronously.

isActivated

abstract fun isActivated(): Boolean

Checks if the audio source is currently playing audio.

isClosed

abstract fun isClosed(): Boolean

Checks if the audio source is closed.

process

abstract fun process(packet: SourceAudioEndPacket)

Processes an audio end packet indicating the end of audio playback.

abstract fun process(packet: SourceAudioPacket)

Processes an incoming audio packet and plays the audio.

resetAsync

abstract fun resetAsync(cause: AudioSourceResetEvent.Cause): CompletableFuture<Void?>

Resets the audio source state asynchronously.

update

abstract fun update(sourceInfo: S)

Updates the audio source with new source information.

updateUnchecked

open fun updateUnchecked(sourceInfo: SourceInfo)

Updates the audio source with new source information, performing unchecked type casting.