Library Sdk Es

download Library Sdk Es

of 159

Transcript of Library Sdk Es

Verbio Software ReferenceReferencia de las funciones del Library SDKVerbio Technologies, S.L.

Verbio Software Reference: Referencia de las funciones del Library SDKVerbio Technologies, S.L. publicado Septiembre de 2009 Copyright 2009 Verbio Technologies, S.L.

Tabla de contenidos1. Introduccin ..................................................................................................................... 1 2. Descripcin de las funciones ................................................................................................ 3 1. vox_activatevcb ........................................................................................................ 4 2. vox_ApplyDictionary ................................................................................................. 6 3. vox_asr_init .............................................................................................................. 8 4. ATVOX_BUILTIN ...................................................................................................11 5. vox_chkwrd .............................................................................................................12 6. vox_clrrsp ...............................................................................................................13 7. vox_clrvad ..............................................................................................................14 8. vox_deactivatevcb ....................................................................................................15 9. vox_devclose ...........................................................................................................17 10. vox_dtmf_close ......................................................................................................18 11. vox_dtmf_open .......................................................................................................19 12. vox_dtmf_word ......................................................................................................20 13. vox_dtmf_write ......................................................................................................21 14. ATVOX_ERRMSGP ...............................................................................................22 15. vox_getasrlic ..........................................................................................................23 16. vox_GetDllVersion .................................................................................................25 17. vox_getparm ..........................................................................................................26 18. vox_getttslic ..........................................................................................................27 19. vox_getusedasrlic ....................................................................................................29 20. vox_getusedttslic ....................................................................................................30 21. ATVOX_IVCB ......................................................................................................31 22. ATVOX_LASTERR ................................................................................................32 23. vox_libclose ...........................................................................................................33 24. vox_libinit .............................................................................................................34 25. vox_loadcd ............................................................................................................36 26. vox_loadvcb ..........................................................................................................37 27. vox_nbest ..............................................................................................................39 28. ATVOX_NIND ......................................................................................................41 29. vox_playstr ............................................................................................................42 30. vox_playstr_close ...................................................................................................44 31. vox_playstr_open ....................................................................................................45 32. vox_playstr_read .....................................................................................................46 33. vox_playstr_release .................................................................................................47 34. vox_playstr_wait .....................................................................................................48 35. vox_prevcb ............................................................................................................49 36. vox_prevcbdev .......................................................................................................51 37. vox_prevcbex .........................................................................................................54 38. vox_prevcbex2 .......................................................................................................56 39. vox_reccfg_release ..................................................................................................59 40. vox_reccfg_wait .....................................................................................................61 41. vox_recind .............................................................................................................63 42. vox_recstr ..............................................................................................................65 43. vox_recstrm ...........................................................................................................67 44. vox_recstr_close .....................................................................................................69 45. vox_recstr_open .....................................................................................................70 46. vox_recstr_release ...................................................................................................71 47. vox_recstr_wait ......................................................................................................72 48. vox_recstr_write .....................................................................................................73 49. vox_RegisterVVICallback ........................................................................................74 50. vox_regsrvclose ......................................................................................................75 51. vox_SapiClose .......................................................................................................76 52. vox_SapiOpen ........................................................................................................77 53. vox_SapiOpenEx ....................................................................................................79 54. vox_SapiSelect .......................................................................................................80 55. vox_SerialNumber ..................................................................................................81 56. vox_SetAbbreviations ..............................................................................................81

Verbio Software Reference

57. vox_setcd ..............................................................................................................84 58. vox_SetDictionary ..................................................................................................85 59. vox_setparm ..........................................................................................................87 60. vox_setvcb ............................................................................................................88 61. vox_spk_addfile .....................................................................................................90 62. vox_spk_exist ........................................................................................................92 63. vox_spk_init ..........................................................................................................93 64. vox_spk_train .........................................................................................................94 65. vox_spk_verify .......................................................................................................96 66. vox_srvclose ..........................................................................................................98 67. vox_termplaystr ......................................................................................................99 68. vox_termrecstr ..................................................................................................... 100 69. vox_thclose .......................................................................................................... 101 70. vox_tts_init .......................................................................................................... 102 71. vox_ttsSetAbbreviations ......................................................................................... 104 72. vox_ttsSetDictionary ............................................................................................. 106 73. vox_unloadvcb ..................................................................................................... 108 74. vox_vsd_close ...................................................................................................... 110 75. vox_vsd_open ...................................................................................................... 111 76. vox_vsd_write ...................................................................................................... 113 77. vox_word ............................................................................................................ 114 78. vox_wordex ......................................................................................................... 115 79. vox_wordrule ....................................................................................................... 116 3. Estructuras de datos y parmetros ...................................................................................... 119 1. VX_RSP - Recognize String Parameter ....................................................................... 120 2. VAD_PRM - Voice Activity Detection Parameters ....................................................... 121 3. MODEATTRIBUTES - SAPI Speaker Id .................................................................... 125 4. Definicin de parmetros para vox_getparm() y vox_setparm() ....................................... 126 5. Obtencin de informacin adicional mediante vox_word o vox_wordex ............................ 134 4. Cdigo de ejemplos en C/C++ ........................................................................................... 137 1. Ejemplo Sncrono ................................................................................................... 138 2. Ejemplo de Deteccin de voz y de tonos DTMF ........................................................... 143 3. Ejemplo de uso del reconocimiento natural basado en modelos estadsticos (SLM) .............. 144 4. Ejemplo de SpeakerID ............................................................................................. 146 A. Ficheros utilizados por los ejemplos .................................................................................. 147 ndice .............................................................................................................................. 149

vi

Referencia de las funciones del Library SDK

Verbio Technologies

Lista de tablas3.1. Parmetros globales en el Library SDK ............................................................................ 126 3.2. Parmetros de canal en el Library SDK ............................................................................ 129 3.3. Elementos de un vocabulario o gramtica ABNF ................................................................ 134

Lista de ejemplos3.1. Informacin devuelta por el servidor de reconocimiento ...................................................... 135 4.1. Ejemplo sncrono de Verbio Library ................................................................................ 138 4.2. Ejemplo de Deteccin de voz y de tonos DTMF ................................................................. 143 4.3. Ejemplo de reconocimiento SLM .................................................................................... 144 4.4. Ejemplo de Verbio Library para verificacin del locutor ...................................................... 146

Captulo 1. IntroduccinEl objectivo de este documento es describir el conjunto de funciones que constituyen el Library SDK proporcionado en Verbio. Este SDK est diseado pensando en aquellos integradores que trabajan en entornos de programacin C/C++ sobre dispositivos de audio genricos (tanto tarjetas CTI como tarjetas de sonido). Es compatible con las versiones antiguas de Verbio (IberVox 6.41 y anteriores), aunque en nuevos desarrollos es aconsejable utilizar la Advanced SDK, puesto que sta facilita el uso de las nuevas funcionalidades incorporadas en Verbio (aunque este SDK slo est disponible en entornos de programacin Microsoft Visual Studio). En el Captulo 2. Descripcin de las funciones se describen todas las funciones disponibles en el SDK. En el Captulo 3. Estructuras de datos y parmetros se describen las estructuras y parmetros comunes a las funciones del SDK. En el Captulo 4. Cdigo de ejemplos en C/C++ se incluyen 2 ejemplos de utilizacin de este SDK: un ejemplo de programacin sncrona y otro de deteccin de voz (VAD) y de tonos DTMF.

Captulo 2. funciones

Descripcin

de

las

Captulo 2. Descripcin de las funciones

1. vox_activatevcbFUNCION int vox_activatevcb(int chdev, int vcbhandle, unsigned int mode) int chdev int vcbhandle unsigned int mode RETORNA descriptor de un canal vlido descriptor de un vocabulario o gramtica ABNF previamente cargado por compatibilidad con versiones anteriores, sese 0

>=0 indicando el descriptor del vocabulario si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

1.1. DescripcinLa funcin vox_activatevcb() activa el vocabulario previamente cargado en el canal especificado. El descriptor del vocabulario cargado se obtiene invocando a la funcin vox_loadvcb(). Cuando no deba utilizarse en el siguente proceso de reconocimiento, debe ser desactivado mediante la funcin vox_deactivatevcb().

1.2. Descripcin de los parmetroschdev vcbhandle mode especifica el descriptor de canal vlido. descriptor de un vocabulario o gramtica ABNF previamente cargado mediante la funcin vox_loadvcb(). por compatibilidad con versiones anteriores, sese 0

1.3. PrecaucionesEn cualquier momento, pueden estar activos varios vocabularios y gramticas. El descriptor utilizado en la funcin vox_activatevcb() debe ser el valor retornado por la funcin vox_loadvcb(). La funcin ATVOX_IVCB() retorna el descriptor asociado al vocabulario que contiene la locucin reconocida. Si se establece el vocabulario o la gramtica activa mediante la funcin vox_setvcb() o vox_setcd(), se descargarn automticamente todos los vocabularios y gramticas cargados hasta ese momento.

1.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, la funcin ATVOX_LASTERR() devolver alguno de los siguientes motivos: EVX_NOMEM EVX_VCBFILE EVX_INVWORD EVX_SYSTEM OUT OF MEMORY THE VOCABULARY FILE NAME IS NOT VALID. Check the vocabulary file name and path writing permission. THE VOCABULARY TRANSCRIPTION WAS NOT FOUND SYSTEM ERROR. Check errno.

4

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

1.5. Elementos relacionadosvox_setvcb, vox_loadvcb, vox_deactivatevcb, vox_unloadvcb, ATVOX_IVCB

1.6. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

5

Captulo 2. Descripcin de las funciones

