Share via

  • Article

Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

Microsoft Speech Platform

ISpVoice::IsUISupported

ISpVoice::IsUISupported checks if the underlying text-to-speech engine's object token supports the requested UI.

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>[local] HRESULT IsUISupported(</strong> <strong> const WCHAR</strong> *<em>pszTypeOfUI</em>, <strong> void</strong> *<em>pvExtraData</em>, <strong> ULONG</strong> <em>cbExtraData</em>, <strong> BOOL</strong> *<em>pfSupported</em> <strong>);</strong> </pre>

Parameters

  • pszTypeOfUI
    [in] Address of the null-terminated string containing the UI type that is being queried.
  • pvExtraData
    [in] Pointer to additional information needed for the object. The TTS Engine implementer dictates the format and usage of the data provided.
  • cbExtraData
    [in] Size, in bytes, of the ExtraData. The TTS Engine implementer dictates the format and usage of the data provided.
  • pfSupported
    [out] Flag specifying whether the specified UI is supported. TRUE indicates the UI is supported, and FALSE indicates the UI is not supported. ** If this value is TRUE, but the return code is S_FALSE, the UI type (pszTypeOfUI) is supported, but not with the current parameters or run-time environment. Check with the engine implementer to verify run-time requirements.

Return Values

Value Description
S_OK Function completed successfully.
S_FALSE The UI is supported but not with the current run-time environment or parameters.
E_INVALIDARG One or more parameters are invalid.
FAILED(hr) Appropriate error message.

Remarks

This method will return S_OK when using Microsoft engines, but the value of pfSupported will be FALSE.