@cycle-robot-drivers/speech
v1.2.6
Published
Cycle.js drivers for speech synthesis and recognition using Web Speech API
Downloads
7
Readme
@cycle-robot-drivers/speech
Cycle.js drivers and action components for speech synthesis and recognition using Web Speech API.
Try the demo at StackBlitz!
Note that this package was tested with Chrome browser (>= 65.0.3325.181) only.
API
SpeechRecognitionAction(sources)
Web Speech API's SpeechRecognition action component.
Params:
- sources
- goal: a stream
SpeechRecognition
properties. - cancel: a stream of
GoalID
. - SpeechSynthesis:
EventSource
forstart
,end
,error
,result
events.
- goal: a stream
Return:
- sinks
- state: a reducer stream.
- output: a stream for the SpeechRecognition driver input.
- result: a stream of action results.
result.result
is a transcript from the recognition; it will be''
for non-speech inputs.
SpeechSynthesisAction(sources)
Web Speech API's SpeechSynthesis action component.
Params:
- sources
- goal: a stream of
SpeechSynthesisUtterance
properties. - cancel: a stream of
GoalID
. - SpeechSynthesis:
EventSource
forstart
andend
events.
- goal: a stream of
Return:
- sinks
- state: a reducer stream.
- status: a stream of action status.
- result: a stream of action results.
result.result
is alwaysnull
. - SpeechSynthesis: a stream for the SpeechSynthesis driver input.
makeSpeechRecognitionDriver()
Web Speech API's SpeechRecognition driver factory.
Return:
Driver the SpeechRecognition Cycle.js driver function. It takes a stream of objects containing
SpeechRecognition
properties and returns aEventSource
:EventSource.events(eventName)
returns a stream ofeventName
events fromSpeechRecognition
.
makeSpeechSynthesisDriver()
Web Speech API's SpeechSynthesis driver factory.
Return:
Driver the SpeechSynthesis Cycle.js driver function. It takes a stream of objects containing
SpeechSynthesisUtterance
properties and returns aEventSource
:EventSource.events(eventName)
returns a stream ofeventName
events fromSpeechSynthesisUtterance
.