deki-audio 1.3.0
Deki package reference
deki-audio

Audio playback peripheral interface with MAX98357 (I²S) backend

Repository: github.com/dekiengine/deki-audio · Latest release: 1.1.0 · Needs engine 1.2.0+ · Requires: deki-i2s

Install: DekiEditor --packages-add deki-audio <project>, or add it in the Package Manager. Part of Deki; the engine's own components and the C++ API are documented there.

Shown in the editor as Audio (Speaker / PCM playback).

Components

Component Category Description
MAX98357AudioComponent Sensors Plays sound through a MAX98357A I2S amplifier.

Feature flags

Compile-time features the package exposes (package.json):

Feature Define Default
MAX98357A (I²S class-D mono amp, 16-bit PCM) DEKI_FEATURE_AUDIO_MAX98357 on

Component reference

MAX98357AudioComponent

Plays sound through a MAX98357A I2S amplifier.

Inspector name: MAX98357A Audio · Category: Sensors · Type GUID: 4d8c9f12-2a7b-4e35-a869-5b1f3e7c4d82

Property Type Default Constraints Description
i2sPort int32 0 0 to 1
bclkPin int32 39 0 to 48
lrclkPin int32 40 0 to 48
dinPin int32 5 0 to 48
sampleRate int32 16000 8000 to 48000
channels int32 1 1 to 2
initialVolume int32 80 0 to 100

Generated from the package's reflection metadata by the Deki documentation build (engine 1.3.0). Reflected property names are the keys scene files use; a rename ships with an alias, see COMPATIBILITY.md.