ASR/TTS Functions
[Core Library]

Functions
switch_status_t	switch_core_speech_open (_In_ switch_speech_handle_t *sh, const char *module_name, const char *voice_name, _In_ unsigned int rate, _In_ unsigned int interval, switch_speech_flag_t *flags, _In_ switch_memory_pool_t *pool)
	Open a speech handle.
switch_status_t	switch_core_speech_feed_tts (switch_speech_handle_t *sh, char *text, switch_speech_flag_t *flags)
	Feed text to the TTS module.
void	switch_core_speech_flush_tts (switch_speech_handle_t *sh)
	Flush TTS audio on a given handle.
void	switch_core_speech_text_param_tts (switch_speech_handle_t *sh, char *param, const char *val)
	Set a text parameter on a TTS handle.
void	switch_core_speech_numeric_param_tts (switch_speech_handle_t *sh, char *param, int val)
	Set a numeric parameter on a TTS handle.
void	switch_core_speech_float_param_tts (switch_speech_handle_t *sh, char *param, double val)
	Set a float parameter on a TTS handle.
switch_status_t	switch_core_speech_read_tts (switch_speech_handle_t *sh, void *data, switch_size_t *datalen, uint32_t *rate, switch_speech_flag_t *flags)
	Read rendered audio from the TTS module.
switch_status_t	switch_core_speech_close (switch_speech_handle_t *sh, switch_speech_flag_t *flags)
	Close an open speech handle.
switch_status_t	switch_core_asr_open (switch_asr_handle_t *ah, const char *module_name, const char *codec, int rate, const char *dest, switch_asr_flag_t *flags, switch_memory_pool_t *pool)
	Open an asr handle.
switch_status_t	switch_core_asr_close (switch_asr_handle_t *ah, switch_asr_flag_t *flags)
	Close an asr handle.
switch_status_t	switch_core_asr_feed (switch_asr_handle_t *ah, void *data, unsigned int len, switch_asr_flag_t *flags)
	Feed audio data to an asr handle.
switch_status_t	switch_core_asr_check_results (switch_asr_handle_t *ah, switch_asr_flag_t *flags)
	Check an asr handle for results.
switch_status_t	switch_core_asr_get_results (switch_asr_handle_t *ah, char **xmlstr, switch_asr_flag_t *flags)
	Get results from an asr handle.
switch_status_t	switch_core_asr_load_grammar (switch_asr_handle_t *ah, const char *grammar, const char *path)
	Load a grammar to an asr handle.
switch_status_t	switch_core_asr_unload_grammar (switch_asr_handle_t *ah, const char *grammar)
	Unload a grammar from an asr handle.
switch_status_t	switch_core_asr_pause (switch_asr_handle_t *ah)
	Pause detection on an asr handle.
switch_status_t	switch_core_asr_resume (switch_asr_handle_t *ah)
	Resume detection on an asr handle.

---

Function Documentation

switch_status_t switch_core_asr_check_results (  switch_asr_handle_t *  ah, switch_asr_flag_t *  flags )

Check an asr handle for results. Parameters: ah  the handle to check flags  flags to influence behaviour Returns: SWITCH_STATUS_SUCCESS { switch_assert(ah != NULL); return ah->asr_interface->asr_check_results(ah, flags); }

switch_status_t switch_core_asr_close (  switch_asr_handle_t *  ah, switch_asr_flag_t *  flags )

Close an asr handle. Parameters: ah  the handle to close flags  flags to influence behaviour Returns: SWITCH_STATUS_SUCCESS { switch_status_t status; switch_assert(ah != NULL); status = ah->asr_interface->asr_close(ah, flags); if (switch_test_flag(ah, SWITCH_ASR_FLAG_FREE_POOL)) { switch_core_destroy_memory_pool(&ah->memory_pool); } return status; }

switch_status_t switch_core_asr_feed (  switch_asr_handle_t *  ah, void *  data, unsigned int  len, switch_asr_flag_t *  flags )

