This topic includes details of the parameters required to
open a session with the MRCP V1.0 text-to-speech server engine and return codes.
Purpose
Use this state table to open a session with the MRCP V1.0 text-to-speech server.
Parameters
Input
- engine_type (String)
- The type (name) of the TTS engine to be used. This should correspond to the type of an engine
configured on an available TTS engine server. This state table only assigns a TTS engine. The mst.xml file will contain
mapping between engine_type (for example, gbtts) and a specific MRCP V1.0 server (for example,
machine.speechtech.com, port 554).
Output
- return_code (Number)
- Contains the result of the action. See below for details.
- session_id (Number)
- If successful a session identifier is returned. This is used on
all subsequent actions to access the same session.
- log_id (String)
- If successful a log identifier is returned. This is used by the
API as an identifier that is associated with all log information created
for this session. It is provided for the application's use to relate
its logging for this session to that of the API.
Return codes
- 0 - Success
- An engine of the specified type is now allocated.
- 1 - Maximum number of sessions already opened
- The maximum number of sessions have already been opened
- 2 - No free engine
- A free engine of the type specified could not be accessed on the specified MRCP V1.0 server
- 7 - Protocol error
- The text-to-speech
server has reported a protocol error. More details about the exact
error will be logged to the Blueworx Voice Response error log.
- 9 - Parameter error
- A parameter is in error (for example, a parameter is too long). More details about the exact
error will be logged to the Blueworx Voice Response error log.
- 10 - Failed
- An unexpected problem occurred. More details about the exact error
will be logged to the Blueworx Voice Response error log.