RaylibAudio class

Inheritance

• Object
• RaylibModule<Raylib>
• RaylibModuleWasm
• RaylibAudio

Constructors

RaylibAudio(Raylib rl)

Properties

$ → RaylibTemp<RaylibBase>

See RaylibTemp.

no setter, inherited

AttachAudioMixedProcessor ↔ WF1<void>

Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'

late, final

AttachAudioStreamProcessor ↔ WF2<void>

Attach audio stream processor to stream, receives the samples as 'float'

late, final

CloseAudioDevice ↔ WF0<void>

Close the audio device and context

late, final

DetachAudioMixedProcessor ↔ WF1<void>

Detach audio stream processor from the entire audio pipeline

late, final

DetachAudioStreamProcessor ↔ WF2<void>

Detach audio stream processor from stream

late, final

ExportWave ↔ WF2<bool>

Export wave data to file, returns true on success

late, final

ExportWaveAsCode ↔ WF2<bool>

Export wave sample data to code (.h), returns true on success

late, final

GetMasterVolume ↔ WF0<double>

Get master volume (listener)

late, final

GetMusicTimeLength ↔ WF1<double>

Get music time length (in seconds)

late, final

GetMusicTimePlayed ↔ WF1<double>

Get current music time played (in seconds)

late, final

hashCode → int

The hash code for this object.

no setter, inherited

InitAudioDevice ↔ WF0<void>

Initialize audio device and context

late, final

IsAudioDeviceReady ↔ WF0<bool>

Check if audio device has been initialized successfully

late, final

IsAudioStreamPlaying ↔ WF1<bool>

Check if audio stream is playing

late, final

IsAudioStreamProcessed ↔ WF1<bool>

Check if any audio stream buffers requires refill

late, final

IsAudioStreamValid ↔ WF1<bool>

Checks if an audio stream is valid (buffers initialized)

late, final

IsMusicStreamPlaying ↔ WF1<bool>

Check if music is playing

late, final

IsMusicValid ↔ WF1<bool>

Checks if a music stream is valid (context and buffers initialized)

late, final

IsSoundPlaying ↔ WF1<bool>

Check if a sound is currently playing

late, final

IsSoundValid ↔ WF1<bool>

Checks if a sound is valid (data loaded and buffers initialized)

late, final

IsWaveValid ↔ WF1<bool>

Checks if wave data is valid (data loaded and parameters)

late, final

LoadAudioStream ↔ WF4<void>

Load audio stream (to stream raw audio pcm data)

late, final

LoadMusicStream ↔ WF2<void>

Load music stream from file

late, final

LoadMusicStreamFromMemory ↔ WF4<void>

Load music stream from data

late, final

LoadSound ↔ WF2<void>

Load sound from file

late, final

LoadSoundAlias ↔ WF2<void>

Create a new sound that shares the same sample data as the source sound, does not own the sound data

late, final

LoadSoundFromWave ↔ WF2<void>

Load sound from wave data

late, final

LoadWave ↔ WF2<void>

/ Load wave data from file

late, final

LoadWaveFromMemory ↔ WF4<void>

Load wave from memory buffer, fileType refers to extension: i.e. '.wav'

late, final

LoadWaveSamples ↔ WF1<WasmMemoryPointer<RFloat>>

Load samples data from wave as a 32bit float data array

late, final

PauseAudioStream ↔ WF1<void>

Pause audio stream

late, final

PauseMusicStream ↔ WF1<void>

Pause music playing

late, final

PauseSound ↔ WF1<void>

Pause a sound

late, final

PlayAudioStream ↔ WF1<void>

Play audio stream

late, final

PlayMusicStream ↔ WF1<void>

Start music playing

late, final

PlaySound ↔ WF1<void>

Play a sound

late, final

ResumeAudioStream ↔ WF1<void>

Resume audio stream

late, final

ResumeMusicStream ↔ WF1<void>

Resume playing paused music

late, final

ResumeSound ↔ WF1<void>

Resume a paused sound

late, final

rl → Raylib

final, inherited

rn → String

Emscripten cwrap return type for anything other than structs and void.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

rv → Null

Emscripten cwrap return type for functions returning void.

final, inherited

SeekMusicStream ↔ WF2<void>

Seek music to a position (in seconds)

late, final

SetAudioStreamBufferSizeDefault ↔ WF1<void>

Default size for new audio streams

late, final

SetAudioStreamCallback ↔ WF2<void>

Audio thread callback to request new data

late, final

SetAudioStreamPan ↔ WF2<void>

Set pan for audio stream (0.5 is centered)

late, final