Feed audio data to an asr handle. Parameters: ah  the handle to feed data to data  a pointer to the data len  the size in bytes of the data flags  flags to influence behaviour Returns: SWITCH_STATUS_SUCCESS { switch_assert(ah != NULL); return ah->asr_interface->asr_feed(ah, data, len, flags); }

switch_status_t switch_core_asr_get_results (  switch_asr_handle_t *  ah, char **  xmlstr, switch_asr_flag_t *  flags )

Get results from an asr handle. Parameters: ah  the handle to get results from xmlstr  a pointer to dynamically allocate an xml result string to flags  flags to influence behaviour Returns: SWITCH_STATUS_SUCCESS { switch_assert(ah != NULL); return ah->asr_interface->asr_get_results(ah, xmlstr, flags); }

switch_status_t switch_core_asr_load_grammar (  switch_asr_handle_t *  ah, const char *  grammar, const char *  path )

Load a grammar to an asr handle. Parameters: ah  the handle to load to grammar  the name of the grammar path  the path to the grammaar file Returns: SWITCH_STATUS_SUCCESS { char *epath = NULL; switch_status_t status; switch_assert(ah != NULL); if (!switch_is_file_path(path)) { epath = switch_mprintf("%s%s%s", SWITCH_GLOBAL_dirs.grammar_dir, SWITCH_PATH_SEPARATOR, path); path = epath; } status = ah->asr_interface->asr_load_grammar(ah, grammar, path); switch_safe_free(epath); return status; }

Here is the call graph for this function:

switch_status_t switch_core_asr_open (  switch_asr_handle_t *  ah, const char *  module_name, const char *  codec, int  rate, const char *  dest, switch_asr_flag_t *  flags, switch_memory_pool_t *  pool )

Open an asr handle. Parameters: ah  the asr handle to open module_name  the name of the asr module codec  the preferred codec rate  the preferred rate dest  the destination address flags  flags to influence behaviour pool  the pool to use (NULL for new pool) Returns: SWITCH_STATUS_SUCCESS if the asr handle was opened { switch_status_t status; char buf[256] = ""; char *param = NULL; if (strchr(module_name, '@')) { switch_set_string(buf, module_name); if ((param = strchr(buf, '@'))) { *param++ = '\0'; module_name = buf; } } switch_assert(ah != NULL); if ((ah->asr_interface = switch_loadable_module_get_asr_interface(module_name)) == 0) { switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "invalid asr module [%s]!\n", module_name); return SWITCH_STATUS_GENERR; } ah->flags = *flags; if (pool) { ah->memory_pool = pool; } else { if ((status = switch_core_new_memory_pool(&ah->memory_pool)) != SWITCH_STATUS_SUCCESS) { return status; } switch_set_flag(ah, SWITCH_ASR_FLAG_FREE_POOL); } if (param) { ah->param = switch_core_strdup(ah->memory_pool, param); } ah->rate = rate; ah->name = switch_core_strdup(ah->memory_pool, module_name); return ah->asr_interface->asr_open(ah, codec, rate, dest, flags); }

Here is the call graph for this function:

switch_status_t switch_core_asr_pause (  switch_asr_handle_t *  ah  )

Pause detection on an asr handle. Parameters: ah  the handle to pause Returns: SWITCH_STATUS_SUCCESS { switch_assert(ah != NULL); return ah->asr_interface->asr_pause(ah); }

switch_status_t switch_core_asr_resume (  switch_asr_handle_t *  ah  )

Resume detection on an asr handle. Parameters: ah  the handle to resume Returns: SWITCH_STATUS_SUCCESS { switch_assert(ah != NULL); return ah->asr_interface->asr_resume(ah); }

switch_status_t switch_core_asr_unload_grammar (  switch_asr_handle_t *  ah, const char *  grammar )

Unload a grammar from an asr handle. Parameters: ah  the handle to unload the grammar from grammar  the grammar to unload Returns: SWITCH_STATUS_SUCCESS { switch_status_t status; switch_assert(ah != NULL); status = ah->asr_interface->asr_unload_grammar(ah, grammar); return status; }

switch_status_t switch_core_speech_close (  switch_speech_handle_t *  sh, switch_speech_flag_t *  flags )

Close an open speech handle. Parameters: sh  the speech handle to close flags  flags in/out for fine tuning Returns: SWITCH_STATUS_SUCCESS if the file handle was closed { switch_status_t status = sh->speech_interface->speech_close(sh, flags); if (switch_test_flag(sh, SWITCH_SPEECH_FLAG_FREE_POOL)) { switch_core_destroy_memory_pool(&sh->memory_pool); } return status; }

switch_status_t switch_core_speech_feed_tts (  switch_speech_handle_t *  sh, char *  text, switch_speech_flag_t *  flags )

Feed text to the TTS module. Parameters: sh  the speech handle to feed text  the buffer to write flags  flags in/out for fine tuning Returns: SWITCH_STATUS_SUCCESS with len adjusted to the bytes written if successful { switch_assert(sh != NULL); return sh->speech_interface->speech_feed_tts(sh, text, flags); }

void switch_core_speech_float_param_tts (  switch_speech_handle_t *  sh, char *  param, double  val )

Set a float parameter on a TTS handle. Parameters: sh  the speech handle param  the parameter val  the value { switch_assert(sh != NULL); if (sh->speech_interface->speech_float_param_tts) { sh->speech_interface->speech_float_param_tts(sh, param, val); } }

void switch_core_speech_flush_tts (  switch_speech_handle_t *  sh  )

Flush TTS audio on a given handle. Parameters: sh  the speech handle { switch_assert(sh != NULL); if (sh->speech_interface->speech_flush_tts) { sh->speech_interface->speech_flush_tts(sh); } }

void switch_core_speech_numeric_param_tts (  switch_speech_handle_t *  sh, char *  param, int  val )

Set a numeric parameter on a TTS handle. Parameters: sh  the speech handle param  the parameter val  the value { switch_assert(sh != NULL); if (sh->speech_interface->speech_numeric_param_tts) { sh->speech_interface->speech_numeric_param_tts(sh, param, val); } }

switch_status_t switch_core_speech_open (  _In_ switch_speech_handle_t *  sh, const char *  module_name, const char *  voice_name, _In_ unsigned int  rate, _In_ unsigned int  interval, switch_speech_flag_t *  flags, _In_ switch_memory_pool_t *  pool )

Open a speech handle. Parameters: sh  a speech handle to use module_name  the speech module to use voice_name  the desired voice name rate  the sampling rate interval  the sampling interval flags  tts flags pool  the pool to use (NULL for new pool) Returns: SWITCH_STATUS_SUCCESS if the handle is opened

switch_status_t switch_core_speech_read_tts (  switch_speech_handle_t *  sh, void *  data, switch_size_t *  datalen, uint32_t *  rate, switch_speech_flag_t *  flags )

Read rendered audio from the TTS module. Parameters: sh  the speech handle to read data  the buffer to read to datalen  the max size / written size of the data rate  the rate of the read audio flags  flags in/out for fine tuning Returns: SWITCH_STATUS_SUCCESS with len adjusted to the bytes written if successful { switch_assert(sh != NULL); return sh->speech_interface->speech_read_tts(sh, data, datalen, rate, flags); }

void switch_core_speech_text_param_tts (  switch_speech_handle_t *  sh, char *  param, const char *  val )

Set a text parameter on a TTS handle. Parameters: sh  the speech handle param  the parameter val  the value { switch_assert(sh != NULL); if (sh->speech_interface->speech_text_param_tts) { sh->speech_interface->speech_text_param_tts(sh, param, val); } }

---