ISpTTSEngineSite::GetVolume (Windows Embedded CE 6.0)
1/6/2010
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 |