Scout for AntMedia Server
=========================

``Scout`` is a commercial plugin for `AntMedia Server <https://antmedia.io>`_ that injects
**CMSD-Static** (CTA-5006 — Common Media Server Data) metadata into HTTP responses for HLS
and DASH streams, with optional Media Quality Assessment (MQA) and telemetry integration.

When a client requests an HLS or DASH resource from an application that has Scout enabled,
the plugin attaches standardised CMSD keys describing the content — bitrate, object type,
streaming format, stream type, and optionally duration — to the response in real time, with
no re-encoding and no interruption to the stream.

Features
--------

- **Five CMSD-Static keys**: ``d`` (duration in ms), ``br`` (encoded bitrate in kbps),
  ``ot`` (object type), ``sf`` (streaming format), ``st`` (stream type).
- **HLS support**: ``.m3u8`` manifests and ``.ts`` segments.
- **DASH support**: ``.mpd`` manifests and ``.m4s`` segments.
- **Flexible delivery**: HTTP response header (``CMSD-Static:``), manifest body injection
  (``#EXT-X-CMSD-STATIC:`` tag for HLS or ``<SupplementalProperty>`` for DASH), or both.
- **Configurable scope**: inject on manifests only, segments only, or both.
- **Per-application configuration** — different delivery and scope settings per AntMedia
  application.
- **Configuration hot-reload** without restarting AntMedia Server.
- **Web-based management UI** for installing the filter per application and editing settings.
- **MQA (Media Quality Assessment)** — per-stream PSNR, SSIM, and optional VMAF scores
  injected as a ``CMSD-MQA:`` response header on segment requests (opt-in, zero overhead
  when disabled).
- **Prometheus metrics export** — per-stream quality metrics available for scraping
  (Standard license and higher).
- **MQA REST score ingest** — accept quality scores pushed by an external encoder or
  quality-assessment tool (Standard license and higher).
- **Quality alerting** — webhook alerts when VMAF drops below a configurable threshold
  (Enterprise license).

License tiers
^^^^^^^^^^^^^

Scout is available in three tiers. See :ref:`License` for details.

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Tier
     - Features included
   * - **Standard**
     - CMSD-Static injection, MQA on-device metrics, web UI, REST API, Prometheus export,
       MQA REST ingest.
   * - **Integration**
     - All Standard features.
   * - **Enterprise**
     - All Integration features, plus quality alerting.

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

   installation
   license
   configuration
   mqa
   telemetry
   alerting
   web-ui
   changelog