#include <mrcp_recog_header.h>
Detailed Description
MRCP recognizer-header
Field Documentation
◆ abort_phrase_enrollment
| apt_bool_t mrcp_recog_header_t::abort_phrase_enrollment |
Can optionally be specified in the END-PHRASE-ENROLLMENT method to abort the phrase enrollment, rather than committing the phrase to the personal grammar
◆ cancel_if_queue
| apt_bool_t mrcp_recog_header_t::cancel_if_queue |
Specifies what will happen if the client attempts to invoke another RECOGNIZE method when this RECOGNIZE request is already in progress for the resource
◆ clash_threshold
| float mrcp_recog_header_t::clash_threshold |
MAY be sent as part of the START-PHRASE-ENROLLMENT, SET-PARAMS, or "GET-PARAMS" method and is used during voice-enrollment to specify how similar the pronunciations of two different phrases can be before they are considered to be clashing
◆ clear_dtmf_buffer
| apt_bool_t mrcp_recog_header_t::clear_dtmf_buffer |
MAY be specified in a RECOGNIZE method and is used to tell the recognizer to clear the DTMF type-ahead buffer before starting the recognize
◆ completion_cause
| mrcp_recog_completion_cause_e mrcp_recog_header_t::completion_cause |
MUST be part of a RECOGNITION-COMPLETE, event coming from the recognizer resource to the client
◆ completion_reason
| apt_str_t mrcp_recog_header_t::completion_reason |
MAY be specified in a RECOGNITION-COMPLETE event coming from the recognizer resource to the client
◆ confidence_threshold
| float mrcp_recog_header_t::confidence_threshold |
Tells the recognizer resource what confidence level the client considers a successful match
◆ confusable_phrases_uri
| apt_str_t mrcp_recog_header_t::confusable_phrases_uri |
Specifies a grammar that defines invalid phrases for enrollment
◆ consistency_threshold
| float mrcp_recog_header_t::consistency_threshold |
MAY be sent as part of the START-PHRASE-ENROLLMENT,"SET-PARAMS", or "GET-PARAMS" method and is used during voice-enrollment to specify how similar to a previously enrolled pronunciation of the same phrase an utterance needs to be in order to be considered "consistent"
◆ dtmf_buffer_time
| apr_size_t mrcp_recog_header_t::dtmf_buffer_time |
MAY be specified in a GET-PARAMS or SET-PARAMS method and is used to specify the size in time, in milliseconds, of the typeahead buffer for the recognizer
◆ dtmf_interdigit_timeout
| apr_size_t mrcp_recog_header_t::dtmf_interdigit_timeout |
Specifies the inter-digit timeout value to use when recognizing DTMF input
◆ dtmf_term_char
| char mrcp_recog_header_t::dtmf_term_char |
Specifies the terminating DTMF character for DTMF input recognition
◆ dtmf_term_timeout
| apr_size_t mrcp_recog_header_t::dtmf_term_timeout |
Specifies the terminating timeout to use when recognizing DTMF input
◆ early_no_match
| apt_bool_t mrcp_recog_header_t::early_no_match |
MAY be specified in a RECOGNIZE method and is used to tell the recognizer that it MUST not wait for the end of speech before processing the collected speech to match active grammars
◆ enroll_utterance
| apt_bool_t mrcp_recog_header_t::enroll_utterance |
MAY be specified in the RECOGNIZE method. If this header is set to "true" and an Enrollment is active, the RECOGNIZE command MUST add the collected utterance to the personal grammar that is being enrolled
◆ failed_uri
| apt_str_t mrcp_recog_header_t::failed_uri |
When a recognizer needs to fetch or access a URI and the access fails the server SHOULD provide the failed URI in this header in the method response
◆ failed_uri_cause
| apt_str_t mrcp_recog_header_t::failed_uri_cause |
When a recognizer method needs a recognizer to fetch or access a URI and the access fails the server MUST provide the URI specific or protocol specific response code for the URI in the Failed-URI header
◆ hotword_max_duration
| apr_size_t mrcp_recog_header_t::hotword_max_duration |
Specifies the maximum length of an utterance (in seconds) that will be considered for Hotword recognition
◆ hotword_min_duration
| apr_size_t mrcp_recog_header_t::hotword_min_duration |
Specifies the minimum length of an utterance (in seconds) that will be considered for Hotword recognition
◆ input_type
| apt_str_t mrcp_recog_header_t::input_type |
Additional header fields for MRCP v2 Specifies if the input that caused a barge-in was DTMF or speech
◆ input_waveform_uri
| apt_str_t mrcp_recog_header_t::input_waveform_uri |
Optional header specifies a URI pointing to audio content to be processed by the RECOGNIZE operation
◆ interpret_text
| apt_str_t mrcp_recog_header_t::interpret_text |
Provides a pointer to the text for which a natural language interpretation is desired
◆ media_type
| apt_str_t mrcp_recog_header_t::media_type |
Tells the server resource the Media Type in which to store captured audio such as the one captured and returned by the Waveform-URI header
◆ n_best_list_length
| apr_size_t mrcp_recog_header_t::n_best_list_length |
The client, by setting this header, can ask the recognition resource to send it more than 1 alternative
◆ new_audio_channel
| apt_bool_t mrcp_recog_header_t::new_audio_channel |
MAY be specified in a RECOGNIZE request and allows the client to tell the server that, from this point on, further input audio comes from a different audio source
◆ new_phrase_id
| apt_str_t mrcp_recog_header_t::new_phrase_id |
Replaces the id used to identify the phrase in a personal grammar
◆ no_input_timeout
| apr_size_t mrcp_recog_header_t::no_input_timeout |
The client can use the no-input-timeout header to set this timeout
◆ num_min_consistent_pronunciations
| apr_size_t mrcp_recog_header_t::num_min_consistent_pronunciations |
MAY be specified in a START-PHRASE-ENROLLMENT, "SET-PARAMS", or "GET-PARAMS" method and is used to specify the minimum number of consistent pronunciations that must be obtained to voice enroll a new phrase
◆ personal_grammar_uri
| apt_str_t mrcp_recog_header_t::personal_grammar_uri |
Specifies the speaker-trained grammar to be used or referenced during enrollment operations
◆ phrase_id
| apt_str_t mrcp_recog_header_t::phrase_id |
Identifies a phrase in an existing personal grammar for which enrollment is desired. It is also returned to the client in the RECOGNIZE complete event
◆ phrase_nl
| apt_str_t mrcp_recog_header_t::phrase_nl |
Specifies the interpreted text to be returned when the phrase is recognized
◆ recognition_mode
| apt_str_t mrcp_recog_header_t::recognition_mode |
Specifies what mode the RECOGNIZE method will operate in
◆ recognition_timeout
| apr_size_t mrcp_recog_header_t::recognition_timeout |
The client can use the recognition-timeout header to set this timeout
◆ recognizer_context_block
| apt_str_t mrcp_recog_header_t::recognizer_context_block |
MAY be sent as part of the SET-PARAMS or GET-PARAMS request
◆ save_best_waveform
| apt_bool_t mrcp_recog_header_t::save_best_waveform |
Allows the client to request the recognizer resource to save the audio stream for the best repetition of the phrase that was used during the enrollment session
◆ save_waveform
| apt_bool_t mrcp_recog_header_t::save_waveform |
Allows the client to request the recognizer resource to save the audio input to the recognizer
◆ sensitivity_level
| float mrcp_recog_header_t::sensitivity_level |
To filter out background noise and not mistake it for speech
◆ speech_complete_timeout
| apr_size_t mrcp_recog_header_t::speech_complete_timeout |
Specifies the length of silence required following user speech before the speech recognizer finalizes a result
◆ speech_incomplete_timeout
| apr_size_t mrcp_recog_header_t::speech_incomplete_timeout |
Specifies the required length of silence following user speech after which a recognizer finalizes a result
◆ speech_language
| apt_str_t mrcp_recog_header_t::speech_language |
Specifies the language of recognition grammar data within a session or request, if it is not specified within the data
◆ speed_vs_accuracy
| float mrcp_recog_header_t::speed_vs_accuracy |
Tunable towards Performance or Accuracy
◆ start_input_timers
| apt_bool_t mrcp_recog_header_t::start_input_timers |
MAY be sent as part of the RECOGNIZE request. A value of false tells the recognizer to start recognition, but not to start the no-input timer yet
◆ ver_buffer_utterance
| apt_bool_t mrcp_recog_header_t::ver_buffer_utterance |
Lets the client request the server to buffer the utterance associated with this recognition request into a buffer available to a co-resident verification resource
◆ waveform_uri
| apt_str_t mrcp_recog_header_t::waveform_uri |
MUST be present in the RECOGNITION-COMPLETE event if the Save-Waveform header was set to true
◆ weight
| float mrcp_recog_header_t::weight |
Represents the occurrence likelihood of a phrase in an enrolled grammar
The documentation for this struct was generated from the following file:
