Share via

ISpTTSEngineSite::GetVolume (SAPI 5.4)

  • Article

Microsoft Speech API 5.4

ISpTTSEngineSite::GetVolume

ISpTTSEngineSite::GetVolume retrieves the base output volume level the engine should use during synthesis.

  
    HRESULT GetVolume(
  USHORT* pusVolume
);

Parameters

  • pusVolume
    [out] Pointer to a USHORT which specifies the baseline volume level.

Return values

Value
S_OK
E POINTER

Remarks

This function should be called when a call to GetActions returns SPVES_VOLUME. The retrieved value establishes a baseline volume. Additional volume adjustments in the XML state should be combined with this value to determine the actual absolute volume level.