SPEAKFLAGS

  • Article

This enumeration defines flags that control the speaking behavior for a voice. The flags are used in calls to ISpVoice::Speak or ISpTTSEngine::Speak.

typedef enum SPEAKFLAGS{
  // SpVoice flags
  SPF_DEFAULT = 0,
  SPF_ASYNC = (1L << 0),
  SPF_PURGEBEFORESPEAK = (1L << 1),
  SPF_IS_FILENAME = (1L << 2),
  SPF_IS_XML = (1L << 3),
  SPF_IS_NOT_XML = (1L << 4),
  SPF_PERSIST_XML = (1L << 5),

  // Normalizer flags
  SPF_NLP_SPEAK_PUNC = (1L << 6),

  // Masks
  SPF_NLP_MASK = (SPF_NLP_SPEAK_PUNC),
  SPF_VOICE_MASK = (SPF_ASYNC|SPF_PURGEBEFORESPEAK|SPF_IS_FILENAME|
  SPF_IS_XML|SPF_IS_NOT_XML|SPF_NLP_MASK|SPF_PERSIST_XML),
  SPF_UNUSED_FLAGS = ~(SPF_VOICE_MASK)
} SPEAKFLAGS;

Elements

  • SPF_DEFAULT
    Use default behavior. The default behavior is to speak the given string synchronously, to not purge pending speak requests, to parse the text as XML only if the first character is a left angle bracket (<), to not persist global XML state changes across speak calls, and to not expand punctuation characters into words. To override this default behavior, the other voice flag values are used.
  • SPF_ASYNC
    ISpVoice::Speak call is asynchronous. The method returns immediately after the speak request is queued.
  • SPF_PURGEBEFORESPEAK
    Purge all pending speak requests prior to the speak call.
  • SPF_IS_FILENAME
    String passed to ISpVoice::Speak is a file name. The file text is spoken.
  • SPF_IS_XML
    Parse input text for XML markup.
  • SPF_IS_NOT_XML
    Parse input text for XML markup.
  • SPF_PERSIST_XML
    Persist global state changes in XML markup across speak calls.
  • SPF_NLP_SPEAK_PUNC
    Expand punctuation characters into words. For example, "This is a sentence." becomes "This is a sentence period".
  • SPF_NLP_MASK
    Use a mask to remove SAPI-handled flags before speak call. . The only flag that the TTS engine must handle is SPF_NLP_SPEAK_PUNC.
  • SPF_VOICE_MASK
    Use a voice mask that has every flag bit set.
  • SPF_UNUSED_FLAGS
    Use a voice mask that has every unused bit set.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.

See Also

SAPI Enumerations | ISpTTSEngine::Speak | ISpVoice::Speak

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.