API Docs for:
Show:

TextWSRecognizer Class

Extends AbstractWSRecognizer
Defined in: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/textWSRecognizer.js:4
Module: MyScript

Text WebSocket recognizer interface

Constructor

TextWSRecognizer

(
  • callback
  • [host='cloud.myscript.com']
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/recognition/textWSRecognizer.js:4

Parameters:

  • callback Function

    The WebSocket response callback

  • [host='cloud.myscript.com'] String optional

    Recognition service host

Methods

_computeHmac

(
  • input
  • applicationKey
  • hmacKey
)
private

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:194

Compute HMAC signature for server authentication

Parameters:

  • input String
  • applicationKey String
  • hmacKey String

continueWSRecognition

(
  • components
  • instanceId
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/recognition/textWSRecognizer.js:132

Continue the recognition

Parameters:

getHost

() String | String |

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:29

Get the recognition service host

Returns:

String | String | :

initWSRecognition

(
  • applicationKey
)

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:154

Initialize the WebSocket

Parameters:

  • applicationKey String

resetWSRecognition

()

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:184

Reset the WebSocket recognition session

setHost

(
  • UNKNOWN
)

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:39

Set the recognition service host

Parameters:

  • UNKNOWN String

setParameters

(
  • parameters
)

Inherited from AbstractWSRecognizer but overwritten in /home/padewitte/projets/webcomponents/myscript-js/src/recognition/textWSRecognizer.js:46

Set parameters

Parameters:

setPrecision

(
  • precision
)

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:93

Set precision

Parameters:

  • precision Number

startWSRecognition

(
  • components
  • [parameters]
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/recognition/textWSRecognizer.js:104

Start the WebSocket session

Parameters:

takeUpHmacChallenge

(
  • applicationKey
  • challenge
  • hmacKey
)

Inherited from AbstractWSRecognizer: /home/padewitte/projets/webcomponents/myscript-js/src/recognition/abstractWSRecognizer.js:166

Authenticate the WebSocket client end with a handshake of HMAC signature

Parameters:

  • applicationKey String
  • challenge String
  • hmacKey String