ISpVoice::SetVolume
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method sets the base volume level of the voice in real time. The default base volume for all voices is 100.
Syntax
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 Value
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
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |