Installation

Requirements

  • AntMedia Server 2.17 or later

  • A valid Scribe license key

  • A Speechmatics API key (when using Speechmatics)

Quick install

Run the following command on your AntMedia server as root or with sudo:

curl -fsSL https://downloads.raskenlund.com/scribe/antmediaserver/install.sh | sudo bash

This downloads Scribe-1.0.0.jar to the AntMedia plugins directory, sets the correct file ownership, and restarts the antmedia service.

Manual install

  1. Copy Scribe-1.0.0.jar to /usr/local/antmedia/plugins/

  2. Create the configuration file /usr/local/antmedia/conf/scribe.properties and add at minimum your license key, API key, and the name of the application you want to transcribe:

    licenseKey: "YOUR-LICENSE-KEY"
    provider: "speechmatics"
    speechmaticsApiKey: "YOUR-SPEECHMATICS-API-KEY"
    
    applications:
      LiveApp:
        speechmaticsLanguage: "en"
    

    Replace LiveApp with the name of your AntMedia application (case-sensitive).

  3. Restart AntMedia:

    systemctl restart antmedia
    

Verifying the installation

After restarting, publish a stream to the configured application. You should see log entries from Scribe in /usr/local/antmedia/log/ant-media-server.log and .vtt subtitle files appearing alongside the HLS segments in the streams directory.