@svta/cml-cmcd 2.3.0 → 2.3.1
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 +89 -79
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +46 -27
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
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,7 @@ type CmcdRequest = {
|
|
|
665
665
|
*
|
|
666
666
|
* Inner list of strings
|
|
667
667
|
*
|
|
668
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#next-object-request | CTA-5004-
|
|
668
|
+
* @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
669
|
*/
|
|
670
670
|
nor?: (string | SfItem<string, {
|
|
671
671
|
r: string;
|
|
@@ -677,7 +677,7 @@ type CmcdRequest = {
|
|
|
677
677
|
*
|
|
678
678
|
* Boolean
|
|
679
679
|
*
|
|
680
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#non-rendered | CTA-5004-
|
|
680
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#non-rendered | CTA-5004-B Non Rendered}
|
|
681
681
|
*/
|
|
682
682
|
nr?: boolean;
|
|
683
683
|
/**
|
|
@@ -700,7 +700,7 @@ type CmcdRequest = {
|
|
|
700
700
|
*
|
|
701
701
|
* Token
|
|
702
702
|
*
|
|
703
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-
|
|
703
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#object-type | CTA-5004-B Object Type}
|
|
704
704
|
*/
|
|
705
705
|
ot?: CmcdObjectType;
|
|
706
706
|
/**
|
|
@@ -710,7 +710,7 @@ type CmcdRequest = {
|
|
|
710
710
|
*
|
|
711
711
|
* Inner list of integer kbps with token identifiers
|
|
712
712
|
*
|
|
713
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-bitrate | CTA-5004-
|
|
713
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-bitrate | CTA-5004-B Playhead Bitrate}
|
|
714
714
|
*/
|
|
715
715
|
pb?: CmcdObjectTypeList;
|
|
716
716
|
/**
|
|
@@ -720,7 +720,7 @@ type CmcdRequest = {
|
|
|
720
720
|
*
|
|
721
721
|
* Decimal
|
|
722
722
|
*
|
|
723
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playback-rate | CTA-5004-
|
|
723
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playback-rate | CTA-5004-B Playback Rate}
|
|
724
724
|
*/
|
|
725
725
|
pr?: number;
|
|
726
726
|
/**
|
|
@@ -730,7 +730,7 @@ type CmcdRequest = {
|
|
|
730
730
|
*
|
|
731
731
|
* Integer milliseconds
|
|
732
732
|
*
|
|
733
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-time | CTA-5004-
|
|
733
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#playhead-time | CTA-5004-B Playhead Time}
|
|
734
734
|
*/
|
|
735
735
|
pt?: number;
|
|
736
736
|
/**
|
|
@@ -741,7 +741,7 @@ type CmcdRequest = {
|
|
|
741
741
|
*
|
|
742
742
|
* Integer kbps
|
|
743
743
|
*
|
|
744
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#requested-maximum-throughput | CTA-5004-
|
|
744
|
+
* @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
745
|
*/
|
|
746
746
|
rtp?: number;
|
|
747
747
|
/**
|
|
@@ -757,7 +757,7 @@ type CmcdRequest = {
|
|
|
757
757
|
*
|
|
758
758
|
* Token
|
|
759
759
|
*
|
|
760
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-
|
|
760
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#streaming-format | CTA-5004-B Streaming Format}
|
|
761
761
|
*/
|
|
762
762
|
sf?: CmcdStreamingFormat;
|
|
763
763
|
/**
|
|
@@ -770,7 +770,7 @@ type CmcdRequest = {
|
|
|
770
770
|
*
|
|
771
771
|
* String
|
|
772
772
|
*
|
|
773
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#session-id | CTA-5004-
|
|
773
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#session-id | CTA-5004-B Session ID}
|
|
774
774
|
*/
|
|
775
775
|
sid?: string;
|
|
776
776
|
/**
|
|
@@ -781,7 +781,7 @@ type CmcdRequest = {
|
|
|
781
781
|
*
|
|
782
782
|
* Integer
|
|
783
783
|
*
|
|
784
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#sequence-number | CTA-5004-
|
|
784
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#sequence-number | CTA-5004-B Sequence Number}
|
|
785
785
|
*/
|
|
786
786
|
sn?: number;
|
|
787
787
|
/**
|
|
@@ -793,7 +793,7 @@ type CmcdRequest = {
|
|
|
793
793
|
*
|
|
794
794
|
* Token
|
|
795
795
|
*
|
|
796
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-
|
|
796
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#stream-type | CTA-5004-B Stream Type}
|
|
797
797
|
*/
|
|
798
798
|
st?: CmcdStreamType;
|
|
799
799
|
/**
|
|
@@ -813,7 +813,7 @@ type CmcdRequest = {
|
|
|
813
813
|
*
|
|
814
814
|
* Token - one of [s,p,k,r,a,e,f,q,d]
|
|
815
815
|
*
|
|
816
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-
|
|
816
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#state | CTA-5004-B State}
|
|
817
817
|
*/
|
|
818
818
|
sta?: CmcdPlayerState;
|
|
819
819
|
/**
|
|
@@ -824,7 +824,7 @@ type CmcdRequest = {
|
|
|
824
824
|
*
|
|
825
825
|
* Boolean
|
|
826
826
|
*
|
|
827
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#startup | CTA-5004-
|
|
827
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#startup | CTA-5004-B Startup}
|
|
828
828
|
*/
|
|
829
829
|
su?: boolean;
|
|
830
830
|
/**
|
|
@@ -837,7 +837,7 @@ type CmcdRequest = {
|
|
|
837
837
|
*
|
|
838
838
|
* Inner list of integer kbps with token identifiers
|
|
839
839
|
*
|
|
840
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-aggregated-encoded-bitrate | CTA-5004-
|
|
840
|
+
* @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
841
|
*/
|
|
842
842
|
tab?: CmcdObjectTypeList;
|
|
843
843
|
/**
|
|
@@ -850,7 +850,7 @@ type CmcdRequest = {
|
|
|
850
850
|
*
|
|
851
851
|
* Inner list of integer kbps with token identifiers
|
|
852
852
|
*
|
|
853
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-encoded-bitrate | CTA-5004-
|
|
853
|
+
* @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
854
|
*/
|
|
855
855
|
tb?: CmcdObjectTypeList;
|
|
856
856
|
/**
|
|
@@ -861,7 +861,7 @@ type CmcdRequest = {
|
|
|
861
861
|
*
|
|
862
862
|
* Inner list of integer milliseconds with token identifiers
|
|
863
863
|
*
|
|
864
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#target-buffer-length | CTA-5004-
|
|
864
|
+
* @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
865
|
*/
|
|
866
866
|
tbl?: CmcdObjectTypeList;
|
|
867
867
|
/**
|
|
@@ -881,7 +881,7 @@ type CmcdRequest = {
|
|
|
881
881
|
*
|
|
882
882
|
* Inner list of integer kbps with token identifiers
|
|
883
883
|
*
|
|
884
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#top-playable-bitrate | CTA-5004-
|
|
884
|
+
* @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
885
|
*/
|
|
886
886
|
tpb?: CmcdObjectTypeList;
|
|
887
887
|
/**
|
|
@@ -893,7 +893,7 @@ type CmcdRequest = {
|
|
|
893
893
|
*
|
|
894
894
|
* Integer
|
|
895
895
|
*
|
|
896
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#version | CTA-5004-
|
|
896
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#version | CTA-5004-B Version}
|
|
897
897
|
*/
|
|
898
898
|
v?: number;
|
|
899
899
|
};
|
|
@@ -905,7 +905,7 @@ type CmcdRequest = {
|
|
|
905
905
|
* Extends {@link CmcdRequest} with event-specific keys for reporting events
|
|
906
906
|
* according to the CMCD version 2 specification.
|
|
907
907
|
*
|
|
908
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-
|
|
908
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-B Event Mode}
|
|
909
909
|
*
|
|
910
910
|
* @public
|
|
911
911
|
*/
|
|
@@ -919,7 +919,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
919
919
|
*
|
|
920
920
|
* String
|
|
921
921
|
*
|
|
922
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#custom-event-name | CTA-5004-
|
|
922
|
+
* @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
923
|
*/
|
|
924
924
|
cen?: string;
|
|
925
925
|
/**
|
|
@@ -950,7 +950,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
950
950
|
*
|
|
951
951
|
* Token
|
|
952
952
|
*
|
|
953
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-
|
|
953
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event | CTA-5004-B Event}
|
|
954
954
|
*/
|
|
955
955
|
e?: CmcdEventType;
|
|
956
956
|
/**
|
|
@@ -960,7 +960,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
960
960
|
*
|
|
961
961
|
* String
|
|
962
962
|
*
|
|
963
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#hostname | CTA-5004-
|
|
963
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#hostname | CTA-5004-B Hostname}
|
|
964
964
|
*/
|
|
965
965
|
h?: string;
|
|
966
966
|
/**
|
|
@@ -974,7 +974,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
974
974
|
*
|
|
975
975
|
* Integer milliseconds
|
|
976
976
|
*
|
|
977
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#timestamp | CTA-5004-
|
|
977
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#timestamp | CTA-5004-B Timestamp}
|
|
978
978
|
*/
|
|
979
979
|
ts?: number;
|
|
980
980
|
};
|
|
@@ -986,7 +986,7 @@ type CmcdEvent = CmcdRequest & {
|
|
|
986
986
|
* Extends {@link CmcdRequest} with response-specific keys for reporting
|
|
987
987
|
* response data according to the CMCD version 2 specification.
|
|
988
988
|
*
|
|
989
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-mode | CTA-5004-
|
|
989
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-mode | CTA-5004-B Response Mode}
|
|
990
990
|
*
|
|
991
991
|
* @public
|
|
992
992
|
*/
|
|
@@ -999,7 +999,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
999
999
|
*
|
|
1000
1000
|
* String
|
|
1001
1001
|
*
|
|
1002
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-dynamic-header | CTA-5004-
|
|
1002
|
+
* @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
1003
|
*/
|
|
1004
1004
|
cmsdd?: string;
|
|
1005
1005
|
/**
|
|
@@ -1010,7 +1010,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1010
1010
|
*
|
|
1011
1011
|
* String
|
|
1012
1012
|
*
|
|
1013
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#cmsd-static-header | CTA-5004-
|
|
1013
|
+
* @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
1014
|
*/
|
|
1015
1015
|
cmsds?: string;
|
|
1016
1016
|
/**
|
|
@@ -1023,7 +1023,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1023
1023
|
*
|
|
1024
1024
|
* Integer
|
|
1025
1025
|
*
|
|
1026
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-code | CTA-5004-
|
|
1026
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#response-code | CTA-5004-B Response Code}
|
|
1027
1027
|
*/
|
|
1028
1028
|
rc?: number;
|
|
1029
1029
|
/**
|
|
@@ -1034,7 +1034,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1034
1034
|
*
|
|
1035
1035
|
* String
|
|
1036
1036
|
*
|
|
1037
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#smrt-data-header | CTA-5004-
|
|
1037
|
+
* @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
1038
|
*/
|
|
1039
1039
|
smrt?: string;
|
|
1040
1040
|
/**
|
|
@@ -1045,7 +1045,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1045
1045
|
*
|
|
1046
1046
|
* Integer milliseconds
|
|
1047
1047
|
*
|
|
1048
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-byte | CTA-5004-
|
|
1048
|
+
* @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
1049
|
*/
|
|
1050
1050
|
ttfb?: number;
|
|
1051
1051
|
/**
|
|
@@ -1056,7 +1056,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1056
1056
|
*
|
|
1057
1057
|
* Integer milliseconds
|
|
1058
1058
|
*
|
|
1059
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-first-body-byte | CTA-5004-
|
|
1059
|
+
* @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
1060
|
*/
|
|
1061
1061
|
ttfbb?: number;
|
|
1062
1062
|
/**
|
|
@@ -1067,7 +1067,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1067
1067
|
*
|
|
1068
1068
|
* Integer milliseconds
|
|
1069
1069
|
*
|
|
1070
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#time-to-last-byte | CTA-5004-
|
|
1070
|
+
* @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
1071
|
*/
|
|
1072
1072
|
ttlb?: number;
|
|
1073
1073
|
/**
|
|
@@ -1078,7 +1078,7 @@ type CmcdResponse = CmcdRequest & {
|
|
|
1078
1078
|
*
|
|
1079
1079
|
* String
|
|
1080
1080
|
*
|
|
1081
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-url | CTA-5004-
|
|
1081
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-url | CTA-5004-B Request URL}
|
|
1082
1082
|
*/
|
|
1083
1083
|
url?: string;
|
|
1084
1084
|
};
|
|
@@ -1407,7 +1407,7 @@ type CmcdEncodeOptions = {
|
|
|
1407
1407
|
* @example
|
|
1408
1408
|
* {@includeCode ../test/appendCmcdHeaders.test.ts#example}
|
|
1409
1409
|
*
|
|
1410
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
1410
|
+
* @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
1411
|
*/
|
|
1412
1412
|
declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd, options?: CmcdEncodeOptions): Record<string, string>;
|
|
1413
1413
|
//#endregion
|
|
@@ -1426,7 +1426,7 @@ declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd,
|
|
|
1426
1426
|
* @example
|
|
1427
1427
|
* {@includeCode ../test/appendCmcdQuery.test.ts#example}
|
|
1428
1428
|
*
|
|
1429
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
1429
|
+
* @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
1430
|
*/
|
|
1431
1431
|
declare function appendCmcdQuery(url: string, cmcd: Cmcd, options?: CmcdEncodeOptions): string;
|
|
1432
1432
|
//#endregion
|
|
@@ -1877,7 +1877,7 @@ type CmcdRequestReport<D = unknown> = HttpRequest & {
|
|
|
1877
1877
|
/**
|
|
1878
1878
|
* The CMCD reporter.
|
|
1879
1879
|
*
|
|
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-
|
|
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-B Reporting Modes}
|
|
1881
1881
|
*
|
|
1882
1882
|
* @public
|
|
1883
1883
|
*/
|
|
@@ -2004,11 +2004,21 @@ declare class CmcdReporter {
|
|
|
2004
2004
|
/**
|
|
2005
2005
|
* Sends an event report. Called by the reporter when a batch is ready to be sent.
|
|
2006
2006
|
*
|
|
2007
|
-
* @param
|
|
2007
|
+
* @param config - The target config to send the event report to.
|
|
2008
2008
|
* @param data - The data to send in the event report.
|
|
2009
2009
|
*/
|
|
2010
2010
|
private sendEventReport;
|
|
2011
2011
|
/**
|
|
2012
|
+
* Cancels the time-interval timer for an event target and clears the stored id.
|
|
2013
|
+
* Safe to call when no timer is armed (clearInterval(undefined) is a no-op).
|
|
2014
|
+
*/
|
|
2015
|
+
private disarmInterval;
|
|
2016
|
+
/**
|
|
2017
|
+
* Permanently removes an event target: cancels its timer and removes it from the
|
|
2018
|
+
* eventTargets map. Used when the collector signals the target is gone (HTTP 410).
|
|
2019
|
+
*/
|
|
2020
|
+
private disposeEventTarget;
|
|
2021
|
+
/**
|
|
2012
2022
|
* Resets the session related data. Called when the session ID changes.
|
|
2013
2023
|
*/
|
|
2014
2024
|
private resetSession;
|
|
@@ -2041,7 +2051,7 @@ type CmcdValidationOptions = {
|
|
|
2041
2051
|
*
|
|
2042
2052
|
* @returns The decoded CMCD object.
|
|
2043
2053
|
*
|
|
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-
|
|
2054
|
+
* @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
2055
|
*
|
|
2046
2056
|
* @public
|
|
2047
2057
|
*
|
|
@@ -2062,7 +2072,7 @@ declare function decodeCmcd<T extends CmcdData = CmcdData>(cmcd: string, options
|
|
|
2062
2072
|
*
|
|
2063
2073
|
* @returns The encoded CMCD string.
|
|
2064
2074
|
*
|
|
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-
|
|
2075
|
+
* @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
2076
|
*
|
|
2067
2077
|
* @public
|
|
2068
2078
|
*
|
|
@@ -2080,7 +2090,7 @@ declare function encodeCmcd(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
|
|
|
2080
2090
|
*
|
|
2081
2091
|
* @returns The decoded CMCD data.
|
|
2082
2092
|
*
|
|
2083
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2093
|
+
* @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
2094
|
*
|
|
2085
2095
|
* @public
|
|
2086
2096
|
*
|
|
@@ -2101,7 +2111,7 @@ declare function fromCmcdHeaders(headers: Record<string, string> | Headers, opti
|
|
|
2101
2111
|
*
|
|
2102
2112
|
* @returns The decoded CMCD data.
|
|
2103
2113
|
*
|
|
2104
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2114
|
+
* @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
2115
|
*
|
|
2106
2116
|
* @public
|
|
2107
2117
|
*
|
|
@@ -2122,7 +2132,7 @@ declare function fromCmcdQuery(query: string | URLSearchParams, options?: CmcdDe
|
|
|
2122
2132
|
*
|
|
2123
2133
|
* @returns The decoded CMCD data.
|
|
2124
2134
|
*
|
|
2125
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2135
|
+
* @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
2136
|
*
|
|
2127
2137
|
* @public
|
|
2128
2138
|
*
|
|
@@ -2143,7 +2153,7 @@ declare function fromCmcdUrl(url: string, options?: CmcdDecodeOptions): CmcdData
|
|
|
2143
2153
|
*
|
|
2144
2154
|
* @returns The CMCD header shards.
|
|
2145
2155
|
*
|
|
2146
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2156
|
+
* @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
2157
|
*
|
|
2148
2158
|
* @public
|
|
2149
2159
|
*/
|
|
@@ -2271,7 +2281,7 @@ declare function prepareCmcdData(obj: Record<string, any>, options?: CmcdEncodeO
|
|
|
2271
2281
|
*
|
|
2272
2282
|
* @returns The CMCD header shards.
|
|
2273
2283
|
*
|
|
2274
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2284
|
+
* @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
2285
|
*
|
|
2276
2286
|
* @public
|
|
2277
2287
|
*
|
|
@@ -2289,7 +2299,7 @@ declare function toCmcdHeaders(cmcd: Cmcd, options?: CmcdEncodeOptions): Record<
|
|
|
2289
2299
|
*
|
|
2290
2300
|
* @returns The CMCD query arg.
|
|
2291
2301
|
*
|
|
2292
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2302
|
+
* @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
2303
|
*
|
|
2294
2304
|
* @public
|
|
2295
2305
|
*
|
|
@@ -2307,7 +2317,7 @@ declare function toCmcdQuery(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
|
|
|
2307
2317
|
*
|
|
2308
2318
|
* @returns The URL encoded CMCD data.
|
|
2309
2319
|
*
|
|
2310
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#query-argument-definition | CTA-5004-
|
|
2320
|
+
* @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
2321
|
*
|
|
2312
2322
|
* @public
|
|
2313
2323
|
*/
|
|
@@ -2336,7 +2346,7 @@ declare function toCmcdValue<V extends SfBareItem, P>(value: V, params?: P): SfI
|
|
|
2336
2346
|
* @param options - Validation options.
|
|
2337
2347
|
* @returns The validation result.
|
|
2338
2348
|
*
|
|
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-
|
|
2349
|
+
* @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
2350
|
*
|
|
2341
2351
|
* @public
|
|
2342
2352
|
*/
|
|
@@ -2358,7 +2368,7 @@ declare function validateCmcd(data: Record<string, unknown>, options?: CmcdValid
|
|
|
2358
2368
|
*
|
|
2359
2369
|
* @example {@includeCode ../test/validateCmcdEventReport.test.ts#example}
|
|
2360
2370
|
*
|
|
2361
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-
|
|
2371
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#event-mode | CTA-5004-B Event Mode}
|
|
2362
2372
|
*
|
|
2363
2373
|
* @public
|
|
2364
2374
|
*/
|
|
@@ -2381,7 +2391,7 @@ declare function validateCmcdEventReport(request: HttpRequest, options?: Omit<Cm
|
|
|
2381
2391
|
* @example
|
|
2382
2392
|
* {@includeCode ../test/validateCmcdEvents.test.ts#example}
|
|
2383
2393
|
*
|
|
2384
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#body-definition | CTA-5004-
|
|
2394
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#body-definition | CTA-5004-B Body Definition}
|
|
2385
2395
|
*
|
|
2386
2396
|
* @public
|
|
2387
2397
|
*/
|
|
@@ -2403,7 +2413,7 @@ declare function validateCmcdEvents(cmcd: string, options?: Omit<CmcdValidationO
|
|
|
2403
2413
|
* @param options - Validation options (excluding `reportingMode`).
|
|
2404
2414
|
* @returns The validation result including decoded data.
|
|
2405
2415
|
*
|
|
2406
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#header-field-definition | CTA-5004-
|
|
2416
|
+
* @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
2417
|
*
|
|
2408
2418
|
* @public
|
|
2409
2419
|
*/
|
|
@@ -2420,7 +2430,7 @@ declare function validateCmcdHeaders(headers: Record<string, string> | Headers,
|
|
|
2420
2430
|
* @param options - Validation options.
|
|
2421
2431
|
* @returns The validation result.
|
|
2422
2432
|
*
|
|
2423
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-
|
|
2433
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-B Reserved Keys}
|
|
2424
2434
|
*
|
|
2425
2435
|
* @public
|
|
2426
2436
|
*/
|
|
@@ -2446,7 +2456,7 @@ declare function validateCmcdKeys(data: Record<string, unknown>, options?: CmcdV
|
|
|
2446
2456
|
* @example
|
|
2447
2457
|
* {@includeCode ../test/validateCmcdRequest.test.ts#example}
|
|
2448
2458
|
*
|
|
2449
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-
|
|
2459
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#request-mode | CTA-5004-B Request Mode}
|
|
2450
2460
|
*
|
|
2451
2461
|
* @public
|
|
2452
2462
|
*/
|
|
@@ -2463,7 +2473,7 @@ declare function validateCmcdRequest(request: Request | HttpRequest, options?: O
|
|
|
2463
2473
|
* @param options - Validation options.
|
|
2464
2474
|
* @returns The validation result.
|
|
2465
2475
|
*
|
|
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-
|
|
2476
|
+
* @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
2477
|
*
|
|
2468
2478
|
* @public
|
|
2469
2479
|
*/
|
|
@@ -2480,7 +2490,7 @@ declare function validateCmcdStructure(data: Record<string, unknown>, options?:
|
|
|
2480
2490
|
* @param options - Validation options.
|
|
2481
2491
|
* @returns The validation result.
|
|
2482
2492
|
*
|
|
2483
|
-
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-
|
|
2493
|
+
* @see {@link https://cta-wave.github.io/Resources/common-media-client-data--cta-5004-b.html#reserved-keys | CTA-5004-B Reserved Keys}
|
|
2484
2494
|
*
|
|
2485
2495
|
* @public
|
|
2486
2496
|
*/
|