Membrane.Element.IBMSpeechToText (Membrane Element: IBMSpeechToText v0.5.0) View Source
An element providing speech recognition via IBM Cloud Speech to Text service.
This element sends speech recognition results (t:IBMSpeechToText.Response.t()
)
via notification mechanism to pipeline.
It uses ibm_speech_to_text client library.
Element options
Passed via struct Membrane.Element.IBMSpeechToText.t/0
region
IBMSpeechToText.region()
Required
Region in which the endpoint is located. SeeIBMSpeechToText.region/0
api_key
String.t()
Required
API key for the Speech to Text Serviceclient_options
keyword
Default value:
[keep_alive: true]
Sets the options forIBMSpeechToText.Client.start_link/3
.recognition_options
keyword
Default value:
[interim_results: true]
Options passed viaIBMSpeechToText.Message.Start
struct to recognition API affecting the results. See the docs forIBMSpeechToText.Message.Start.t/0
and IBM API docs
Pads
:input
Availability | :always |
Caps | Membrane.Caps.Audio.FLAC |
Demand unit | :buffers |
Direction | :input |
Mode | :pull |
Name | :input |
Link to this section Summary
Types
Struct containing options for Membrane.Element.IBMSpeechToText
Functions
Returns pads descriptions for Membrane.Element.IBMSpeechToText
Returns description of options available for this module
Link to this section Types
Specs
t() :: %Membrane.Element.IBMSpeechToText{ api_key: String.t(), client_options: keyword(), recognition_options: keyword(), region: IBMSpeechToText.region() }
Struct containing options for Membrane.Element.IBMSpeechToText
Link to this section Functions
Specs
membrane_pads() :: [{Membrane.Pad.name_t(), Membrane.Pad.description_t()}]
Returns pads descriptions for Membrane.Element.IBMSpeechToText
Specs
options() :: keyword()
Returns description of options available for this module