Common

AudioApi

top.katton.api.audiocommon/src/main/kotlin/top/katton/api/audio/AudioApi.kt

Audio bytes are resolved on the client.

Members

Jump directly to declarations on this page.

• AudioSourceData Class
• AudioOptionsData Class
• AudioSnapshotData Class
• AudioHandleInterface
• AudioClientProviderObject
• playClientAudioFunction

AudioSource

AudioSourceCommonData Class

@ConsistentCopyVisibility
data class AudioSource internal constructor(val kind: Kind, val path: String, val packId: String

Audio bytes are resolved on the client.

AudioOptions

AudioOptionsCommonData Class

data class AudioOptions( val volume: Float

Spatial audio is mono; null position/target means stereo background audio.

AudioSnapshot

AudioSnapshotCommonData Class

data class AudioSnapshot(val state: AudioState, val position: Duration, val duration: Duration?, val playbackRate: Float, val volume: Float, val loop: Boolean, val error: String?

Position and duration use original media time, independent of speed.

AudioHandle

AudioHandleCommonInterface

interface AudioHandle : AutoCloseable

Rate changes also change pitch. Commands complete when applied, not when playback ends.

AudioClientProvider

AudioClientProviderCommonObject

object AudioClientProvider

Physical-client implementation installed by the loader; safe to load on dedicated servers.

playClientAudio

playClientAudioCommonFunction

fun playClientAudio(source: AudioSource, options: AudioOptions = AudioOptions()): AudioHandle

Play through the installed Katton client.