Repository of a plugin for BigBlueButton

Description

RecordingLiveTranscription.mp4

This plugin provides a panel to the client where the live transcription is visible. Users joining via supported browsers (Google Chrome currently) can opt in to have their browser provide transcription as they speak.

Plugin Versioning

Please be aware that we have a separate branch of this plugin for each version of the SDK. This ensures that everything merged into a branch is compatible with the corresponding version of the BigBlueButton core. As of now, here’s the correspondence between the branches, SDK versions, and BigBlueButton core versions:

Repository Branch	Plugin-SDK Version	BigBlueButton Core Version
v0.0.x	v0.0.x	v3.0.x
v0.1.x	v0.1.x	v3.1.x

For more information about the plugin API features, see the documentation (readme files) within the specific branch you are interested in. We separate the branches because, going forward, v0.1.x is becoming more and more different from v0.0.x.

If you have any suggestions, requirements, or questions, don’t hesitate to contact us.

Extra Settings:

The audio captions must be enabled, to do that, open /etc/bigbluebutton/bbb-html5.yml and add the yaml directive public.app.audioCaptions.enabled=true, just like the following:

public:
  app:
    # You may have other setting items here
    audioCaptions:
      enabled: true

also, ensure the captions needed are uncommented in the list public.app.audioCaptions.language.available, as the following example for en-US:

public:
  app:
    audioCaptions:
      language:
        # the uncommented languages will be loaded as captions 
        available:
        # - de-DE
          - en-US
        # - fr-FR

Lastly, make sure that liveTranscription is not on the disabledFeatures list of your meetings/server (For that, you can check /etc/bigbluebutton/bbb-web.properties or the custom parameters sent to the /create endpoint of your meeting).

Building the Plugin

To build the plugin for production use, follow these steps:

cd $HOME/src/plugin-live-transcription
npm ci
npm run build-bundle

The above command will generate the dist folder, containing the bundled JavaScript file named <plugin-name>.js. This file can be hosted on any HTTPS server along with its manifest.json. You can copy the entire content of dist/ to include localizations too.

If you install the Plugin separated from the manifest, remember to change the javascriptEntrypointUrl in the manifest.json to the correct endpoint.

To use the plugin in BigBlueButton, send this parameter along in create call:

pluginManifests=[{"url":"<your-domain>/path/to/manifest.json"}]

Or additionally, you can add this same configuration in the .properties file from bbb-web in /etc/bigbluebutton/bbb-web.properties

Development mode

As for development mode (running this plugin from source), please refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section Running the Plugin from Source