@svta/cml-cmcd 2.3.0 → 2.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +105 -81
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +49 -30
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -110,7 +110,7 @@ declare const CMCD_EVENT_CUSTOM_EVENT: "ce";
|
|
|
110
110
|
*
|
|
111
111
|
* @enum
|
|
112
112
|
*
|
|
113
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-
|
|
113
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-B Event}
|
|
114
114
|
*
|
|
115
115
|
* @public
|
|
116
116
|
*/
|
|
@@ -216,7 +216,7 @@ type CmcdCustomValue = string | SfItem<string> | (string | SfItem<string>)[] | n
|
|
|
216
216
|
*
|
|
217
217
|
* @enum
|
|
218
218
|
*
|
|
219
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-
|
|
219
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-B Object Type}
|
|
220
220
|
*/
|
|
221
221
|
declare const CmcdObjectType: {
|
|
222
222
|
/**
|
|
@@ -278,7 +278,7 @@ type CmcdObjectTypeList = (number | SfItem<number, ExclusiveRecord<CmcdObjectTyp
|
|
|
278
278
|
*
|
|
279
279
|
* @public
|
|
280
280
|
*
|
|
281
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-
|
|
281
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-B State}
|
|
282
282
|
*/
|
|
283
283
|
declare const CmcdPlayerState: {
|
|
284
284
|
/**
|
|
@@ -333,7 +333,7 @@ type CmcdPlayerState = ValueOf<typeof CmcdPlayerState>;
|
|
|
333
333
|
*
|
|
334
334
|
* @enum
|
|
335
335
|
*
|
|
336
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-
|
|
336
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-B Stream Type}
|
|
337
337
|
*
|
|
338
338
|
* @public
|
|
339
339
|
*/
|
|
@@ -362,7 +362,7 @@ type CmcdStreamType = ValueOf<typeof CmcdStreamType>;
|
|
|
362
362
|
*
|
|
363
363
|
* @enum
|
|
364
364
|
*
|
|
365
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-
|
|
365
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-B Streaming Format}
|
|
366
366
|
*
|
|
367
367
|
* @public
|
|
368
368
|
*/
|
|
@@ -396,7 +396,7 @@ type CmcdStreamingFormat = ValueOf<typeof CmcdStreamingFormat>;
|
|
|
396
396
|
* A standardized set of HTTP request header fields and query string parameters
|
|
397
397
|
* for communicating media playback metrics in request mode.
|
|
398
398
|
*
|
|
399
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-
|
|
399
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-B Request Mode}
|
|
400
400
|
*
|
|
401
401
|
* @public
|
|
402
402
|
*/
|
|
@@ -416,7 +416,7 @@ type CmcdRequest = {
|
|
|
416
416
|
*
|
|
417
417
|
* Inner list of integer kbps with token identifiers
|
|
418
418
|
*
|
|
419
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#aggregate-encoded-bitrate | CTA-5004-
|
|
419
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#aggregate-encoded-bitrate | CTA-5004-B Aggregate Encoded Bitrate}
|
|
420
420
|
*/
|
|
421
421
|
ab?: CmcdObjectTypeList;
|
|
422
422
|
/**
|
|
@@ -427,7 +427,7 @@ type CmcdRequest = {
|
|
|
427
427
|
*
|
|
428
428
|
* Boolean
|
|
429
429
|
*
|
|
430
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#backgrounded | CTA-5004-
|
|
430
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#backgrounded | CTA-5004-B Backgrounded}
|
|
431
431
|
*/
|
|
432
432
|
bg?: boolean;
|
|
433
433
|
/**
|
|
@@ -437,7 +437,7 @@ type CmcdRequest = {
|
|
|
437
437
|
*
|
|
438
438
|
* Inner list of integer milliseconds with token identifiers
|
|
439
439
|
*
|
|
440
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-length | CTA-5004-
|
|
440
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-length | CTA-5004-B Buffer Length}
|
|
441
441
|
*/
|
|
442
442
|
bl?: CmcdObjectTypeList;
|
|
443
443
|
/**
|
|
@@ -450,7 +450,7 @@ type CmcdRequest = {
|
|
|
450
450
|
*
|
|
451
451
|
* Inner list of integer kbps with token identifiers
|
|
452
452
|
*
|
|
453
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#encoded-bitrate | CTA-5004-
|
|
453
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#encoded-bitrate | CTA-5004-B Encoded Bitrate}
|
|
454
454
|
*/
|
|
455
455
|
br?: CmcdObjectTypeList;
|
|
456
456
|
/**
|
|
@@ -462,7 +462,7 @@ type CmcdRequest = {
|
|
|
462
462
|
*
|
|
463
463
|
* Boolean
|
|
464
464
|
*
|
|
465
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation | CTA-5004-
|
|
465
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation | CTA-5004-B Buffer Starvation}
|
|
466
466
|
*/
|
|
467
467
|
bs?: boolean;
|
|
468
468
|
/**
|
|
@@ -473,7 +473,7 @@ type CmcdRequest = {
|
|
|
473
473
|
*
|
|
474
474
|
* Inner list of integers with optional token identifiers
|
|
475
475
|
*
|
|
476
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-absolute | CTA-5004-
|
|
476
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-absolute | CTA-5004-B Buffer Starvation Absolute}
|
|
477
477
|
*/
|
|
478
478
|
bsa?: CmcdObjectTypeList;
|
|
479
479
|
/**
|
|
@@ -484,7 +484,7 @@ type CmcdRequest = {
|
|
|
484
484
|
*
|
|
485
485
|
* Inner list of integer milliseconds with optional token identifiers
|
|
486
486
|
*
|
|
487
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-duration | CTA-5004-
|
|
487
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-duration | CTA-5004-B Buffer Starvation Duration}
|
|
488
488
|
*/
|
|
489
489
|
bsd?: CmcdObjectTypeList;
|
|
490
490
|
/**
|
|
@@ -495,7 +495,7 @@ type CmcdRequest = {
|
|
|
495
495
|
*
|
|
496
496
|
* Inner list of integer milliseconds with optional token identifiers
|
|
497
497
|
*
|
|
498
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-duration-absolute | CTA-5004-
|
|
498
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#buffer-starvation-duration-absolute | CTA-5004-B Buffer Starvation Duration Absolute}
|
|
499
499
|
*/
|
|
500
500
|
bsda?: CmcdObjectTypeList;
|
|
501
501
|
/**
|
|
@@ -505,7 +505,7 @@ type CmcdRequest = {
|
|
|
505
505
|
*
|
|
506
506
|
* String
|
|
507
507
|
*
|
|
508
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cdn-id | CTA-5004-
|
|
508
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cdn-id | CTA-5004-B CDN ID}
|
|
509
509
|
*/
|
|
510
510
|
cdn?: string;
|
|
511
511
|
/**
|
|
@@ -516,7 +516,7 @@ type CmcdRequest = {
|
|
|
516
516
|
*
|
|
517
517
|
* String
|
|
518
518
|
*
|
|
519
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#content-id | CTA-5004-
|
|
519
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#content-id | CTA-5004-B Content ID}
|
|
520
520
|
*/
|
|
521
521
|
cid?: string;
|
|
522
522
|
/**
|
|
@@ -527,7 +527,7 @@ type CmcdRequest = {
|
|
|
527
527
|
*
|
|
528
528
|
* String
|
|
529
529
|
*
|
|
530
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#content-signature | CTA-5004-
|
|
530
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#content-signature | CTA-5004-B Content Signature}
|
|
531
531
|
*/
|
|
532
532
|
cs?: string;
|
|
533
533
|
/**
|
|
@@ -540,7 +540,7 @@ type CmcdRequest = {
|
|
|
540
540
|
*
|
|
541
541
|
* Integer milliseconds
|
|
542
542
|
*
|
|
543
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-duration | CTA-5004-
|
|
543
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-duration | CTA-5004-B Object Duration}
|
|
544
544
|
*/
|
|
545
545
|
d?: number;
|
|
546
546
|
/**
|
|
@@ -552,7 +552,7 @@ type CmcdRequest = {
|
|
|
552
552
|
*
|
|
553
553
|
* Integer
|
|
554
554
|
*
|
|
555
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#dropped-frames-absolute | CTA-5004-
|
|
555
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#dropped-frames-absolute | CTA-5004-B Dropped Frames Absolute}
|
|
556
556
|
*/
|
|
557
557
|
dfa?: number;
|
|
558
558
|
/**
|
|
@@ -564,7 +564,7 @@ type CmcdRequest = {
|
|
|
564
564
|
*
|
|
565
565
|
* Integer milliseconds
|
|
566
566
|
*
|
|
567
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#deadline | CTA-5004-
|
|
567
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#deadline | CTA-5004-B Deadline}
|
|
568
568
|
*/
|
|
569
569
|
dl?: number;
|
|
570
570
|
/**
|
|
@@ -576,7 +576,7 @@ type CmcdRequest = {
|
|
|
576
576
|
*
|
|
577
577
|
* Inner list of strings
|
|
578
578
|
*
|
|
579
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#player-error-code | CTA-5004-
|
|
579
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#player-error-code | CTA-5004-B Player Error Code}
|
|
580
580
|
*/
|
|
581
581
|
ec?: string[];
|
|
582
582
|
/**
|
|
@@ -589,7 +589,7 @@ type CmcdRequest = {
|
|
|
589
589
|
*
|
|
590
590
|
* Inner list of integer kbps with token identifiers
|
|
591
591
|
*
|
|
592
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#lowest-aggregated-encoded-bitrate | CTA-5004-
|
|
592
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#lowest-aggregated-encoded-bitrate | CTA-5004-B Lowest Aggregated Encoded Bitrate}
|
|
593
593
|
*/
|
|
594
594
|
lab?: CmcdObjectTypeList;
|
|
595
595
|
/**
|
|
@@ -602,7 +602,7 @@ type CmcdRequest = {
|
|
|
602
602
|
*
|
|
603
603
|
* Inner list of integer kbps with token identifiers
|
|
604
604
|
*
|
|
605
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#lowest-encoded-bitrate | CTA-5004-
|
|
605
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#lowest-encoded-bitrate | CTA-5004-B Lowest Encoded Bitrate}
|
|
606
606
|
*/
|
|
607
607
|
lb?: CmcdObjectTypeList;
|
|
608
608
|
/**
|
|
@@ -613,7 +613,7 @@ type CmcdRequest = {
|
|
|
613
613
|
*
|
|
614
614
|
* Integer milliseconds
|
|
615
615
|
*
|
|
616
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#live-stream-latency | CTA-5004-
|
|
616
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#live-stream-latency | CTA-5004-B Live Stream Latency}
|
|
617
617
|
*/
|
|
618
618
|
ltc?: number;
|
|
619
619
|
/**
|
|
@@ -627,7 +627,7 @@ type CmcdRequest = {
|
|
|
627
627
|
*
|
|
628
628
|
* Integer milliseconds
|
|
629
629
|
*
|
|
630
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#media-start-delay | CTA-5004-
|
|
630
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#media-start-delay | CTA-5004-B Media Start Delay}
|
|
631
631
|
*/
|
|
632
632
|
msd?: number;
|
|
633
633
|
/**
|
|
@@ -644,7 +644,7 @@ type CmcdRequest = {
|
|
|
644
644
|
*
|
|
645
645
|
* Inner list of integer kbps with token identifiers
|
|
646
646
|
*
|
|
647
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#measured-throughput | CTA-5004-
|
|
647
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#measured-throughput | CTA-5004-B Measured Throughput}
|
|
648
648
|
*/
|
|
649
649
|
mtp?: CmcdObjectTypeList;
|
|
650
650
|
/**
|
|
@@ -665,7 +665,11 @@ type CmcdRequest = {
|
|
|
665
665
|
*
|
|
666
666
|
* Inner list of strings
|
|
667
667
|
*
|
|
668
|
-
* @
|
|
668
|
+
* @remarks
|
|
669
|
+
* Values may be provided as absolute URLs for convenience; when {@link CmcdEncodeOptions.baseUrl} is set,
|
|
670
|
+
* same-origin URLs are converted to paths relative to that base. Already-relative values are emitted unchanged.
|
|
671
|
+
*
|
|
672
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#next-object-request | CTA-5004-B Next Object Request}
|
|
669
673
|
*/
|
|
670
674
|
nor?: (string | SfItem<string, {
|
|
671
675
|
r: string;
|
|
@@ -677,7 +681,7 @@ type CmcdRequest = {
|
|
|
677
681
|
*
|
|
678
682
|
* Boolean
|
|
679
683
|
*
|
|
680
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#non-rendered | CTA-5004-
|
|
684
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#non-rendered | CTA-5004-B Non Rendered}
|
|
681
685
|
*/
|
|
682
686
|
nr?: boolean;
|
|
683
687
|
/**
|
|
@@ -700,7 +704,7 @@ type CmcdRequest = {
|
|
|
700
704
|
*
|
|
701
705
|
* Token
|
|
702
706
|
*
|
|
703
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-
|
|
707
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-B Object Type}
|
|
704
708
|
*/
|
|
705
709
|
ot?: CmcdObjectType;
|
|
706
710
|
/**
|
|
@@ -710,7 +714,7 @@ type CmcdRequest = {
|
|
|
710
714
|
*
|
|
711
715
|
* Inner list of integer kbps with token identifiers
|
|
712
716
|
*
|
|
713
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-bitrate | CTA-5004-
|
|
717
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-bitrate | CTA-5004-B Playhead Bitrate}
|
|
714
718
|
*/
|
|
715
719
|
pb?: CmcdObjectTypeList;
|
|
716
720
|
/**
|
|
@@ -720,7 +724,7 @@ type CmcdRequest = {
|
|
|
720
724
|
*
|
|
721
725
|
* Decimal
|
|
722
726
|
*
|
|
723
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playback-rate | CTA-5004-
|
|
727
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playback-rate | CTA-5004-B Playback Rate}
|
|
724
728
|
*/
|
|
725
729
|
pr?: number;
|
|
726
730
|
/**
|
|
@@ -730,7 +734,7 @@ type CmcdRequest = {
|
|
|
730
734
|
*
|
|
731
735
|
* Integer milliseconds
|
|
732
736
|
*
|
|
733
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-time | CTA-5004-
|
|
737
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-time | CTA-5004-B Playhead Time}
|
|
734
738
|
*/
|
|
735
739
|
pt?: number;
|
|
736
740
|
/**
|
|
@@ -741,7 +745,7 @@ type CmcdRequest = {
|
|
|
741
745
|
*
|
|
742
746
|
* Integer kbps
|
|
743
747
|
*
|
|
744
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#requested-maximum-throughput | CTA-5004-
|
|
748
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#requested-maximum-throughput | CTA-5004-B Requested Maximum Throughput}
|
|
745
749
|
*/
|
|
746
750
|
rtp?: number;
|
|
747
751
|
/**
|
|
@@ -757,7 +761,7 @@ type CmcdRequest = {
|
|
|
757
761
|
*
|
|
758
762
|
* Token
|
|
759
763
|
*
|
|
760
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-
|
|
764
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-B Streaming Format}
|
|
761
765
|
*/
|
|
762
766
|
sf?: CmcdStreamingFormat;
|
|
763
767
|
/**
|
|
@@ -770,7 +774,7 @@ type CmcdRequest = {
|
|
|
770
774
|
*
|
|
771
775
|
* String
|
|
772
776
|
*
|
|
773
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#session-id | CTA-5004-
|
|
777
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#session-id | CTA-5004-B Session ID}
|
|
774
778
|
*/
|
|
775
779
|
sid?: string;
|
|
776
780
|
/**
|
|
@@ -781,7 +785,7 @@ type CmcdRequest = {
|
|
|
781
785
|
*
|
|
782
786
|
* Integer
|
|
783
787
|
*
|
|
784
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#sequence-number | CTA-5004-
|
|
788
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#sequence-number | CTA-5004-B Sequence Number}
|
|
785
789
|
*/
|
|
786
790
|
sn?: number;
|
|
787
791
|
/**
|
|
@@ -793,7 +797,7 @@ type CmcdRequest = {
|
|
|
793
797
|
*
|
|
794
798
|
* Token
|
|
795
799
|
*
|
|
796
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-
|
|
800
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-B Stream Type}
|
|
797
801
|
*/
|
|
798
802
|
st?: CmcdStreamType;
|
|
799
803
|
/**
|
|
@@ -813,7 +817,7 @@ type CmcdRequest = {
|
|
|
813
817
|
*
|
|
814
818
|
* Token - one of [s,p,k,r,a,e,f,q,d]
|
|
815
819
|
*
|
|
816
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-
|
|
820
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-B State}
|
|
817
821
|
*/
|
|
818
822
|
sta?: CmcdPlayerState;
|
|
819
823
|
/**
|
|
@@ -824,7 +828,7 @@ type CmcdRequest = {
|
|
|
824
828
|
*
|
|
825
829
|
* Boolean
|
|
826
830
|
*
|
|
827
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#startup | CTA-5004-
|
|
831
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#startup | CTA-5004-B Startup}
|
|
828
832
|
*/
|
|
829
833
|
su?: boolean;
|
|
830
834
|
/**
|
|
@@ -837,7 +841,7 @@ type CmcdRequest = {
|
|
|
837
841
|
*
|
|
838
842
|
* Inner list of integer kbps with token identifiers
|
|
839
843
|
*
|
|
840
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-aggregated-encoded-bitrate | CTA-5004-
|
|
844
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-aggregated-encoded-bitrate | CTA-5004-B Top Aggregated Encoded Bitrate}
|
|
841
845
|
*/
|
|
842
846
|
tab?: CmcdObjectTypeList;
|
|
843
847
|
/**
|
|
@@ -850,7 +854,7 @@ type CmcdRequest = {
|
|
|
850
854
|
*
|
|
851
855
|
* Inner list of integer kbps with token identifiers
|
|
852
856
|
*
|
|
853
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-encoded-bitrate | CTA-5004-
|
|
857
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-encoded-bitrate | CTA-5004-B Top Encoded Bitrate}
|
|
854
858
|
*/
|
|
855
859
|
tb?: CmcdObjectTypeList;
|
|
856
860
|
/**
|
|
@@ -861,7 +865,7 @@ type CmcdRequest = {
|
|
|
861
865
|
*
|
|
862
866
|
* Inner list of integer milliseconds with token identifiers
|
|
863
867
|
*
|
|
864
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#target-buffer-length | CTA-5004-
|
|
868
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#target-buffer-length | CTA-5004-B Target Buffer Length}
|
|
865
869
|
*/
|
|
866
870
|
tbl?: CmcdObjectTypeList;
|
|
867
871
|
/**
|
|
@@ -881,7 +885,7 @@ type CmcdRequest = {
|
|
|
881
885
|
*
|
|
882
886
|
* Inner list of integer kbps with token identifiers
|
|
883
887
|
*
|
|
884
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-playable-bitrate | CTA-5004-
|
|
888
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-playable-bitrate | CTA-5004-B Top Playable Bitrate}
|
|
885
889
|
*/
|
|
886
890
|
tpb?: CmcdObjectTypeList;
|
|
887
891
|
/**
|
|
@@ -893,7 +897,7 @@ type CmcdRequest = {
|
|
|
893
897
|
*
|
|
894
898
|
* Integer
|
|
895
899
|
*
|
|
896
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#version | CTA-5004-
|
|
900
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#version | CTA-5004-B Version}
|
|
897
901
|
*/
|
|
898
902
|
v?: number;
|
|
899
903
|
};
|
|
@@ -905,7 +909,7 @@ type CmcdRequest = {
|
|
|
905
909
|
* Extends {@link CmcdRequest} with event-specific keys for reporting events
|
|
906
910
|
* according to the CMCD version 2 specification.
|
|
907
911
|
*
|
|
908
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-
|
|
912
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-B Event Mode}
|
|
909
913
|
*
|
|
910
914
|
* @public
|
|
911
915
|
*/
|
|
@@ -919,7 +923,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
919
923
|
*
|
|
920
924
|
* String
|
|
921
925
|
*
|
|
922
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#custom-event-name | CTA-5004-
|
|
926
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#custom-event-name | CTA-5004-B Custom Event Name}
|
|
923
927
|
*/
|
|
924
928
|
cen?: string;
|
|
925
929
|
/**
|
|
@@ -950,7 +954,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
950
954
|
*
|
|
951
955
|
* Token
|
|
952
956
|
*
|
|
953
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-
|
|
957
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-B Event}
|
|
954
958
|
*/
|
|
955
959
|
e?: CmcdEventType;
|
|
956
960
|
/**
|
|
@@ -960,7 +964,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
960
964
|
*
|
|
961
965
|
* String
|
|
962
966
|
*
|
|
963
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#hostname | CTA-5004-
|
|
967
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#hostname | CTA-5004-B Hostname}
|
|
964
968
|
*/
|
|
965
969
|
h?: string;
|
|
966
970
|
/**
|
|
@@ -974,7 +978,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
974
978
|
*
|
|
975
979
|
* Integer milliseconds
|
|
976
980
|
*
|
|
977
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#timestamp | CTA-5004-
|
|
981
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#timestamp | CTA-5004-B Timestamp}
|
|
978
982
|
*/
|
|
979
983
|
ts?: number;
|
|
980
984
|
};
|
|
@@ -986,7 +990,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
986
990
|
* Extends {@link CmcdRequest} with response-specific keys for reporting
|
|
987
991
|
* response data according to the CMCD version 2 specification.
|
|
988
992
|
*
|
|
989
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-mode | CTA-5004-
|
|
993
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-mode | CTA-5004-B Response Mode}
|
|
990
994
|
*
|
|
991
995
|
* @public
|
|
992
996
|
*/
|
|
@@ -999,7 +1003,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
999
1003
|
*
|
|
1000
1004
|
* String
|
|
1001
1005
|
*
|
|
1002
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-dynamic-header | CTA-5004-
|
|
1006
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-dynamic-header | CTA-5004-B CMSD Dynamic Header}
|
|
1003
1007
|
*/
|
|
1004
1008
|
cmsdd?: string;
|
|
1005
1009
|
/**
|
|
@@ -1010,7 +1014,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1010
1014
|
*
|
|
1011
1015
|
* String
|
|
1012
1016
|
*
|
|
1013
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-static-header | CTA-5004-
|
|
1017
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-static-header | CTA-5004-B CMSD Static Header}
|
|
1014
1018
|
*/
|
|
1015
1019
|
cmsds?: string;
|
|
1016
1020
|
/**
|
|
@@ -1023,7 +1027,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1023
1027
|
*
|
|
1024
1028
|
* Integer
|
|
1025
1029
|
*
|
|
1026
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-code | CTA-5004-
|
|
1030
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-code | CTA-5004-B Response Code}
|
|
1027
1031
|
*/
|
|
1028
1032
|
rc?: number;
|
|
1029
1033
|
/**
|
|
@@ -1034,7 +1038,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1034
1038
|
*
|
|
1035
1039
|
* String
|
|
1036
1040
|
*
|
|
1037
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#smrt-data-header | CTA-5004-
|
|
1041
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#smrt-data-header | CTA-5004-B SMRT-Data Header}
|
|
1038
1042
|
*/
|
|
1039
1043
|
smrt?: string;
|
|
1040
1044
|
/**
|
|
@@ -1045,7 +1049,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1045
1049
|
*
|
|
1046
1050
|
* Integer milliseconds
|
|
1047
1051
|
*
|
|
1048
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-byte | CTA-5004-
|
|
1052
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-byte | CTA-5004-B Time to First Byte}
|
|
1049
1053
|
*/
|
|
1050
1054
|
ttfb?: number;
|
|
1051
1055
|
/**
|
|
@@ -1056,7 +1060,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1056
1060
|
*
|
|
1057
1061
|
* Integer milliseconds
|
|
1058
1062
|
*
|
|
1059
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-body-byte | CTA-5004-
|
|
1063
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-body-byte | CTA-5004-B Time to First Body Byte}
|
|
1060
1064
|
*/
|
|
1061
1065
|
ttfbb?: number;
|
|
1062
1066
|
/**
|
|
@@ -1067,7 +1071,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1067
1071
|
*
|
|
1068
1072
|
* Integer milliseconds
|
|
1069
1073
|
*
|
|
1070
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-last-byte | CTA-5004-
|
|
1074
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-last-byte | CTA-5004-B Time to Last Byte}
|
|
1071
1075
|
*/
|
|
1072
1076
|
ttlb?: number;
|
|
1073
1077
|
/**
|
|
@@ -1078,7 +1082,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1078
1082
|
*
|
|
1079
1083
|
* String
|
|
1080
1084
|
*
|
|
1081
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-url | CTA-5004-
|
|
1085
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-url | CTA-5004-B Request URL}
|
|
1082
1086
|
*/
|
|
1083
1087
|
url?: string;
|
|
1084
1088
|
};
|
|
@@ -1174,7 +1178,9 @@ type CmcdFormatterOptions = {
|
|
|
1174
1178
|
*/
|
|
1175
1179
|
reportingMode: CmcdReportingMode;
|
|
1176
1180
|
/**
|
|
1177
|
-
*
|
|
1181
|
+
* Base URL (typically the manifest or current request URL) used to convert absolute `nor` values
|
|
1182
|
+
* into paths relative to this base, per the CMCD specification. Values that are already relative
|
|
1183
|
+
* paths are passed through unchanged. When omitted, `nor` values are emitted as-is.
|
|
1178
1184
|
*/
|
|
1179
1185
|
baseUrl?: string;
|
|
1180
1186
|
};
|
|
@@ -1240,6 +1246,11 @@ type CmcdV1 = {
|
|
|
1240
1246
|
* pre-fetch to take place.
|
|
1241
1247
|
*
|
|
1242
1248
|
* String
|
|
1249
|
+
*
|
|
1250
|
+
* @remarks
|
|
1251
|
+
* Values may be provided as absolute URLs for convenience; when `CmcdEncodeOptions.baseUrl` is set,
|
|
1252
|
+
* same-origin URLs are converted to paths relative to that base. Already-relative values are not
|
|
1253
|
+
* converted, but are still URL-encoded on emission as required by CMCD v1.
|
|
1243
1254
|
*/
|
|
1244
1255
|
nor?: string;
|
|
1245
1256
|
/**
|
|
@@ -1383,7 +1394,10 @@ type CmcdEncodeOptions = {
|
|
|
1383
1394
|
*/
|
|
1384
1395
|
filter?: (key: CmcdKey) => boolean;
|
|
1385
1396
|
/**
|
|
1386
|
-
*
|
|
1397
|
+
* Base URL (typically the manifest or current request URL) used to convert absolute `nor` values
|
|
1398
|
+
* into paths relative to this base, per the CMCD specification. Values that are already relative
|
|
1399
|
+
* paths are not modified by this option, though CMCD v1 still URL-encodes them on emission. When
|
|
1400
|
+
* omitted, `nor` values are emitted as-is (subject to the v1 URL-encoding rule).
|
|
1387
1401
|
*/
|
|
1388
1402
|
baseUrl?: string;
|
|
1389
1403
|
/**
|
|
@@ -1407,7 +1421,7 @@ type CmcdEncodeOptions = {
|
|
|
1407
1421
|
* @example
|
|
1408
1422
|
* {@includeCode ../test/appendCmcdHeaders.test.ts#example}
|
|
1409
1423
|
*
|
|
1410
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
1424
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-B Header Field Definition}
|
|
1411
1425
|
*/
|
|
1412
1426
|
declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd, options?: CmcdEncodeOptions): Record<string, string>;
|
|
1413
1427
|
//#endregion
|
|
@@ -1426,7 +1440,7 @@ declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd,
|
|
|
1426
1440
|
* @example
|
|
1427
1441
|
* {@includeCode ../test/appendCmcdQuery.test.ts#example}
|
|
1428
1442
|
*
|
|
1429
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
1443
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-B Query Argument Definition}
|
|
1430
1444
|
*/
|
|
1431
1445
|
declare function appendCmcdQuery(url: string, cmcd: Cmcd, options?: CmcdEncodeOptions): string;
|
|
1432
1446
|
//#endregion
|
|
@@ -1877,7 +1891,7 @@ type CmcdRequestReport<D = unknown> = HttpRequest & {
|
|
|
1877
1891
|
/**
|
|
1878
1892
|
* The CMCD reporter.
|
|
1879
1893
|
*
|
|
1880
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reporting-modes-when-we-send-data | CTA-5004-
|
|
1894
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reporting-modes-when-we-send-data | CTA-5004-B Reporting Modes}
|
|
1881
1895
|
*
|
|
1882
1896
|
* @public
|
|
1883
1897
|
*/
|
|
@@ -2004,11 +2018,21 @@ declare class CmcdReporter {
|
|
|
2004
2018
|
/**
|
|
2005
2019
|
* Sends an event report. Called by the reporter when a batch is ready to be sent.
|
|
2006
2020
|
*
|
|
2007
|
-
* @param
|
|
2021
|
+
* @param config - The target config to send the event report to.
|
|
2008
2022
|
* @param data - The data to send in the event report.
|
|
2009
2023
|
*/
|
|
2010
2024
|
private sendEventReport;
|
|
2011
2025
|
/**
|
|
2026
|
+
* Cancels the time-interval timer for an event target and clears the stored id.
|
|
2027
|
+
* Safe to call when no timer is armed (clearInterval(undefined) is a no-op).
|
|
2028
|
+
*/
|
|
2029
|
+
private disarmInterval;
|
|
2030
|
+
/**
|
|
2031
|
+
* Permanently removes an event target: cancels its timer and removes it from the
|
|
2032
|
+
* eventTargets map. Used when the collector signals the target is gone (HTTP 410).
|
|
2033
|
+
*/
|
|
2034
|
+
private disposeEventTarget;
|
|
2035
|
+
/**
|
|
2012
2036
|
* Resets the session related data. Called when the session ID changes.
|
|
2013
2037
|
*/
|
|
2014
2038
|
private resetSession;
|
|
@@ -2041,7 +2065,7 @@ type CmcdValidationOptions = {
|
|
|
2041
2065
|
*
|
|
2042
2066
|
* @returns The decoded CMCD object.
|
|
2043
2067
|
*
|
|
2044
|
-
* @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-
|
|
2068
|
+
* @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-B Payload Definition}
|
|
2045
2069
|
*
|
|
2046
2070
|
* @public
|
|
2047
2071
|
*
|
|
@@ -2062,7 +2086,7 @@ declare function decodeCmcd<T extends CmcdData = CmcdData>(cmcd: string, options
|
|
|
2062
2086
|
*
|
|
2063
2087
|
* @returns The encoded CMCD string.
|
|
2064
2088
|
*
|
|
2065
|
-
* @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-
|
|
2089
|
+
* @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-B Payload Definition}
|
|
2066
2090
|
*
|
|
2067
2091
|
* @public
|
|
2068
2092
|
*
|
|
@@ -2080,7 +2104,7 @@ declare function encodeCmcd(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
|
|
|
2080
2104
|
*
|
|
2081
2105
|
* @returns The decoded CMCD data.
|
|
2082
2106
|
*
|
|
2083
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2107
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-B Header Field Definition}
|
|
2084
2108
|
*
|
|
2085
2109
|
* @public
|
|
2086
2110
|
*
|
|
@@ -2101,7 +2125,7 @@ declare function fromCmcdHeaders(headers: Record<string, string> | Headers, opti
|
|
|
2101
2125
|
*
|
|
2102
2126
|
* @returns The decoded CMCD data.
|
|
2103
2127
|
*
|
|
2104
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2128
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-B Query Argument Definition}
|
|
2105
2129
|
*
|
|
2106
2130
|
* @public
|
|
2107
2131
|
*
|
|
@@ -2122,7 +2146,7 @@ declare function fromCmcdQuery(query: string | URLSearchParams, options?: CmcdDe
|
|
|
2122
2146
|
*
|
|
2123
2147
|
* @returns The decoded CMCD data.
|
|
2124
2148
|
*
|
|
2125
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2149
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-B Query Argument Definition}
|
|
2126
2150
|
*
|
|
2127
2151
|
* @public
|
|
2128
2152
|
*
|
|
@@ -2143,7 +2167,7 @@ declare function fromCmcdUrl(url: string, options?: CmcdDecodeOptions): CmcdData
|
|
|
2143
2167
|
*
|
|
2144
2168
|
* @returns The CMCD header shards.
|
|
2145
2169
|
*
|
|
2146
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2170
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-B Header Field Definition}
|
|
2147
2171
|
*
|
|
2148
2172
|
* @public
|
|
2149
2173
|
*/
|
|
@@ -2271,7 +2295,7 @@ declare function prepareCmcdData(obj: Record<string, any>, options?: CmcdEncodeO
|
|
|
2271
2295
|
*
|
|
2272
2296
|
* @returns The CMCD header shards.
|
|
2273
2297
|
*
|
|
2274
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2298
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-B Header Field Definition}
|
|
2275
2299
|
*
|
|
2276
2300
|
* @public
|
|
2277
2301
|
*
|
|
@@ -2289,7 +2313,7 @@ declare function toCmcdHeaders(cmcd: Cmcd, options?: CmcdEncodeOptions): Record<
|
|
|
2289
2313
|
*
|
|
2290
2314
|
* @returns The CMCD query arg.
|
|
2291
2315
|
*
|
|
2292
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2316
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-B Query Argument Definition}
|
|
2293
2317
|
*
|
|
2294
2318
|
* @public
|
|
2295
2319
|
*
|
|
@@ -2307,7 +2331,7 @@ declare function toCmcdQuery(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
|
|
|
2307
2331
|
*
|
|
2308
2332
|
* @returns The URL encoded CMCD data.
|
|
2309
2333
|
*
|
|
2310
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2334
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-B Query Argument Definition}
|
|
2311
2335
|
*
|
|
2312
2336
|
* @public
|
|
2313
2337
|
*/
|
|
@@ -2336,7 +2360,7 @@ declare function toCmcdValue<V extends SfBareItem, P>(value: V, params?: P): SfI
|
|
|
2336
2360
|
* @param options - Validation options.
|
|
2337
2361
|
* @returns The validation result.
|
|
2338
2362
|
*
|
|
2339
|
-
* @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-
|
|
2363
|
+
* @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-B Data Payload Definition}
|
|
2340
2364
|
*
|
|
2341
2365
|
* @public
|
|
2342
2366
|
*/
|
|
@@ -2358,7 +2382,7 @@ declare function validateCmcd(data: Record<string, unknown>, options?: CmcdValid
|
|
|
2358
2382
|
*
|
|
2359
2383
|
* @example {@includeCode ../test/validateCmcdEventReport.test.ts#example}
|
|
2360
2384
|
*
|
|
2361
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-
|
|
2385
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-B Event Mode}
|
|
2362
2386
|
*
|
|
2363
2387
|
* @public
|
|
2364
2388
|
*/
|
|
@@ -2381,7 +2405,7 @@ declare function validateCmcdEventReport(request: HttpRequest, options?: Omit<Cm
|
|
|
2381
2405
|
* @example
|
|
2382
2406
|
* {@includeCode ../test/validateCmcdEvents.test.ts#example}
|
|
2383
2407
|
*
|
|
2384
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#body-definition | CTA-5004-
|
|
2408
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#body-definition | CTA-5004-B Body Definition}
|
|
2385
2409
|
*
|
|
2386
2410
|
* @public
|
|
2387
2411
|
*/
|
|
@@ -2403,7 +2427,7 @@ declare function validateCmcdEvents(cmcd: string, options?: Omit<CmcdValidationO
|
|
|
2403
2427
|
* @param options - Validation options (excluding `reportingMode`).
|
|
2404
2428
|
* @returns The validation result including decoded data.
|
|
2405
2429
|
*
|
|
2406
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2430
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-B Header Field Definition}
|
|
2407
2431
|
*
|
|
2408
2432
|
* @public
|
|
2409
2433
|
*/
|
|
@@ -2420,7 +2444,7 @@ declare function validateCmcdHeaders(headers: Record<string, string> | Headers,
|
|
|
2420
2444
|
* @param options - Validation options.
|
|
2421
2445
|
* @returns The validation result.
|
|
2422
2446
|
*
|
|
2423
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-
|
|
2447
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-B Reserved Keys}
|
|
2424
2448
|
*
|
|
2425
2449
|
* @public
|
|
2426
2450
|
*/
|
|
@@ -2446,7 +2470,7 @@ declare function validateCmcdKeys(data: Record<string, unknown>, options?: CmcdV
|
|
|
2446
2470
|
* @example
|
|
2447
2471
|
* {@includeCode ../test/validateCmcdRequest.test.ts#example}
|
|
2448
2472
|
*
|
|
2449
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-
|
|
2473
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-B Request Mode}
|
|
2450
2474
|
*
|
|
2451
2475
|
* @public
|
|
2452
2476
|
*/
|
|
@@ -2463,7 +2487,7 @@ declare function validateCmcdRequest(request: Request | HttpRequest, options?: O
|
|
|
2463
2487
|
* @param options - Validation options.
|
|
2464
2488
|
* @returns The validation result.
|
|
2465
2489
|
*
|
|
2466
|
-
* @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-
|
|
2490
|
+
* @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-B Data Payload Definition}
|
|
2467
2491
|
*
|
|
2468
2492
|
* @public
|
|
2469
2493
|
*/
|
|
@@ -2480,7 +2504,7 @@ declare function validateCmcdStructure(data: Record<string, unknown>, options?:
|
|
|
2480
2504
|
* @param options - Validation options.
|
|
2481
2505
|
* @returns The validation result.
|
|
2482
2506
|
*
|
|
2483
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-
|
|
2507
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-B Reserved Keys}
|
|
2484
2508
|
*
|
|
2485
2509
|
* @public
|
|
2486
2510
|
*/
|