IAgentCharacter::SetSoundEffectsOn

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

HRESULT SetSoundEffectsOn(
   long bOn  // character sound effects setting 
);

Determines whether the character's sound effects are played.

• Returns S_OK to indicate the operation was successful.

bOn

Sound effects setting. If this parameter is True, the sound effects for animations are played when the animation plays; if False, sound effects are not played.

This setting determines whether sound effects compiled as a part of the character are played when you play an associated animation. This property's setting applies to all clients of the character. The setting is also subject to the user's global sound effects setting in IAgentAudioOutputProperties::GetUsingSoundEffects.

See Also

IAgentCharacter::GetSoundEffectsOn, IAgentAudioOutputProperties::GetUsingSoundEffects