ISpTTSEngineSite::GetVolume
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 gets the base output volume level that the TTS engine should use during synthesis. The engine should call this method when a call to ISpTTSEngineSite::GetActions returns SPVES_VOLUME.
The value retrieved by this method establishes a baseline volume. The engine should combine additional volume adjustments in the XML state with this value to determine the actual absolute volume level.
Syntax
HRESULT GetVolume(
USHORT* pusVolume
);
Parameters
- pusVolume
[out] Pointer to the baseline volume level.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_POINTER |
pusVolume is invalid. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |