ISpVoice::SetVolume (Windows CE 5.0)

Send Feedback

This method sets the base volume level of the voice in real time. The default base volume for all voices is 100.

HRESULT SetVolume(  USHORT usVolume);

Parameters

  • usVolume
    [in] Value specifying the requested volume level. Volume levels are specified in percentage values ranging from 0 to 100. Values outside this range can be truncated.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
E_INVALIDARG One or more arguments are invalid.

Remarks

Volume is specified as a percentage of the maximum volume of the current voice. Different voices can have different maximum volume levels.

Applications can adjust the volume of a voice either through this function call, or through XML passed to the voice with the input text of a speak call. The voice should combine volume adjustments made in these two ways to arrive at a final volume.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpVoice | SAPI Interfaces

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.