SetAudioStreamPitch ↔ WF2<void>

Set pitch for audio stream (1.0 is base level)

late, final

SetAudioStreamVolume ↔ WF2<void>

Set volume for audio stream (1.0 is max level)

late, final

SetMasterVolume ↔ WF1<void>

Set master volume (listener)

late, final

SetMusicPan ↔ WF2<void>

Set pan for a music (0.5 is center)

late, final

SetMusicPitch ↔ WF2<void>

Set pitch for a music (1.0 is base level)

late, final

SetMusicVolume ↔ WF2<void>

Set volume for music (1.0 is max level)

late, final

SetSoundPan ↔ WF2<void>

Set pan for a sound (-1.0 left, 0.0 center, 1.0 right)

late, final

SetSoundPitch ↔ WF2<void>

Set pitch for a sound (1.0 is base level)

late, final

SetSoundVolume ↔ WF2<void>

Set volume for a sound (1.0 is max level)

late, final

StopAudioStream ↔ WF1<void>

Stop audio stream

late, final

StopMusicStream ↔ WF1<void>

Stop music playing

late, final

StopSound ↔ WF1<void>

Stop playing a sound

late, final

UnloadAudioStream ↔ WF1<void>

Unload audio stream and free memory

late, final

UnloadMusicStream ↔ WF1<void>

Unload music stream

late, final

UnloadSound ↔ WF1<void>

Unload sound

late, final

UnloadSoundAlias ↔ WF1<void>

Unload a sound alias (does not deallocate sample data)

late, final

UnloadWave ↔ WF1<void>

Unload wave data

late, final

UnloadWaveSamples ↔ WF1<void>

Unload samples data loaded with LoadWaveSamples()

late, final

UpdateAudioStream ↔ WF3<void>

Update audio stream buffers with data

late, final

UpdateMusicStream ↔ WF1<void>

Updates buffers for music streaming

late, final

UpdateSound ↔ WF3<void>

Update sound buffer with new data (default data format: 32 bit float, stereo)

late, final

WaveCopy ↔ WF2<void>

Copy a wave to a new wave

late, final

WaveCrop ↔ WF3<void>

Crop a wave to defined frames range

late, final

WaveFormat ↔ WF4<void>

Convert wave data to desired format

late, final

Methods

debug(bool v) → void

Enables or disables debug logging for this module.

inherited

debugError(String message) → void

Logs message at error level if debug is enabled and message passes all filters.

inherited

debugFilter(bool filter(String)) → void

Adds a predicate that gates debug output. Only messages satisfying at least one filter are logged.

inherited

debugInfo(String message) → void

Logs message at info level if debug is enabled and message passes all filters.

inherited

debugTime(bool v) → void

Enables or disables per-call timing output alongside debug logs.

inherited

debugWarn(String message) → void

Logs message at warn level if debug is enabled and message passes all filters.

inherited

disableSync<T>(T f()) → T

Executes f with RaylibTemp syncing temporarily disabled, restoring the previous sync state afterward.

inherited

dispose() → void

Calls all registered onDispose callbacks and clears them.

inherited

disposeStructWithOpFreed<D extends RaylibStruct<D>>(D struct, void fn(StructPointer<D> ptr)) → void

Disposes struct, invokes fn with its underlying pointer, and then frees the temporary allocation backing the pointer, if any.

inherited

disposeStructWithOpUnslotted<D extends RaylibStruct<D>>(D struct, void fn(StructPointer<D> ptr)) → void

Disposes struct, invokes fn with its underlying pointer, and then unslots the temporary allocation backing the pointer, if any.

inherited

dwrap0<R>(String name) → WF0<R>

Binds a cwraped C function taking 0 arguments and returning a plain (non-struct) value.

inherited

dwrap1<R>(String name) → WF1<R>

Binds a cwraped C function taking 1 argument and returning a plain (non-struct) value.

inherited

dwrap2<R>(String name) → WF2<R>

Binds a cwraped C function taking 2 arguments and returning a plain (non-struct) value.

inherited

dwrap3<R>(String name) → WF3<R>

Binds a cwraped C function taking 3 arguments and returning a plain (non-struct) value.

inherited

dwrap4<R>(String name) → WF4<R>

Binds a cwraped C function taking 4 arguments and returning a plain (non-struct) value.

inherited

dwrap5<R>(String name) → WF5<R>

Binds a cwraped C function taking 5 arguments and returning a plain (non-struct) value.

inherited

dwrap6<R>(String name) → WF6<R>

Binds a cwraped C function taking 6 arguments and returning a plain (non-struct) value.

inherited

