Membrane Element: IBMSpeechToText v0.1.3 Membrane.Element.IBMSpeechToText 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
recognition_options
Default value:
[interim_results: true]
Options passed via
IBMSpeechToText.Message.Start
struct to recognition API affecting the results. See the docs forIBMSpeechToText.Message.Start.t/0
and IBM API docsclient_options
Default value:
[keep_alive: true]
Sets the options for
IBMSpeechToText.Client.start_link/3
.api_key
Required
API key for the Speech to Text Service
region
Required
Region in which the endpoint is located. See
IBMSpeechToText.region/0
Pads
:input
Availability | :always |
Caps | Membrane.Caps.Audio.FLAC |
Demand unit | :buffers |
Direction | :input |
Mode | :pull |
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
t()
View Source
t() :: %Membrane.Element.IBMSpeechToText{
api_key: String.t(),
client_options: keyword(),
recognition_options: keyword(),
region: IBMSpeechToText.region()
}
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
membrane_pads()
View Source
membrane_pads() :: [
{Membrane.Element.Pad.name_t(), Membrane.Element.Pad.description_t()}
]
membrane_pads() :: [ {Membrane.Element.Pad.name_t(), Membrane.Element.Pad.description_t()} ]
Returns pads descriptions for Membrane.Element.IBMSpeechToText
options()
View Source
options() :: keyword()
options() :: keyword()
Returns description of options available for this module