ISpTTSEngine::GetOutputFormat
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 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.
Syntax
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 Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |