Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/membraneframework/membrane_element_ibm_speech_to_text
Membrane plugin providing speech recognition via IBM Cloud Speech-to-Text service
https://github.com/membraneframework/membrane_element_ibm_speech_to_text
Last synced: 2 days ago
JSON representation
Membrane plugin providing speech recognition via IBM Cloud Speech-to-Text service
- Host: GitHub
- URL: https://github.com/membraneframework/membrane_element_ibm_speech_to_text
- Owner: membraneframework
- License: apache-2.0
- Created: 2019-05-22T13:05:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-17T14:52:49.000Z (12 months ago)
- Last Synced: 2024-03-15T08:05:45.295Z (8 months ago)
- Language: Elixir
- Homepage:
- Size: 212 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Membrane Multimedia Framework: IBM Speech To Text
[](https://hex.pm/packages/membrane_element_ibm_speech_to_text)
[](https://hexdocs.pm/membrane_element_ibm_speech_to_text/)
[](https://circleci.com/gh/membraneframework/membrane_element_ibm_speech_to_text)
This package provides a Sink wrapping [IBM Speech To Text Streaming API client](https://hex.pm/packages/ibm_speech_to_text).
Currently supports only audio streams in FLAC format.
The docs can be found at [HexDocs](https://hexdocs.pm/membrane_element_ibm_speech_to_text).
## Installation
The package can be installed by adding `membrane_element_ibm_speech_to_text` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:membrane_element_ibm_speech_to_text, "~> 0.9.0"}
]
end
```
## Usage
The input stream for this element should be parsed, so most of the time it should be
placed in pipeline right after [FLACParser](https://github.com/membraneframework/membrane-element-flac-parser)
Here's an example of pipeline streaming audio file to speech recognition API:
```elixir
defmodule SpeechRecognition do
use Membrane.Pipeline
alias IBMSpeechToText.Response
alias Membrane.{File, IBMSpeechToText}
alias Membrane.FLAC.Parser
@impl true
def handle_init(_ctx, _opts) do
structure =
child(:src, %File.Source{location: "sample.flac"})
|> child(:parser, Parser)
|> child(:sink, %IBMSpeechToText{
region: :frankfurt,
api_key: "PUT_YOUR_API_KEY_HERE"
})
{[spec: structure, playback: :playing], nil}
end
@impl true
def handle_child_notification(%Response{} = response, _element, _ctx, state) do
IO.inspect(response)
{[], state}
end
def handle_child_notification(_notification, _element, _ctx, state) do
{[], state}
end
end
```
To run, the pipeline requires following dependencies:
```elixir
[
{:membrane_core, "~> 1.0"},
{:membrane_file_plugin, "~> 0.16.0"},
{:membrane_flac_plugin, "~> 0.11.0"},
{:membrane_element_ibm_speech_to_text, "~> 0.9.0"}
]
```
## Testing
The tests contacting real IBM API are excluded by default. You can run them using `mix test --include external`.
To make it work, you need to provide api key via `config/config.exs` or `config/test.secret.exs` the file needs to look like this:
```elixir
use Mix.Config
config :ibm_speech_to_text, region: :your_region # e.g. :frankfurt
config :ibm_speech_to_text, api_key: "YOUR_API_KEY_HERE"
```
## Copyright and License
Copyright 2019, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane-element-ibm-speech-to-text)
[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane-element-ibm-speech-to-text)
ipeline
Licensed under the [Apache License, Version 2.0](LICENSE)