1. References
  2. Avatar API
Rate this page:

ASR

Represents an ASR object provides speech recognition capabilities. Audio stream can be sent to an ASR instance from Call, Player or Conference instances. Parameters language or dictionary should be passed to the VoxEngine.createASR function.
Add the following line to your scenario code to use the class:

require(Modules.ASR);

Constructors

constructor

Copy URL

Parameters

  • id:

    string

  • language:

    string

  • dictionary:

    string

Methods

addEventListener

Copy URL
addEventListener(eventcallback) undefined

Adds a handler for the specified ASREvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

Parameters

  • event:

    ASREvents

    Event class (i.e., ASREvents.Stopped)

  • callback:

    Function

    Handler function. A single parameter is passed - object with event information

Returns

  • type:

    void

dictionary

Copy URL
dictionary() undefined

Returns the asr's dictionary.

Returns

  • type:

    string[]

id

Copy URL
id() undefined

Returns the asr's id.

Returns

  • type:

    string

language

Copy URL
language() undefined

Returns the asr's language.

Returns

  • type:

    string

removeEventListener

Copy URL
removeEventListener(eventcallback) undefined

Removes a handler for the specified ASREvents event.

Parameters

  • event:

    ASREvents

    Event class (i.e., ASREvents.Stopped)

  • callback:

    Function

    Optional

    Optional. Handler function. If not specified, all handler functions are removed

Returns

  • type:

    void

stop

Copy URL
stop() undefined

Stops recognition. Triggers the ASREvents.Stopped event. Do not call any other ASR functions/handlers after the ASR.stop call.

Returns

  • type:

    void