Scribe for AntMedia Server
==========================

``Scribe`` is a commercial plugin for `AntMedia Server <https://antmedia.io>`_ that adds
real-time speech-to-text transcription and WebVTT subtitle tracks to your live HLS streams.

When a stream is published to an application that has Scribe enabled, the plugin automatically
captures the audio, sends it to a cloud transcription service, and writes segmented ``.vtt``
subtitle files aligned to your HLS segment boundaries. Any standard HLS player — including
Safari, hls.js, and Video.js — will detect the subtitle track and offer it to the viewer.

Features
--------

- Real-time transcription via Speechmatics or Speaches
- Automatic subtitle injection into HLS playlists
- Optional live translation into one or more target languages
- Three-level configuration hierarchy: global → per-application → per-stream
- Per-stream settings using regex stream-name patterns (``streamNameTemplates``)
- Configuration hot-reload without restarting AntMedia Server
- Web-based management UI

.. toctree::
   :maxdepth: 1
   :caption: Contents

   installation
   configuration
   web-ui
   changelog
   license