https://github.com/asyncwebio/bigbluebutton-mp4-transcription
The BigBlueButton Transcription Plugin is a powerful tool that enables automatic transcription of recorded sessions in BigBlueButton using Google Speech-to-Text. With this plugin, you can easily convert your recorded sessions into text, making it more accessible and searchable.
https://github.com/asyncwebio/bigbluebutton-mp4-transcription
bigbluebutton bigbluebutton-mp4
Last synced: about 2 months ago
JSON representation
The BigBlueButton Transcription Plugin is a powerful tool that enables automatic transcription of recorded sessions in BigBlueButton using Google Speech-to-Text. With this plugin, you can easily convert your recorded sessions into text, making it more accessible and searchable.
- Host: GitHub
- URL: https://github.com/asyncwebio/bigbluebutton-mp4-transcription
- Owner: asyncwebio
- License: mit
- Created: 2023-08-05T04:18:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-19T05:08:36.000Z (over 1 year ago)
- Last Synced: 2025-01-26T09:27:48.948Z (4 months ago)
- Topics: bigbluebutton, bigbluebutton-mp4
- Language: JavaScript
- Homepage: https://higheredlab.com
- Size: 1.24 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BigBlueButton MP4 and Transcription
BigBlueButton Mp4 and Transcription - Your free, open-source solution that enables automatic transcription and mp4 converstion of recorded sessions in BigBlueButton. With this plugin, you can easily convert your recorded sessions into text and mp4 format, making it more accessible.
## Table of Contents
- [💡 Features](#-features)
- [📋 Requirements](#-requirements)
- [📦 Installation](#-installation)
- [🔎 How it works](#-how-it-works)
- [📖 Usage](#-usage)
- [🗑️ Uninstall](#%EF%B8%8F-uninstall)
## 💡 Features
- Automatic transcription and mp4 convertion of recorded sessions
- Seamless integration with Google Speech-to-Text
- Easy installation and configuration
- Transcribed text avaibale via API
- Supports a variety of languages and accents
- Callbacks for custom integrations
## 📋 Requirements
- BigBlueButton server 2.6 or later
- Playback of recordings on ios enabled (see [here](https://docs.bigbluebutton.org/administration/customize#enable-playback-of-recordings-on-ios) for more details)
- Google Cloud Speech-to-Text APIs enabled
- Google Cloud Storage APIs enabled
- Google Cloud Storage bucket with name `bbb-transcription` (for storing audio files and transcripts)
- Google Cloud credentials (in json format)
## 📦 Installation
To install the BigBlueButton Transcription Plugin, follow these steps:
1. Clone the repository to your BigBlueButton server:
```bash
cd /var/www
git clone https://github.com/AsyncWeb/bigbluebutton-mp4-transcription.git
```
2. Navigate to the plugin directory
```bash
cd bigbluebutton-mp4-transcription
```
3. Add google auth credentials to the `transcription_node_app` directory:
```bash
cp transcription_node_app/auth-key.json.sample transcription_node_app/auth-key.json
# get the credentials from the Google Cloud Console
# edit auth-key.json and add the your credentials
```
You can find the credentials in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials).
- Login to your Google Cloud Console.
- Create a new project or select an existing one.
- Go to the `APIs & Services`
- Click on `Enable APIs and Services` and enable `Cloud Speech-to-Text API` and `Cloud Storage API`.
- Goto `Credentials` and click on `Create Credentials`.
- Follow the steps and create a new service account.
- Download the credentials in json format and copy the contents to `auth-key.json` file.
4. Install the plugin:
```bash
bash install.sh
```
## 🔎 How it works
Transcription: Plugin extracts the audio from the recorded sessions and uploads it to Google Cloud Storage. The audio is then transcribed using Google Speech-to-Text. The transcript is then saved in a Google Cloud Storage. Once the process is complete, the plugin calls the `bbb-transcription-ready-url` with the transcript URL.
MP4: Plugin converts the recorded session to mp4 format using the `ffmpeg` library. Once the process is complete, the plugin calls the `bbb-mp4-ready-url` with the mp4 URL.
## 📖 Usage
1. You need to pass below meta tags while creating the meeting
- `bbb-transcription-enabled`: Set this to `true` to enable transcription for the meeting. Default is `false`.
- `bbb-mp4-enabled`: Set this to `true` to enable mp4 convertion of recording for the meeting. Default is `false`.
- `bbb-transcription-ready-url` (optional): A URL that will be called when the transcription is ready. The URL will be called with the json payload with following parameters:
```
meeting_name
start_time
end_time
meeting_id
transcription_url
```
- `bbb-mp4-ready-url` (optional): The URL will be called with the json payload with following parameters when the mp4 conversion is complete:
```
recordingId
mp4Url
```
- `bbb-transcription-source-language` (optional): The language spoken in the meeting. The value should be a valid language code. For example, `en-US` for English (United States), `en-GB` for English (United Kingdom), `fr-FR` for French (France), etc. You can check allowed language codes [here](https://cloud.google.com/speech-to-text/docs/languages).
2. You can access the transcript and mp4 of the meeting using the below url formats:
- Transcription:
```bash
https:///transcripts//transcript.json
```
- MP4:
```bash
https:///recording/.mp4
```
## 🗑️ Uninstall
To uninstall the BigBlueButton-MP4-Transcription Plugin, run the following command:
```bash
cd /var/www/bigbluebutton-mp4-transcription
bash uninstall.sh
```
## 🚀 Stress-free BigBlueButton hosting! Start free Trial
**Save big with our affordable BigBlueButton hosting.**
- Bare metal servers for HD video
- 40% lower hosting costs
- Top-rated tech support, 100% uptime
- Upgrade / cancel anytime
- 2 weeks free trial; No credit card needed