Type Alias: CmcdReporterConfig<C>

type CmcdReporterConfig<C> = CmcdRequestReportConfig<C> & object;

Defined in: CmcdReporterConfig.ts:14

Configuration for a CMCD reporting component.

Type Parameters

C

C = Record<string, unknown>

The type of the player's customData on the requests this reporter receives. If one transform is annotated, the rest of the configuration infers the type. Defaults to Record<string, unknown>.

Type Declaration

cid?

cid?: string;

The content ID.

Default Value

undefined

eventTargets?

eventTargets?: CmcdEventReportConfig<C>[];

The event configurations. If omitted, no events are reported.

Default Value

undefined

sessionRetention?

sessionRetention?: number;

The number of ended sessions the reporter retains state for, in addition to the current one. Retained sessions let a response that completes after a sid change report under the session that issued its request. The report uses that session's data snapshot and sequence numbers. 0 retains nothing, so stale responses are dropped. Infinity never evicts, which also retains every session's unsent report queues. Numbers are floored. Every other input uses the default.

Default Value

2

sid?

sid?: string;

The session ID. If omitted, the reporter generates a new random session ID.

Default Value

undefined