Synthesizer SET-PARAMS
The SET-PARAMS method, sent from the client to the server, sets or modifies the synthesizer context parameters—speech language, voice, and prosody settings. Values set this way persist for the session, establishing the defaults that subsequent requests inherit.
Many of these parameters can also be supplied directly on another method, such as SPEAK, in which case they apply to that request only and override the session defaults. If the server accepts the supplied parameters, it responds with a Status-Code of 200.
The headers below can be used with SET-PARAMS and GET-PARAMS for the synthesizer resource. The table records whether each header is defined in MRCPv1, defined in MRCPv2, and supported on Capacity Private Cloud.
Header | MRCP V1 | MRCP V2 | Platform Support |
Jump-Size | — | ✓ | — |
Jump-Target | ✓ | — | — |
Speaker-Profile | ✓ | ✓ | — |
Completion-Cause | ✓ | ✓ | ✓ |
Completion-Reason | — | ✓ | ✓ |
Voice-Parameter | ✓ | ✓ | ✓ |
Prosody-Parameter | ✓ | ✓ | ✓ |
Speech-Marker | ✓ | ✓ | ✓ |
Speech-Language | ✓ | ✓ | ✓ |
Fetch-Hint | ✓ | ✓ | — |
Auto-Fetch-Hint | ✓ | ✓ | — |
Failed-URI | ✓ | ✓ | — |
Failed-URI-Cause | ✓ | ✓ | — |
Speak-Restart | ✓ | ✓ | — |
Speak-Length | ✓ | ✓ | — |
Load-Lexicon | — | ✓ | — |
Lexicon-Search-Order | — | ✓ | — |
✓ = defined or supported | — = not defined in that version, or not supported on the platform
For voice and prosody selection, the platform maintains default settings in the client_property.conf file and also supports SSML, which offers a rich set of formatting options and is recommended wherever possible.
MRCPv1 example
Setting the synthesizer voice gender for the session:
| C->S: SET-PARAMS 543256 MRCP/1.0 Voice-Gender:female S->C: MRCP/1.0 543256 200 COMPLETE |
MRCPv2 example
The same request in MRCPv2, with the Channel-Identifier header:
| C->S: MRCP/2.0 ... SET-PARAMS 543256 Channel-Identifier:32AECB23433802@speechsynth Voice-Gender:female S->C: MRCP/2.0 ... 543256 200 COMPLETE Channel-Identifier:32AECB23433802@speechsynth |
