0.2.6-SNAPSHOT

basic-sound/app.lexilabs.basic.sound

Package-level declarations

Types

actual class Audio : AudioBuilder

Play audio from a url (String).

actual class Audio

Play audio from a url (String).

expect class Audio

Play audio from a url (String).

actual class Audio : AudioBuilder

actual class Audio : AudioBuilder

actual class Audio : AudioBuilder

interface AudioBuilder

A common interface to enable multiplatform audio.

actual class ~~AudioByte~~ : AudioByteBuilder

actual class ~~AudioByte~~

expect class ~~AudioByte~~ : AudioByteBuilder

Play audio from a local file path or a Compose Resource (String).

actual class ~~AudioByte~~ : AudioByteBuilder

actual class ~~AudioByte~~ : AudioByteBuilder

actual class ~~AudioByte~~ : AudioByteBuilder

AudioByteBuilder

interface ~~AudioByteBuilder~~

sealed class AudioState

ExperimentalBasicSound

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalBasicSound

This API is not considered 'production' until reaching version 1.0.0 or higher

typealias MixerChannel = Channel<String>

A version of Channel used to play sounds on a SoundBoard

actual class SoundBoard(context: Any?) : SoundBoardBuilder

actual class SoundBoard(context: Any?)

expect class SoundBoard(context: Any?) : SoundBoardBuilder

Creates a standard SoundBoard format to replicate across all platforms

actual class SoundBoard(context: Any?) : SoundBoardBuilder

actual class SoundBoard(context: Any?) : SoundBoardBuilder

actual class SoundBoard(context: Any?) : SoundBoardBuilder

SoundBoardBuilder

interface SoundBoardBuilder

Creates a standard SoundBoard format to replicate across all platforms

class SoundByte(val name: String, val localPath: String)

Used to associate a name with a file resource in preparation for SoundBoard

Functions

fun MixerChannel.play(sound: SoundByte)

fun MixerChannel.play(soundName: String)

Used to play a SoundByte on a SoundBoard, but requires a SoundBoard.powerUp first