@svta/cml-cmcd 0.19.0

package/dist/CMCD_OBJECT.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_OBJECT.js","sourceRoot":"","sources":["../src/CMCD_OBJECT.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC","sourcesContent":["/**\n * CMCD object header name.\n *\n *\n * @beta\n */\nexport const CMCD_OBJECT = 'CMCD-Object';\n"]}

package/dist/CMCD_PARAM.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD parameter name.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_PARAM = "CMCD";
+//# sourceMappingURL=CMCD_PARAM.d.ts.map

package/dist/CMCD_PARAM.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_PARAM.d.ts","sourceRoot":"","sources":["../src/CMCD_PARAM.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,UAAU,SAAS,CAAC"}

package/dist/CMCD_PARAM.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD parameter name.
+ *
+ *
+ * @beta
+ */
+export const CMCD_PARAM = 'CMCD';
+//# sourceMappingURL=CMCD_PARAM.js.map

package/dist/CMCD_PARAM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_PARAM.js","sourceRoot":"","sources":["../src/CMCD_PARAM.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC","sourcesContent":["/**\n * CMCD parameter name.\n *\n *\n * @beta\n */\nexport const CMCD_PARAM = 'CMCD';\n"]}

package/dist/CMCD_QUERY.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD `query` transmission mode.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_QUERY = "query";
+//# sourceMappingURL=CMCD_QUERY.d.ts.map

package/dist/CMCD_QUERY.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_QUERY.d.ts","sourceRoot":"","sources":["../src/CMCD_QUERY.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,UAAU,UAAU,CAAC"}

package/dist/CMCD_QUERY.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD `query` transmission mode.
+ *
+ *
+ * @beta
+ */
+export const CMCD_QUERY = 'query';
+//# sourceMappingURL=CMCD_QUERY.js.map

package/dist/CMCD_QUERY.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_QUERY.js","sourceRoot":"","sources":["../src/CMCD_QUERY.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/**\n * CMCD `query` transmission mode.\n *\n *\n * @beta\n */\nexport const CMCD_QUERY = 'query';\n"]}

package/dist/CMCD_REQUEST.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD request header name.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_REQUEST = "CMCD-Request";
+//# sourceMappingURL=CMCD_REQUEST.d.ts.map

package/dist/CMCD_REQUEST.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_REQUEST.d.ts","sourceRoot":"","sources":["../src/CMCD_REQUEST.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,iBAAiB,CAAC"}

package/dist/CMCD_REQUEST.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD request header name.
+ *
+ *
+ * @beta
+ */
+export const CMCD_REQUEST = 'CMCD-Request';
+//# sourceMappingURL=CMCD_REQUEST.js.map

package/dist/CMCD_REQUEST.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_REQUEST.js","sourceRoot":"","sources":["../src/CMCD_REQUEST.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAC","sourcesContent":["/**\n * CMCD request header name.\n *\n *\n * @beta\n */\nexport const CMCD_REQUEST = 'CMCD-Request';\n"]}

package/dist/CMCD_REQUEST_KEYS.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines the request-specific keys for CMCD (Common Media Client Data) version 2.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_REQUEST_KEYS: readonly ["d", "dl", "nor", "ot", "rtp", "su"];
+//# sourceMappingURL=CMCD_REQUEST_KEYS.d.ts.map

package/dist/CMCD_REQUEST_KEYS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_REQUEST_KEYS.d.ts","sourceRoot":"","sources":["../src/CMCD_REQUEST_KEYS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,gDAOpB,CAAC"}

package/dist/CMCD_REQUEST_KEYS.js

@@ -0,0 +1,15 @@
+/**
+ * Defines the request-specific keys for CMCD (Common Media Client Data) version 2.
+ *
+ *
+ * @beta
+ */
+export const CMCD_REQUEST_KEYS = [
+    'd',
+    'dl',
+    'nor',
+    'ot',
+    'rtp',
+    'su',
+];
+//# sourceMappingURL=CMCD_REQUEST_KEYS.js.map

package/dist/CMCD_REQUEST_KEYS.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_REQUEST_KEYS.js","sourceRoot":"","sources":["../src/CMCD_REQUEST_KEYS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,GAAG;IACH,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;CACK,CAAC","sourcesContent":["/**\n * Defines the request-specific keys for CMCD (Common Media Client Data) version 2.\n *\n *\n * @beta\n */\nexport const CMCD_REQUEST_KEYS = [\n\t'd',\n\t'dl',\n\t'nor',\n\t'ot',\n\t'rtp',\n\t'su',\n] as const;\n"]}

package/dist/CMCD_REQUEST_MODE.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD request mode variable name.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_REQUEST_MODE = "request";
+//# sourceMappingURL=CMCD_REQUEST_MODE.d.ts.map

package/dist/CMCD_REQUEST_MODE.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_REQUEST_MODE.d.ts","sourceRoot":"","sources":["../src/CMCD_REQUEST_MODE.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,YAAY,CAAC"}

package/dist/CMCD_REQUEST_MODE.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD request mode variable name.
+ *
+ *
+ * @beta
+ */
+export const CMCD_REQUEST_MODE = 'request';
+//# sourceMappingURL=CMCD_REQUEST_MODE.js.map

package/dist/CMCD_REQUEST_MODE.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_REQUEST_MODE.js","sourceRoot":"","sources":["../src/CMCD_REQUEST_MODE.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAC","sourcesContent":["/**\n * CMCD request mode variable name.\n *\n *\n * @beta\n */\nexport const CMCD_REQUEST_MODE = 'request';\n"]}

package/dist/CMCD_RESPONSE_KEYS.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD v2 - Response-only and timing keys.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_RESPONSE_KEYS: readonly ["cmsdd", "cmsds", "rc", "smrt", "ttfb", "ttfbb", "ttlb", "url"];
+//# sourceMappingURL=CMCD_RESPONSE_KEYS.d.ts.map

package/dist/CMCD_RESPONSE_KEYS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_RESPONSE_KEYS.d.ts","sourceRoot":"","sources":["../src/CMCD_RESPONSE_KEYS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,2EASrB,CAAC"}

package/dist/CMCD_RESPONSE_KEYS.js

@@ -0,0 +1,17 @@
+/**
+ * CMCD v2 - Response-only and timing keys.
+ *
+ *
+ * @beta
+ */
+export const CMCD_RESPONSE_KEYS = [
+    'cmsdd',
+    'cmsds',
+    'rc',
+    'smrt',
+    'ttfb',
+    'ttfbb',
+    'ttlb',
+    'url',
+];
+//# sourceMappingURL=CMCD_RESPONSE_KEYS.js.map

package/dist/CMCD_RESPONSE_KEYS.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_RESPONSE_KEYS.js","sourceRoot":"","sources":["../src/CMCD_RESPONSE_KEYS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC,OAAO;IACP,OAAO;IACP,IAAI;IACJ,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,KAAK;CACI,CAAC","sourcesContent":["/**\n * CMCD v2 - Response-only and timing keys.\n *\n *\n * @beta\n */\nexport const CMCD_RESPONSE_KEYS = [\n\t'cmsdd',\n\t'cmsds',\n\t'rc',\n\t'smrt',\n\t'ttfb',\n\t'ttfbb',\n\t'ttlb',\n\t'url',\n] as const;\n"]}

package/dist/CMCD_RESPONSE_MODE.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD response mode variable name.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_RESPONSE_MODE = "response";
+//# sourceMappingURL=CMCD_RESPONSE_MODE.d.ts.map

package/dist/CMCD_RESPONSE_MODE.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_RESPONSE_MODE.d.ts","sourceRoot":"","sources":["../src/CMCD_RESPONSE_MODE.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,aAAa,CAAC"}

package/dist/CMCD_RESPONSE_MODE.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD response mode variable name.
+ *
+ *
+ * @beta
+ */
+export const CMCD_RESPONSE_MODE = 'response';
+//# sourceMappingURL=CMCD_RESPONSE_MODE.js.map

package/dist/CMCD_RESPONSE_MODE.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_RESPONSE_MODE.js","sourceRoot":"","sources":["../src/CMCD_RESPONSE_MODE.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC","sourcesContent":["/**\n * CMCD response mode variable name.\n *\n *\n * @beta\n */\nexport const CMCD_RESPONSE_MODE = 'response';\n"]}

