ISpTTSEngine::GetOutputFormat

This method gets information about a specific output format. The TTS engine should examine the requested output format, and retrieve a pointer to the supported format that is closest to the one requested.

HRESULT GetOutputFormat(
  const GUID* pTargetFmtId,
  const WAVEFORMATEX* pTargetWaveFormatEx,
  GUID* pOutputFormatId,
  WAVEFORMATEX** ppCoMemOutputWaveFormatEx
);

Parameters

• pTargetFmtId
  [in] Pointer to the identifier for the requested output format. Possible values are:

  Value	Description
  SPDFID_Text	Output in the form of text. Engines are not required to support this format. If they do support it, they are not required to do anything specific with it. It is provided merely for debugging purposes.
  SPDFID_WaveFormatEx	Output in the form of a WAVEFORMATEX structure.

• pTargetWaveFormatEx
  [in] Pointer to a WAVEFORMATEX structure describing the requested output format. This value is NULL if pTargetFmtId is set to SPDFID_Text.
• pOutputFormatId
  [out] Pointer to the identifier for the engine-supported output format. Possible values are:

  Value	Description
  SPDFID_Text	Output in the form of text. If this value is retrieved, NULL should be retrieved in ppCoMemOutputWaveFormatEx.
  SPDFID_WaveFormatEx	Output in the form of a WAVEFORMATEX structure.

• ppCoMemOutputWaveFormatEx
  [out] Address of a pointer to a WAVEFORMATEX structure defining the engine-supported output format. The caller should allocate space for the structure using CoTaskMemAlloc.

Return Values

The following table shows the possible return values.

Requirements

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

See Also

ISpTTSEngine | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.