2. vox_ApplyDictionaryFUNCION int vox_ApplyDictionary(const char *inVcbName, const char *outVcbName, const char *Dictionary) const char *inVcbName const char *outVcbName const char *Dictionary RETORNA nombre del fichero que contiene el vocabulario que debe procesarse nombre del fichero bajo el que se almacenar el fichero de vocabulario procesado nombre del fichero que contiene el vocabulario de excepciones

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

2.1. DescripcinLa funcin vox_ApplyDictionary() genera un fichero de vocabulario a partir de otro original incluyendo las excepciones y acrnimos contenidos en el diccionario especificado.

2.2. Descripcin de los parmetrosinVcbName outVcbName nombre del fichero de vocabulario original que debe ser procesado. Cada lnea debe contener una palabra del vocabulario formado por una o ms palabras. nombre del fichero que contendr el nuevo vocabulario. Cada lnea contendr una palabra del vocabulario formada por las palabras originales o bien por aquellas que hayan sido modificadas siguiendo las pautas del diccionario de excepciones. nombre del fichero de texto que contiene las excepciones que deben considerarse. Consulte Verbio Software Reference: Gua del usuario para ms informacin del formato que debe tener este un fichero de excepciones.

Dictionary

2.3. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error: EVX_NOMEM EVX_VCBFILE EVX_DICFILE OUT OF MEMORY THE VOCABULARY FILE NAME IS NOT VALID. Check the vocabulary file name and path writing permission. THE DICTIONARY FILE NAME IS NOT VALID. Check the dictionary file name.

2.4. Elementos relacionadosvox_prevcb, vox_prevcbex, vox_prevcbex2, vox_prevcbdev, vox_chkwrd

6

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

2.5. Cdigos de ejemploConsulte el ejemplo asncrono del Dialogic SDK.

Verbio Technologies

Referencia de las funciones del Library SDK

7

Captulo 2. Descripcin de las funciones

3. vox_asr_initFUNCION int vox_asr_init(const char *configuration, const char *defasrlng) const char *configuration const char *defasrlng RETORNA identificador de la configuracin de reconocimiento por defecto identificador del idioma de reconocimiento por defecto

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

3.1. DescripcinLa funcin vox_asr_init() inicializa la librera de reconocimiento del habla de Verbio. En nuevos desarrollos es recomendable utilizar esta funcin (conjuntamente con la funcin vox_tts_init en caso de que tambin se requiera sntesis del habla) en lugar de la funcin vox_libinit, puesto que permite indicar al servidor los parmetros de inicializacin de una manera mucho ms concreta.

3.2. Descripcin de los parmetrosconfiguration especifica la configuracin por defecto con la que arrancar el servidor de reconocimiento. Por configuracin de reconocimiento se entiende el idioma o idiomas soportados (en caso de configuraciones multilinges) por el servidor de reconocimiento. Cualquier proceso de reconocimiento invocado usar los modelos de reconocimiento asociados con la configuracin activa en ese momento, por lo que nicamente podr reconocerse en alguno de los idiomas contenidos en dicha configuracin. Para ms informacin, puede consultarse el documento Verbio Software Reference: Gua del Usuario. CFG_SPANISH CFG_SPANISH_CATALAN CFG_SPANISH_BASQUE CFG_SPANISH_GALICIAN CFG_SPANISH_CATALAN_BASQUE_GALICIAN CFG_PORTUGUESE CFG_PORTUGUESE_BRAZILIAN CFG_SPANISH_ARGENTINIAN CFG_SPANISH_CHILEAN CFG_SPANISH_COLOMBIAN Espaol castellano Espaol cataln Espaol euskera Espaol gallego castellano castellano castellano + + +

Espaol castellano + cataln + euskera + gallego Portugus Portugus brasileo Espaol argentino Espaol chileno Espaol colombiano

8

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

CFG_SPANISH_MEXICAN CFG_SPANISH_VENEZUELAN CFG_FRENCH CFG_ENGLISH defasrlng

Espaol mexicano Espaol venezolano Francs Ingls

especifica el idioma por defecto con el que trabaja la configuracin por defecto. En el caso de configuraciones monolinges es redundante, aunque s es imprescindible cuando se activa una configuracin multilinge. LNG_SPANISH LNG_CATALAN LNG_BASQUE LNG_GALICIAN LNG_PORTUGUESE LNG_PORTUGUESE_BRAZILIAN LNG_SPANISH_ARGENTINIAN LNG_SPANISH_CHILEAN LNG_SPANISH_COLOMBIAN LNG_SPANISH_MEXICAN LNG_SPANISH_VENEZUELAN LNG_FRENCH LNG_ENGLISH Espaol castellano Cataln Euskera Gallego Portugus Portugus brasileo Espaol argentino Espaol chileno Espaol colombiano Espaol mexicano Espaol venezolano Francs Ingls

3.3. PrecaucionesLa funcin vox_asr_init() debe invocarse antes que ninguna otra de las funciones del Library SDK relacionadas con el reconocimiento del habla, a excepcin de aquella destinada a establecer el servidor de trabajo por defecto en configuraciones cliente-servidor (vox_setparm).

3.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error: EVX_INVSETUP EVX_NOMEM EVX_NOLICFILE EVX_INVLIC VERBIO INTERNAL ERROR. Files may be corrupted. Check disk and repeat Setup. OUT OF MEMORY. NO LICENSE FILE WAS FOUND. Run CheckOut to obtain a license file. THE LICENSE FILE IS NOT VALID. Run CheckOut to obtain a valid license file.

Verbio Technologies

Referencia de las funciones del Library SDK

9

Captulo 2. Descripcin de las funciones

EVX_SYSTEM

SYSTEM ERROR.Check errno.

3.5. Elementos relacionadosvox_libinit, vox_tts_init, vox_libclose

3.6. Cdigos de ejemploConsulte el ejemplo anexo.

10

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

4. ATVOX_BUILTINFUNCION int ATVOX_BUILTIN(int chdev) int chdev RETORNA descriptor de un canal vlido

0 para indicar que el resultado del reconocimiento no procede de una gramtica built-in 1 para indicar que el resultado del reconocimiento s procede de una gramtica built-in

INCLUDES MODO

voxlib.h sncrono

4.1. DescripcinLa funcin ATVOX_BUILTIN() indica si la gramtica que ha devuelto el resultado de reconocimiento al finalizar la llamada a la funcin vox_recind() o vox_nbest() es una gramtica interna (built-in) o no.

4.2. Descripcin de los parmetroschdev especifica el descriptor de canal vlido.

4.3. PrecaucionesEl valor devuelto por la funcin ATVOX_BUILTIN() nicamente es vlido despus de la correcta finalizacin de la funcin vox_recind() o vox_nbest().

4.4. Elementos relacionadosvox_recind, vox_nbest

4.5. Cdigos de ejemploConsulte el ejemplo asncrono del Dialogic SDK.

Verbio Technologies

Referencia de las funciones del Library SDK

11

Captulo 2. Descripcin de las funciones

5. vox_chkwrdFUNCION int vox_chkwrd(const char *word, int language) const char *word unsigned int language RETORNA puntero a la palabra del vocabulario que desea verificarse idioma del vocabulario

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

5.1. DescripcinLa funcin vox_chkwrd() chequea la palabra del vocabulario especificada para garantizar que la funcin vox_prevcb() (o vox_prevcbex() o vox_prevcbex2() o vox_prevcbdev()) realizar la transcripcin de texto a fonema de forma correcta. Esta funcin es independiente del canal, por lo que nicamente debe ser llamada una vez para cada nueva palabra de los vocabularios, independientemente de si, con posterioridad, el vocabulario se usar en varios canales.

5.2. Descripcin de los parmetrosword language puntero a la palabra del vocabulario (formada por una o ms palabras) que desea verificarse. especifica el idioma con el que se preparar el vocabulario que contiene la palabra a analizar. LVX_SPANISH LVX_CATALAN Espaol Cataln

5.3. PrecaucionesEsta funcin realiza una verificacin ms exhaustiva que la utilizada por la funcin vox_prevcb(). Por lo tanto, es posible que la funcin vox_prevcb() (o vox_prevcbex() o vox_prevcbex2() o vox_prevcbdev()) realice una correcta transcripcin a pesar de que la funcin vox_chkwrd() devuelva error. No obstante, es aconsejable corregir aquellas palabras incorrectas para conseguir una transcripcin ms precisa. Esta funcin nicamente est disponible para los idiomas castellano y cataln.

5.4. Elementos relacionadosvox_prevcb, vox_prevcbex, vox_prevcbex2, vox_prevcbdev, vox_ApplyDictionary

5.5. Cdigos de ejemploConsulte el ejemplo asncrono del Dialogic SDK.

12

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

6. vox_clrrspFUNCION void vox_clrrsp(VX_RSP *rspp) VX_RSP *rspp puntero a una estructura de tipo Recognition String Parameter

RETORNA INCLUDES MODO

Nada voxlib.h sncrono

6.1. DescripcinLa funcin vox_clrrsp() resetea todos los campos de la estructura VX_RSP asignndoles sus valores por defecto. Es aconsejable utilizar esta funcin para inicializar cualquier estructura VX_RSP antes de ser utilizada por otras funciones.

6.2. Descripcin de los parmetrosrspp puntero a la estructura de tipo Recognition String Parameter que desea inicializarse. Esta estructura especifica parmetros y condiciones de terminacin adicionales para el proceso de reconocimiento. Consulte Captulo 3. Estructuras de datos y parmetros para obtener ms informacin acerca de las estructuras VX_RSP.

6.3. PrecaucionesLa estructura RSP debe ser reseteada mediante la funcin vox_clrrsp() antes de modificar cualquiera de sus campos.

6.4. Elementos relacionadosvox_recstr, vox_recstr_open

6.5. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

13

Captulo 2. Descripcin de las funciones

7. vox_clrvadFUNCION void vox_clrvad(VAD_PRM *prm) VAD_PRM *prm puntero a una estructura de tipo Voice Detection Parameter Activity

RETORNA INCLUDES MODO

Nada voxlib.h sncrono

7.1. DescripcinLa funcin vox_clrvad() resetea todos los campos de la estructura VAD_PRM asignndoles sus valores por defecto. Es aconsejable utilizar esta funcin para inicializar cualquier estructura VAD_PRM antes de ser utilizada por otras funciones. Para conocer el contenido de la estructura y los valores por defecto que les asigna esta funcin, consulte el Captulo 3. Estructuras de datos y parmetros.

7.2. Descripcin de los parmetrosprm puntero a la estructura de tipo Voice Activity Detection Parameter que desea inicializarse. Esta estructura especifica parmetros y condiciones de contorno para el proceso de deteccin de la actividad vocal. Consulte el Captulo 3. Estructuras de datos y parmetros para obtener ms informacin acerca de la estructura VAD_PRM.

7.3. PrecaucionesLa estructura VAD_PRM debe ser reseteada mediante la funcin vox_clrvad antes de modificar cualquiera de sus campos.

7.4. Elementos relacionadosvox_vsd_open

7.5. Cdigos de ejemploConsulte el ejemplo anexo.

14

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

8. vox_deactivatevcbFUNCION int vox_deactivatevcb(int chdev, int vcbhandle, unsigned int mode) int chdev int vcbhandle unsigned int mode RETORNA descriptor de un canal vlido descriptor de un vocabulario o gramtica ABNF previamente cargado y activado por compatibilidad con versiones anteriores, sese 0

>=0 indicando el descriptor del vocabulario si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

8.1. DescripcinLa funcin vox_deactivatevcb() desactiva un vocabulario o gramtica ABNF previamente cargado y activado en el canal especificado. El descriptor del vocabulario se obtiene al cargarlo mediante la funcin vox_loadvcb() y tambin debe usarse para activarlo mediante la funcin vox_activatevcb() o para descargarlo mediante la funcin vox_unloadvcb().

8.2. Descripcin de los parmetroschdev vcbhandle mode especifica el descriptor de canal vlido. descriptor de un vocabulario o gramtica ABNF previamente cargado mediante la funcin vox_loadvcb() y activado mediante la funcin vox_activatevcb(). por compatibilidad con versiones anteriores, sese 0

8.3. PrecaucionesEn cualquier momento, pueden estar activos varios vocabularios y gramticas. El descriptor utilizado en la funcin vox_deactivatevcb() debe ser el valor retornado por la funcin vox_loadvcb(). Si se establece el vocabulario o la gramtica activa mediante la funcin vox_setvcb() o vox_setcd(), se descargarn automticamente todos los vocabularios y gramticas cargados hasta ese momento.

8.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, la funcin ATVOX_LASTERR() devolver alguno de los siguientes motivos: EVX_NOMEM EVX_VCBFILE EVX_INVWORD EVX_SYSTEM OUT OF MEMORY THE VOCABULARY FILE NAME IS NOT VALID. THE VOCABULARY TRANSCRIPTION WAS OT FOUND SYSTEM ERROR. Check errno.

Verbio Technologies

Referencia de las funciones del Library SDK

15

Captulo 2. Descripcin de las funciones

8.5. Elementos relacionadosvox_setvcb, vox_loadvcb, vox_loadcd, vox_activatevcb, vox_unloadvcb, ATVOX_IVCB

8.6. Cdigos de ejemploConsulte el ejemplo anexo.

16

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

9. vox_devcloseFUNCION int vox_devclose(int chdev) int chdev RETORNA descriptor de un canal vlido

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

9.1. DescripcinLa funcin vox_devclose() libera los recursos consumidos por el canal especificado. Es aconsejable invocarla cuando la aplicacin no deba hacer uso de recursos de reconocimiento ni de sntesis por el canal indicado.

9.2. Descripcin de los parmetroschdev especifica el descriptor de canal vlido.

9.3. PrecaucionesEn aplicaciones cuyos descriptores de canal se creen y destruyan de forma permanente (es decir, que no son utilizados a lo largo de todo el tiempo de vida de la aplicacin) es muy recomandable invocar a esta funcin al finalizar el uso del cada canal. De este modo, se liberaran recursos (memoria, procesos, etc.) que pueden ser requeridos por los nuevos canales a utilizar.

9.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_NOLINE NO MORE LINES ARE AVAILABLE FOR THE SPECIFIED CHANNEL DEVICE

9.5. Elementos relacionadosvox_libclose, vox_srvclose, vox_thclose

9.6. Cdigos de ejemploConsulte el ejemplo sncrono del Dialogic SDK.

Verbio Technologies

Referencia de las funciones del Library SDK

17

Captulo 2. Descripcin de las funciones

10. vox_dtmf_closeFUNCION int vox_dtmf_close(int chdev, DTMF_REG* dtmfdev) int chdev DTMF_REG* dtmfdev RETORNA descriptor de un canal vlido descriptor de deteccin de tonos DTMF vlido

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

10.1. DescripcinLa funcin vox_dtmf_close() cierra el desciptor de deteccin de tonos DTMF abierto mediante la funcin vox_dtmf_open y libera los recursos utilizados durante el proceso de deteccin de tonos DTMF.

10.2. Descripcin de los parmetroschdev dtmfdev especifica el descriptor de canal vlido. especifica el descriptor de deteccin de tonos DTMF vlido obtenido mediante la funcin vox_dtmf_open.

10.3. Elementos relacionadosvox_dtmf_open, vox_dtmf_write

10.4. Cdigos de ejemploConsulte el ejemplo anexo.

18

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

11. vox_dtmf_openFUNCION DTMF_REG* vox_dtmf_open(int chdev, unsigned int mode) int chdev unsigned int mode RETORNA descriptor de un canal vlido formato de las muestras (Ley A, Ley Mu o lineal)

!= -1 para indicar el descriptor de deteccin de tonos DTMF -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

11.1. DescripcinLa funcin vox_dtmf_open() inicializa el detector de tonos DTMF en el canal especificado, de modo que est preparado para empezar a recibir las muestras de audio mediante la funcin vox_dtmf_write(). El valor devuelto por la funcin es requerido por las funciones vox_dtmf_write() y vox_dtmf_close().

11.2. Descripcin de los parmetroschdev mode especifica el descriptor de canal vlido. especifica el formato de las muestras de audio pasadas al detector de voz. MC_ALAW MC_MULAW MC_LIN16 formato PCM (Ley A) a 8 KHz. formato PCM (Ley Mu) a 8 KHz. formato PCM (lineal 16 bits) a 8 KHz.

11.3. PrecaucionesUna vez finalizado el proceso de deteccin de tonos DTMF, es imprescindible invocar a la funcin vox_dtmf_close para liberar los recursos de memoria utilizados durante el proceso de deteccin.

11.4. Elementos relacionadosvox_dtmf_write, vox_dtmf_close

11.5. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

19

Captulo 2. Descripcin de las funciones

12. vox_dtmf_wordFUNCION char* vox_dtmf_word(int chdev, const char *sequence) int chdev const char* sequence RETORNA descriptor de un canal vlido cadena de tonos DTMF recibida en el canal.

puntero a un vector de caracteres con el contenido de la palabra del vocabulario retornada por la gramtica, cuando se cumple una de sus alternativas. puntero nulo si la secuencia no cumple ninguna de las opciones contempladas por la gramtica DTMF.

INCLUDES MODO

voxlib.h sncrono

12.1. DescripcinLa funcin vox_dtmfword() devuelve un puntero a un vector de caracteres ASCIIZ con el contenido asociado a la secuencia de tonos DTMF recibido por el canal y contenidos en el vocabulario o gramtica activa en el canal.

12.2. Descripcin de los parmetroschdev sequence especifica el descriptor de canal vlido. cadena de tonos DTMF recibida mediante las funciones vox_dtmf_open, vox_dtmf_write y vox_dtmf_close y de la que se desea saber si cumple la gramtica DTMF cargada en el canal especificado.

12.3. Elementos relacionadosvox_wordex, vox_recstr

12.4. Cdigos de ejemploConsulte el ejemplo sncrono.

20

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

13. vox_dtmf_writeFUNCION const char* vox_dtmf_write(DTMF_REG* dtmfdev, const void *buffer, unsigned int n) DTMF_REG* dtmfdev const void *buffer unsigned int n RETORNA descriptor de deteccin de tonos DTMF vlido vector en el que se encuentran las muestras de audio que debe procesar el detector de tonos DTMF tamao del vector de muestras (en bytes)

puntero a un vector de caracteres con los tonos DTMF reconocidos en el vector de muestras acabado de procesar 0 (NULL) en caso de que no se haya detectado ningn tono DTMF en el vector de muestras acabado de procesar

INCLUDES MODO

voxlib.h sncrono

13.1. DescripcinLa funcin vox_dtmf_write() enva las muestras recibidas hacia el detector de tonos DTMF para ser procesadas. La funcin retorna los identificadores de los tonos DTMF detectados dentro de la ltima trama de muestras procesada. Los posibles identificadores son: 1 2 3 4 5 6 7 8 9 0 * # A B C D.

13.2. Descripcin de los parmetrosdtmfdev buffer n especifica el descriptor de deteccin de tonos DTMF vlido obtenido mediante la funcin vox_dtmf_open. vector en el que se encuentran las muestras de audio que debe procesar el detector de tonos DTMF. tamao del vector de muestras.

13.3. PrecaucionesEl vector de caracteres retornado es voltil, de modo que en las sucesivas invocaciones a esta funcin o a las funciones vox_dtmf_open y vox_dtmf_close su valor se ver modificado, siendo necesario su almacenamiento si se requiere un procesado posterior del resultado retornado.

13.4. Elementos relacionadosvox_dtmf_open, vox_dtmf_close

13.5. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

