Asterisk - The Open Source Telephony Project GIT-master-f36a736
Public Member Functions | Data Fields
ast_speech_engine Struct Reference

#include <speech.h>

Collaboration diagram for ast_speech_engine:
Collaboration graph
[legend]

Public Member Functions

 AST_LIST_ENTRY (ast_speech_engine) list
 

Data Fields

int(* activate )(struct ast_speech *speech, const char *grammar_name)
 
int(* change )(struct ast_speech *speech, const char *name, const char *value)
 
int(* change_results_type )(struct ast_speech *speech, enum ast_speech_results_type results_type)
 
int(* create )(struct ast_speech *speech, struct ast_format *format)
 
int(* deactivate )(struct ast_speech *speech, const char *grammar_name)
 
int(* destroy )(struct ast_speech *speech)
 
int(* dtmf )(struct ast_speech *speech, const char *dtmf)
 
struct ast_format_capformats
 
struct ast_speech_result *(* get )(struct ast_speech *speech)
 
int(* get_setting )(struct ast_speech *speech, const char *name, char *buf, size_t len)
 
int(* load )(struct ast_speech *speech, const char *grammar_name, const char *grammar)
 
char * name
 
int(* start )(struct ast_speech *speech)
 
int(* unload )(struct ast_speech *speech, const char *grammar_name)
 
int(* write )(struct ast_speech *speech, void *data, int len)
 

Detailed Description

Definition at line 76 of file speech.h.

Member Function Documentation

◆ AST_LIST_ENTRY()

AST_LIST_ENTRY ( ast_speech_engine  )

Field Documentation

◆ activate

int(* activate) (struct ast_speech *speech, const char *grammar_name)

Activate a loaded grammar

Definition at line 88 of file speech.h.

Referenced by ast_speech_grammar_activate().

◆ change

int(* change) (struct ast_speech *speech, const char *name, const char *value)

Change an engine specific setting

Definition at line 98 of file speech.h.

Referenced by ast_speech_change(), and speech_engine_alloc().

◆ change_results_type

int(* change_results_type) (struct ast_speech *speech, enum ast_speech_results_type results_type)

Change the type of results we want back

Definition at line 102 of file speech.h.

Referenced by ast_speech_change_results_type(), and speech_engine_alloc().

◆ create

int(* create) (struct ast_speech *speech, struct ast_format *format)

Set up the speech structure within the engine

Definition at line 80 of file speech.h.

Referenced by ast_speech_new(), ast_speech_register(), should_unregister(), and speech_engine_alloc().

◆ deactivate

int(* deactivate) (struct ast_speech *speech, const char *grammar_name)

Deactivate a loaded grammar

Definition at line 90 of file speech.h.

Referenced by ast_speech_grammar_deactivate().

◆ destroy

int(* destroy) (struct ast_speech *speech)

Destroy any data set on the speech structure by the engine

Definition at line 82 of file speech.h.

Referenced by ast_speech_destroy(), ast_speech_register(), and speech_engine_alloc().

◆ dtmf

int(* dtmf) (struct ast_speech *speech, const char *dtmf)

Signal DTMF was received

Definition at line 94 of file speech.h.

Referenced by ast_speech_dtmf(), and speech_engine_alloc().

◆ formats

Accepted formats by the engine

Definition at line 106 of file speech.h.

Referenced by ast_speech_new(), load_engine(), speech_engine_alloc(), speech_engine_alloc_and_register(), and speech_engine_destroy().

◆ get

struct ast_speech_result *(* get) (struct ast_speech *speech)

◆ get_setting

int(* get_setting) (struct ast_speech *speech, const char *name, char *buf, size_t len)

Get an engine specific setting

Definition at line 100 of file speech.h.

Referenced by ast_speech_get_setting(), and speech_engine_alloc().

◆ load

int(* load) (struct ast_speech *speech, const char *grammar_name, const char *grammar)

Load a local grammar on the speech structure

Definition at line 84 of file speech.h.

Referenced by ast_speech_grammar_load(), ApiDeclaration::load_file(), and ResourceListing::load_file().

◆ name

char* name

◆ start

int(* start) (struct ast_speech *speech)

Prepare engine to accept audio

Definition at line 96 of file speech.h.

Referenced by ast_speech_start(), and speech_engine_alloc().

◆ unload

int(* unload) (struct ast_speech *speech, const char *grammar_name)

Unload a local grammar

Definition at line 86 of file speech.h.

Referenced by ast_speech_grammar_unload().

◆ write

int(* write) (struct ast_speech *speech, void *data, int len)

Write audio to the speech engine

Definition at line 92 of file speech.h.

Referenced by ast_speech_register(), ast_speech_write(), speech_engine_alloc(), and MultiOrderedConfigParser::write().


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