RTS API Documentation  1.10.11
Data Fields
switch_asr_interface Struct Reference

Abstract interface to an asr module. More...

#include <switch_module_interfaces.h>

+ Collaboration diagram for switch_asr_interface:

Data Fields

const char * interface_name
 
switch_status_t(* asr_open )(switch_asr_handle_t *ah, const char *codec, int rate, const char *dest, switch_asr_flag_t *flags)
 
switch_status_t(* asr_load_grammar )(switch_asr_handle_t *ah, const char *grammar, const char *name)
 
switch_status_t(* asr_unload_grammar )(switch_asr_handle_t *ah, const char *name)
 
switch_status_t(* asr_close )(switch_asr_handle_t *ah, switch_asr_flag_t *flags)
 
switch_status_t(* asr_feed )(switch_asr_handle_t *ah, void *data, unsigned int len, switch_asr_flag_t *flags)
 
switch_status_t(* asr_resume )(switch_asr_handle_t *ah)
 
switch_status_t(* asr_pause )(switch_asr_handle_t *ah)
 
switch_status_t(* asr_check_results )(switch_asr_handle_t *ah, switch_asr_flag_t *flags)
 
switch_status_t(* asr_get_results )(switch_asr_handle_t *ah, char **xmlstr, switch_asr_flag_t *flags)
 
switch_status_t(* asr_get_result_headers )(switch_asr_handle_t *ah, switch_event_t **headers, switch_asr_flag_t *flags)
 
switch_status_t(* asr_start_input_timers )(switch_asr_handle_t *ah)
 
void(* asr_text_param )(switch_asr_handle_t *ah, char *param, const char *val)
 
void(* asr_numeric_param )(switch_asr_handle_t *ah, char *param, int val)
 
void(* asr_float_param )(switch_asr_handle_t *ah, char *param, double val)
 
switch_thread_rwlock_trwlock
 
int refs
 
switch_mutex_treflock
 
switch_loadable_module_interface_tparent
 
struct switch_asr_interfacenext
 
switch_status_t(* asr_enable_grammar )(switch_asr_handle_t *ah, const char *name)
 
switch_status_t(* asr_disable_grammar )(switch_asr_handle_t *ah, const char *name)
 
switch_status_t(* asr_disable_all_grammars )(switch_asr_handle_t *ah)
 
switch_status_t(* asr_feed_dtmf )(switch_asr_handle_t *ah, const switch_dtmf_t *dtmf, switch_asr_flag_t *flags)
 

Detailed Description

Abstract interface to an asr module.

Definition at line 390 of file switch_module_interfaces.h.

Field Documentation

◆ asr_check_results

switch_status_t(* switch_asr_interface::asr_check_results) (switch_asr_handle_t *ah, switch_asr_flag_t *flags)

function to read results from the ASR

Definition at line 408 of file switch_module_interfaces.h.

Referenced by switch_core_asr_check_results().

◆ asr_close

switch_status_t(* switch_asr_interface::asr_close) (switch_asr_handle_t *ah, switch_asr_flag_t *flags)

function to close the asr interface

Definition at line 400 of file switch_module_interfaces.h.

Referenced by switch_core_asr_close().

◆ asr_disable_all_grammars

switch_status_t(* switch_asr_interface::asr_disable_all_grammars) (switch_asr_handle_t *ah)

function to disable all grammars to the asr interface

Definition at line 428 of file switch_module_interfaces.h.

Referenced by switch_core_asr_disable_all_grammars().

◆ asr_disable_grammar

switch_status_t(* switch_asr_interface::asr_disable_grammar) (switch_asr_handle_t *ah, const char *name)

function to disable a grammar to the asr interface

Definition at line 426 of file switch_module_interfaces.h.

Referenced by switch_core_asr_disable_grammar().

◆ asr_enable_grammar

switch_status_t(* switch_asr_interface::asr_enable_grammar) (switch_asr_handle_t *ah, const char *name)

function to enable a grammar to the asr interface

Definition at line 424 of file switch_module_interfaces.h.

Referenced by switch_core_asr_enable_grammar().

◆ asr_feed

switch_status_t(* switch_asr_interface::asr_feed) (switch_asr_handle_t *ah, void *data, unsigned int len, switch_asr_flag_t *flags)

function to feed audio to the ASR

Definition at line 402 of file switch_module_interfaces.h.

