Table of Contents

 
IsMuted
 

Purpose

Returns whether the clip is muted or not

 

Protoype

bool CSoundMngr::IsMuted (string str_id)
 

Parameters

id the ID of the sound object to query
 

Description

This function returns the value of the sound object's mute flag. If the sound clip is muted, then the function returns TRUE, otherwise it returns FALSE.

NOTE: This is a channel function, which means it can be used for both music and sfx objects. The function itself will handle distinguishing between the two.

 

Use

CSoundMngr sound;
if (sound.IsMuted("my_sound"))
    // sound is muted
 

Prev: GetVolume
Next: IsPaused