Readme for DolSAPI4 Version 1.01

This file is best read in a text editor with wordwrap turned on.



Contents

1. Introduction
2. Supported Control Tags
3. Unsupported Functionality
4. Known Issues



1. Introduction
This document provides information on using Dolphin Orpheus 2.x SAPI 4 interface. For information on using SAPI 4 refer to the relevent SAPI documentation.

2. Supported Control Tags

The following tags are supported

\Mrk=number\
\Pau=number\
\Pit=number\
\RmS=number\
\RmW=number\
\Rst\
\Spd=number\
\Vol=number\
\Eng:command\	SEE BELOW

Refer to "DirectTextToSpeech API Control Tags" document for further details.

2.1 Eng Tag Supported Commands


\Eng:SFX=number\
Plays a sound effect. Sound effects are referenced using a selector. Selectors are numbered sequentially from 0.

\Eng:PHRASEPAUSE=number\
Sets the inter-phrase pause when synthesising associated input stream text.
 
\Eng:SPELLMASK=number\
Spells out words or numbers dependant on which bits of the mask are set.

	BIT  |	MEANING
	-------------------------
	1    |	Spell text
	2    |	Spell numbers
	3    |	Spell modifiers
	4    |	Spell punctuation



3. Unsupported Features

3.1 Does not provide viseme (visual) notifications.
3.2 ITTSCentral::TextData will fail if eCharacterSet is CHARSET_ENGINEPHONETIC or CHARSET_IPAPHONETIC.  
3.3 ITTSCentral::Phoneme will fail if eCharacterSet is set to CHARSET_TEXT or CHARSET_IPAPHONETIC and if dwFlags is set to TTSDATAFLAG_TAGGED.
3.4 ITTSAttributes::RealTimeGet and ITTSAttributes::RealTimeSet functions are not supported.
3.5 Does not provide word position notifications. 
3.6 ILexPronounce interface is not supported.

4. Known Issues

4.1 If a parameter is changed by using ITTSCentral::inject Orpheus will alter the speech on the nearest phrase boundary. It will, however, immediately notify a client application that the attribute has changed.


END_OF_DOCUMENT