Referenced by switch_core_asr_feed().

◆ asr_feed_dtmf

switch_status_t(* switch_asr_interface::asr_feed_dtmf) (switch_asr_handle_t *ah, const switch_dtmf_t *dtmf, switch_asr_flag_t *flags)

function to feed DTMF to the ASR

Definition at line 430 of file switch_module_interfaces.h.

Referenced by switch_core_asr_feed_dtmf().

◆ asr_float_param

void(* switch_asr_interface::asr_float_param) (switch_asr_handle_t *ah, char *param, double val)

Definition at line 417 of file switch_module_interfaces.h.

Referenced by switch_core_asr_float_param().

◆ asr_get_result_headers

switch_status_t(* switch_asr_interface::asr_get_result_headers) (switch_asr_handle_t *ah, switch_event_t **headers, switch_asr_flag_t *flags)

function to read result headers from the ASR

Definition at line 412 of file switch_module_interfaces.h.

Referenced by switch_core_asr_get_result_headers().

◆ asr_get_results

switch_status_t(* switch_asr_interface::asr_get_results) (switch_asr_handle_t *ah, char **xmlstr, switch_asr_flag_t *flags)

function to read results from the ASR

Definition at line 410 of file switch_module_interfaces.h.

Referenced by switch_core_asr_get_results().

◆ asr_load_grammar

switch_status_t(* switch_asr_interface::asr_load_grammar) (switch_asr_handle_t *ah, const char *grammar, const char *name)

function to load a grammar to the asr interface

Definition at line 396 of file switch_module_interfaces.h.

Referenced by switch_core_asr_load_grammar().

◆ asr_numeric_param

void(* switch_asr_interface::asr_numeric_param) (switch_asr_handle_t *ah, char *param, int val)

Definition at line 416 of file switch_module_interfaces.h.

Referenced by switch_core_asr_numeric_param().

◆ asr_open

switch_status_t(* switch_asr_interface::asr_open) (switch_asr_handle_t *ah, const char *codec, int rate, const char *dest, switch_asr_flag_t *flags)

function to open the asr interface

Definition at line 394 of file switch_module_interfaces.h.

Referenced by switch_core_asr_open().

◆ asr_pause

switch_status_t(* switch_asr_interface::asr_pause) (switch_asr_handle_t *ah)

function to pause the ASR

Definition at line 406 of file switch_module_interfaces.h.

Referenced by switch_core_asr_pause().

◆ asr_resume

switch_status_t(* switch_asr_interface::asr_resume) (switch_asr_handle_t *ah)

function to resume the ASR

Definition at line 404 of file switch_module_interfaces.h.

Referenced by switch_core_asr_resume().

◆ asr_start_input_timers

switch_status_t(* switch_asr_interface::asr_start_input_timers) (switch_asr_handle_t *ah)

function to start ASR input timers

Definition at line 414 of file switch_module_interfaces.h.

Referenced by switch_core_asr_start_input_timers().

◆ asr_text_param

void(* switch_asr_interface::asr_text_param) (switch_asr_handle_t *ah, char *param, const char *val)

Definition at line 415 of file switch_module_interfaces.h.

Referenced by switch_core_asr_text_param().

◆ asr_unload_grammar

switch_status_t(* switch_asr_interface::asr_unload_grammar) (switch_asr_handle_t *ah, const char *name)

function to unload a grammar to the asr interface

Definition at line 398 of file switch_module_interfaces.h.

Referenced by switch_core_asr_unload_grammar().

◆ interface_name

const char* switch_asr_interface::interface_name

the name of the interface

Definition at line 392 of file switch_module_interfaces.h.

Referenced by switch_loadable_module_process(), and switch_loadable_module_unprocess().

◆ next

struct switch_asr_interface* switch_asr_interface::next

◆ parent

switch_loadable_module_interface_t* switch_asr_interface::parent

Definition at line 421 of file switch_module_interfaces.h.

◆ reflock

switch_mutex_t* switch_asr_interface::reflock

Definition at line 420 of file switch_module_interfaces.h.

◆ refs

int switch_asr_interface::refs

Definition at line 419 of file switch_module_interfaces.h.

◆ rwlock

switch_thread_rwlock_t* switch_asr_interface::rwlock

Definition at line 418 of file switch_module_interfaces.h.

Referenced by switch_loadable_module_unprocess().


The documentation for this struct was generated from the following file: