Struct in ldk_audio.h

LDKAudioVoice

typedef struct LDKAudioVoice{
  u32 index;
  u32 version;
}LDKAudioVoice;
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_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_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_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_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_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_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.