Readme for DolSAPI5 Version 1.01

This file is best viewed with WordWrap selected.



Contents

1. Introduction
2. Supported XML Tags
3. Unsupported functionality.




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

2. Supported XML Tags

The following tags are supported
<BOOKMARK>
<LANG>
<PITCH>
<RATE>
<SILENCE>
<SPELL>
<VOLUME>

Refer to "SAPI 5.0 XML Schema" document for further details.

In addition, the following custom tags are also supported

<CHANGEVOICE>
Sets which voice implementation is used for synthesis of associated input stream text. A language can support any number of voices that are referenced using a selector. Selectors are numbered sequentially from 0.

syntax: <CHANGEVOICE SELECTOR = int>
content: empty
order: many (default)  
attributes:  SELECTOR 

<SFX>
Plays a sound effect. Sound effects are referenced using a selector. Selectors are numbered sequentially from 0.

syntax: <SFX EFFECT = int>
content: empty
order: many (default)  
attributes:  EFFECT 

<WORDPAUSE>
Sets the inter-word pause when synthesising associated input stream text.

syntax: <WORDPAUSE MSEC = int>
content: empty
order: many (default)  
attributes:  MSEC 

<PHRASEPAUSE>
Sets the inter-phrase pause when synthesising associated input stream text.

syntax: <PHRASEPAUSE MSEC = int>
content: empty
order: many (default)  
attributes:  MSEC 
 
<SPELLING>
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

syntax: <SPELLING MASK = int>
content: empty
order: many (default)  
attributes:  MSEC 



3. Unsupported features

3.1 DolSAPI5 does not indicate that Orpheus has synthesised a viseme.
3.2 Sentence skip is not supported.



















END_OF_DOCUMENT