21

Captulo 2. Descripcin de las funciones

14. ATVOX_ERRMSGPFUNCION char * ATVOX_ERRMSGP(int dev) int dev RETORNA INCLUDES MODO descriptor de un canal o -1 para funciones independientes del canal

vector de caracteres con una descripcin del error ocurrido en la ltima llamada a una funcin del SDK voxlib.h sncrono

14.1. DescripcinLa funcin ATVOX_ERRMSGP() devuelve un puntero a un vector ASCIIZ que describe el motivo del error producido durante la ltima llamada a una funcin de la librera Verbio. Este puntero es vlido a lo largo de la ejecucin de la aplicacin. Si no se ha producido ningn error durante la ltima llamada a una funcin, el vector contiene el valor "NO ERROR". Si el error se ha producido durante la llamada a una funcin dependiente del canal (vox_setvcb(), vox_recstr(), ...) el parmetro de entrada dev especifica el descriptor de canal vlido. Si el error se ha producido durante la llamada a una funcin independiente del canal (vox_libinit(), vox_prevcb(), vox_ApplyDictionary(), ...) debe utilizarse -1 como valor del parmetro dev.

14.2. Descripcin de los parmetrosdev especifica el descriptor de canal vlido o -1 para funciones independientes del canal.

14.3. Elementos relacionadosATVOX_LASTERR

14.4. Cdigos de ejemploConsulte el ejemplo anexo.

22

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

15. vox_getasrlicFUNCION int vox_getasrlic(const char *configuration) const char *configuration RETORNA INCLUDES MODO identificador de la configuracin de reconocimiento de la que se desean consultar las licencias disponibles

Nmero de licencias mximas disponibles (adquiridas) voxlib.h sncrono

15.1. DescripcinLa funcin vox_getasrlic() consulta el nmero de licencias de la configuracin especificada disponibles en total (adquiridas) en el servidor utilizado (aqul especificado antes de invocar a la funcin vox_libinit o vox_asr_init).

15.2. Descripcin de los parmetrosconfiguration especifica la configuracin de reconocimiento de la que se desea conocer el nmero de licencias disponibles. Para ms informacin, puede consultarse el documento Verbio Software Reference: Gua del Usuario. CFG_SPANISH CFG_SPANISH_CATALAN CFG_SPANISH_BASQUE CFG_SPANISH_GALICIAN CFG_SPANISH_CATALAN_BASQUE_GALICIAN CFG_PORTUGUESE CFG_PORTUGUESE_BRAZILIAN CFG_SPANISH_ARGENTINIAN CFG_SPANISH_CHILEAN CFG_SPANISH_COLOMBIAN CFG_SPANISH_MEXICAN CFG_SPANISH_VENEZUELAN CFG_FRENCH CFG_ENGLISH Espaol castellano Espaol cataln Espaol euskera Espaol gallego castellano castellano castellano + + +

Espaol castellano + cataln + euskera + gallego Portugus Portugus brasileo Espaol argentino Espaol chileno Espaol colombiano Espaol mexicano Espaol venezolano Francs Ingls

Verbio Technologies

Referencia de las funciones del Library SDK

23

Captulo 2. Descripcin de las funciones

15.3. PrecaucionesLa funcin vox_getasrlic() debe invocarse una vez establecida la comunicacin con el servidor de reconocimiento al que se le solicita el nmero de licencias disponibles, entendiendo por disponibles el nmero mximo de peticiones de reconocimiento simultneas que pueden realizarse, en ese servidor, para la configuracin especificada.

15.4. Elementos relacionadosvox_getusedasrlic, vox_getttslic, vox_getusedttslic, vox_libinit, vox_asr_init

15.5. Cdigos de ejemploConsulte el ejemplo anexo.

24

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

16. vox_GetDllVersionFUNCION int vox_GetDllVersion(unsigned long *fileverp, unsigned long *prodverp) unsigned long *fileverp unsigned long *prodverp RETORNA nmero de versin del fichero DLL de VERBIO nmero de versin del producto

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

16.1. DescripcinLa funcin vox_GetDllVersion() retorna el nmero de versin de la DLL de VERBIO tanto del fichero como del producto.

16.2. Descripcin de los parmetrosfileverp prodverp puntero en el que se guardar la informacin referente a la versin del fichero. puntero en el que se guardar la informacin referente a la versin del producto.

16.3. Elementos relacionadosvox_SerialNumber

16.4. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

25

Captulo 2. Descripcin de las funciones

17. vox_getparmFUNCION int vox_getparm(int dev, unsigned long parm, void *valuep) int dev unsigned long parm void *valuep descriptor de un canal o -1 para parmetros globales de VERBIO (independientes del canal) parmetro del que se desea obtener el valor puntero a la variable en la que se almacenar el valor del parmetro solicitado

RETORNA

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

17.1. DescripcinLa funcin vox_getparm() obtiene los valores actuales de los parmetros globales o dependientes del canal de VERBIO. Esta funcin puede obtener el valor de un nico parmetro en cada invocacin.

17.2. Descripcin de los parmetrosdev parm especifica el descriptor de canal vlido. Use -1 para obtener el valor de parmetros globales de VERBIO. especifica el identificador del parmetro del que se desea recuperar el valor en la variable apuntada por valuep. Los identificadores de los parmetros pueden consultarse en Captulo 3. Estructuras de datos y parmetros. puntero a la variable en la que se almacenar el valor del parmetro solicitado.

valuep

17.3. Elementos relacionadosvox_setparm

17.4. Cdigos de ejemploConsulte el ejemplo anexo.

26

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

18. vox_getttslicFUNCION int vox_getttslic(const char *language) const char *language identificador del idioma de sntesis del que se desean consultar las licencias disponibles

RETORNA INCLUDES MODO

Nmero de licencias mximas disponibles (adquiridas) voxlib.h sncrono

18.1. DescripcinLa funcin vox_getttslic() consulta el nmero de licencias del idioma especificado disponibles en total (adquiridas) en el servidor utilizado (aqul especificado antes de invocar a la funcin vox_libinit o vox_tts_init).

18.2. Descripcin de los parmetroslanguage especifica el idioma de sntesis del que se desea conocer el nmero de licencias disponibles. Para ms informacin, puede consultarse el documento Verbio Software Reference: Gua del Usuario. LNG_SPANISH LNG_CATALAN LNG_BASQUE LNG_GALICIAN LNG_PORTUGUESE LNG_PORTUGUESE_BRAZILIAN LNG_SPANISH_ARGENTINIAN LNG_SPANISH_MEXICAN LNG_FRENCH LNG_ENGLISH Espaol castellano Cataln Euskera Gallego Portugus Portugus brasileo Espaol argentino Espaol mexicano Francs Ingls

18.3. PrecaucionesLa funcin vox_getttslic() debe invocarse una vez establecida la comunicacin con el servidor de sntesis al que se le solicita el nmero de licencias disponibles, entendiendo por disponibles el nmero mximo de peticiones de sntesis simultneas que pueden realizarse, en ese servidor, para el idioma especificado.

18.4. Elementos relacionadosvox_getusedttslic, vox_getasrlic, vox_getusedasrlic, vox_libinit, vox_tts_init

18.5. Cdigos de ejemplo

Verbio Technologies

Referencia de las funciones del Library SDK

27

Captulo 2. Descripcin de las funciones

Consulte el ejemplo anexo.

28

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

19. vox_getusedasrlicFUNCION RETORNA INCLUDES MODO int vox_getusedasrlic() Nmero de licencias disponibles en el momento de la invocacin voxlib.h sncrono

19.1. DescripcinLa funcin vox_getusedasrlic() consulta el nmero de licencias de la configuracin especificada disponibles en un momento determinado (libres) en el servidor utilizado (aqul especificado antes de invocar a la funcin vox_libinit o vox_asr_init).

19.2. PrecaucionesLa funcin vox_getusedasrlic() devuelve el nmero de licencias disponibles en un momento determinado, para controlar la disponibilidad de las mismas antes de realizar una peticin. Puede combinarse tambin con las funciones vox_recstr_wait y vox_recstr_release.

19.3. Elementos relacionadosvox_getttslic, vox_recstr_wait, vox_recstr_release

19.4. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

29

Captulo 2. Descripcin de las funciones

20. vox_getusedttslicFUNCION RETORNA INCLUDES MODO int vox_getusedttslic() Nmero de licencias disponibles en el momento de la invocacin voxlib.h sncrono

20.1. DescripcinLa funcin vox_getusedttslic() consulta el nmero de licencias de la configuracin especificada disponibles en un momento determinado (libres) en el servidor utilizado (aqul especificado antes de invocar a la funcin vox_libinit o vox_tts_init).

20.2. PrecaucionesLa funcin vox_getusedttslic() devuelve el nmero de licencias disponibles en un momento determinado, para controlar la disponibilidad de las mismas antes de realizar una peticin. Puede combinarse tambin con las funciones vox_playstr_wait y vox_playstr_release.

20.3. Elementos relacionadosvox_getusedasrlic, vox_playstr_wait, vox_playstr_release

20.4. Cdigos de ejemploConsulte el ejemplo anexo.

30

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

21. ATVOX_IVCBFUNCION int ATVOX_IVCB(int chdev) int chdev RETORNA descriptor de un canal vlido

>=0 indicando el descriptor del vocabulario afectado por el ltimo resultado de reconocimiento -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

21.1. DescripcinLa funcin ATVOX_IVCB() retorna el descriptor del vocabulario del que se ha reconocido una secuencia durante el ltimo proceso de reconocimiento. Este valor est disponible despus de la finalizacin de una llamada a las funciones vox_recind() o vox_nbest().

21.2. Descripcin de los parmetroschdev especifica el descriptor de canal vlido.

21.3. PrecaucionesEl valor devuelto por la funcin ATVOX_IVCB() slo es vlido tras la correcta finalizacin de la funcin vox_recind() o vox_nbest().

21.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_NORECIND NO RECIND. Call vox_recind() before calling ATVOX_IVCB().

21.5. Elementos relacionadosvox_recind, vox_nbest

21.6. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

31

Captulo 2. Descripcin de las funciones

22. ATVOX_LASTERRFUNCION long ATVOX_LASTERR(int dev) int dev RETORNA INCLUDES MODO nmero del error voxlib.h sncrono descriptor de un canal vlido o -1 para funciones independientes del canal

22.1. DescripcinLa funcin ATVOX_LASTERR() retorna un valor long que identifica el error que se ha producido durante la ltima llamada a una funcin del SDK de Verbio. Los errores estn definidos en voxlib.h. Si no se ha producido ningn error durante la ltima llamada a una funcin, el valor devuelto es 0. Si el error se ha producido durante la llamada a una funcin dependiente del canal (vox_setvcb(), vox_recstr(), ...) el parmetro de entrada dev especifica el descriptor de canal vlido. Si el error se ha producido durante la llamada a una funcin independiente del canal (vox_libinit(), vox_prevcb(), vox_ApplyDictionary(), ...) debe utilizarse -1 como valor del parmetro dev.

22.2. Descripcin de los parmetrosdev especifica el descriptor de canal vlido o -1 para funciones independientes del canal.

22.3. Elementos relacionadosATVOX_ERRMSGP

22.4. Cdigos de ejemploConsulte el ejemplo anexo.

32

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

23. vox_libcloseFUNCION RETORNA int vox_libclose() 0 si el resultado es satisfactorio -1 en caso de error INCLUDES MODO voxlib.h sncrono

23.1. DescripcinLa funcin vox_libclose libera las conexiones con el motor de sntesis y o reconocimiento del habla iniciadas mediante la funcin vox_libinit, vox_asr_init o vox_tts_init y libera todos los recursos utilizados por el cliente de Verbio. Una vez finalizada la funcin vox_libclose, no pueden invocarse otras funciones del SDK de Verbio desde el cliente afectado, exceptuando aquellas destinadas a establecer de nuevo la conexin con el servidor.

23.2. Elementos relacionadosvox_libinit, vox_asr_init, vox_tts_init

23.3. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

33

Captulo 2. Descripcin de las funciones

24. vox_libinitFUNCION int vox_libinit(int options) int options RETORNA identificador del idioma por defecto

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

24.1. DescripcinLa funcin vox_libinit() inicializa la librera Verbio. El parmetro options especifica el idioma por defecto que utilizarn el servidor de reconocimiento y el servidor de sntesis. Esta funcin est incluida por compatibilidad con versiones anteriores, aunque en nuevos desarrollos es muy recomendable utilizar las nuevas funciones equivalentes vox_asr_init y/o vox_tts_init, segn las necesidades concretas.

24.2. Descripcin de los parmetrosoptions especifica el idioma de trabajo por defecto y si deben inicializarse los servidores de reconocimiento y de sntesis (por defecto, ambos se inicializan). LVX_SPANISH LVX_CATALAN LVX_BASQUE LVX_GALICIAN LVX_PORTUGUESE LVX_BRAZILIAN OVX_NORECSTR OVX_NOPLAYSTR OVX_TTSLITE Espaol Cataln Euskera Gallego Portugus Portugus brasileo no se inicializa el servidor de reconocimiento no se inicializa el servidor de sntesis inicializacin rpida (menores prestaciones) del sintetizador (depuracin)

24.3. PrecaucionesLa funcin vox_libinit() debe invocarse antes que ninguna otra de las funciones del Library SDK, a excepcin de aquella destinada a establecer el servidor de trabajo por defecto en configuraciones cliente-servidor (vox_setparm).

24.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error:

34

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

EVX_INVSETUP EVX_NOMEM EVX_NOLICFILE EVX_INVLIC EVX_SYSTEM

VERBIO INTERNAL ERROR. Files may be corrupted. Check disk and repeat Setup. OUT OF MEMORY. NO LICENSE FILE WAS FOUND. Run CheckOut to obtain a license file. THE LICENSE FILE IS NOT VALID. Run CheckOut to obtain a valid license file. SYSTEM ERROR.Check errno.

24.5. Elementos relacionadosvox_libclose, vox_asr_init, vox_tts_init

24.6. Cdigos de ejemploConsulte el ejemplo sncrono del Dialogic SDK.

Verbio Technologies

Referencia de las funciones del Library SDK

35

Captulo 2. Descripcin de las funciones

25. vox_loadcdFUNCION int vox_loadcd(int chdev, unsigned int mode) int chdev unsigned int mode RETORNA descriptor de un canal vlido por compatibilidad con versiones anteriores, sese 0

>=0 indicando el descriptor del vocabulario si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

25.1. DescripcinLa funcin vox_loadcd() carga el vocabulario de dgitos conectados (consulte Seccin 57 para ms informacin) en el canal especificado. En caso satisfactorio, retorna un descriptor asociado con el vocabulario cargado para que ste pueda ser activado, desactivado y descargado mediante las funciones vox_activatevcb(), vox_deactivatevcb() y vox_unloadvcb() respectivamente.

25.2. Descripcin de los parmetroschdev mode especifica el descriptor de canal vlido. por compatibilidad con versiones anteriores, sese 0

25.3. PrecaucionesSi se establece el vocabulario o la gramtica activa mediante la funcin vox_setvcb() o vox_setcd(), se descargarn automticamente todos los vocabularios y gramticas cargados hasta ese momento.

25.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, la funcin ATVOX_LASTERR() devolver alguno de los siguientes motivos: EVX_NOMEM EVX_SYSTEM OUT OF MEMORY SYSTEM ERROR. Check errno.

25.5. Elementos relacionadosvox_setcd, vox_loadvcb, vox_activatevcb, vox_deactivatevcb, vox_unloadvcb, ATVOX_IVCB

36

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

26. vox_loadvcbFUNCION int vox_loadvcb(int chdev, const char *filename, unsigned int mode) int chdev const char *filename unsigned int mode RETORNA descriptor de un canal vlido nombre del vocabulario o de la gramtica ABNF/DTMF que debe cargarse vocabulario o gramtica ABNF o DTMF

>=0 indicando el descriptor del vocabulario si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

26.1. DescripcinLa funcin vox_loadvcb() carga el vocabulario o la gramtica ABNF o DTMF en el canal especificado. En caso satisfactorio, retorna un descriptor asociado con el vocabulario cargado para que ste pueda ser activado, desactivado y descargado mediante las funciones vox_activatevcb(), vox_deactivatevcb() y vox_unloadvcb() respectivamente.

26.2. Descripcin de los parmetroschdev filename mode especifica el descriptor de canal vlido. puntero al nombre del fichero de texto que contiene el vocabulario (cada lnea contiene una palabra del vocabulario formada por una o ms palabras) o la gramtica ABNF. indica el tipo de vocabulario o gramtica GVX_ISOLATED GVX_CONNECTED Palabras aisladas. El reconocedor espera reconocer una nica palabra del vocabulario de este vocabulario. Palabras conectadas (valor por defecto). El reconocedor espera reconocer una o ms palabras del vocabulario de este vocabulario. gramtica ABNF. El reconocedor espera reconocer una o ms palabras de la gramtica. gramtica DTMF. El reconocedor espera recibir uno o ms tonos DTMF.

GVX_ABNF GVX_DTMF

26.3. PrecaucionesSin la opcin GVX_ABNF habilitada, la funcin vox_loadvcb() requiere el fichero de definiciones y el fichero de transcripciones generados mediante la funcin vox_prevcb() (o vox_prevcbex() o vox_prevcbex2() o vox_prevcbdev()). Si estos ficheros existen y el fichero de vocabulario correspondiente no ha sido modificado desde que se llam a la funcin vox_prevcb() (o vox_prevcbex() o vox_prevcbex2() o vox_prevcbdev()), no es necesario volver a invocarlas antes de cargar el vocabulario mediante la funcin vox_loadvcb(). Con la opcin GVX_ABNF habilitada, la funcin vox_loadvcb() requiere el fichero de estados de la gramtica,

Verbio Technologies

Referencia de las funciones del Library SDK

37

Captulo 2. Descripcin de las funciones

el fichero de definiciones y el fichero de transcripciones generado mediante la funcin vox_prevcb() (o vox_prevcbex() o vox_prevcbex2() o vox_prevcbdev()). Si estos ficheros existen y la gramtica ABNF correspondiente no ha sido modificado desde que se llam a la funcin vox_prevcb() (o vox_prevcbex() o vox_prevcbex2() o vox_prevcbdev()), no es necesario volver a invocarlas antes de cargar la gramtica mediante la funcin vox_loadvcb(). Con la opcin GVX_DTMF la gramtica no crea ficheros adicionales resultados de la compilacin. Si se establece el vocabulario o la gramtica activa mediante la funcin vox_setvcb() o vox_setcd(), se descargarn automticamente todos los vocabularios y gramticas cargados hasta ese momento. La configuracin de reconocimiento activa en el momento de cargar la gramtica debe ser la misma que la existente en el momento de su preparacin. En caso contrario, aparecer el error THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words.

26.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, la funcin ATVOX_LASTERR() devolver alguno de los siguientes motivos: EVX_NOMEM EVX_VCBFILE EVX_INVWORD EVX_SYSTEM OUT OF MEMORY. THE VOCABULARY FILE NAME IS NOT VALID. THE VOCABULARY TRANSCRIPTION WAS NOT FOUND. SYSTEM ERROR. Check errno.

26.5. Elementos relacionadosvox_setcd, vox_loadcd, vox_activatevcb, vox_deactivatevcb, vox_unloadvcb, ATVOX_IVCB

26.6. Cdigos de ejemploConsulte el ejemplo anexo.

38

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

27. vox_nbestFUNCION int vox_nbest(int chdev, int maxind, int *index, float *score, int ibest, unsigned int mode) int chdev int maxind int *index float *score int ibest unsigned int mode RETORNA descriptor de un canal vlido nmero mximo de palabras del conectadas o de palabras de la gramtica vocabulario

vector de enteros en el que se recibirn los ndices de las palabras reconocidas vector de float en el que se recibirn los ndices de confianza de las palabras reconocidas nmero de la hiptesis de inters por compatibilidad con versiones anteriores, sese 0

>=0 para indicar la cantidad de palabras reconocidas -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

27.1. DescripcinLa funcin vox_nbest() debe ser llamada al finalizar las funciones vox_recstr() (o vox_recstr_open() + vox_recstr_write() + vox_recstr_close()) para obtener los ndices y niveles de confianza de las palabras reconocidas correspondientes a la hiptesis ibest-sima. La funcin vox_nbest() es una extensin de la funcin vox_recind() para permitir la obtencin de mltiples hiptesis de reconocimiento de una misma locucin. El nmero mximo de hiptesis devuelto por el servidor de reconocimiento depende del parmetro VXCH_ACTIVE_NBEST (y VXCH_NBEST). Estos parmetros son dependientes del canal y deben ser especificados mediante la funcin vox_setparm() antes de iniciar el reconocimiento mediante las funciones vox_recstr() o vox_recstr_open(). El valor por defecto de ambos parmetros es 1. Si el nmero de palabras reconocidas es cero, index[0] contiene uno de los siguientes ndices especiales: IND_NOVOICE IND_NOWORD IND_EARLY_START No se ha detectado voz. No se ha reconocido ninguna palabra del vocabulario ni de la gramtica. No se ha detectado silencio inicial.

27.2. Descripcin de los parmetroschdev maxind especifica el descriptor de canal vlido. especifica el nmero mximo de palabras del vocabulario conectadas o palabras de la gramtica que pueden reconocerse. En reconocimiento de palabras aisladas, el valor de esta parmetro debe fijarse a 1. puntero a un vector de enteros que recibir los ndices de las palabras reconocidas. El tamao de

index

Verbio Technologies

Referencia de las funciones del Library SDK

39

Captulo 2. Descripcin de las funciones

este vector debe ser mayor o igual a maxind. score puntero a un vector de float que recibir los niveles de confianza de las palabras reconocidas. El nivel de confianza de cada ndice proporciona una medida de fiabilidad del reconocimiento, que puede ser utilizada para rechazar o pedir confirmacin de las palabras reconocidas. El tamao de este vector debe ser mayor o igual a maxind. nmero de la hiptesis de inters. El valor de este parmetro puede estar entre 0 (hiptesis ms fiable) y NBest-1, donde NBest es el mximo nmero de hiptesis activo en un canal especificado mediante la funcin vox_setparm() (parmetro VXCH_ACTIVE_NBEST).

ibest

27.3. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_NORECSTR NO RECOGNITION. Use vox_recstr() to start recognition.

27.4. Elementos relacionadosvox_recstr, vox_recstr_open, vox_recind, ATVOX_NIND

27.5. Cdigos de ejemploConsulte el ejemplo sncrono del Dialogic SDK.

40

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

28. ATVOX_NINDFUNCION int ATVOX_NIND(int chdev) int chdev RETORNA descriptor de un canal vlido

>=0 para indicar el nmero de palabras del vocabulario o de la gramtica reconocidas -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

28.1. DescripcinLa funcin ATVOX_NIND() retorna el nmero de palabras del vocabulario o de la gramtica reconocidas despus de la finalizacin de la llamada a la funcin vox_recind() o vox_nbest().

28.2. Descripcin de los parmetroschdev especifica el descriptor de canal vlido.

28.3. PrecaucionesEl valor devuelto por la funcin ATVOX_NIND() nicamente es vlido despus de la correcta finalizacin de la funcin vox_recind() o vox_nbest().

28.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_NORECIND NO RECIND. Call vox_recind() before calling ATVOX_NIND().

28.5. Elementos relacionadosvox_recind, vox_nbest

28.6. Cdigos de ejemploConsulte el ejemplo asncrono del Dialogic SDK.

Verbio Technologies

Referencia de las funciones del Library SDK

41

Captulo 2. Descripcin de las funciones

29. vox_playstrFUNCION int vox_playstr(int chdev, const char *filename, const char *string, unsigned int mode) int chdev const char *filename const char *string unsigned int mode RETORNA descriptor de un canal vlido vector ASCIIZ con el nombre del fichero de audio en el que se almacenar la voz sinttica vector ASCIIZ con el texto que debe ser sintetizado formato de las muestras de audio

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

29.1. DescripcinLa funcin vox_playstr() inicia la conversin de texto a voz del texto especificado. Una vez la funcin es invocada, la conversin continua hasta el final del texto.

29.2. Descripcin de los parmetroschdev filename string mode especifica el descriptor de canal vlido. vector ASCIIZ con el nombre del fichero de audio en el que se almacenarn las muestras de audio de voz sinttica procedentes del servidor de sntesis. vector ASCIIZ con el texto que debe ser sintetizado. Para una ptima sntesis, es imprescindible que el texto est bien puntuado, acentuado, etc. especifica el formato de las muestras de audio generadas por el motor de sntesis MC_ALAW MC_MULAW MC_LIN16 Muestras de audio en formato de Ley A (8 bits, 8 KHz) Muestras de audio en formato de Ley Mu (8 bits, 8 KHz) Muestras de audio en formato lineal (16 bits, 8 KHz). (valor por defecto)

29.3. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_SYSTEM SYSTEM ERROR. Check errno.

29.4. Elementos relacionados

42

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

vox_playstr_open

29.5. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

43

Captulo 2. Descripcin de las funciones

30. vox_playstr_closeFUNCION int vox_playstr_close(int chdev, int playdev) int chdev int playdev RETORNA descriptor de un canal vlido descriptor de reproduccin vlido

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

30.1. DescripcinLa funcin vox_playstr_close() cierra el descriptor de reproduccin abierto mediante la funcin vox_playstr_open y libera los recursos utilizados durante el proceso de sntesis.

30.2. Descripcin de los parmetroschdev playdev especifica el descriptor de canal vlido. especifica el descriptor vox_playstr_open. de reproduccin vlido obtenido mediante la funcin

30.3. Elementos relacionadosvox_playstr_open, vox_playstr_read

30.4. Cdigos de ejemploConsulte el ejemplo anexo.

44

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

31. vox_playstr_openFUNCION int vox_playstr_open(int chdev, char *string, unsigned int mode) int chdev char *string unsigned int mode RETORNA descriptor de un canal vlido vector ASCIIZ que contiene el texto a sintetizar formato de las muestras (Ley A o Ley Mu)

!= -1 para indicar el descriptor de reproduccin -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

31.1. DescripcinLa funcin vox_playstr_open() inicia la sntesis del texto especificado y no finaliza hasta que se haya sintetizado completamente. Las muestras de audio resultantes se obtendrn mediante la funcin vox_playstr_read(), utilizando el descriptor de reproduccin devuelto por la funcin vox_playstr_open().

31.2. Descripcin de los parmetroschdev string mode especifica el descriptor de canal vlido. vector ASCIIZ que contiene el texto que debe sintetizarse. Para una ptima sntesis, es imprescindible que el texto est bien puntuado, acentuado, etc. especifica el formato de las muestras de audio generadas por el sintetizador. MC_ALAW MC_MULAW MC_LIN16 Muestras de audio en formato de Ley A (8 bits, 8 KHz) Muestras de audio en formato de Ley Mu (8 bits, 8 KHz) Muestras de audio en formato lineal (16 bits, 8 KHz). (valor por defecto)

31.3. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_SYSTEM SYSTEM ERROR. Check errno.

31.4. Elementos relacionadosvox_playstr_read, vox_playstr_close

31.5. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

45

Captulo 2. Descripcin de las funciones

32. vox_playstr_readFUNCION int vox_playstr_read(int playdev, void *buffer, unsigned int count) int playdev void *buffer unsigned int count RETORNA descriptor de reproduccin vlido vector en el que se almacenarn las muestras de audio procedentes del sintetizador nmero de muestras a obtener (en bytes)

>=0 nmero de muestras obtenidas del sintetizador -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

32.1. DescripcinLa funcin vox_playstr_read() obtiene las muestras de audio generadas por la funcin vox_playstr_open(). La funcin retorna un nmero igual al nmero de bytes solicitados para indicar que todava no ha finalizado el proceso de sntesis. La funcin retorna un nmero de muestras menor que el solicitado para indicar que el servidor de sntesis ya no dispone de ms muestras de voz sinttica para entregar, por lo que no debe invocarse a la funcin vox_playstr_read() nuevamente.

32.2. Descripcin de los parmetrosplaydev buffer n especifica el descriptor vox_playstr_open. de reproduccin vlido obtenido mediante la funcin

vector en el que se almacenarn las muestras de audio procedentes del sintetizador. Debe tener un tamao igual o superior al nmero de muestras solicitadas mediante el parmetro n. cantidad de muestras solicitadas al sintetizador.

32.3. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR() y ATVOX_ERRMSGP() obtendr alguno de los siguientes motivos de error: EVX_SYSTEM SYSTEM ERROR. Check errno.

32.4. Elementos relacionadosvox_playstr_open, vox_playstr_close

32.5. Cdigos de ejemploConsulte el ejemplo anexo.

46

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

33. vox_playstr_releaseFUNCION int vox_playstr_release(int chdev) int chdev RETORNA descriptor de un canal vlido

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

33.1. DescripcinLa funcin vox_playstr_release() libera un recurso (licencia) de sntesis del habla reservado mediante la funcin vox_playstr_wait() en el canal especificado.

