This topic includes details
of the parameters required to close a session with the MRCP text-to-speech
server engine and return codes.
Purpose
Use this state table to close a
session with an MRCP Server TTS engine. The resource should be explicitly
freed when no longer required.
All resources must be freed
before the application terminates otherwise the MST custom server
will raise an error and may need to be stopped and restarted.
Parameters
Input
- session_id (Number)
- The session identifier allocated on the successful
call to MST_TTS_Assign.
Output
- return_code (Number)
- Contains the result of the action. See below for details.
Return codes
- 0 - Succeeded Session closed.
- The TTS engine has been freed and may be allocated to another
application.
- 8 - Invalid session
- The session ID specified was not valid.
- 10 - Failed
- An unexpected problem occurred. More details about the exact error
will be logged to the Blueworx Voice Response error log.