Enum in ldk_audio.h

LDKAudioPriority

typedef enum LDKAudioPriority{
  LDK_AUDIO_PRIORITY_LOW=0,
  LDK_AUDIO_PRIORITY_NORMAL,
  LDK_AUDIO_PRIORITY_HIGH,
  LDK_AUDIO_PRIORITY_CRITICAL
}LDKAudioPriority;
Struct in ldk_audio.h

LDKAudioVoice

typedef struct LDKAudioVoice{
  u32 index;
  u32 version;
}LDKAudioVoice;
Struct in ldk_audio.h

LDKAudioPlayDesc

typedef struct LDKAudioPlayDesc{
  LDKAudioPriority priority;
  float volume;
  float range;
  Vec3 position;
  bool loop;
  bool spatialized;
}LDKAudioPlayDesc;
Struct in ldk_audio.h

LDKAudio

typedef struct LDKAudio{
  void *internal;
  bool is_initialized;
}LDKAudio;
Function in ldk_audio.h

ldk_audio_initialize

Initialize the audio.

LDK_API bool ldk_audio_initialize(
 LDKAudio *audio,
 LDKAssetManager *assets
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAssetManager *assets
Asset manager used to resolve referenced assets.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_audio.h

ldk_audio_terminate

Shut down the audio.

LDK_API void ldk_audio_terminate(LDKAudio *audio);

Parameters

LDKAudio *audio
Audio used by this operation.
Function in ldk_audio.h

ldk_audio_master_volume_set

Set the master output volume for all voices (0.0 = silent, 1.0 = full). Returns false if audio is not initialized or volume is outside [0, 1].

LDK_API bool ldk_audio_master_volume_set(
 LDKAudio *audio,
 float volume
);

Parameters

LDKAudio *audio
Audio used by this operation.
float volume
Volume used by this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_audio.h

ldk_audio_master_volume_get

Return the current master volume, or 1.0 if audio is unavailable.

LDK_API float ldk_audio_master_volume_get(LDKAudio *audio);

Parameters

LDKAudio *audio
Audio used by this operation.

Returns

The resulting value.

Function in ldk_audio.h

ldk_audio_listener_set

Set the audio listener.

LDK_API void ldk_audio_listener_set(
 LDKAudio *audio,
 Vec3 position,
 Vec3 direction,
 Vec3 world_up
);

Parameters

LDKAudio *audio
Audio used by this operation.
Vec3 position
Position used by the operation.
Vec3 direction
Direction used by this operation.
Vec3 world_up
World up used by this operation.
Function in ldk_audio.h

ldk_audio_play_desc_default

Initialize an audio playback descriptor with defaults.

LDK_API LDKAudioPlayDesc ldk_audio_play_desc_default(void);

Returns

A descriptor for the requested component or resource.

Function in ldk_audio.h

ldk_audio_voice_null

Return an invalid handle for the audio voice.

LDK_API LDKAudioVoice ldk_audio_voice_null(void);

Returns

An invalid or empty handle.

Function in ldk_audio.h

ldk_audio_voice_is_null

Check whether an audio voice handle is null.

LDK_API bool ldk_audio_voice_is_null(LDKAudioVoice voice);

Parameters

LDKAudioVoice voice
Voice used by this operation.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_audio.h

ldk_audio_voice_is_alive

Check whether the audio voice refers to a live resource.

LDK_API bool ldk_audio_voice_is_alive(
 LDKAudio *audio,
 LDKAudioVoice voice
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAudioVoice voice
Voice used by this operation.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_audio.h

ldk_audio_voice_is_playing

Check whether the audio voice is playing.

LDK_API bool ldk_audio_voice_is_playing(
 LDKAudio *audio,
 LDKAudioVoice voice
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAudioVoice voice
Voice used by this operation.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_audio.h

ldk_audio_voice_position_set

Set the audio voice position.

LDK_API bool ldk_audio_voice_position_set(
 LDKAudio *audio,
 LDKAudioVoice voice,
 Vec3 position
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAudioVoice voice
Voice used by this operation.
Vec3 position
Position used by the operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_audio.h

ldk_audio_voice_volume_set

Set the audio voice volume.

LDK_API bool ldk_audio_voice_volume_set(
 LDKAudio *audio,
 LDKAudioVoice voice,
 float volume
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAudioVoice voice
Voice used by this operation.
float volume
Volume used by this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_audio.h

ldk_audio_voice_range_set

Set the audio voice range.

LDK_API bool ldk_audio_voice_range_set(
 LDKAudio *audio,
 LDKAudioVoice voice,
 float range
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAudioVoice voice
Voice used by this operation.
float range
Range used by this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_audio.h

ldk_audio_voice_loop_set

Set the audio voice loop.

LDK_API bool ldk_audio_voice_loop_set(
 LDKAudio *audio,
 LDKAudioVoice voice,
 bool loop
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAudioVoice voice
Voice used by this operation.
bool loop
Loop used by this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_audio.h

ldk_audio_asset_play

Plays a shared audio asset and returns a versioned playback handle. Small assets may be cached in memory; larger assets stream from RunTree or an open .box package. Active voices retain a reference to the asset data.

LDK_API LDKAudioVoice ldk_audio_asset_play(
 LDKAudio *audio,
 LDKAssetAudio asset,
 const LDKAudioPlayDesc *desc
);

Parameters

LDKAudio *audio
Audio used by this operation.
LDKAssetAudio asset
Asset handle to inspect or modify.
const LDKAudioPlayDesc *desc
Description or configuration for this operation.

Returns

The requested value.

Function in ldk_audio.h

ldk_audio_sound_play

Convenience path-based playback. The path is resolved through the asset manager and then played as a shared LDKAssetAudio.

LDK_API LDKAudioVoice ldk_audio_sound_play(
 LDKAudio *audio,
 const char *path
);

Parameters

LDKAudio *audio
Audio used by this operation.
const char *path
Path identifying the file or resource.

Returns

The requested value.

Function in ldk_audio.h

ldk_audio_sound_play_ex

Play a sound using the supplied playback options.

LDK_API LDKAudioVoice ldk_audio_sound_play_ex(
 LDKAudio *audio,
 const char *path,
 const LDKAudioPlayDesc *desc
);

Parameters

LDKAudio *audio
Audio used by this operation.
const char *path
Path identifying the file or resource.
const LDKAudioPlayDesc *desc
Description or configuration for this operation.

Returns

The requested value.