package/dist/CMCD_SESSION.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD session header name.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_SESSION = "CMCD-Session";
+//# sourceMappingURL=CMCD_SESSION.d.ts.map

package/dist/CMCD_SESSION.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_SESSION.d.ts","sourceRoot":"","sources":["../src/CMCD_SESSION.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,iBAAiB,CAAC"}

package/dist/CMCD_SESSION.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD session header name.
+ *
+ *
+ * @beta
+ */
+export const CMCD_SESSION = 'CMCD-Session';
+//# sourceMappingURL=CMCD_SESSION.js.map

package/dist/CMCD_SESSION.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_SESSION.js","sourceRoot":"","sources":["../src/CMCD_SESSION.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAC","sourcesContent":["/**\n * CMCD session header name.\n *\n *\n * @beta\n */\nexport const CMCD_SESSION = 'CMCD-Session';\n"]}

package/dist/CMCD_STATUS.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD status header name.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_STATUS = "CMCD-Status";
+//# sourceMappingURL=CMCD_STATUS.d.ts.map

package/dist/CMCD_STATUS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_STATUS.d.ts","sourceRoot":"","sources":["../src/CMCD_STATUS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,WAAW,gBAAgB,CAAC"}

package/dist/CMCD_STATUS.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD status header name.
+ *
+ *
+ * @beta
+ */
+export const CMCD_STATUS = 'CMCD-Status';
+//# sourceMappingURL=CMCD_STATUS.js.map

package/dist/CMCD_STATUS.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_STATUS.js","sourceRoot":"","sources":["../src/CMCD_STATUS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC","sourcesContent":["/**\n * CMCD status header name.\n *\n *\n * @beta\n */\nexport const CMCD_STATUS = 'CMCD-Status';\n"]}

package/dist/CMCD_V1.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD Version 1
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_V1 = 1;
+//# sourceMappingURL=CMCD_V1.d.ts.map

package/dist/CMCD_V1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_V1.d.ts","sourceRoot":"","sources":["../src/CMCD_V1.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,OAAO,IAAI,CAAC"}

package/dist/CMCD_V1.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD Version 1
+ *
+ *
+ * @beta
+ */
+export const CMCD_V1 = 1;
+//# sourceMappingURL=CMCD_V1.js.map

package/dist/CMCD_V1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_V1.js","sourceRoot":"","sources":["../src/CMCD_V1.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC","sourcesContent":["/**\n * CMCD Version 1\n *\n *\n * @beta\n */\nexport const CMCD_V1 = 1;\n"]}

package/dist/CMCD_V1_KEYS.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines the keys for CMCD (Common Media Client Data) version 1.
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_V1_KEYS: readonly ["bl", "br", "bs", "cid", "d", "dl", "mtp", "nor", "nrr", "ot", "pr", "rtp", "sf", "sid", "st", "su", "tb", "v"];
+//# sourceMappingURL=CMCD_V1_KEYS.d.ts.map

package/dist/CMCD_V1_KEYS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_V1_KEYS.d.ts","sourceRoot":"","sources":["../src/CMCD_V1_KEYS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,2HAmBf,CAAC"}

package/dist/CMCD_V1_KEYS.js

@@ -0,0 +1,27 @@
+/**
+ * Defines the keys for CMCD (Common Media Client Data) version 1.
+ *
+ *
+ * @beta
+ */
+export const CMCD_V1_KEYS = [
+    'bl',
+    'br',
+    'bs',
+    'cid',
+    'd',
+    'dl',
+    'mtp',
+    'nor',
+    'nrr',
+    'ot',
+    'pr',
+    'rtp',
+    'sf',
+    'sid',
+    'st',
+    'su',
+    'tb',
+    'v',
+];
+//# sourceMappingURL=CMCD_V1_KEYS.js.map