dwrap7<R>(String name) → WF7<R>

Binds a cwraped C function taking 7 arguments and returning a plain (non-struct) value.

inherited

dwrap8<R>(String name) → WF8<R>

Binds a cwraped C function taking 8 arguments and returning a plain (non-struct) value.

inherited

dwrap9<R>(String name) → WF9<R>

Binds a cwraped C function taking 9 arguments and returning a plain (non-struct) value.

inherited

load() → void

Override to perform one-time module initialization.

inherited

logError(Object? message) → void

inherited

logInfo(Object? message) → void

inherited

logWarn(Object? message) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDispose(void fn()) → void

Registers fn to be called when this module is disposed.

inherited

pwrap0<X extends RType>(String name) → WF0<WasmMemoryPointer<X>>

Binds a cwraped C function taking 0 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap1<X extends RType>(String name) → WF1<WasmMemoryPointer<X>>

Binds a cwraped C function taking 1 argument and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap2<X extends RType>(String name) → WF2<WasmMemoryPointer<X>>

Binds a cwraped C function taking 2 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap3<X extends RType>(String name) → WF3<WasmMemoryPointer<X>>

Binds a cwraped C function taking 3 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap4<X extends RType>(String name) → WF4<WasmMemoryPointer<X>>

Binds a cwraped C function taking 4 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap5<X extends RType>(String name) → WF5<WasmMemoryPointer<X>>

Binds a cwraped C function taking 5 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap6<X extends RType>(String name) → WF6<WasmMemoryPointer<X>>

Binds a cwraped C function taking 6 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap7<X extends RType>(String name) → WF7<WasmMemoryPointer<X>>

Binds a cwraped C function taking 7 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap8<X extends RType>(String name) → WF8<WasmMemoryPointer<X>>

Binds a cwraped C function taking 8 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

pwrap9<X extends RType>(String name) → WF9<WasmMemoryPointer<X>>

Binds a cwraped C function taking 9 arguments and returning a pointer, wrapped as WasmMemoryPointer<X>.

inherited

qwrap0<X extends RaylibStruct<X>>(String name) → WF0<StructPointer<X>>

Binds a cwraped C function taking 0 arguments and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap1<X extends RaylibStruct<X>>(String name) → WF1<StructPointer<X>>

Binds a cwraped C function taking 1 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap2<X extends RaylibStruct<X>>(String name) → WF2<StructPointer<X>>

Binds a cwraped C function taking 2 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap3<X extends RaylibStruct<X>>(String name) → WF3<StructPointer<X>>

Binds a cwraped C function taking 3 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap4<X extends RaylibStruct<X>>(String name) → WF4<StructPointer<X>>

Binds a cwraped C function taking 4 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap5<X extends RaylibStruct<X>>(String name) → WF5<StructPointer<X>>

Binds a cwraped C function taking 5 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap6<X extends RaylibStruct<X>>(String name) → WF6<StructPointer<X>>

Binds a cwraped C function taking 6 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap7<X extends RaylibStruct<X>>(String name) → WF7<StructPointer<X>>

Binds a cwraped C function taking 7 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap8<X extends RaylibStruct<X>>(String name) → WF8<StructPointer<X>>

Binds a cwraped C function taking 8 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

qwrap9<X extends RaylibStruct<X>>(String name) → WF9<StructPointer<X>>

Binds a cwraped C function taking 9 argument and returning a struct pointer, wrapped as StructPointer<X>.

inherited

run<T>(String name(), T f()) → T

Executes f, logging its label (and optionally timing it) when debug is enabled and the label passes all filters.

inherited

swrap0(String name) → WF1<void>

Binds a cwraped C function taking 0 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap1(String name) → WF2<void>

Binds a cwraped C function taking 1 argument that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap2(String name) → WF3<void>

Binds a cwraped C function taking 2 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap3(String name) → WF4<void>

Binds a cwraped C function taking 3 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap4(String name) → WF5<void>

Binds a cwraped C function taking 4 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap5(String name) → WF6<void>

Binds a cwraped C function taking 5 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap6(String name) → WF7<void>

Binds a cwraped C function taking 6 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap7(String name) → WF8<void>

Binds a cwraped C function taking 7 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

swrap8(String name) → WF9<void>

Binds a cwraped C function taking 8 arguments that returns a struct via the WASM structure-return (sret) convention.

inherited

symbol<X extends RType>(String name) → WasmMemoryPointer<X>

Resolves a global symbol exported by the WASM module and wraps its address as a WasmMemoryPointer.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited