MRCP-2-ATel

Acapela MRCP-2 Addon/Server

Reference manual

Ref. : Add-MRCP2-ATel

Acapela Group3939 la Lauragaise, BP 758, 31683 Labge Cedex, France. T. : +33 (0)562 24 71 00 F. : +33 (0)562 24 71 01

Acapela MRCP-2Addon/Server

Reference manual

Date : 2012/02/22

Page : 2/31

Add-MRCP2-ATel

Document revisions

Version Date Subject Author(s)

A 2009/06/05 Initial version RD

B 2012/02/22 V2.100 RD

C 2013/05/28 V2.200 RD

Acapela Grouphttp://www.acapela-group.com


Reference manual

Date : 2012/02/22

Page : 3/31

Add-MRCP2-ATel

Table of contents

Table of Contents1Foreword.....................................................................................................6

2Prerequisites...............................................................................................7

2.1For a Windows based application..................................................................7

2.1For a Linux based application.......................................................................7

1Reference documents..................................................................................8

1.1From IETF................................................................................................8

1.1From Acapela............................................................................................81.1.1For Windows.................................................................................................................81.1.2For Linux......................................................................................................................8

2Usage..........................................................................................................9

2.1Generalities..............................................................................................9

2.2Acapela MRCP-2 service/daemon.................................................................92.2.1Windows service............................................................................................................9

2.2.1.1Options................................................................................................................102.2.2Linux daemon.............................................................................................................10

2.3Command line.........................................................................................102.3.1Option : r | --root-dir path..........................................................................................10

2.3.1.1Windows..............................................................................................................102.3.1.2Linux...................................................................................................................11

2.3.2Option : -l | --log-prio priority.......................................................................................112.3.3Option : -o | --log-ouptput...........................................................................................122.3.4Option : -s | --service (Windows) only............................................................................122.3.5Option : -d | --daemon (Linux only)...............................................................................122.3.6Option : -h | --help......................................................................................................12

2.4MRCP Interface........................................................................................12

2.1Configuration files....................................................................................12

1Server configuration.................................................................................13

1.1Configuration format................................................................................13

1.1Properties...............................................................................................13

1.2Components ...........................................................................................131.2.1Factory of MRCP resources............................................................................................131.2.2Session management agents.........................................................................................14

1.2.2.1MRCP V2 session management................................................................................14

Acapela GroupLes Erables, rue du Lac, BP98153, 31681 Labge Cedex, France. T. : +33 (0)562 24 71 00 F. : +33 (0)562 24 71 01


Reference manual

Date : 2012/02/22

Page : 4/31

Add-MRCP2-ATel

1.2.2.2MRCP V1 session management................................................................................141.2.3MRCP V2 connection agent............................................................................................151.2.4Media processing engines.............................................................................................161.2.5Factory of RTP terminations..........................................................................................161.2.6Factory of plugins/resource engines...............................................................................16

1.1Settings..................................................................................................171.1.1RTP settings................................................................................................................17

1.1.1.1RTCP protocol.......................................................................................................181.1.1.1.1Enabling.........................................................................................................181.1.1.1.2Transmission of RTCP reports ............................................................................181.1.1.1.3Transmission of an RTCP BYE packet...................................................................181.1.1.1.4Reception of RTCP packets................................................................................18

1.2Profiles...................................................................................................19

2AcapelaTTS plugin configuration...............................................................20

2.1Configuration format................................................................................20

2.1Settings..................................................................................................202.1.1Connection settings.....................................................................................................20

2.1.1.1Alternative TTS server............................................................................................212.1.1.2Watchdog.............................................................................................................21

2.1.2Flow control settings....................................................................................................212.1.3TTS settings................................................................................................................222.1.1Log/trace settings.......................................................................................................22

2.1.1.1NSCAPI................................................................................................................222.1.1.2Plugin..................................................................................................................23

2.2Profile....................................................................................................232.2.1Default languages & voices...........................................................................................23

2.2.1.1Default language...................................................................................................232.2.1.1.1Default gender and voice per language...............................................................24

3Features....................................................................................................26

3.1Supported MRCP commands......................................................................263.1.1SPEAK........................................................................................................................263.1.1SET-PARAMS...............................................................................................................263.1.1GET-PARAMS...............................................................................................................26

3.1.1.1Vendor-Specific-Parameters....................................................................................273.1.2CONTROL...................................................................................................................273.1.1STOP and BARGE-IN-OCCURRED...................................................................................273.1.1PAUSE........................................................................................................................283.1.1RESUME.....................................................................................................................28

3.2Unsupported MRCP commands...................................................................28

3.3Supported MRCP events............................................................................28



Reference manual

Date : 2012/02/22

Page : 5/31

Add-MRCP2-ATel

3.3.1SPEAK-COMPLETE........................................................................................................283.3.2SPEECH-MARKER.........................................................................................................28

1Appendix A : List of NSCAPI languages identifiers....................................29



Reference manual

Date : 2012/02/22

Page : 6/31

Add-MRCP2-ATel

1 Foreword

This document explains how to use Acapela MRCP-2 Server product for telecom applications in the context of the Acapela TTS Server environment.

Acapela MRCP-2 Server is an MRCP server compliant with MRCP V1 & MRCP V2 protocols.

It is based on open source cross-platform MRCP project :

uniMRCP

Various informations about uniMRCP configuration are available on Wiki page :

uniMRCP Wiki page



Reference manual

Date : 2012/02/22

Page : 7/31

Add-MRCP2-ATel

2 Prerequisites

Acapela MRCP-2 Server is available for Windows and Linux.

2.1 For a Windows based application

An Acapela TTS Server, either for Linux or Windows.

An MRCP-2 Server, either for Linux or Windows.

2.1 For a Linux based application

An Acapela TTS Server, either for Linux or Windows.

An MRCP-2 Server, either for Linux or Windows.



Reference manual

Date : 2012/02/22

Page : 8/31

Add-MRCP2-ATel

1 Reference documents

1.1 From IETF

Acapela MRCP-2 Server is based on :

RFC4463 (www.ietf.org/rfc/rfc4463.txt) for MRCP V1 protocol,

Internet-draft draft-ietf-speechsc-mrcpv2-17.txt (www.ietf.org/internet-drafts/draft-ietf-speechsc-mrcpv2-17.txt) for MRCP V2 protocol.

1.1 From Acapela

1.1.1 For Windows

Acapela TTS Server server is described in the document : 4406-TEC-DOC-PAGA-33.pdf.

NSCAPI interface is described in the document : 4488-TEC-DOC-BELE-192.pdf.

NOTE :NSCAPI interface is embedded in Acapela TTS plugin.

1.1.2 For Linux

Acapela TTS Server server is described in the document: 4488-TEC-DOC-BELE-227.pdf.

NSCAPI interface is described in the document: 4488-TEC-DOC-BELE-192.pdf.



Reference manual

Date : 2012/02/22

Page : 9/31

Add-MRCP2-ATel

2 Usage

2.1 Generalities

Acapela MRCP-2 server supports MRCP V2 & V1 protocols.

Speech synthesizer (TTS) resource is performed by Acapela TTS plugin which performs the dialog with Acapela TTS Server server via Acapela NSCAPI.

The server listens for SIP requests on port 8060.

Acapela MRCP-2 Server can run as a console application or as a service (Windows) or daemon (Linux).

Acapela TTS Server server must be running before Acapela MRCP-2 Server is started .

2.2 Acapela MRCP-2 service/daemon

Acapela MRCP server can be launched :

as a Windows service (4.3.4.Option : -s | --service (Windows) only)

as Linux daemon (4.3.5.Option : -d | --daemon (Linux only)).

2.2.1 Windows service

The windows service can be installed/uninstalled with acapelamrcpservice utility.

To install the service, run :

acapelamrcpservice -i [rootdir] -d

rootdir the root directory is the directory where Acapela MRCP-2 serverfinds common sub-directory (\plugin, \conf, \log)

(by default, it is the install directory : %PROGRAMFILES%\Acapela Group\MRCP-2 Addon),if rootdir is not specified, the current directory is used.

-d install service with dependency on Acapela TTS Server

Important note : If MRCP-2 server is installed as a service, be careful that Acapela TTS Server is running before the service is started. If Acapela TTS Server is installed on the same machine, you can start it as a service and add it as dependency of Acapela MRCP-2 server service to insure that Acapela TTS Server started first.

To do so, instal Acapela MRCP-2 service with option -d.

To uninstall the service, run :



Reference manual

Date : 2012/02/22

Page : 10/31

Add-MRCP2-ATel

acapelamrcpservice -u

2.2.1.1 Options

-i | --install [rootdir] install the service with rootdir as root directory

-d set Acapela TTS Server as service dependency

-u | -- uninstall uninstall the service

-start start the service

-stop stop the service

2.2.2 Linux daemon

A daemon called :

acatel_mrcpv2srvdis installed in /etc/init.d to launch Acapela MRCP-2 Server as a service.

Syntax :

acatel_mrcpv2srvd start|stop|restart|statusstart start the servicestop stop the servicerestart restart the servicestatus displays service status

To start Acapela MRCP-2 Server service at system initialisation, you can add it to service list using the following command (Red Hat Linux):

chkconfig --add acatel_mrcpv2srvd

2.3 Command line

Syntax:

unimrcpserver [options]

2.3.1 Option : r | --root-dir path

Set the root directory path.The root directory path is used to calculate path for all the components used by Acapela MRCP-2 server.

2.3.1.1 Windows

By default, MRCP-2 server is installed in :Acapela GroupLes Erables, rue du Lac, BP98153, 31681 Labge Cedex, France. T. : +33 (0)562 24 71 00 F. : +33 (0)562 24 71 01


Reference manual

Date : 2012/02/22

Page : 11/31

Add-MRCP2-ATel

%PROGRAMFILES%\Acapela Group\MRCP-2

with following tree :

./bin main uniMRCP binaries

./plugin AcapelaTTS plugin

./doc documentation

./conf configuration files (unimrcpserver.xml, logger.xml, acapelatts.xml)

./log log files

For Windows 2008, conf and log directories are located in :

%PROGRAMDATA%\Acapela Group\MRCP-2

2.3.1.2 Linux

By default, MRCP-2 server is installed in :

/opt/Acapela/MRCP-2

with following tree :

./bin main uniMRCP binaries

./plugin AcapelaTTS plugin & dependency

./lib 3rd party libraries (SOFIA-SIP, APR)

./doc documentation

./conf a symlink to /etc/opt/Acapela/MRCP-2/conf that contains configuration files (unimrcpserver.xml, logger.xml, acapelatts.xml)

./log a symlink to /var/opt/Acapela/MRCP-2/log that contains log files

2.3.2 Option : -l | --log-prio priority

Set the log output level : 0 to 7 (full log infos).

EMERGENCY 0 system is unusableALERT 1 action must be taken immediately CRITICAL 2 critical conditionERROR 3 error conditionWARNING 4 warning conditionNOTICE 5 normal, but significant conditionINFO 6 informational message (default)DEBUG 7 debug-level message



Reference manual

Date : 2012/02/22

Page : 12/31

Add-MRCP2-ATel

2.3.3 Option : -o | --log-ouptput

Set the log output mode :

0 none1 console only,2 file only,3 both console & file.

By default logs are printed on console. When process is run from link start menu, or as a service, the log output mode is et to file only (2).

2.3.4 Option : -s | --service (Windows) only

Run the process as a Windows service.

NOTE : this option is only valid in service context. Running server with this option under a Window console will fail with error 1063.

2.3.5 Option : -d | --daemon (Linux only)

Run the process as a daemon.

2.3.6 Option : -h | --help

Displays help.

2.4 MRCP Interface

The MRCP server interface is a simple command line that accept the following commands:

help displays help about command

quit, exit exit server

loglevel [level] changes log level (level = 0 .. 7)

2.1 Configuration files

There are 3 configuration files :

unimrcpserver.xml configuration for MRCP-2 server for MRCP V2 & V1 protocols,

acapelatts.xml configuration file for Acapela TTS plugin

logger.xml configuration file for log output



Reference manual

Date : 2012/02/22

Page : 13/31

Add-MRCP2-ATel

1 Server configuration

1.1 Configuration format

UniMRCP uses XML based configuration file (unimrcpserver.xml).

Root element may contain sections :

,

,

,

.

1.1 Properties

There are a few named properties, which can be defined in one common place and applied to the whole document. These properties are effective for and , wherever they are allowed or intended to be defined.

10.10.0.1 local IP address to bind to 10.10.0.1 external (NAT) IP address

Note: IP address will be implicitly guessed if it is specified as .In some cases, server may fail to resolve IP address if is specified as auto; in thesecases, remove this property and set ip address may solve the issue.

1.2 Components

Components are core entities UniMRCP server is built upon. Each component is a separate logical entity. There is no direct association among the components.

1.2.1 Factory of MRCP resources

One and only one factory of MRCP resources can be specified. Speech synthesizer resource is named "speechsynth".



Reference manual

Date : 2012/02/22

Page : 14/31

Add-MRCP2-ATel

1.2.2 Session management agents

One or more session management (signaling) agents can be specified.

1.2.2.1 MRCP V2 session management

Set the parameters of SIP/MRCP v2 session.

8060 udp,tcp UniMRCP SofiaSIP UniMRCPServer

Parameters :

sip-port the SIP port value (default = 8060)

sip-ipsip-ext-ip the server IP address value (local and NAT).

If not set, server use parameters set in section.

sip-transport SIP transport protocols

sdp-origin SDP origin name

1.2.2.2 MRCP V1 session management

Set the parameters of RTSP/MRCP v2 session.

1554



Reference manual

Date : 2012/02/22

Page : 15/31

Add-MRCP2-ATel

100 UniMRCPServer

Parameters :

rtsp-port the RTSP port value (default = 1554)

rtsp-iprtsp-ext-ip the server IP address value (local and NAT).

If not set, server use parameters set in section.

sdp-origin SDP origin name

1.2.3 MRCP V2 connection agent

One or more MRCPv2 connection (transport) agents can be specified. These agents are used only for MRCPv2.

1544 100 false 1024 1024


Reference manual

Date : 2012/02/22

Page : 16/31

Add-MRCP2-ATel

1.2.4 Media processing engines

One or more media processing engines can be specified.

1

Parameters :

realtime-rate set the real-time rate from 1 to 10; 1 is the default value.

1.2.5 Factory of RTP terminations

One or more factory of RTP terminations can be specified.

5000 6000

rtp-port-minrtp-port-max min & max RTP port values

1.2.6 Factory of plugins/resource engines

One and only one factory of plugins can be specified.

Acapela TTS plugin (TTS resource engine) is identified by :

engine id = AcapelaTTS-1

engine name = acapelatts



Reference manual

Date : 2012/02/22

Page : 17/31

Add-MRCP2-ATel

1.1 Settings

Several RTP related settings can be specified. These settings should be used with appropriate components. Profiles will define associations among components and settings.

1.1.1 RTP settings

One or more RTP settings can be specified. RTP settings can be used with both SIP/MRCPv2 and RTSP/MRCPv1.

1 50 600 1 20 PCMU PCMA LPCM L16/96/8000 1 5000 1000

Parameter :

ptime packetization time ie. the period (in ms) at which RTP packets are sent

codecs list of supported codecs

playout-delay initial playout delay in msec

max-playout-delay max playout delay in msec (used in case of adaptative jitter

buffer)Acapela GroupLes Erables, rue du Lac, BP98153, 31681 Labge Cedex, France. T. : +33 (0)562 24 71 00 F. : +33 (0)562 24 71 01


Reference manual

Date : 2012/02/22

Page : 18/31

Add-MRCP2-ATel

1.1.1.1 RTCP protocol

1.1.1.1.1 Enabling

RTCP protocol is enabled by :

1.1.1.1.2 Transmission of RTCP reports

The default transmission interval is 5 sec. This is the period RTCP reports are generated and sent with. Typically, RTCP traffic bandwidth should be fixed at 5% of overall RTP/RTCP session bandwidth. Anyway, you can adjust the interval by the following parameter. To disable periodic transmission set it 0.

5000

1.1.1.1.3 Transmission of an RTCP BYE packet

According to the specification (RFC3550), a participant should sent an RTCP BYE packet when he wishes to leave an RTP session. Typically, RTP is used in conjunction with higher level session management protocols such as SIP, H323, which provide own mechanisms for the participants to join/leave a session. Therefore, presence of RTCP BYE packet is usually optional. However, the role of RTCP BYE in an MRCP environment was re-defined by well known vendor(s). It's intended to indicate end of input (utterance). All the mentioned options are supported by UniMRCP now.

1

1.1.1.1.4 Reception of RTCP packets

Currently this routine dumps received RTCP packets in the logs and it is mainly helpful for monitoring and debugging.The period, which is used to check for new RTCP messages, can be adjusted by the following parameter.

To disable the reception of RTCP packets set it 0.



Reference manual

Date : 2012/02/22

Page : 19/31

Add-MRCP2-ATel

1000

1.2 Profiles

A profile is just a collection of certain components and settings. Each profile must be assigned a unique identifier. Multiple MRCPv1 and/or MRCPv2 profiles can be defined. Profile will be chosen based on session management (signaling) agent MRCP session is created or originated by.

SIP-Agent-1 MRCPv2-Agent-1 Media-Engine-1 RTP-Factory-1 RTP-Settings-1

RTSP-Agent-1 Media-Engine-1 RTP-Factory-1 RTP-Settings-1



Reference manual

Date : 2012/02/22

Page : 20/31

Add-MRCP2-ATel

2 AcapelaTTS plugin configuration

2.1 Configuration format

AcapelaTTS uses XML based configuration file (unimrcpserver.xml).

Root element may contain sections :

,

.

This file defines mainly the parameters for :

communication with Acapela TTS Server,

default language, gender & voice.

2.1 Settings

Acapela TTS plugin communicates with Acapela TTS Server server via Acapela NSCAPI interface.

The section set mainly the Acapela TTS Server server configuration (ip address, ports). These settings are used by NSCAPI to communicate with Acapela TTS Server server (see NSCAPI User Manual : 4488-TEC-DOC-BELE-192.pdf for more information).

2.1.1 Connection settings

This section defines the required settings for connection to TTS server, and additionnal features (alternative address, watchdog).

Parameters :

command-port the Acapela TTS Server server command port (default = 666)

data-port the Acapela TTS Server data port (default = 6665)



Reference manual

Date : 2012/02/22

Page : 21/31

Add-MRCP2-ATel

ip-address the Acapela TTS Server server ip address (default = 127.0.0.1)

2.1.1.1 Alternative TTS server

Set alternative TTS server ip address.

Parameters :

alt-ip-address ip address for alternative TT server

2.1.1.2 Watchdog

The purpose of the watchdog is to survey the connection with TTS server.

When it is enabled, periodically, plugin sends a command to TTS server to see if it is alive.

If not, and if an alternative ip address is provided, plugin try to connect to alternate TTS

server.

Parameters :

watchdog-period the period of watchdog in seconds.

NOTE :

2.1.2 Flow control settings

Control the signal flow between plugin and TTS server.

When flow-control is enabled, plugin controls the amount of signal coming from from TTS server and stored in MRCP audio buffer : when it is higher than buffer-high-size, it sends a PAUSE command to TTS server to suspend flow, when it is lower than buffer-low-size it sends a RESUME command to restart the flow.

Parameters :

flow-control 1 to enable, 0 to disable - by default flow control is disabled

buffer-low-size buffer low size, default = 4096

buffer-high-size buffer high size, default = 32768



Reference manual

Date : 2012/02/22

Page : 22/31

Add-MRCP2-ATel

2.1.3 TTS settings

Set the default encoding of text sent to NSCAPI/TTS server when it is not specified by :

'Content-Encoding' field of generic header,

'encoding' attribute of XML header.

Default encoding is UTF-8.

2.1.1 Log/trace settings

Enable/disable AcapelaTTS plugin and NSCAPI logs.

2.1.1.1 NSCAPI

Set NSCAPI log settings. Parameters are similar to parameters described in NSCAPI interface documentation : 4488-TEC-DOC-BELE-192.pdf.

Parameters :

log-file log file name; %u if present is replaced by process pid

log-level log level; OFF=disabled,ERROR,WARNING,INFO,TRACE,VERBOSE,DEBUG

log-max-size max size of log file; if set the log output will be cut in single files with a size lower or equal to defined size.



Reference manual

Date : 2012/02/22

Page : 23/31

Add-MRCP2-ATel

2.1.1.2 Plugin

Set plugin log level.

Parameters :

trace-level the log level : OFF=disabled, ERROR, WARNING, INFO, DEBUG,TRACE,VERBOSE;

levels ERROR to DEBUG are similars to uniMRCP levels, VERBOSE and TRACE are deeper levels

NOTE : this parameter allows to control the plugin log level independenly BUT in the limits fixed by uniMRCP log settings, i.e. a plugin log message is not printed if its level is higher than the log level set globally in logger.xml or by command line argument.

2.2 Profile

The sections : & set the default language, payload, gender & voice to be used by TTS resource when no language and/or voice information are given in MRCP Speak header.

2.2.1 Default languages & voices

The sections : & set the default language, gender & voice to be used by TTS resource when no language and/or voice information are given in MRCP Speak header.

2.2.1.1 Default language

The section : set the default language to be used when no language or voice has been specified in MRCP Speak header, and the default payload used to enumerate voices from TTS server.



Reference manual

Date : 2012/02/22

Page : 24/31

Add-MRCP2-ATel

Parameter :

default-language default XML language identifier (IETF BCP47)(for ex. : = fr-FR for French standard)

payload default payload

LPCM linear PCM 16bits

PCMU G711 Mu-Law

PCMA G711 A-Law

2.2.1.1.1 Default gender and voice per language

The section : set the list of languages and the default gender and voice linked to a given language. A section : must be given for each language used in MRCP V2 server.

...

Parameter :

name XML language identifier (IETF BCP47)

Parameter :Acapela GroupLes Erables, rue du Lac, BP98153, 31681 Labge Cedex, France. T. : +33 (0)562 24 71 00 F. : +33 (0)562 24 71 01


Reference manual

Date : 2012/02/22

Page : 25/31

Add-MRCP2-ATel

id NSCAPI language identifier (see Appendix A : List of NSCAPI languages identifiers)

gender default gender (male or female)male-voice default male speaker namefemale-voicedefault female speaker name



Reference manual

Date : 2012/02/22

Page : 26/31

Add-MRCP2-ATel

3 Features

3.1 Supported MRCP commands

3.1.1 SPEAK

Following header fields are supported :o Channel-Identifiero Speech-Languageo Voice-gendero Voice-nameo Prosody-rateo Prosody-volumeo Content-Encoding

NOTE : when none of the following header fields : Voice-Name, Speech-Language, Voice-gender are given, and the sent text is an XML text, the server (via the plugin) parses the text to find XML attributes : xml:lang and gender and apply them as current speak attributes.

NOTE : when SPEAK command fails due to a TTS server error, MRCP server returns a SPEAK-COMPLETE event with following header field :Completion-cause: 004 errorCompletion-reason : TTS Server error :

3.1.1 SET-PARAMS

Following header fields are supported :o Channel-Identifiero Speech-Languageo Voice-gendero Voice-nameo Prosody-rateo Prosody-volumeo Content-Encoding

3.1.1 GET-PARAMS

Following header fields are supported :o Channel-Identifiero Speech-Languageo Voice-gendero Voice-nameo Prosody-rateo Prosody-volume



Reference manual

Date : 2012/02/22

Page : 27/31

Add-MRCP2-ATel

o Content-Encoding

3.1.1.1 Vendor-Specific-Parameters

GET-PARAMS method also handle vendor-specific-parameter named :

com.acapela-group.server_info

This parameter will return a string containing TTS server status information.

String format is the following :

///

status TTS server status (UNKNOWN, OFF, RUNNING,DOWN)

current-nb-channel Current number of loaded channels on TTS server

auth-max-rt-rateauth-max-nb-channel auth-max-rt-rate = n and auth-max-nb-channel = -1

means that server works in standard mode; thespeech generation rate is limited to n but the number of TTS channels that can be created is unlimited;

auth-max-rt-rate = n and auth-max-nb-channel = m means that server works in standard mode with channel number limit; the speech generation rate is limited to n AND the number of TTS channels that can be created is limited to m

NOTE : see NSCAPI User Manual : 4488-TEC-DOC-BELE-192.pdf, 5.2 NSC_SRVINFO_DATA for more information).

3.1.2 CONTROL

Following header fields are supported :o Channel-Identifiero Prosody-rateo Prosody-volume

3.1.1 STOP and BARGE-IN-OCCURRED

These 2 commands are handeled identically.Following header fields are supported :

o Channel-Identifier



Reference manual

Date : 2012/02/22

Page : 28/31

Add-MRCP2-ATel

3.1.1 PAUSE

Following header fields are supported :o Channel-Identifier

3.1.1 RESUME

Following header fields are supported :o Channel-Identifier

3.2 Unsupported MRCP commands

The following commands are not supoorted :

DEFINE-LEXICON

3.3 Supported MRCP events

The following events are supported :

SPEAK-COMPLETE

SPEECH-MARKER

3.3.1 SPEAK-COMPLETE

SPEAK-COMPLETE event includes :

Completion-Cause header field indicating the status of SPEAK request (success or error,

Completion-Reason header field indicating reason of failure and NSCAPI error code when SPEAK fails because of TTS Server error.

3.3.2 SPEECH-MARKER

Supported with Acapela TTS Server native tags :

\mrk=nnnn\

\notif={nnnn}

and with SSML tag :



Reference manual

Date : 2012/02/22

Page : 29/31

Add-MRCP2-ATel

4 Appendix A : Integrated solutions

Some useful links to integrated solutions compatibles with uniMRCP :

FreeSWITCH integration

Asterisk integration



Reference manual

Date : 2012/02/22

Page : 30/31

Add-MRCP2-ATel

5 Appendix B : List of NSCAPI languages identifiers

This is the list of (Windows) language identifiers known by NSCAPI.

Identifier Language1025 Arabic (Saudi Arabia)1043 Dutch2067 Dutch (Belgium)1033 English (United States)2057 English (United Kingdom)1036 French3084 French (Canada)1031 German1040 Italian1045 Polish1046 Brazilian1049 Russian1034 Spanish21514 Spanish (United States)1029 Czech1055 Turkish1030 Danish1032 Greek2070 Portuguese1039 Icelandic1035 Finnish1053 Swedish1044 Norwegian1080 Faeroese16393 Indian English1027 Catalan2077 Finland Swedish3081 Australian1041 Japanese2052 Chinese



Reference manual

Date : 2012/02/22

Page : 31/31

Add-MRCP2-ATel

Identifier Language1042 Korean

The full list is available at: http://msdn.microsoft.com/en-us/library/ms776260.aspx


1 Foreword2 Prerequisites2.1 For a Windows based application2.1 For a Linux based application

1 Reference documents1.1 From IETF1.1 From Acapela1.1.1 For Windows1.1.2 For Linux

2 Usage2.1 Generalities2.2 Acapela MRCP-2 service/daemon2.2.1 Windows service2.2.1.1 Options

2.2.2 Linux daemon

2.3 Command line2.3.1 Option : r | --root-dir path2.3.1.1 Windows2.3.1.2 Linux

2.3.2 Option : -l | --log-prio priority2.3.3 Option : -o | --log-ouptput2.3.4 Option : -s | --service (Windows) only2.3.5 Option : -d | --daemon (Linux only)2.3.6 Option : -h | --help

2.4 MRCP Interface2.1 Configuration files

1 Server configuration1.1 Configuration format1.1 Properties1.2 Components 1.2.1 Factory of MRCP resources1.2.2 Session management agents1.2.2.1 MRCP V2 session management1.2.2.2 MRCP V1 session management

1.2.3 MRCP V2 connection agent1.2.4 Media processing engines1.2.5 Factory of RTP terminations1.2.6 Factory of plugins/resource engines

1.1 Settings1.1.1 RTP settings1.1.1.1 RTCP protocol1.1.1.1.1 Enabling1.1.1.1.2 Transmission of RTCP reports 1.1.1.1.3 Transmission of an RTCP BYE packet1.1.1.1.4 Reception of RTCP packets

1.2 Profiles

2 AcapelaTTS plugin configuration2.1 Configuration format2.1 Settings2.1.1 Connection settings2.1.1.1 Alternative TTS server2.1.1.2 Watchdog

2.1.2 Flow control settings2.1.3 TTS settings2.1.1 Log/trace settings2.1.1.1 NSCAPI2.1.1.2 Plugin

2.2 Profile2.2.1 Default languages & voices2.2.1.1 Default language2.2.1.1.1 Default gender and voice per language

3 Features3.1 Supported MRCP commands3.1.1 SPEAK3.1.1 SET-PARAMS3.1.1 GET-PARAMS3.1.1.1 Vendor-Specific-Parameters

3.1.2 CONTROL3.1.1 STOP and BARGE-IN-OCCURRED3.1.1 PAUSE3.1.1 RESUME

3.2 Unsupported MRCP commands3.3 Supported MRCP events3.3.1 SPEAK-COMPLETE3.3.2 SPEECH-MARKER

4 Appendix A : Integrated solutions 5 Appendix B : List of NSCAPI languages identifiers

MRCP-2-ATel

Documents

acapela mrcp

service windows

daemon linux

windows based application

linux based application

addonserverreference

mrcp2atelacapela group3939

initial version rdb