package/dist/CMCD_V1_KEYS.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_V1_KEYS.js","sourceRoot":"","sources":["../src/CMCD_V1_KEYS.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,GAAG;IACH,IAAI;IACJ,KAAK;IACL,KAAK;IACL,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,GAAG;CACM,CAAC","sourcesContent":["/**\n * Defines the keys for CMCD (Common Media Client Data) version 1.\n *\n *\n * @beta\n */\nexport const CMCD_V1_KEYS = [\n\t'bl',\n\t'br',\n\t'bs',\n\t'cid',\n\t'd',\n\t'dl',\n\t'mtp',\n\t'nor',\n\t'nrr',\n\t'ot',\n\t'pr',\n\t'rtp',\n\t'sf',\n\t'sid',\n\t'st',\n\t'su',\n\t'tb',\n\t'v',\n] as const;\n"]}

package/dist/CMCD_V2.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CMCD Version 2
+ *
+ *
+ * @beta
+ */
+export declare const CMCD_V2 = 2;
+//# sourceMappingURL=CMCD_V2.d.ts.map

package/dist/CMCD_V2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_V2.d.ts","sourceRoot":"","sources":["../src/CMCD_V2.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,OAAO,IAAI,CAAC"}

package/dist/CMCD_V2.js

@@ -0,0 +1,8 @@
+/**
+ * CMCD Version 2
+ *
+ *
+ * @beta
+ */
+export const CMCD_V2 = 2;
+//# sourceMappingURL=CMCD_V2.js.map

package/dist/CMCD_V2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CMCD_V2.js","sourceRoot":"","sources":["../src/CMCD_V2.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC","sourcesContent":["/**\n * CMCD Version 2\n *\n *\n * @beta\n */\nexport const CMCD_V2 = 2;\n"]}

package/dist/Cmcd.d.ts

@@ -0,0 +1,214 @@
+import type { SfItem } from '@svta/cml-structured-field-values/SfItem.js';
+import type { ValueOrArray } from '@svta/cml-utils/ValueOrArray.js';
+import type { CmcdCustomKey } from './CmcdCustomKey.js';
+import type { CmcdObjectType } from './CmcdObjectType.js';
+import type { CmcdStreamType } from './CmcdStreamType.js';
+import type { CmcdStreamingFormat } from './CmcdStreamingFormat.js';
+import type { CmcdValue } from './CmcdValue.js';
+/**
+ * Common Media Client Data (CMCD) is a standardized set of HTTP request header fields and query string parameters.
+ *
+ * @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf|CMCD Spec}
+ *
+ *
+ * @beta
+ */
+export type Cmcd = {
+    /**
+     * Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision
+     * with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
+     */
+    [index: CmcdCustomKey]: CmcdValue;
+    /**
+     * Encoded bitrate
+     *
+     * The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however,
+     * it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values,
+     * the peak value should be transmitted.
+     *
+     * Integer kbps
+     */
+    br?: number;
+    /**
+     * Object duration
+     *
+     * The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value
+     * MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the
+     * estimated duration if the explicit value is not known.
+     *
+     * Integer milliseconds
+     */
+    d?: number;
+    /**
+     * Object type
+     *
+     * The media type of the current object being requested:
+     * - `m` = text file, such as a manifest or playlist
+     * - `a` = audio only
+     * - `v` = video only
+     * - `av` = muxed audio and video
+     * - `i` = init segment
+     * - `c` = caption or subtitle
+     * - `tt` = ISOBMFF timed text track
+     * - `k` = cryptographic key, license or certificate.
+     * - `o` = other
+     *
+     * If the object type being requested is unknown, then this key MUST NOT be used.
+     */
+    ot?: CmcdObjectType;
+    /**
+     * Top bitrate
+     *
+     * The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and
+     * sizing constraints.
+     *
+     * Integer Kbps
+     */
+    tb?: number;
+    /**
+     * Buffer length
+     *
+     * The buffer length associated with the media object being requested. This value MUST be rounded to the nearest 100 ms. This key SHOULD only be
+     * sent with an object type of ‘a’, ‘v’ or ‘av’.
+     *
+     * Integer milliseconds
+     */
+    bl?: number;
+    /**
+     * Deadline
+     *
+     * Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or
+     * any other playback problems. This value MUST be rounded to the nearest 100ms. For a playback rate of 1, this may be equivalent to the player’s
+     * remaining buffer length.
+     *
+     * Integer milliseconds
+     */
+    dl?: number;
+    /**
+     * Measured mtp CMCD throughput
+     *
+     * The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived,
+     * SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple
+     * servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent
+     * connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.
+     *
+     * Integer kbps
+     */
+    mtp?: number;
+    /**
+     * Next object request
+     *
+     * Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current
+     * request. This string MUST be URLEncoded. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a
+     * pre-fetch to take place.
+     *
+     * String
+     */
+    nor?: ValueOrArray<string | SfItem>;
+    /**
+     * Next range request
+     *
+     * If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the
+     * object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a
+     * request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is
+     * NOT required and specifying multiple ranges is NOT allowed. Valid combinations are:
+     *
+     * - `"\<range-start\>-"`
+     * - `"\<range-start\>-\<range-end\>"`
+     * - `"-\<suffix-length\>"`
+     *
+     * String
+     */
+    nrr?: string;
+    /**
+     * Startup
+     *
+     * Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be
+     * rendering when this request is made. This key MUST not be sent if it is FALSE.
+     *
+     * Boolean
+     */
+    su?: boolean;
+    /**
+     * Content ID
+     *
+     * A unique string identifying the current content. Maximum length is 64 characters. This value is consistent across multiple different
+     * sessions and devices and is defined and updated at the discretion of the service provider.
+     *
+     * String
+     */
+    cid?: string;
+    /**
+     * Playback rate
+     *
+     * `1` if real-time, `2` if double speed, `0` if not playing. SHOULD only be sent if not equal to `1`.
+     *
+     * Decimal
+     */
+    pr?: number;
+    /**
+     * Streaming format
+     *
+     * The streaming format that defines the current request.
+     *
+     * - `d` = MPEG DASH
+     * - `h` = HTTP Live Streaming (HLS)
+     * - `s` = Smooth Streaming
+     * - `o` = other
+     *
+     * If the streaming format being requested is unknown, then this key MUST NOT be used.
+     */
+    sf?: CmcdStreamingFormat;
+    /**
+     * Session ID
+     *
+     * A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset.
+     * Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification.
+     *
+     * String
+     */
+    sid?: string;
+    /**
+     * Stream type
+     * - `v` = all segments are available – e.g., VOD
+     * - `l` = segments become available over time – e.g., LIVE
+     */
+    st?: CmcdStreamType;
+    /**
+     * CMCD version
+     *
+     * The version of this specification used for interpreting the defined key names and values. If this key is omitted, the client and server MUST
+     * interpret the values as being defined by version 1. Client SHOULD omit this field if the version is 1.
+     *
+     * Integer
+     */
+    v?: number;
+    /**
+     * Buffer starvation
+     *
+     * Key is included without a value if the buffer was starved at some point between the prior request and this object request,
+     * resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be
+     * sent if the buffer was not starved since the prior request.
+     *
+     * If the object type `ot` key is sent along with this key, then the `bs` key refers to the buffer associated with the particular
+     * object type. If no object type is communicated, then the buffer state applies to the current session.
+     *
+     * Boolean
+     */
+    bs?: boolean;
+    /**
+     * Requested maximum throughput
+     *
+     * The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the
+     * nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more
+     * than 10Mbps, by using rtp=10000.
+     *
+     * Note: This can benefit clients by preventing buffer saturation through over-delivery and can also deliver a community benefit
+     * through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more.
+     * The CDN may not support the rtp feature.
+     *
+     * Integer kbps
+     */
+    rtp?: number;
+};
+//# sourceMappingURL=Cmcd.d.ts.map

package/dist/Cmcd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cmcd.d.ts","sourceRoot":"","sources":["../src/Cmcd.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6CAA6C,CAAC;AAC1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,MAAM,IAAI,GAAG;IAElB;;;OAGG;IACH,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;IAMlC;;;;;;;;OAQG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;OAQG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;;;;;;OAeG;IACH,EAAE,CAAC,EAAE,cAAc,CAAC;IAEpB;;;;;;;OAOG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAKZ;;;;;;;OAOG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;OAQG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAEpC;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IAMb;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,mBAAmB,CAAC;IAEzB;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,EAAE,CAAC,EAAE,cAAc,CAAC;IAEpB;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAMX;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb,CAAC"}

package/dist/Cmcd.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Cmcd.js.map

package/dist/Cmcd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cmcd.js","sourceRoot":"","sources":["../src/Cmcd.ts"],"names":[],"mappings":"","sourcesContent":["import type { SfItem } from '@svta/cml-structured-field-values/SfItem.js';\nimport type { ValueOrArray } from '@svta/cml-utils/ValueOrArray.js';\nimport type { CmcdCustomKey } from './CmcdCustomKey.js';\nimport type { CmcdObjectType } from './CmcdObjectType.js';\nimport type { CmcdStreamType } from './CmcdStreamType.js';\nimport type { CmcdStreamingFormat } from './CmcdStreamingFormat.js';\nimport type { CmcdValue } from './CmcdValue.js';\n\n/**\n * Common Media Client Data (CMCD) is a standardized set of HTTP request header fields and query string parameters.\n *\n * @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf|CMCD Spec}\n *\n *\n * @beta\n */\nexport type Cmcd = {\n\n\t/**\n\t * Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision\n\t * with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.\n\t */\n\t[index: CmcdCustomKey]: CmcdValue;\n\n\t/////////////////\n\t// CMCD Object //\n\t/////////////////\n\n\t/**\n\t * Encoded bitrate\n\t *\n\t * The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however,\n\t * it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values,\n\t * the peak value should be transmitted.\n\t *\n\t * Integer kbps\n\t */\n\tbr?: number;\n\n\t/**\n\t * Object duration\n\t *\n\t * The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value\n\t * MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the\n\t * estimated duration if the explicit value is not known.\n\t *\n\t * Integer milliseconds\n\t */\n\td?: number;\n\n\t/**\n\t * Object type\n\t *\n\t * The media type of the current object being requested:\n\t * - `m` = text file, such as a manifest or playlist\n\t * - `a` = audio only\n\t * - `v` = video only\n\t * - `av` = muxed audio and video\n\t * - `i` = init segment\n\t * - `c` = caption or subtitle\n\t * - `tt` = ISOBMFF timed text track\n\t * - `k` = cryptographic key, license or certificate.\n\t * - `o` = other\n\t *\n\t * If the object type being requested is unknown, then this key MUST NOT be used.\n\t */\n\tot?: CmcdObjectType;\n\n\t/**\n\t * Top bitrate\n\t *\n\t * The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and\n\t * sizing constraints.\n\t *\n\t * Integer Kbps\n\t */\n\ttb?: number;\n\n\t//////////////////\n\t// CMCD Request //\n\t//////////////////\n\t/**\n\t * Buffer length\n\t *\n\t * The buffer length associated with the media object being requested. This value MUST be rounded to the nearest 100 ms. This key SHOULD only be\n\t * sent with an object type of ‘a’, ‘v’ or ‘av’.\n\t *\n\t * Integer milliseconds\n\t */\n\tbl?: number;\n\n\t/**\n\t * Deadline\n\t *\n\t * Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or\n\t * any other playback problems. This value MUST be rounded to the nearest 100ms. For a playback rate of 1, this may be equivalent to the player’s\n\t * remaining buffer length.\n\t *\n\t * Integer milliseconds\n\t */\n\tdl?: number;\n\n\t/**\n\t * Measured mtp CMCD throughput\n\t *\n\t * The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived,\n\t * SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple\n\t * servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent\n\t * connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.\n\t *\n\t * Integer kbps\n\t */\n\tmtp?: number;\n\n\t/**\n\t * Next object request\n\t *\n\t * Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current\n\t * request. This string MUST be URLEncoded. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a\n\t * pre-fetch to take place.\n\t *\n\t * String\n\t */\n\tnor?: ValueOrArray<string | SfItem>;\n\n\t/**\n\t * Next range request\n\t *\n\t * If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the\n\t * object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a\n\t * request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is\n\t * NOT required and specifying multiple ranges is NOT allowed. Valid combinations are:\n\t *\n\t * - `\"\\<range-start\\>-\"`\n\t * - `\"\\<range-start\\>-\\<range-end\\>\"`\n\t * - `\"-\\<suffix-length\\>\"`\n\t *\n\t * String\n\t */\n\tnrr?: string;\n\n\t/**\n\t * Startup\n\t *\n\t * Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be\n\t * rendering when this request is made. This key MUST not be sent if it is FALSE.\n\t *\n\t * Boolean\n\t */\n\tsu?: boolean;\n\n\t//////////////////\n\t// CMCD Session //\n\t//////////////////\n\n\t/**\n\t * Content ID\n\t *\n\t * A unique string identifying the current content. Maximum length is 64 characters. This value is consistent across multiple different\n\t * sessions and devices and is defined and updated at the discretion of the service provider.\n\t *\n\t * String\n\t */\n\tcid?: string;\n\n\t/**\n\t * Playback rate\n\t *\n\t * `1` if real-time, `2` if double speed, `0` if not playing. SHOULD only be sent if not equal to `1`.\n\t *\n\t * Decimal\n\t */\n\tpr?: number;\n\n\t/**\n\t * Streaming format\n\t *\n\t * The streaming format that defines the current request.\n\t *\n\t * - `d` = MPEG DASH\n\t * - `h` = HTTP Live Streaming (HLS)\n\t * - `s` = Smooth Streaming\n\t * - `o` = other\n\t *\n\t * If the streaming format being requested is unknown, then this key MUST NOT be used.\n\t */\n\tsf?: CmcdStreamingFormat;\n\n\t/**\n\t * Session ID\n\t *\n\t * A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset.\n\t * Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification.\n\t *\n\t * String\n\t */\n\tsid?: string;\n\n\t/**\n\t * Stream type\n\t * - `v` = all segments are available – e.g., VOD\n\t * - `l` = segments become available over time – e.g., LIVE\n\t */\n\tst?: CmcdStreamType;\n\n\t/**\n\t * CMCD version\n\t *\n\t * The version of this specification used for interpreting the defined key names and values. If this key is omitted, the client and server MUST\n\t * interpret the values as being defined by version 1. Client SHOULD omit this field if the version is 1.\n\t *\n\t * Integer\n\t */\n\tv?: number;\n\n\t/////////////////\n\t// CMCD Status //\n\t/////////////////\n\n\t/**\n\t * Buffer starvation\n\t *\n\t * Key is included without a value if the buffer was starved at some point between the prior request and this object request,\n\t * resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be\n\t * sent if the buffer was not starved since the prior request.\n\t *\n\t * If the object type `ot` key is sent along with this key, then the `bs` key refers to the buffer associated with the particular\n\t * object type. If no object type is communicated, then the buffer state applies to the current session.\n\t *\n\t * Boolean\n\t */\n\tbs?: boolean;\n\n\t/**\n\t * Requested maximum throughput\n\t *\n\t * The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the\n\t * nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more\n\t * than 10Mbps, by using rtp=10000.\n\t *\n\t * Note: This can benefit clients by preventing buffer saturation through over-delivery and can also deliver a community benefit\n\t * through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more.\n\t * The CDN may not support the rtp feature.\n\t *\n\t * Integer kbps\n\t */\n\trtp?: number;\n};\n"]}

package/dist/CmcdCustomKey.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A custom key for CMCD. Custom keys MUST carry a hyphenated prefix
+ * to ensure that there will not be a namespace collision with future
+ * revisions to this specification. Clients SHOULD use a reverse-DNS
+ * syntax when defining their own prefix.
+ *
+ *
+ * @beta
+ */
+export type CmcdCustomKey = `${string}-${string}`;
+//# sourceMappingURL=CmcdCustomKey.d.ts.map

package/dist/CmcdCustomKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdCustomKey.d.ts","sourceRoot":"","sources":["../src/CmcdCustomKey.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC"}

package/dist/CmcdCustomKey.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdCustomKey.js.map

package/dist/CmcdCustomKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdCustomKey.js","sourceRoot":"","sources":["../src/CmcdCustomKey.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A custom key for CMCD. Custom keys MUST carry a hyphenated prefix\n * to ensure that there will not be a namespace collision with future\n * revisions to this specification. Clients SHOULD use a reverse-DNS\n * syntax when defining their own prefix.\n *\n *\n * @beta\n */\nexport type CmcdCustomKey = `${string}-${string}`;\n"]}