RaylibAudioModuleBase<R extends RaylibBase, AudioStreamStructType extends AudioStreamBase<AudioStreamStructType> , MusicStructType extends MusicBase<MusicStructType, AudioStreamStructType> , SoundStructType extends SoundBase<SoundStructType, AudioStreamStructType> , WaveStructType extends WaveBase<WaveStructType> , AudioCallbackType extends AudioCallbackBase> class
abstract
Backend-agnostic contract for the Raylib Audio module.
Concrete platform implementations mix in or extend this to provide the full Core API surface across different backends.
- Inheritance
-
- Object
- RaylibModule<
R> - RaylibAudioModuleBase
Constructors
- RaylibAudioModuleBase(R rl)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- RaylibCaptureIds → RaylibAudioModuleCaptureIds
-
Capture ID generator for pointer slots allocated by this module.
final
- RaylibDebugLabels → RaylibAudioModuleDebugLabels
-
Debug label generator for this module's function calls.
final
- rl → R
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
AttachAudioMixedProcessor(
AudioCallbackType callback) → void -
AttachAudioStreamProcessor(
AudioStreamStructType stream, AudioCallbackType callback) → void -
CloseAudioDevice(
) → void -
debug(
bool v) → void -
Enables or disables debug logging for this module.
inherited
-
debugError(
String message) → void -
Logs
messageat error level if debug is enabled andmessagepasses 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
messageat info level if debug is enabled andmessagepasses all filters.inherited -
debugTime(
bool v) → void -
Enables or disables per-call timing output alongside debug logs.
inherited
-
debugWarn(
String message) → void -
Logs
messageat warn level if debug is enabled andmessagepasses all filters.inherited -
DetachAudioMixedProcessor(
AudioCallbackType callback, {bool keepAlive = false}) → void -
DetachAudioStreamProcessor(
AudioStreamStructType stream, AudioCallbackType callback, {bool keepAlive = false}) → void -
disableSync<
T> (T f()) → T -
Executes
fwith RaylibTempBase syncing temporarily disabled, restoring the previous sync state afterward.inherited -
dispose(
) → void -
Calls all registered onDispose callbacks and clears them.
inherited
-
doLoad(
) → void -
Ensures load is called exactly once, regardless of how many times doLoad is invoked.
inherited
-
ExportWave(
WaveStructType wave, String fileName) → bool -
ExportWaveAsCode(
WaveStructType wave, String fileName) → bool -
GetMasterVolume(
) → double -
GetMusicTimeLength(
MusicStructType music) → double -
GetMusicTimePlayed(
MusicStructType music) → double -
InitAudioDevice(
) → void -
IsAudioDeviceReady(
) → bool -
IsAudioStreamPlaying(
AudioStreamStructType stream) → bool -
IsAudioStreamProcessed(
AudioStreamStructType stream) → bool -
IsAudioStreamValid(
AudioStreamStructType stream) → bool -
IsMusicStreamPlaying(
MusicStructType music) → bool -
IsMusicValid(
MusicStructType music) → bool -
IsSoundPlaying(
SoundStructType sound) → bool -
IsSoundValid(
SoundStructType sound) → bool -
IsWaveValid(
WaveStructType wave) → bool -
load(
) → void -
Override to perform one-time module initialization. Called by doLoad.
inherited
-
LoadAudioStream(
num sampleRate, num sampleSize, num channels) → AudioStreamStructType -
LoadMusicStream(
String fileName) → MusicStructType -
LoadMusicStreamFromMemory(
String fileType, Uint8List data) → MusicStructType -
LoadSound(
String fileName) → SoundStructType -
LoadSoundAlias(
SoundStructType source) → SoundStructType -
LoadSoundFromWave(
WaveStructType wave) → SoundStructType -
LoadWave(
String fileName) → WaveStructType -
LoadWaveFromMemory(
String fileType, Uint8List fileData) → WaveStructType -
LoadWaveSamples(
WaveStructType wave) → List< double> -
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
fnto be called when this module is disposed.inherited -
PauseAudioStream(
AudioStreamStructType stream) → void -
PauseMusicStream(
MusicStructType music) → void -
PauseSound(
SoundStructType sound) → void -
PlayAudioStream(
AudioStreamStructType stream) → void -
PlayMusicStream(
MusicStructType music) → void -
PlaySound(
SoundStructType sound) → void -
ResumeAudioStream(
AudioStreamStructType stream) → void -
ResumeMusicStream(
MusicStructType music) → void -
ResumeSound(
SoundStructType sound) → void -
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 -
SeekMusicStream(
MusicStructType music, num position) → void -
SetAudioStreamBufferSizeDefault(
num size) → void -
SetAudioStreamCallback(
AudioStreamStructType stream, AudioCallbackType callback) → void -
SetAudioStreamPan(
AudioStreamStructType stream, num pan) → void -
SetAudioStreamPitch(
AudioStreamStructType stream, num pitch) → void -
SetAudioStreamVolume(
AudioStreamStructType stream, num volume) → void -
SetMasterVolume(
num volume) → void -
SetMusicPan(
MusicStructType music, num pan) → void -
SetMusicPitch(
MusicStructType music, num pitch) → void -
SetMusicVolume(
MusicStructType music, num volume) → void -
SetSoundPan(
SoundStructType sound, num pan) → void -
SetSoundPitch(
SoundStructType sound, num pitch) → void -
SetSoundVolume(
SoundStructType sound, num volume) → void -
StopAudioStream(
AudioStreamStructType stream) → void -
StopMusicStream(
MusicStructType music) → void -
StopSound(
SoundStructType sound) → void -
toString(
) → String -
A string representation of this object.
inherited
-
UnloadAudioStream(
AudioStreamStructType stream) → void -
UnloadMusicStream(
MusicStructType music) → void -
UnloadSound(
SoundStructType sound) → void -
UnloadSoundAlias(
SoundStructType alias) → void -
UnloadWave(
WaveStructType wave) → void -
UpdateAudioStream(
AudioStreamStructType stream, TypedDataList data) → void -
UpdateMusicStream(
MusicStructType music) → void -
UpdateSound(
SoundStructType sound, TypedDataList data, num sampleCount) → void -
WaveCopy(
WaveStructType wave) → WaveStructType -
WaveCrop(
WaveStructType wave, num initFrame, num finalFrame) → void -
WaveFormat(
WaveStructType wave, num sampleRate, num sampleSize, num channels) → void
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited