Skip to content

Class Notes transcribes online classes with subtitles, summaries, topics and sentiments, enabling students, facing poor internet or language barrier, to learn better, at their own pace

Notifications You must be signed in to change notification settings

pliniopecanha/bigbluebutton-class-notes

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Class Notes Logo

Class Notes

Class Notes transcribes online classes with subtitles, summaries, topics and sentiments, enabling students, facing poor internet or language barrier, learn better at their own pace.


EsLint


Class Notes, powered by AssemblyAI, for BigBlueButton

BigBlueButton is the most-popular open-source software for online classes. It is like-Zoom to conduct online classes but at a 40% lower cost, with better analytics, whiteboard, chat, poll, and, the best part, is white-labelled.

AssemblyAI You can automatically convert audio and video files and live audio streams to text with AssemblyAI's Speech-to-Text APIs. You can do more with Audio Intelligence - summarization, content moderation, topic detection, and more. Powered by cutting-edge AI models.

How it works?

After an online class ends, the BigBlueButton server processes the recording and makes it available for students to refer later.

The Class Notes plugin is triggered as soon as BigBlueButton completes its processing of the recording and converts the recording into MP4 format. It also strips off audio of the MP4 recording using ffmpeg and sends it to AssemblyAI to transcriot and provide information such as summary, topics and sentiment analysis. Class Notes displays that information along with MP4 video the class, enhacned with siubtitles, in a nice, easy-to-use UI.

Class Notes also lists out topics of discussion and provide easy navigation to jump off to the section of the class where that topic was discussed.

✨ Features

Class Notes provides you automated notes of the online classes that you can easily refer to, at your own pace, to improve your comprehension. Specifically:

  • MP4 Video with Subtiles. View the class recording in MP4 format, along with subtitles, which, unlike BigBlueButton recording, plays smoothly in any browser on a laptop or a mobile device.
  • Transcription. Below the video, you can read the full transcription of the class, annotated with corresponding time.
  • Summary. Interested in just skimming through the lecture? Just go through the crisp summary of the class in a few bullet points.
  • Topics. Want to learn more about specific topic? View the list of key topics discussed during the class and click on a topic to jump to the corresponding section of the lecture.
  • Sentiments. Lastly, get a sense of the tone of the lecturer - postitive, neutraul or negative, with which specific part of the lecture was delivered.

🖐 Requirements

The requirements to Setup Class Notes.

  1. BigBlueButton Server.
  2. bbb-mp4 installed.

⏳ Installation

Backend

cd backend
mkdir -p /etc/bigbluebutton/nginx
cp -r class_notes.nginx /etc/bigbluebutton/nginx/class_notes.nginx
nginx -t
service nginx reload

Setup post publish script

cp -r class_notes.rb class_notes_config.yml /usr/local/bigbluebutton/core/scripts/post_publish/

update the config file

vi /usr/local/bigbluebutton/core/scripts/post_publish/class_notes_config.yml

get the api key from https://www.assemblyai.com and update assembly_ai_api_key variable in class_notes_config.yml

Note: You will only get 3 hours of transcription per month in free plan.

If you set the trigger_mode: "metadata" in config file you need to pass meta_class_notes_enabled=true in meeting create call


Frontend

cd frontend

Update the config file

vi  src/utils/config.js

Build the frontend

npm install
npm run build

Copy the build files to /var/bigbluebutton/class-notes

mkdir -p /var/bigbluebutton/class-notes
cp -r build/* /var/bigbluebutton/class-notes

How to

Once you visit bigbluebutton playback page, you will see class notes button at bottom of the screen if class notes is available. Click on that.

Class notes will be opened in another tab, https://<your_bbb_server>/class-notes/?meetingId=<meetingId>

📝 License

MIT License

Copyright © 2022 HigherEdLab.com

About

Class Notes transcribes online classes with subtitles, summaries, topics and sentiments, enabling students, facing poor internet or language barrier, to learn better, at their own pace

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 67.9%
  • Ruby 20.3%
  • HTML 7.7%
  • CSS 4.1%