Share via

ISpTTSEngineSite::GetVolume

  • Article

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.

HRESULT GetVolume(
  USHORT* pusVolume
);

Parameters

  • pusVolume
    [out] Pointer to the baseline volume level.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
E_POINTER pusVolume is invalid.

Requirements

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

See Also

ISpTTSEngineSite | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.