Sound

Functions for controlling the engine sound mixer from native extensions.

Namespace: dmSound
Include: #include <dmsdk/sound/sound.h>
ENUMS
Result
FUNCTIONS
bool IsGroupMuted(dmhash_t group) Query group mute state
Result SetGroupMute(dmhash_t group, bool mute) Set mute state for a mixer group
Result ToggleGroupMute(dmhash_t group) Toggle mute state for a mixer group

Functions

IsGroupMuted

bool IsGroupMuted(dmhash_t group)

Query group mute state

PARAMETERS

dmhash_t group hash of the mixer group (e.g. hash("master"))

RETURNS

bool true if the mixer group is muted

SetGroupMute

Result SetGroupMute(dmhash_t group, bool mute)

Temporarily mute or restore an individual mixer group.

PARAMETERS

dmhash_t group hash of the mixer group (e.g. hash("master"))
bool mute true to mute, false to restore audio

RETURNS

Result RESULT_OK on success

ToggleGroupMute

Result ToggleGroupMute(dmhash_t group)

Convenience toggle for SetGroupMute.

PARAMETERS

dmhash_t group hash of the mixer group (e.g. hash("master"))

RETURNS

Result RESULT_OK on success

Enums

Result

RESULT_OK
RESULT_PARTIAL_DATA
RESULT_OUT_OF_SOURCES
RESULT_EFFECT_NOT_FOUND
RESULT_OUT_OF_INSTANCES
RESULT_RESOURCE_LEAK
RESULT_OUT_OF_BUFFERS
RESULT_INVALID_PROPERTY
RESULT_UNKNOWN_SOUND_TYPE
RESULT_INVALID_STREAM_DATA
RESULT_OUT_OF_MEMORY
RESULT_UNSUPPORTED
RESULT_DEVICE_NOT_FOUND
RESULT_OUT_OF_GROUPS
RESULT_NO_SUCH_GROUP
RESULT_NOTHING_TO_PLAY
RESULT_INIT_ERROR
RESULT_FINI_ERROR
RESULT_NO_DATA
RESULT_END_OF_STREAM
RESULT_UNKNOWN_ERROR