33.2. Descripcin de los parmetroschdev especifica el descriptor de canal vlido.

33.3. Elementos relacionadosvox_playstr_wait, vox_getusedttslic, vox_recstr_release, vox_recstr_wait

33.4. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

47

Captulo 2. Descripcin de las funciones

34. vox_playstr_waitFUNCION int vox_playstr_wait(int chdev, int ms) int chdev int ms RETORNA descriptor de un canal vlido tiempo mximo de espera para obtener un recurso (en milisegundos)

0 si el resultado es satisfactorio -1 en caso de no poder obtener un recurso en el tiempo especificado

INCLUDES MODO

voxlib.h sncrono

34.1. DescripcinLa funcin vox_playstr_wait() reserva un recurso (licencia) de sntesis del habla para el canal especificado hasta que se libere mediante la funcin vox_playstr_release(). La funcin espera un mximo de ms milisegundos la disponibilidad de un recurso, transcurridos los cuales devuelve un error. El uso de esta funcin es aconsejable para gestionar el uso de los recursos (licencias) disponibles. En entornos en los que nunca se producirn ms peticiones simultneas de sntesis que licencias disponibles no es necesario su uso.

34.2. Descripcin de los parmetroschdev ms especifica el descriptor de canal vlido. tiempo mximo de espera, en milisegundos, para obtener un recurso (licencia) de sntesis del habla para el canal especificado.

34.3. Elementos relacionadosvox_playstr_release, vox_getusedttslic, vox_recstr_wait, vox_recstr_release

34.4. Cdigos de ejemploConsulte el ejemplo anexo.

48

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

35. vox_prevcbFUNCION int vox_prevcb(const char *filename, unsigned int mode) const char *filename unsigned int mode puntero al nombre del fichero que contiene el vocabulario o la gramtica ABNF a preparar vocabulario convencional (lista de palabras) o gramtica ABNF

RETORNA

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

35.1. DescripcinSin especificar el modo GVX_ABNF (vocabulario convencional), la funcin vox_prevcb() realiza la transcripcin fontica del contenido del fichero, almacenndola en un nuevo fichero binario con el mismo nombre que el del vocabulario pero con extensin ".trc". Esta funcin es independiente del canal y debe utilizarse una vez para cada vocabulario aunque ste se utilice en distintos canales (s es necesario invocar de nuevo a la funcin cuando se modifica dinmicamente el contenido del vocabulario). Cuando se especifica el modo GVX_ABNF (gramtica ABNF), la funcin vox_prevcb() compila la gramtica especificada. El resultado de la compilacin se almacena en un nuevo fichero de texto con el mismo nombre que la gramtica pero con extensin ".trx" (conteniendo el vocabulario de la gramtica) y en un nuevo fichero de texto con extensin ".grm" (conteniendo los estados de la gramtica). Tambin se realiza la trancripcin fontica que se almacena en un nuevo fichero binario con el mismo nombre que el de la gramtica pero con extensin ".trc". Esta funcin es independiente del canal y debe utilizarse una vez para cada gramtica aunque sta se utilice en distintos canales (s es necesario invocar de nuevo a la funcin cuando se modifica dinmicamente el contenido de la gramtica). En caso que deba preparar gramticas dinmicas en distintos canales, debe utilizarse la funcin vx_prevcbdev para evitar conflictos entre ellos. El vocabulario se preparar en el idioma y configuracin de reconocimiento especificados mediante la funcin vox_asr_init o bien mediante la funcin vox_setparm (parmetros VXCH_DEFASRCFG y VXCH_DEFASRLNG ). El idioma puede especificarse independientemente usando la funcin vx_prevcbex2.

35.2. Descripcin de los parmetrosfilename mode puntero al nombre del fichero que contiene el vocabulario (cada lnea constituye una palabra del vocabulario formada por una o ms palabras) o la gramtica ABNF. especifica si se trata de una gramtica ABNF. GVX_ABNF gramtica ABNF

35.3. PrecaucionesLa funcin vovx_prevcb() preparar el vocabulario en el idioma por defecto presente en el canal (excepto aquellas palabras que incorporen el identificador del idioma). Si desea especificarse un idioma distinto, deber utilizarse la funcin vox_prevcbex2(). La configuracin de reconocimiento activa en el momento de cargar la gramtica debe ser la misma que la

Verbio Technologies

Referencia de las funciones del Library SDK

49

Captulo 2. Descripcin de las funciones

existente en el momento de su preparacin. En caso contrario, aparecer el error THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words.

35.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error: EVX_NOMEM EVX_VCBFILE EVX_PARSER EVX_INVWORD EVX_SYSTEM OUT OF MEMORY THE VOCABULARY FILE NAME IS NOT VALID. Check the vocabulary file name and path writing permission. ABNF PARSER ERROR. Check the ABNF grammar syntax. THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words SYSTEM ERROR. Check errno.

35.5. Elementos relacionadosvox_prevcbex, vox_prevcbex2, vox_prevcbdev, vox_setvcb, vox_loadvcb

35.6. Cdigos de ejemploConsulte el ejemplo anexo.

50

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

36. vox_prevcbdevFUNCION int vox_prevcbdev(int chdev, const char *filename, unsigned int mode, int *lpiword, const char *language) int chdev const char *filename unsigned int mode int *lpiword const char *language RETORNA descriptor de un canal vlido puntero al nombre del fichero que contiene el vocabulario o la gramtica ABNF a preparar vocabulario convencional (lista de palabras) o gramtica ABNF puntero que almacenar la lnea errnea del fichero en caso de error idioma en el que se preparar el vocabulario

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

36.1. DescripcinSin especificar el modo GVX_ABNF (vocabulario convencional), la funcin vox_prevcbex2() realiza la transcripcin fontica del contenido del fichero en el canal indicado, almacenndola en un nuevo fichero binario con el mismo nombre que el del vocabulario pero con extensin ".trc". Esta funcin est indicada para preparar gramticas dinmicas que no pueden haberse preparado al lanzar la aplicacin mediante las funciones vox_prevcb, vox_prevcbex o vox_prevcbex2. Cuando se especifica el modo GVX_ABNF (gramtica ABNF), la funcin vox_prevcbex2() compila la gramtica especificada en el canal indicado. El resultado de la compilacin se almacena en un nuevo fichero de texto con el mismo nombre que la gramtica pero con extensin ".trx" (conteniendo el vocabulario de la gramtica) y en un nuevo fichero de texto con extensin ".grm" (conteniendo los estados de la gramtica). Tambin se realiza la trancripcin fontica que se almacena en un nuevo fichero binario con el mismo nombre que el de la gramtica pero con extensin ".trc". Para evitar conflictos entre gramticas preparadas simultneamente entre distintos canales, es absolutamente imprescindible evitar que canales distintos preparen gramticas con el mismo nombre. En caso de que se produjera este hecho, los resultados son imprevisibles. Por lo tanto, una estrategia recomendada es la de utilizar nombres de gramtica que incluyan tambin el identificador del canal. De este modo, se imposibilita la coincidencia de nombres de gramtica en canales distintos.

36.2. Descripcin de los parmetroschdev filename mode especifica el descriptor de canal vlido. puntero al nombre del fichero que contiene el vocabulario (cada lnea constituye una palabra del vocabulario formada por una o ms palabras) o la gramtica ABNF. especifica si se trata de una gramtica ABNF. GVX_ABNF gramtica ABNF

Verbio Technologies

Referencia de las funciones del Library SDK

51

Captulo 2. Descripcin de las funciones

lpiword language

en caso de error, este puntero contendr la lnea del fichero en la que se encuentra la primera palabra incorrecta. idioma en el que se preparar el vocabulario, independientemente del idioma por defecto establecido en el canal. El vocabulario se preparar en la configuracin de reconocimiento especificada mediante la funcin vox_asr_init o bien mediante la funcin vox_setparm (parmetro VXCH_DEFASRCFG). LNG_SPANISH LNG_CATALAN LNG_BASQUE LNG_GALICIAN LNG_PORTUGUESE LNG_PORTUGUESE_BRAZILIAN LNG_FRENCH LNG_ENGLISH LNG_SPANISH_MEXICAN LNG_SPANISH_ARGENTINIAN LNG_SPANISH_COLOMBIAN LNG_SPANISH_CHILEAN LNG_SPANISH_VENEZUELAN Espaol castellano Cataln Euskera Gallego Portugus Portugus brasileo Francs Ingls Espaol mexicano Espaol argentino Espaol colombiano Espaol chileno Espaol venezolano

36.3. PrecaucionesLa configuracin de reconocimiento activa en el momento de cargar la gramtica debe ser la misma que la existente en el momento de su preparacin. En caso contrario, aparecer el error THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words.

36.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error: EVX_NOMEM EVX_VCBFILE EVX_PARSER EVX_INVWORD EVX_SYSTEM OUT OF MEMORY. THE VOCABULARY FILE NAME IS NOT VALID. Check the vocabulary file name and path writing permission. ABNF PARSER ERROR. Check the ABNF grammar syntax. THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words. SYSTEM ERROR. Check errno.

36.5. Elementos relacionados

52

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

vox_prevcb, vox_prevcbex, vox_prevcbex2, vox_chkwrd, vox_setvcb, vox_loadvcb

36.6. Cdigos de ejemploConsulte el ejemplo sncrono del Dialogic SDK.

Verbio Technologies

Referencia de las funciones del Library SDK

53

Captulo 2. Descripcin de las funciones

37. vox_prevcbexFUNCION int vox_prevcbex(const char *filename, unsigned int mode, int *lpiword) const char *filename unsigned int mode int *lpiword puntero al nombre del fichero que contiene el vocabulario o la gramtica ABNF a preparar vocabulario convencional (lista de palabras) o gramtica ABNF puntero que almacenar la lnea errnea del fichero en caso de error

RETORNA

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

37.1. DescripcinSin especificar el modo GVX_ABNF (vocabulario convencional), la funcin vox_prevcbex() realiza la transcripcin fontica del contenido del fichero, almacenndola en un nuevo fichero binario con el mismo nombre que el del vocabulario pero con extensin ".trc". Esta funcin es independiente del canal y debe utilizarse una vez para cada vocabulario aunque ste se utilice en distintos canales (s es necesario invocar de nuevo a la funcin cuando se modifica dinmicamente el contenido del vocabulario). Cuando se especifica el modo GVX_ABNF (gramtica ABNF), la funcin vox_prevcbex() compila la gramtica especificada. El resultado de la compilacin se almacena en un nuevo fichero de texto con el mismo nombre que la gramtica pero con extensin ".trx" (conteniendo el vocabulario de la gramtica) y en un nuevo fichero de texto con extensin ".grm" (conteniendo los estados de la gramtica). Tambin se realiza la trancripcin fontica que se almacena en un nuevo fichero binario con el mismo nombre que el de la gramtica pero con extensin ".trc". Esta funcin es independiente del canal y debe utilizarse una vez para cada gramtica aunque sta se utilice en distintos canales (s es necesario invocar de nuevo a la funcin cuando se modifica dinmicamente el contenido de la gramtica). En caso que deba preparar gramticas dinmicas en distintos canales, debe utilizarse la funcin vox_prevcbdev para evitar conflictos entre ellos. El vocabulario se preparar en el idioma y configuracin de reconocimiento especificados mediante la funcin vox_asr_init o bien mediante la funcin vox_setparm (parmetros VXCH_DEFASRCFG y VXCH_DEFASRLNG ). nicamente el idioma puede especificarse independientemente usando la funcin vox_prevcbex2.

37.2. Descripcin de los parmetrosfilename mode puntero al nombre del fichero que contiene el vocabulario (cada lnea constituye una palabra del vocabulario formada por una o ms palabras) o la gramtica ABNF. especifica si se trata de una gramtica ABNF. GVX_ABNF lpiword gramtica ABNF

en caso de error, este puntero contendr la lnea del fichero en la que se encuentra la primera palabra incorrecta.

37.3. Precauciones

54

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

La funcin vovx_prevcbex() preparar el vocabulario en el idioma por defecto presente en el canal (excepto aquellas palabras que incorporen el identificador del idioma). Si desea especificarse un idioma distinto, deber utilizarse la funcin vox_prevcbex2(). La configuracin de reconocimiento activa en el momento de cargar la gramtica debe ser la misma que la existente en el momento de su preparacin. En caso contrario, aparecer el error THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words.

37.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error: EVX_NOMEM EVX_VCBFILE EVX_PARSER EVX_INVWORD EVX_SYSTEM OUT OF MEMORY. THE VOCABULARY FILE NAME IS NOT VALID. Check the vocabulary file name and path writing permission. ABNF PARSER ERROR. Check the ABNF grammar syntax. THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words. SYSTEM ERROR. Check errno.

37.5. Elementos relacionadosvox_prevcb, vox_prevcbex2, vox_prevcbdev, vox_chkwrd, vox_setvcb, vox_loadvcb

37.6. Cdigos de ejemploConsulte el ejemplo anexo.

Verbio Technologies

Referencia de las funciones del Library SDK

55

Captulo 2. Descripcin de las funciones

38. vox_prevcbex2FUNCION int vox_prevcbex2(const char *filename, unsigned int mode, int *lpiword, const char *language) const char *filename unsigned int mode int *lpiword const char *language RETORNA puntero al nombre del fichero que contiene el vocabulario o la gramtica ABNF a preparar vocabulario convencional (lista de palabras) o gramtica ABNF puntero que almacenar la lnea errnea del fichero en caso de error idioma en el que se preparar el vocabulario

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

38.1. DescripcinSin especificar el modo GVX_ABNF (vocabulario convencional), la funcin vox_prevcbex2() realiza la transcripcin fontica del contenido del fichero, almacenndola en un nuevo fichero binario con el mismo nombre que el del vocabulario pero con extensin ".trc". Esta funcin es independiente del canal y debe utilizarse una vez para cada vocabulario aunque ste se utilice en distintos canales (s es necesario invocar de nuevo a la funcin cuando se modifica dinmicamente el contenido del vocabulario). Cuando se especifica el modo GVX_ABNF (gramtica ABNF), la funcin vox_prevcbex2() compila la gramtica especificada. El resultado de la compilacin se almacena en un nuevo fichero de texto con el mismo nombre que la gramtica pero con extensin ".trx" (conteniendo el vocabulario de la gramtica) y en un nuevo fichero de texto con extensin ".grm" (conteniendo los estados de la gramtica). Tambin se realiza la trancripcin fontica que se almacena en un nuevo fichero binario con el mismo nombre que el de la gramtica pero con extensin ".trc". Esta funcin es independiente del canal y debe utilizarse una vez para cada gramtica aunque sta se utilice en distintos canales (s es necesario invocar de nuevo a la funcin cuando se modifica dinmicamente el contenido de la gramtica). En caso que deba preparar gramticas dinmicas en distintos canales, debe utilizarse la funcin vox_prevcbdev para evitar conflictos entre ellos.

38.2. Descripcin de los parmetrosfilename mode puntero al nombre del fichero que contiene el vocabulario (cada lnea constituye una palabra del vocabulario formada por una o ms palabras) o la gramtica ABNF. especifica si se trata de una gramtica ABNF. GVX_ABNF lpiword language gramtica ABNF

en caso de error, este puntero contendr la lnea del fichero en la que se encuentra la primera palabra incorrecta. idioma en el que se preparar el vocabulario, independientemente del idioma por defecto establecido en el canal. El vocabulario se preparar en la configuracin de reconocimiento especificada mediante la funcin vox_asr_init o bien mediante la funcin vox_setparm (parmetro VXCH_DEFASRCFG).

56

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

LNG_SPANISH LNG_CATALAN LNG_BASQUE LNG_GALICIAN LNG_PORTUGUESE LNG_PORTUGUESE_BRAZILIAN LNG_FRENCH LNG_ENGLISH LNG_SPANISH_MEXICAN LNG_SPANISH_ARGENTINIAN LNG_SPANISH_COLOMBIAN LNG_SPANISH_CHILEAN LNG_SPANISH_VENEZUELAN

Espaol castellano Cataln Euskera Gallego Portugus Portugus brasileo Francs Ingls Espaol mexicano Espaol argentino Espaol colombiano Espaol chileno Espaol venezolano

38.3. PrecaucionesLa configuracin de reconocimiento activa en el momento de cargar la gramtica debe ser la misma que la existente en el momento de su preparacin. En caso contrario, aparecer el error THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words. Esta funcin est indicada para permitir preparar vocabularios y gramticas en distintos idiomas de la configuracin de reconocimiento activa en el motor. En caso de que se desee utilizar un idioma no contenido en la configuracin activa, es necesario activarla primero mediante la funcin vox_setparm (parmetro VXCH_DEFASRCFG). Por ejemplo, en caso de que est cargada la configuracin multilinge CFG_SPANISH_CATALAN, pueden prepararse gramticas en ambos idiomas utilizando esta funcin sin necesidad de cambiar la configuracin ni de idioma por defecto mediante la funcin vox_setparm (parmetro VXCH_DEFASRLANG).

38.4. ErroresSi la funcin retorna -1 indicando que se ha producido un error, mediante las funciones ATVOX_LASTERR(-1) y ATVOX_ERRMSGP(-1) obtendr alguno de los siguientes motivos de error: EVX_NOMEM EVX_VCBFILE EVX_PARSER EVX_INVWORD EVX_SYSTEM OUT OF MEMORY. THE VOCABULARY FILE NAME IS NOT VALID. Check the vocabulary file name and path writing permission. ABNF PARSER ERROR. Check the ABNF grammar syntax. THE VOCABULARY CONTAINS AN INVALID WORD. Check and correct invalid words. SYSTEM ERROR. Check errno.

38.5. Elementos relacionados

Verbio Technologies

Referencia de las funciones del Library SDK

57

Captulo 2. Descripcin de las funciones

vox_prevcb, vox_prevcbex, vox_prevcbdev, vox_chkwrd, vox_setvcb, vox_loadvcb

38.6. Cdigos de ejemploConsulte el ejemplo anexo.

58

Referencia de las funciones del Library SDK

Verbio Technologies

Captulo 2. Descripcin de las funciones

39. vox_reccfg_releaseFUNCION int vox_reccfg_release(int chdev, const char * cfg) int chdev const char* cfg descriptor de un canal vlido configuracin de la que se desea liberar una licencia o 0 para licencia de motor ASR

RETORNA

0 si el resultado es satisfactorio -1 en caso de error

INCLUDES MODO

voxlib.h sncrono

39.1. DescripcinLa funcin vox_reccfg_release() libera un recurso (licencia) de reconocimiento del habla reservado mediante la funcin vox_reccfg_wait() en el canal especificado. De este modo, otras peticiones de licencias pendientes podrn ser atendidas por el recurso liberado.

39.2. Descripcin de los parmetroschdev cfg especifica el descriptor de canal vlido. Especifica el tipo de licencia de reconocimiento que debe liberarse. Los posibles valores son: NULL o 0 CFG_SPANISH CFG_SPANISH_CATALAN CFG_SPANISH_BASQUE CFG_SPANISH_GALICIAN CFG_SPANISH_CATALAN_BASQUE_GALICIAN CFG_PORTUGUESE CFG_PORTUGUESE_BRAZILIAN CFG_SPANISH_MEXICAN CFG_SPANISH_ARGENTINIAN CFG_SPANISH_