Configuration

Settings are stored in /usr/local/antmedia/conf/scout.properties as YAML. You can edit the file directly or use the web UI.

Changes to configuration can be applied without restarting AntMedia Server using the hot reload feature (Dashboard → “Reload Configuration” button or POST /rest/scout/reload). Active streams continue with their existing configuration; new streams use the reloaded settings.

Example configuration

licenseKey: "YOUR-LICENSE-KEY"
delivery: headers
scope: both

applications:
  LiveApp:
    delivery: headers
    scope: both
  VodApp:
    delivery: both
    scope: manifests

The plugin only activates for applications that appear under applications:. The application name must match the AntMedia webapp context name exactly (case-sensitive).

An application is enabled when it has an entry under applications: and disabled when that entry is absent. Using the web UI to disable an application removes its entry from the file.

Global settings

These settings apply to all applications unless overridden at the application level.

Key	Description	Default
`licenseKey`	Your Scout license key.	—
`delivery`	Where CMSD-Static data is injected: `headers`, `tags`, or `both` (see Delivery modes below).	`headers`
`scope`	Which request types receive CMSD data: `manifests`, `segments`, or `both` (see Scope below).	`both`

Delivery modes

The delivery setting controls how CMSD-Static data is surfaced on each response:

Value	Behaviour
`headers`	Adds a `CMSD-Static:` HTTP response header formatted as an RFC 8941 Dictionary, e.g. `CMSD-Static: br=500, ot=m, sf=h, st=l`.
`tags`	For `.m3u8` manifests: inserts `#EXT-X-CMSD-STATIC:` on the line after `#EXTM3U`. For `.mpd` manifests: inserts a `<SupplementalProperty>` element with `schemeIdUri="urn:mpeg:dash:cmsd:2020"` as the first child of `<MPD>`. No body modification is applied to segments.
`both`	Applies both `headers` and `tags` behaviour simultaneously.

Scope

The scope setting limits which request types receive CMSD data:

Value	Behaviour
`manifests`	Only `.m3u8` and `.mpd` requests are annotated.
`segments`	Only `.ts` and `.m4s` requests are annotated (header only — body injection is skipped for segments).
`both`	All four file types are annotated.

CMSD keys

Scout emits up to five CMSD-Static keys per response. Keys that cannot be resolved are omitted; the output remains valid with a partial key set.

Key	Type	Description
`d`	Integer (ms)	Content duration in milliseconds. Currently emitted for VOD manifests only when the duration can be determined.
`br`	Integer (kbps)	Encoded video bitrate. Resolved first from the `_<N>kbps` suffix in the filename (e.g. `stream_500kbps.ts`), then from cached encoder settings populated when the stream starts.
`ot`	Token	Object type: `m` (manifest), `i` (init segment), `v` (video/muxed TS), `a` (audio fMP4), `av` (muxed fMP4).
`sf`	Token	Streaming format: `h` (HLS), `d` (DASH).
`st`	Token	Stream type: `l` (live), `v` (VoD).

Per-application settings

These go under applications.<appName>. Any setting not specified falls back to the global value, then to the built-in default.

Key	Description	Default
`delivery`	Override the delivery mode for this application: `headers`, `tags`, or `both`.	(global)
`scope`	Override the scope for this application: `manifests`, `segments`, or `both`.	(global)