@svta/cml-cmcd 2.1.2 → 2.3.0

package/dist/index.d.ts

@@ -4,11 +4,11 @@ import { ExclusiveRecord, HttpRequest, HttpResponse, ValueOf, ValueOrArray } fro
 //#region src/CmcdEventType.d.ts
 
 /**
-* CMCD event type for the 'br' key (bitrate change).
+* CMCD event type for the 'bc' key (bitrate change).
 *
 * @public
 */
-declare const CMCD_EVENT_BITRATE_CHANGE: "br";
+declare const CMCD_EVENT_BITRATE_CHANGE: "bc";
 /**
 * CMCD event type for the 'ps' key (play state change).
 *
@@ -108,9 +108,10 @@ declare const CMCD_EVENT_CUSTOM_EVENT: "ce";
 /**
 * CMCD event types for the 'e' key (event mode).
 *
-*
 * @enum
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-A Event}
+*
 * @public
 */
 declare const CmcdEventType: {
@@ -214,6 +215,8 @@ type CmcdCustomValue = string | SfItem<string> | (string | SfItem<string>)[] | n
 * @public
 *
 * @enum
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-A Object Type}
 */
 declare const CmcdObjectType: {
   /**
@@ -274,6 +277,8 @@ type CmcdObjectTypeList = (number | SfItem<number, ExclusiveRecord<CmcdObjectTyp
 * @enum
 *
 * @public
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-A State}
 */
 declare const CmcdPlayerState: {
   /**
@@ -328,6 +333,8 @@ type CmcdPlayerState = ValueOf<typeof CmcdPlayerState>;
 *
 * @enum
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-A Stream Type}
+*
 * @public
 */
 declare const CmcdStreamType: {
@@ -353,9 +360,10 @@ type CmcdStreamType = ValueOf<typeof CmcdStreamType>;
 /**
 * Common Media Client Data Streaming Format
 *
-*
 * @enum
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-A Streaming Format}
+*
 * @public
 */
 declare const CmcdStreamingFormat: {
@@ -388,7 +396,7 @@ type CmcdStreamingFormat = ValueOf<typeof CmcdStreamingFormat>;
 * A standardized set of HTTP request header fields and query string parameters
 * for communicating media playback metrics in request mode.
 *
-* @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf|CMCD v1 Spec}
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-A Request Mode}
 *
 * @public
 */
@@ -407,6 +415,8 @@ type CmcdRequest = {
   * the encoded bitrate is known.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#aggregate-encoded-bitrate | CTA-5004-A Aggregate Encoded Bitrate}
   */
   ab?: CmcdObjectTypeList;
   /**
@@ -416,6 +426,8 @@ type CmcdRequest = {
   * be sent if it is TRUE. If the visibility state of the player is not known this key SHOULD NOT be reported.
   *
   * Boolean
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#backgrounded | CTA-5004-A Backgrounded}
   */
   bg?: boolean;
   /**
@@ -424,6 +436,8 @@ type CmcdRequest = {
   * The buffer length associated with the media object being requested. This value SHOULD be rounded to the nearest 100 ms.
   *
   * Inner list of integer milliseconds with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-length | CTA-5004-A Buffer Length}
   */
   bl?: CmcdObjectTypeList;
   /**
@@ -435,6 +449,8 @@ type CmcdRequest = {
   * If the playlist declares both peak and average bitrate values, the peak value MUST be transmitted.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#encoded-bitrate | CTA-5004-A Encoded Bitrate}
   */
   br?: CmcdObjectTypeList;
   /**
@@ -445,6 +461,8 @@ type CmcdRequest = {
   * new CDN, then this key might initially report buffering caused by the prior CDN. This key SHOULD NOT be reported if it is FALSE.
   *
   * Boolean
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation | CTA-5004-A Buffer Starvation}
   */
   bs?: boolean;
   /**
@@ -454,6 +472,8 @@ type CmcdRequest = {
   * to rebuffering. Token identifier MAY be omitted if the cause of the rebuffering is unknown.
   *
   * Inner list of integers with optional token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-absolute | CTA-5004-A Buffer Starvation Absolute}
   */
   bsa?: CmcdObjectTypeList;
   /**
@@ -463,6 +483,8 @@ type CmcdRequest = {
   * once per reporting mode and report destination. Token identifier MAY be omitted if the cause of the rebuffering is unknown.
   *
   * Inner list of integer milliseconds with optional token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-duration | CTA-5004-A Buffer Starvation Duration}
   */
   bsd?: CmcdObjectTypeList;
   /**
@@ -472,6 +494,8 @@ type CmcdRequest = {
   * rebuffering is unknown.
   *
   * Inner list of integer milliseconds with optional token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-duration-absolute | CTA-5004-A Buffer Starvation Duration Absolute}
   */
   bsda?: CmcdObjectTypeList;
   /**
@@ -480,6 +504,8 @@ type CmcdRequest = {
   * A string identifying the current delivery network from which the player is retrieving content. Maximum length is 128 characters.
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cdn-id | CTA-5004-A CDN ID}
   */
   cdn?: string;
   /**
@@ -489,6 +515,8 @@ type CmcdRequest = {
   * sessions and devices and is defined and updated at the discretion of the service provider.
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#content-id | CTA-5004-A Content ID}
   */
   cid?: string;
   /**
@@ -498,6 +526,8 @@ type CmcdRequest = {
   * to the content. For example, this field may be used to transmit the C2PA signature associated with the content being viewed.
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#content-signature | CTA-5004-A Content Signature}
   */
   cs?: string;
   /**
@@ -509,6 +539,8 @@ type CmcdRequest = {
   * This value MUST NOT be sent for objects which do not have an object type of 'a', 'v', 'av', 'tt', 'c', or 'o'.
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-duration | CTA-5004-A Object Duration}
   */
   d?: number;
   /**
@@ -519,6 +551,8 @@ type CmcdRequest = {
   * beneficial if accompanied by the playhead time 'pt' key to allow for correct interpretation.
   *
   * Integer
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#dropped-frames-absolute | CTA-5004-A Dropped Frames Absolute}
   */
   dfa?: number;
   /**
@@ -529,6 +563,8 @@ type CmcdRequest = {
   * player's remaining buffer length.
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#deadline | CTA-5004-A Deadline}
   */
   dl?: number;
   /**
@@ -539,6 +575,8 @@ type CmcdRequest = {
   * Even if only one error code is being specified, the list notation MUST still be used.
   *
   * Inner list of strings
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#player-error-code | CTA-5004-A Player Error Code}
   */
   ec?: string[];
   /**
@@ -550,6 +588,8 @@ type CmcdRequest = {
   * sent if the lowest encoded bitrate is known.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#lowest-aggregated-encoded-bitrate | CTA-5004-A Lowest Aggregated Encoded Bitrate}
   */
   lab?: CmcdObjectTypeList;
   /**
@@ -561,6 +601,8 @@ type CmcdRequest = {
   * requests for audio objects MUST specify the lowest audio bitrate.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#lowest-encoded-bitrate | CTA-5004-A Lowest Encoded Bitrate}
   */
   lb?: CmcdObjectTypeList;
   /**
@@ -570,6 +612,8 @@ type CmcdRequest = {
   * accuracy of this estimate is dependent on synchronization between the packager and the player clocks.
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#live-stream-latency | CTA-5004-A Live Stream Latency}
   */
   ltc?: number;
   /**
@@ -582,6 +626,8 @@ type CmcdRequest = {
   * This key MUST only be sent once per Session ID and MUST be sent for each reporting mode which is active within the player.
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#media-start-delay | CTA-5004-A Media Start Delay}
   */
   msd?: number;
   /**
@@ -597,6 +643,8 @@ type CmcdRequest = {
   * since the prior interval report.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#measured-throughput | CTA-5004-A Measured Throughput}
   */
   mtp?: CmcdObjectTypeList;
   /**
@@ -616,6 +664,8 @@ type CmcdRequest = {
   * The player SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.
   *
   * Inner list of strings
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#next-object-request | CTA-5004-A Next Object Request}
   */
   nor?: (string | SfItem<string, {
     r: string;
@@ -626,6 +676,8 @@ type CmcdRequest = {
   * True when the content being retrieved by a player is not rendered as audio or video. The key SHOULD only be sent when it is TRUE.
   *
   * Boolean
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#non-rendered | CTA-5004-A Non Rendered}
   */
   nr?: boolean;
   /**
@@ -647,6 +699,8 @@ type CmcdRequest = {
   * This key is also used as a token parameter for other keys.
   *
   * Token
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-A Object Type}
   */
   ot?: CmcdObjectType;
   /**
@@ -655,6 +709,8 @@ type CmcdRequest = {
   * The encoded bitrate of the media object(s) being shown to the end user.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-bitrate | CTA-5004-A Playhead Bitrate}
   */
   pb?: CmcdObjectTypeList;
   /**
@@ -663,6 +719,8 @@ type CmcdRequest = {
   * 1.0 if real-time, 2.0 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.0.
   *
   * Decimal
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playback-rate | CTA-5004-A Playback Rate}
   */
   pr?: number;
   /**
@@ -671,6 +729,8 @@ type CmcdRequest = {
   * The playhead time, expressed in milliseconds, which is being rendered to the viewer when the report is made.
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-time | CTA-5004-A Playhead Time}
   */
   pt?: number;
   /**
@@ -680,6 +740,8 @@ type CmcdRequest = {
   * nearest 100kbps.
   *
   * Integer kbps
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#requested-maximum-throughput | CTA-5004-A Requested Maximum Throughput}
   */
   rtp?: number;
   /**
@@ -694,6 +756,8 @@ type CmcdRequest = {
   * - `o` = other
   *
   * Token
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-A Streaming Format}
   */
   sf?: CmcdStreamingFormat;
   /**
@@ -705,6 +769,8 @@ type CmcdRequest = {
   * UUID specification.
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#session-id | CTA-5004-A Session ID}
   */
   sid?: string;
   /**
@@ -714,6 +780,8 @@ type CmcdRequest = {
   * zero on the start of a new session-id. Sequence numbers increase independently per each combination of mode and target.
   *
   * Integer
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#sequence-number | CTA-5004-A Sequence Number}
   */
   sn?: number;
   /**
@@ -724,6 +792,8 @@ type CmcdRequest = {
   * - `ll` = low latency LIVE
   *
   * Token
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-A Stream Type}
   */
   st?: CmcdStreamType;
   /**
@@ -742,6 +812,8 @@ type CmcdRequest = {
   * - `d` - preloading: the player is loading, or has loaded, assets ahead of starting in order to provide a fast startup. The expectation is that playback will commence at a future time.
   *
   * Token - one of [s,p,k,r,a,e,f,q,d]
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-A State}
   */
   sta?: CmcdPlayerState;
   /**
@@ -751,6 +823,8 @@ type CmcdRequest = {
   * reports this key as true until its buffer first reaches the target buffer for stable playback.
   *
   * Boolean
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#startup | CTA-5004-A Startup}
   */
   su?: boolean;
   /**
@@ -762,6 +836,8 @@ type CmcdRequest = {
   * sent if the top encoded bitrate is known.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-aggregated-encoded-bitrate | CTA-5004-A Top Aggregated Encoded Bitrate}
   */
   tab?: CmcdObjectTypeList;
   /**
@@ -773,6 +849,8 @@ type CmcdRequest = {
   * specify the top video bitrate and requests for audio objects MUST specify the top audio bitrate.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-encoded-bitrate | CTA-5004-A Top Encoded Bitrate}
   */
   tb?: CmcdObjectTypeList;
   /**
@@ -782,6 +860,8 @@ type CmcdRequest = {
   * to the nearest 100 ms.
   *
   * Inner list of integer milliseconds with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#target-buffer-length | CTA-5004-A Target Buffer Length}
   */
   tbl?: CmcdObjectTypeList;
   /**
@@ -800,6 +880,8 @@ type CmcdRequest = {
   * of 'a', 'v', 'av' or 'c'.
   *
   * Inner list of integer kbps with token identifiers
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-playable-bitrate | CTA-5004-A Top Playable Bitrate}
   */
   tpb?: CmcdObjectTypeList;
   /**
@@ -810,6 +892,8 @@ type CmcdRequest = {
   * if the version is not 1.
   *
   * Integer
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#version | CTA-5004-A Version}
   */
   v?: number;
 };
@@ -821,6 +905,8 @@ type CmcdRequest = {
 * Extends {@link CmcdRequest} with event-specific keys for reporting events
 * according to the CMCD version 2 specification.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-A Event Mode}
+*
 * @public
 */
 type CmcdEvent = CmcdRequest & {
@@ -832,6 +918,8 @@ type CmcdEvent = CmcdRequest & {
   * a custom value associated with this event. The names chosen SHOULD associate the custom event name with the custom key name.
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#custom-event-name | CTA-5004-A Custom Event Name}
   */
   cen?: string;
   /**
@@ -861,6 +949,8 @@ type CmcdEvent = CmcdRequest & {
   * - `um` - unmute
   *
   * Token
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-A Event}
   */
   e?: CmcdEventType;
   /**
@@ -869,6 +959,8 @@ type CmcdEvent = CmcdRequest & {
   * A string identifying the current hostname from which the player is retrieving content. Maximum length is 128 characters.
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#hostname | CTA-5004-A Hostname}
   */
   h?: string;
   /**
@@ -881,6 +973,8 @@ type CmcdEvent = CmcdRequest & {
   * This key MUST be included with all Event reports.
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#timestamp | CTA-5004-A Timestamp}
   */
   ts?: number;
 };
@@ -892,6 +986,8 @@ type CmcdEvent = CmcdRequest & {
 * Extends {@link CmcdRequest} with response-specific keys for reporting
 * response data according to the CMCD version 2 specification.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-mode | CTA-5004-A Response Mode}
+*
 * @public
 */
 type CmcdResponse = CmcdRequest & {
@@ -902,6 +998,8 @@ type CmcdResponse = CmcdRequest & {
   * events of type `rr` (response received).
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-dynamic-header | CTA-5004-A CMSD Dynamic Header}
   */
   cmsdd?: string;
   /**
@@ -911,6 +1009,8 @@ type CmcdResponse = CmcdRequest & {
   * events of type `rr` (response received).
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-static-header | CTA-5004-A CMSD Static Header}
   */
   cmsds?: string;
   /**
@@ -922,6 +1022,8 @@ type CmcdResponse = CmcdRequest & {
   * This key MUST only be reported on events of type `rr` (response received).
   *
   * Integer
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-code | CTA-5004-A Response Code}
   */
   rc?: number;
   /**
@@ -931,6 +1033,8 @@ type CmcdResponse = CmcdRequest & {
   * only be reported on events of type `rr` (response received).
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#smrt-data-header | CTA-5004-A SMRT-Data Header}
   */
   smrt?: string;
   /**
@@ -940,6 +1044,8 @@ type CmcdResponse = CmcdRequest & {
   * was received. This key MUST only be reported on events of type `rr` (response received).
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-byte | CTA-5004-A Time to First Byte}
   */
   ttfb?: number;
   /**
@@ -949,6 +1055,8 @@ type CmcdResponse = CmcdRequest & {
   * are received. This key MUST only be reported on events of type `rr` (response received).
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-body-byte | CTA-5004-A Time to First Body Byte}
   */
   ttfbb?: number;
   /**
@@ -958,6 +1066,8 @@ type CmcdResponse = CmcdRequest & {
   * This key MUST only be reported on events of type `rr` (response received).
   *
   * Integer milliseconds
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-last-byte | CTA-5004-A Time to Last Byte}
   */
   ttlb?: number;
   /**
@@ -967,6 +1077,8 @@ type CmcdResponse = CmcdRequest & {
   * MUST be reported on events of type `rr` (response received).
   *
   * String
+  *
+  * @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-url | CTA-5004-A Request URL}
   */
   url?: string;
 };
@@ -1022,6 +1134,30 @@ declare const CmcdReportingMode: {
 */
 type CmcdReportingMode = ValueOf<typeof CmcdReportingMode>;
 //#endregion
+//#region src/CMCD_V1.d.ts
+/**
+* CMCD Version 1
+*
+* @public
+*/
+declare const CMCD_V1: 1;
+//#endregion
+//#region src/CMCD_V2.d.ts
+/**
+* CMCD Version 2
+*
+* @public
+*/
+declare const CMCD_V2: 2;
+//#endregion
+//#region src/CmcdVersion.d.ts
+/**
+* The version of the CMCD specification.
+*
+* @public
+*/
+type CmcdVersion = typeof CMCD_V1 | typeof CMCD_V2;
+//#endregion
 //#region src/CmcdFormatterOptions.d.ts
 /**
 * Options for formatting CMCD data values.
@@ -1032,7 +1168,7 @@ type CmcdFormatterOptions = {
   /**
   * The version of the CMCD specification to use.
   */
-  version: number;
+  version: CmcdVersion;
   /**
   * The reporting mode to use.
   */
@@ -1196,6 +1332,12 @@ declare const CmcdHeaderField: {
 * @public
 */
 type CmcdHeaderField = ValueOf<typeof CmcdHeaderField>;
+/**
+* All CMCD header fields as an array.
+*
+* @public
+*/
+declare const CMCD_HEADER_FIELDS: readonly CmcdHeaderField[];
 //#endregion
 //#region src/CmcdHeaderMap.d.ts
 /**
@@ -1217,7 +1359,7 @@ type CmcdEncodeOptions = {
   *
   * @defaultValue `1`
   */
-  version?: number;
+  version?: CmcdVersion;
   /**
   * The reporting mode to use.
   *
@@ -1264,6 +1406,8 @@ type CmcdEncodeOptions = {
 *
 * @example
 * {@includeCode ../test/appendCmcdHeaders.test.ts#example}
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-A Header Field Definition}
 */
 declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd, options?: CmcdEncodeOptions): Record<string, string>;
 //#endregion
@@ -1281,6 +1425,8 @@ declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd,
 *
 * @example
 * {@includeCode ../test/appendCmcdQuery.test.ts#example}
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-A Query Argument Definition}
 */
 declare function appendCmcdQuery(url: string, cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 //#endregion
@@ -1320,6 +1466,10 @@ type CmcdRequestKey = keyof CmcdRequest | "nrr";
 /**
 * The map of CMCD keys to their appropriate header shard.
 *
+* Note: Event-only keys (e, ts, cen, h) and response-received keys
+* (rc, ttfb, ttlb, url, etc.) are intentionally absent. They are
+* transmitted via the event-mode POST body, not HTTP headers.
+*
 * @public
 */
 declare const CMCD_HEADER_MAP: Record<CmcdRequestKey | "nrr", CmcdHeaderField>;
@@ -1332,6 +1482,14 @@ declare const CMCD_HEADER_MAP: Record<CmcdRequestKey | "nrr", CmcdHeaderField>;
 */
 declare const CMCD_KEYS: CmcdKey[];
 //#endregion
+//#region src/CMCD_MIME_TYPE.d.ts
+/**
+* CMCD MIME type for event report payloads.
+*
+* @public
+*/
+declare const CMCD_MIME_TYPE = "application/cmcd";
+//#endregion
 //#region src/CMCD_PARAM.d.ts
 /**
 * CMCD parameter name.
@@ -1356,37 +1514,163 @@ declare const CMCD_REQUEST_KEYS: readonly ["ab", "bg", "bl", "br", "bs", "bsa",
 */
 declare const CMCD_RESPONSE_KEYS: readonly ["cmsdd", "cmsds", "rc", "smrt", "ttfb", "ttfbb", "ttlb", "url"];
 //#endregion
-//#region src/CMCD_V1.d.ts
+//#region src/CMCD_V1_KEYS.d.ts
 /**
-* CMCD Version 1
+* Defines the keys for CMCD (Common Media Client Data) version 1.
 *
 * @public
 */
-declare const CMCD_V1: 1;
+declare const CMCD_V1_KEYS: readonly ["bl", "br", "bs", "cid", "d", "dl", "mtp", "nor", "nrr", "ot", "pr", "rtp", "sf", "sid", "st", "su", "tb", "v"];
 //#endregion
-//#region src/CMCD_V1_KEYS.d.ts
+//#region src/CmcdData.d.ts
 /**
-* Defines the keys for CMCD (Common Media Client Data) version 1.
+* CMCD version 1 data.
+*
+* Overrides keys whose types differ in version 1 (e.g., `bl` and `br`
+* are plain integers instead of inner lists).
 *
 * @public
 */
-declare const CMCD_V1_KEYS: readonly ["bl", "br", "bs", "cid", "d", "dl", "mtp", "nor", "nrr", "ot", "pr", "rtp", "sf", "sid", "st", "su", "tb", "v"];
+type CmcdV1Data = Omit<CmcdRequest, keyof CmcdV1 | "v"> & CmcdV1 & {
+  v?: 1;
+};
+/**
+* CMCD version 2 data.
+*
+* Includes all request, event, and response mode keys with version 2
+* types.
+*
+* @public
+*/
+type CmcdV2Data = Omit<Cmcd, "v"> & {
+  v: 2;
+};
+/**
+* A CMCD data object that is either version 1 or version 2.
+*
+* The `v` property acts as a discriminator:
+*
+* - When `v` is `2`, the type narrows to {@link CmcdV2Data} with
+*   inner-list values and event/response keys.
+* - When `v` is `1` or absent, the type narrows to {@link CmcdV1Data}
+*   with scalar values.
+*
+* @example
+* ```ts
+* function process(data: CmcdData) {
+*   if (data.v === 2) {
+*     // data.bl is CmcdObjectTypeList | undefined
+*   } else {
+*     // data.bl is number | undefined
+*   }
+* }
+* ```
+*
+* @public
+*/
+type CmcdData = CmcdV1Data | CmcdV2Data;
 //#endregion
-//#region src/CMCD_V2.d.ts
+//#region src/CmcdValidationSeverity.d.ts
 /**
-* CMCD Version 2
+* CMCD validation severity level: error.
 *
 * @public
 */
-declare const CMCD_V2: 2;
+declare const CMCD_VALIDATION_SEVERITY_ERROR: "error";
+/**
+* CMCD validation severity level: warning.
+*
+* @public
+*/
+declare const CMCD_VALIDATION_SEVERITY_WARNING: "warning";
+/**
+* CMCD validation severity level.
+*
+* @public
+*/
+declare const CmcdValidationSeverity: {
+  readonly ERROR: typeof CMCD_VALIDATION_SEVERITY_ERROR;
+  readonly WARNING: typeof CMCD_VALIDATION_SEVERITY_WARNING;
+};
+/**
+* CMCD validation severity level.
+*
+* @public
+*/
+type CmcdValidationSeverity = ValueOf<typeof CmcdValidationSeverity>;
 //#endregion
-//#region src/CmcdVersion.d.ts
+//#region src/CmcdValidationIssue.d.ts
 /**
-* The version of the CMCD specification.
+* Describes a single validation issue found in a CMCD payload.
 *
 * @public
 */
-type CmcdVersion = typeof CMCD_V1 | typeof CMCD_V2;
+type CmcdValidationIssue = {
+  /**
+  * The CMCD key associated with the issue, or undefined for
+  * structural issues.
+  */
+  key?: string;
+  /**
+  * A human-readable description of the issue.
+  */
+  message: string;
+  /**
+  * The severity of the issue.
+  */
+  severity: CmcdValidationSeverity;
+};
+//#endregion
+//#region src/CmcdValidationResult.d.ts
+/**
+* The result of validating a CMCD payload.
+*
+* @public
+*/
+type CmcdValidationResult = {
+  /** Whether the payload is valid. True if there are zero errors
+  * (warnings are acceptable).
+  */
+  valid: boolean;
+  /**
+  * The list of validation issues found.
+  */
+  issues: CmcdValidationIssue[];
+};
+//#endregion
+//#region src/CmcdDataValidationResult.d.ts
+/**
+* The result of validating a single CMCD payload (headers or query).
+*
+* Extends {@link CmcdValidationResult} with the decoded {@link CmcdData}.
+*
+* @public
+*/
+type CmcdDataValidationResult = CmcdValidationResult & {
+  /**
+  * The decoded CMCD data.
+  */
+  data: CmcdData;
+};
+//#endregion
+//#region src/CmcdDecodeOptions.d.ts
+/**
+* Options for decoding CMCD data.
+*
+* @public
+*/
+type CmcdDecodeOptions = {
+  /**
+  * When `true`, up-converts version 1 data to version 2 format by wrapping
+  * scalar values in arrays for inner-list keys (e.g., `bl`, `br`, `mtp`).
+  *
+  * This ensures a consistent data shape regardless of the source version,
+  * mirroring the down-conversion that occurs during encoding.
+  *
+  * @defaultValue false
+  */
+  convertToLatest?: boolean;
+};
 //#endregion
 //#region src/CmcdReportConfig.d.ts
 /**
@@ -1453,6 +1737,22 @@ type CmcdEventReportConfig = CmcdReportConfig & {
   batchSize?: number;
 };
 //#endregion
+//#region src/CmcdEventsValidationResult.d.ts
+/**
+* The result of validating a multi-line CMCD event payload.
+*
+* Extends {@link CmcdValidationResult} with an array of decoded
+* {@link CmcdData} objects, one per event line.
+*
+* @public
+*/
+type CmcdEventsValidationResult = CmcdValidationResult & {
+  /**
+  * The decoded CMCD data, one entry per event line.
+  */
+  data: CmcdData[];
+};
+//#endregion
 //#region src/CmcdHeaderKey.d.ts
 /**
 * A CMCD header key.
@@ -1577,6 +1877,8 @@ type CmcdRequestReport<D = unknown> = HttpRequest & {
 /**
 * The CMCD reporter.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reporting-modes-when-we-send-data | CTA-5004-A Reporting Modes}
+*
 * @public
 */
 declare class CmcdReporter {
@@ -1600,6 +1902,10 @@ declare class CmcdReporter {
   }>);
   /**
   * Starts the CMCD reporter. Called by the player when the reporter is enabled.
+  *
+  * Note: This fires an initial time-interval event immediately (synchronously)
+  * before the first interval elapses. Ensure CMCD data (sid, cid, etc.) is
+  * populated before calling start().
   */
   start(): void;
   /**
@@ -1682,7 +1988,7 @@ declare class CmcdReporter {
   * Creates a new request with the CMCD request report data applied. Called by the player
   * before sending the request.
   *
-  * @param req - The request to apply the CMCD request report to.
+  * @param request - The request to apply the CMCD request report to.
   * @param data - The data to apply to the request. This data only
   *               applies to this request report. Persistent data
   *               should be updated using `update()`.
@@ -1708,20 +2014,44 @@ declare class CmcdReporter {
   private resetSession;
 }
 //#endregion
+//#region src/CmcdValidationOptions.d.ts
+/**
+* Options for CMCD validation functions.
+*
+* @public
+*/
+type CmcdValidationOptions = {
+  /**
+  * Explicit CMCD version override. If not provided, the version is
+  * inferred from the payload's `v` key, defaulting to 1.
+  */
+  version?: CmcdVersion;
+  /**
+  * The reporting mode of the payload.
+  */
+  reportingMode?: CmcdReportingMode;
+};
+//#endregion
 //#region src/decodeCmcd.d.ts
 /**
 * Decode a CMCD string to an object.
 *
 * @param cmcd - The CMCD string to decode.
+* @param options - Options for decoding.
 *
 * @returns The decoded CMCD object.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#payload-definition-for-headers-and-query-argument-transmission | CTA-5004-A Payload Definition}
+*
 * @public
 *
 * @example
 * {@includeCode ../test/decodeCmcd.test.ts#example}
 */
-declare function decodeCmcd<T extends Cmcd = Cmcd>(cmcd: string): T;
+declare function decodeCmcd(cmcd: string, options: CmcdDecodeOptions & {
+  convertToLatest: true;
+}): Cmcd;
+declare function decodeCmcd<T extends CmcdData = CmcdData>(cmcd: string, options?: CmcdDecodeOptions): T;
 //#endregion
 //#region src/encodeCmcd.d.ts
 /**
@@ -1732,6 +2062,8 @@ declare function decodeCmcd<T extends Cmcd = Cmcd>(cmcd: string): T;
 *
 * @returns The encoded CMCD string.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#payload-definition-for-headers-and-query-argument-transmission | CTA-5004-A Payload Definition}
+*
 * @public
 *
 * @example
@@ -1744,45 +2076,63 @@ declare function encodeCmcd(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 * Decode CMCD data from request headers.
 *
 * @param headers - The request headers to decode.
+* @param options - Options for decoding.
 *
 * @returns The decoded CMCD data.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-A Header Field Definition}
+*
 * @public
 *
 * @example
 * {@includeCode ../test/fromCmcdHeaders.test.ts#example}
 */
-declare function fromCmcdHeaders(headers: Record<string, string> | Headers): Cmcd;
+declare function fromCmcdHeaders(headers: Record<string, string> | Headers, options: CmcdDecodeOptions & {
+  convertToLatest: true;
+}): Cmcd;
+declare function fromCmcdHeaders(headers: Record<string, string> | Headers, options?: CmcdDecodeOptions): CmcdData;
 //#endregion
 //#region src/fromCmcdQuery.d.ts
 /**
 * Decode CMCD data from a query string.
 *
 * @param query - The query string to decode.
+* @param options - Options for decoding.
 *
 * @returns The decoded CMCD data.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-A Query Argument Definition}
+*
 * @public
 *
 * @example
 * {@includeCode ../test/fromCmcdQuery.test.ts#example}
 */
-declare function fromCmcdQuery(query: string | URLSearchParams): Cmcd;
+declare function fromCmcdQuery(query: string | URLSearchParams, options: CmcdDecodeOptions & {
+  convertToLatest: true;
+}): Cmcd;
+declare function fromCmcdQuery(query: string | URLSearchParams, options?: CmcdDecodeOptions): CmcdData;
 //#endregion
 //#region src/fromCmcdUrl.d.ts
 /**
 * Decode CMCD data from a url encoded string.
 *
 * @param url - The url encoded string to decode.
+* @param options - Options for decoding.
 *
 * @returns The decoded CMCD data.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-A Query Argument Definition}
+*
 * @public
 *
 * @example
 * {@includeCode ../test/fromCmcdUrl.test.ts#example}
 */
-declare function fromCmcdUrl(url: string): Cmcd;
+declare function fromCmcdUrl(url: string, options: CmcdDecodeOptions & {
+  convertToLatest: true;
+}): Cmcd;
+declare function fromCmcdUrl(url: string, options?: CmcdDecodeOptions): CmcdData;
 //#endregion
 //#region src/groupCmcdHeaders.d.ts
 /**
@@ -1793,6 +2143,8 @@ declare function fromCmcdUrl(url: string): Cmcd;
 *
 * @returns The CMCD header shards.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-A Header Field Definition}
+*
 * @public
 */
 declare function groupCmcdHeaders(cmcd: Cmcd, customHeaderMap?: Partial<CmcdHeaderMap>): Record<CmcdHeaderField, CmcdHeaderValue>;
@@ -1854,6 +2206,21 @@ declare function isCmcdRequestKey(key: string): key is keyof Cmcd;
 */
 declare function isCmcdResponseReceivedKey(key: string): key is keyof Cmcd;
 //#endregion
+//#region src/isCmcdV1Data.d.ts
+/**
+* Check if a CMCD data object is version 1.
+*
+* @param data - The CMCD data object to check.
+*
+* @returns `true` if the data is version 1, `false` otherwise.
+*
+* @public
+*
+* @example
+* {@includeCode ../test/isCmcdV1Data.test.ts#example}
+*/
+declare function isCmcdV1Data(data: CmcdData): data is CmcdV1Data;
+//#endregion
 //#region src/isCmcdV1Key.d.ts
 /**
 * Filter function for CMCD v1 keys.
@@ -1869,6 +2236,21 @@ declare function isCmcdResponseReceivedKey(key: string): key is keyof Cmcd;
 */
 declare function isCmcdV1Key(key: string): key is CmcdKey;
 //#endregion
+//#region src/isCmcdV2Data.d.ts
+/**
+* Check if a CMCD data object is version 2.
+*
+* @param data - The CMCD data object to check.
+*
+* @returns `true` if the data is version 2, `false` otherwise.
+*
+* @public
+*
+* @example
+* {@includeCode ../test/isCmcdV2Data.test.ts#example}
+*/
+declare function isCmcdV2Data(data: CmcdData): data is CmcdV2Data;
+//#endregion
 //#region src/prepareCmcdData.d.ts
 /**
 * Convert a generic object to CMCD data.
@@ -1889,6 +2271,8 @@ declare function prepareCmcdData(obj: Record<string, any>, options?: CmcdEncodeO
 *
 * @returns The CMCD header shards.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-A Header Field Definition}
+*
 * @public
 *
 * @example
@@ -1905,6 +2289,8 @@ declare function toCmcdHeaders(cmcd: Cmcd, options?: CmcdEncodeOptions): Record<
 *
 * @returns The CMCD query arg.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-A Query Argument Definition}
+*
 * @public
 *
 * @example
@@ -1921,6 +2307,8 @@ declare function toCmcdQuery(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 *
 * @returns The URL encoded CMCD data.
 *
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-A Query Argument Definition}
+*
 * @public
 */
 declare function toCmcdUrl(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
@@ -1937,5 +2325,166 @@ declare function toCmcdUrl(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 */
 declare function toCmcdValue<V extends SfBareItem, P>(value: V, params?: P): SfItem<V, P>;
 //#endregion
-export { CMCD_DEFAULT_TIME_INTERVAL, CMCD_EVENT_AD_BREAK_END, CMCD_EVENT_AD_BREAK_START, CMCD_EVENT_AD_END, CMCD_EVENT_AD_START, CMCD_EVENT_BACKGROUNDED_MODE, CMCD_EVENT_BITRATE_CHANGE, CMCD_EVENT_CONTENT_ID, CMCD_EVENT_CUSTOM_EVENT, CMCD_EVENT_ERROR, CMCD_EVENT_KEYS, CMCD_EVENT_MODE, CMCD_EVENT_MUTE, CMCD_EVENT_PLAYER_COLLAPSE, CMCD_EVENT_PLAYER_EXPAND, CMCD_EVENT_PLAY_STATE, CMCD_EVENT_RESPONSE_RECEIVED, CMCD_EVENT_SKIP, CMCD_EVENT_TIME_INTERVAL, CMCD_EVENT_UNMUTE, CMCD_FORMATTER_MAP, CMCD_HEADERS, CMCD_HEADER_MAP, CMCD_JSON, CMCD_KEYS, CMCD_OBJECT, CMCD_PARAM, CMCD_QUERY, CMCD_REQUEST, CMCD_REQUEST_KEYS, CMCD_REQUEST_MODE, CMCD_RESPONSE_KEYS, CMCD_SESSION, CMCD_STATUS, CMCD_V1, CMCD_V1_KEYS, CMCD_V2, Cmcd, CmcdCustomKey, CmcdCustomValue, CmcdEncodeOptions, CmcdEvent, CmcdEventReportConfig, CmcdEventType, CmcdFormatter, CmcdFormatterMap, CmcdFormatterOptions, CmcdHeaderField, CmcdHeaderKey, CmcdHeaderMap, CmcdHeaderValue, CmcdKey, CmcdObjectType, CmcdObjectTypeList, CmcdPlayerState, CmcdReportConfig, CmcdReporter, CmcdReporterConfig, CmcdReportingMode, CmcdRequest, CmcdRequestKey, CmcdRequestReport, CmcdRequestReportConfig, CmcdResponse, CmcdStreamType, CmcdStreamingFormat, CmcdTransmissionMode, CmcdV1, CmcdValue, CmcdVersion, appendCmcdHeaders, appendCmcdQuery, decodeCmcd, encodeCmcd, fromCmcdHeaders, fromCmcdQuery, fromCmcdUrl, groupCmcdHeaders, isCmcdCustomKey, isCmcdEventKey, isCmcdRequestKey, isCmcdResponseReceivedKey, isCmcdV1Key, prepareCmcdData, toCmcdHeaders, toCmcdQuery, toCmcdUrl, toCmcdValue };
+//#region src/validateCmcd.d.ts
+/**
+* Validates a CMCD payload by checking keys, values, and structure.
+*
+* @example
+* {@includeCode ../test/validateCmcd.test.ts#example}
+*
+* @param data - The CMCD payload to validate.
+* @param options - Validation options.
+* @returns The validation result.
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#data-payload-definition-what-data-to-send | CTA-5004-A Data Payload Definition}
+*
+* @public
+*/
+declare function validateCmcd(data: Record<string, unknown>, options?: CmcdValidationOptions): CmcdValidationResult;
+//#endregion
+//#region src/validateCmcdEventReport.d.ts
+/**
+* Validates a full HTTP request as an event-mode payload.
+*
+* Accepts an {@link @svta/cml-utils!HttpRequest | HttpRequest} object.
+*
+* This function validates that the request uses the POST method and has
+* the correct `Content-Type` header (`application/cmcd`) in addition to
+* validating the body content via {@link validateCmcdEvents}.
+*
+* @param request - An `HttpRequest` to validate.
+* @param options - Validation options (excluding `reportingMode`).
+* @returns The validation result including decoded data per event line.
+*
+* @example {@includeCode ../test/validateCmcdEventReport.test.ts#example}
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-A Event Mode}
+*
+* @public
+*/
+declare function validateCmcdEventReport(request: HttpRequest, options?: Omit<CmcdValidationOptions, "reportingMode">): CmcdEventsValidationResult;
+//#endregion
+//#region src/validateCmcdEvents.d.ts
+/**
+* Validates a raw CMCD string as an event-mode payload.
+*
+* This function decodes the string internally and validates it with
+* `reportingMode` set to `'event'`. The input may contain multiple
+* newline-separated events (e.g. an `application/cmcd` POST body), in which
+* case each line is validated independently and the results are merged.
+*
+* @param cmcd - The raw CMCD-encoded string to validate. May contain
+*   multiple newline-separated event lines.
+* @param options - Validation options (excluding `reportingMode`).
+* @returns The validation result including decoded data per event line.
+*
+* @example
+* {@includeCode ../test/validateCmcdEvents.test.ts#example}
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#body-definition | CTA-5004-A Body Definition}
+*
+* @public
+*/
+declare function validateCmcdEvents(cmcd: string, options?: Omit<CmcdValidationOptions, "reportingMode">): CmcdEventsValidationResult;
+//#endregion
+//#region src/validateCmcdHeaders.d.ts
+/**
+* Validates CMCD HTTP headers by checking shard placement and payload validity.
+*
+* This function accepts raw CMCD header strings, decodes each shard
+* internally, verifies that each key is placed in its correct header shard,
+* then merges all shards and runs full payload validation (keys, values, and
+* structure) on the merged data.
+*
+* @example
+* {@includeCode ../test/validateCmcdHeaders.test.ts#example}
+*
+* @param headers - A `Headers` instance or a record of CMCD header fields to their raw encoded string values.
+* @param options - Validation options (excluding `reportingMode`).
+* @returns The validation result including decoded data.
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-A Header Field Definition}
+*
+* @public
+*/
+declare function validateCmcdHeaders(headers: Record<string, string> | Headers, options?: Omit<CmcdValidationOptions, "reportingMode">): CmcdDataValidationResult;
+//#endregion
+//#region src/validateCmcdKeys.d.ts
+/**
+* Validates that all keys in a CMCD payload are recognized spec keys or valid custom keys.
+*
+* @example
+* {@includeCode ../test/validateCmcdKeys.test.ts#example}
+*
+* @param data - The CMCD payload to validate.
+* @param options - Validation options.
+* @returns The validation result.
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-A Reserved Keys}
+*
+* @public
+*/
+declare function validateCmcdKeys(data: Record<string, unknown>, options?: CmcdValidationOptions): CmcdValidationResult;
+//#endregion
+//#region src/validateCmcdRequest.d.ts
+/**
+* Validates CMCD data from a request as a request-mode payload.
+*
+* Accepts a
+* {@link https://developer.mozilla.org/en-US/docs/Web/API/Request | Request}
+* object or an {@link @svta/cml-utils!HttpRequest | HttpRequest} object.
+*
+* The function checks for CMCD data in the HTTP headers first. If CMCD
+* headers are found, validation includes shard-placement checks via
+* {@link validateCmcdHeaders}. Otherwise, the CMCD query parameter is
+* extracted from the URL and validated.
+*
+* @param request - A `Request` or `HttpRequest` to validate.
+* @param options - Validation options (excluding `reportingMode`).
+* @returns The validation result including decoded data.
+*
+* @example
+* {@includeCode ../test/validateCmcdRequest.test.ts#example}
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-A Request Mode}
+*
+* @public
+*/
+declare function validateCmcdRequest(request: Request | HttpRequest, options?: Omit<CmcdValidationOptions, "reportingMode">): CmcdDataValidationResult;
+//#endregion
+//#region src/validateCmcdStructure.d.ts
+/**
+* Validates the structural rules of a CMCD payload.
+*
+* @example
+* {@includeCode ../test/validateCmcdStructure.test.ts#example}
+*
+* @param data - The CMCD payload to validate.
+* @param options - Validation options.
+* @returns The validation result.
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#data-payload-definition-what-data-to-send | CTA-5004-A Data Payload Definition}
+*
+* @public
+*/
+declare function validateCmcdStructure(data: Record<string, unknown>, options?: CmcdValidationOptions): CmcdValidationResult;
+//#endregion
+//#region src/validateCmcdValues.d.ts
+/**
+* Validates that all values in a CMCD payload conform to the expected types and constraints.
+*
+* @example
+* {@includeCode ../test/validateCmcdValues.test.ts#example}
+*
+* @param data - The CMCD payload to validate.
+* @param options - Validation options.
+* @returns The validation result.
+*
+* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-A Reserved Keys}
+*
+* @public
+*/
+declare function validateCmcdValues(data: Record<string, unknown>, options?: CmcdValidationOptions): CmcdValidationResult;
+//#endregion
+export { CMCD_DEFAULT_TIME_INTERVAL, CMCD_EVENT_AD_BREAK_END, CMCD_EVENT_AD_BREAK_START, CMCD_EVENT_AD_END, CMCD_EVENT_AD_START, CMCD_EVENT_BACKGROUNDED_MODE, CMCD_EVENT_BITRATE_CHANGE, CMCD_EVENT_CONTENT_ID, CMCD_EVENT_CUSTOM_EVENT, CMCD_EVENT_ERROR, CMCD_EVENT_KEYS, CMCD_EVENT_MODE, CMCD_EVENT_MUTE, CMCD_EVENT_PLAYER_COLLAPSE, CMCD_EVENT_PLAYER_EXPAND, CMCD_EVENT_PLAY_STATE, CMCD_EVENT_RESPONSE_RECEIVED, CMCD_EVENT_SKIP, CMCD_EVENT_TIME_INTERVAL, CMCD_EVENT_UNMUTE, CMCD_FORMATTER_MAP, CMCD_HEADERS, CMCD_HEADER_FIELDS, CMCD_HEADER_MAP, CMCD_JSON, CMCD_KEYS, CMCD_MIME_TYPE, CMCD_OBJECT, CMCD_PARAM, CMCD_QUERY, CMCD_REQUEST, CMCD_REQUEST_KEYS, CMCD_REQUEST_MODE, CMCD_RESPONSE_KEYS, CMCD_SESSION, CMCD_STATUS, CMCD_V1, CMCD_V1_KEYS, CMCD_V2, CMCD_VALIDATION_SEVERITY_ERROR, CMCD_VALIDATION_SEVERITY_WARNING, Cmcd, CmcdCustomKey, CmcdCustomValue, CmcdData, CmcdDataValidationResult, CmcdDecodeOptions, CmcdEncodeOptions, CmcdEvent, CmcdEventReportConfig, CmcdEventType, CmcdEventsValidationResult, CmcdFormatter, CmcdFormatterMap, CmcdFormatterOptions, CmcdHeaderField, CmcdHeaderKey, CmcdHeaderMap, CmcdHeaderValue, CmcdKey, CmcdObjectType, CmcdObjectTypeList, CmcdPlayerState, CmcdReportConfig, CmcdReporter, CmcdReporterConfig, CmcdReportingMode, CmcdRequest, CmcdRequestKey, CmcdRequestReport, CmcdRequestReportConfig, CmcdResponse, CmcdStreamType, CmcdStreamingFormat, CmcdTransmissionMode, CmcdV1, CmcdV1Data, CmcdV2Data, CmcdValidationIssue, CmcdValidationOptions, CmcdValidationResult, CmcdValidationSeverity, CmcdValue, CmcdVersion, appendCmcdHeaders, appendCmcdQuery, decodeCmcd, encodeCmcd, fromCmcdHeaders, fromCmcdQuery, fromCmcdUrl, groupCmcdHeaders, isCmcdCustomKey, isCmcdEventKey, isCmcdRequestKey, isCmcdResponseReceivedKey, isCmcdV1Data, isCmcdV1Key, isCmcdV2Data, prepareCmcdData, toCmcdHeaders, toCmcdQuery, toCmcdUrl, toCmcdValue, validateCmcd, validateCmcdEventReport, validateCmcdEvents, validateCmcdHeaders, validateCmcdKeys, validateCmcdRequest, validateCmcdStructure, validateCmcdValues };
 //# sourceMappingURL=index.d.ts.map