@svta/cml-error-codes 0.1.1 → 0.1.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.
Files changed (5) hide show
  1. package/dist/index.d.ts +1424 -1426
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/index.js +454 -25
  4. package/dist/index.js.map +1 -1
  5. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -1,1775 +1,1773 @@
1
1
  import { ValueOf } from "@svta/cml-utils";
2
-
3
2
  //#region src/SvtaErrorCategory.d.ts
4
-
5
- /**
6
- * SVTA error category 0: Unknown error
7
- *
8
- * @public
9
- */
10
- declare const SVTA_ERROR_CATEGORY_UNKNOWN: 0;
11
- /**
12
- * SVTA error category 1: Issues with the content itself, such as an unsupported format
13
- *
14
- * @public
15
- */
16
- declare const SVTA_ERROR_CATEGORY_MEDIA_CONTENT: 1;
17
- /**
18
- * SVTA error category 2: Player unable to sustain the experience
19
- *
20
- * @public
21
- */
22
- declare const SVTA_ERROR_CATEGORY_PLAYBACK: 2;
23
- /**
24
- * SVTA error category 3: Issues on the network, including unavailable resources
25
- *
26
- * @public
27
- */
28
- declare const SVTA_ERROR_CATEGORY_NETWORK: 3;
29
- /**
30
- * SVTA error category 4: Security related error, including authentication or entitlement issues
31
- *
32
- * @public
33
- */
34
- declare const SVTA_ERROR_CATEGORY_CONTENT_PROTECTION: 4;
35
- /**
36
- * SVTA error category 5: Defective captions or audio description
37
- *
38
- * @public
39
- */
40
- declare const SVTA_ERROR_CATEGORY_ACCESSIBILITY: 5;
41
- /**
42
- * SVTA error category 6: Framework supporting the play out of the stream on a second device
43
- *
44
- * @public
45
- */
46
- declare const SVTA_ERROR_CATEGORY_REMOTE_PLAY: 6;
47
- /**
48
- * SVTA error category 7: Issues triggered by ad insertion
49
- *
50
- * @public
51
- */
52
- declare const SVTA_ERROR_CATEGORY_ADVERTISING: 7;
53
- /**
54
- * SVTA error category 99: Reserved category for Publisher-defined errors
55
- *
56
- * @public
57
- */
58
- declare const SVTA_ERROR_CATEGORY_CUSTOM: 99;
59
- /**
60
- * SVTA standardized error code categories. The category of an error code
61
- * occupies its thousands digits: `Math.floor(code / 1000)` yields the
62
- * category of any SVTA error code.
63
- *
64
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
65
- *
66
- * @enum
67
- *
68
- * @public
69
- */
70
- declare const SvtaErrorCategory: {
71
- /**
72
- * Unknown error
73
- */
3
+ /**
4
+ * SVTA error category 0: Unknown error
5
+ *
6
+ * @public
7
+ */
8
+ export declare const SVTA_ERROR_CATEGORY_UNKNOWN: 0;
9
+ /**
10
+ * SVTA error category 1: Issues with the content itself, such as an unsupported format
11
+ *
12
+ * @public
13
+ */
14
+ export declare const SVTA_ERROR_CATEGORY_MEDIA_CONTENT: 1;
15
+ /**
16
+ * SVTA error category 2: Player unable to sustain the experience
17
+ *
18
+ * @public
19
+ */
20
+ export declare const SVTA_ERROR_CATEGORY_PLAYBACK: 2;
21
+ /**
22
+ * SVTA error category 3: Issues on the network, including unavailable resources
23
+ *
24
+ * @public
25
+ */
26
+ export declare const SVTA_ERROR_CATEGORY_NETWORK: 3;
27
+ /**
28
+ * SVTA error category 4: Security related error, including authentication or entitlement issues
29
+ *
30
+ * @public
31
+ */
32
+ export declare const SVTA_ERROR_CATEGORY_CONTENT_PROTECTION: 4;
33
+ /**
34
+ * SVTA error category 5: Defective captions or audio description
35
+ *
36
+ * @public
37
+ */
38
+ export declare const SVTA_ERROR_CATEGORY_ACCESSIBILITY: 5;
39
+ /**
40
+ * SVTA error category 6: Framework supporting the play out of the stream on a second device
41
+ *
42
+ * @public
43
+ */
44
+ export declare const SVTA_ERROR_CATEGORY_REMOTE_PLAY: 6;
45
+ /**
46
+ * SVTA error category 7: Issues triggered by ad insertion
47
+ *
48
+ * @public
49
+ */
50
+ export declare const SVTA_ERROR_CATEGORY_ADVERTISING: 7;
51
+ /**
52
+ * SVTA error category 99: Reserved category for Publisher-defined errors
53
+ *
54
+ * @public
55
+ */
56
+ export declare const SVTA_ERROR_CATEGORY_CUSTOM: 99;
57
+ /**
58
+ * SVTA standardized error code categories. The category of an error code
59
+ * occupies its thousands digits: `Math.floor(code / 1000)` yields the
60
+ * category of any SVTA error code.
61
+ *
62
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
63
+ *
64
+ * @enum
65
+ *
66
+ * @public
67
+ */
68
+ export declare const SvtaErrorCategory: {
69
+ /**
70
+ * Unknown error
71
+ */
74
72
  readonly UNKNOWN: typeof SVTA_ERROR_CATEGORY_UNKNOWN;
75
73
  /**
76
- * Issues with the content itself, such as an unsupported format
77
- */
74
+ * Issues with the content itself, such as an unsupported format
75
+ */
78
76
  readonly MEDIA_CONTENT: typeof SVTA_ERROR_CATEGORY_MEDIA_CONTENT;
79
77
  /**
80
- * Player unable to sustain the experience
81
- */
78
+ * Player unable to sustain the experience
79
+ */
82
80
  readonly PLAYBACK: typeof SVTA_ERROR_CATEGORY_PLAYBACK;
83
81
  /**
84
- * Issues on the network, including unavailable resources
85
- */
82
+ * Issues on the network, including unavailable resources
83
+ */
86
84
  readonly NETWORK: typeof SVTA_ERROR_CATEGORY_NETWORK;
87
85
  /**
88
- * Security related error, including authentication or entitlement issues
89
- */
86
+ * Security related error, including authentication or entitlement issues
87
+ */
90
88
  readonly CONTENT_PROTECTION: typeof SVTA_ERROR_CATEGORY_CONTENT_PROTECTION;
91
89
  /**
92
- * Defective captions or audio description
93
- */
90
+ * Defective captions or audio description
91
+ */
94
92
  readonly ACCESSIBILITY: typeof SVTA_ERROR_CATEGORY_ACCESSIBILITY;
95
93
  /**
96
- * Framework supporting the play out of the stream on a second device
97
- */
94
+ * Framework supporting the play out of the stream on a second device
95
+ */
98
96
  readonly REMOTE_PLAY: typeof SVTA_ERROR_CATEGORY_REMOTE_PLAY;
99
97
  /**
100
- * Issues triggered by ad insertion
101
- */
98
+ * Issues triggered by ad insertion
99
+ */
102
100
  readonly ADVERTISING: typeof SVTA_ERROR_CATEGORY_ADVERTISING;
103
101
  /**
104
- * Reserved category for Publisher-defined errors
105
- */
102
+ * Reserved category for Publisher-defined errors
103
+ */
106
104
  readonly CUSTOM: typeof SVTA_ERROR_CATEGORY_CUSTOM;
107
105
  };
108
106
  /**
109
- * Union type of all {@link (SvtaErrorCategory:variable)} values.
110
- *
111
- * @public
112
- */
113
- type SvtaErrorCategory = ValueOf<typeof SvtaErrorCategory>;
107
+ * Union type of all {@link (SvtaErrorCategory:variable)} values.
108
+ *
109
+ * @public
110
+ */
111
+ export type SvtaErrorCategory = ValueOf<typeof SvtaErrorCategory>;
114
112
  //#endregion
115
113
  //#region src/getSvtaErrorCategory.d.ts
116
114
  /**
117
- * Get the `SvtaErrorCategory` of an SVTA error code, per the spec's
118
- * `code / 1000` rule.
119
- *
120
- * @param code - An SVTA error code.
121
- * @returns The error category. Returns `undefined` if the code is not a
122
- * non-negative integer, or if the spec does not assign its category.
123
- * Categories 8-98 and above 99 are reserved for future use.
124
- *
125
- * @public
126
- *
127
- * @example
128
- * {@includeCode ../test/getSvtaErrorCategory.test.ts#example}
129
- */
130
- declare function getSvtaErrorCategory(code: number): SvtaErrorCategory | undefined;
115
+ * Get the `SvtaErrorCategory` of an SVTA error code, per the spec's
116
+ * `code / 1000` rule.
117
+ *
118
+ * @param code - An SVTA error code.
119
+ * @returns The error category. Returns `undefined` if the code is not a
120
+ * non-negative integer, or if the spec does not assign its category.
121
+ * Categories 8-98 and above 99 are reserved for future use.
122
+ *
123
+ * @public
124
+ *
125
+ * @example
126
+ * {@includeCode ../test/getSvtaErrorCategory.test.ts#example}
127
+ */
128
+ export declare function getSvtaErrorCategory(code: number): SvtaErrorCategory | undefined;
131
129
  //#endregion
132
130
  //#region src/getSvtaErrorIndex.d.ts
133
131
  /**
134
- * Get the error index of an SVTA error code, per the spec's
135
- * `code mod 1000` rule. The index identifies the specific error within
136
- * its category: native indices are 0-99, embedded external codes (HTTP,
137
- * VAST) are 100-999.
138
- *
139
- * @param code - An SVTA error code.
140
- * @returns The error index within the code's category, or `undefined`
141
- * if the code is not a non-negative integer.
142
- *
143
- * @public
144
- *
145
- * @example
146
- * {@includeCode ../test/getSvtaErrorIndex.test.ts#example}
147
- */
148
- declare function getSvtaErrorIndex(code: number): number | undefined;
132
+ * Get the error index of an SVTA error code, per the spec's
133
+ * `code mod 1000` rule. The index identifies the specific error within
134
+ * its category: native indices are 0-99, embedded external codes (HTTP,
135
+ * VAST) are 100-999.
136
+ *
137
+ * @param code - An SVTA error code.
138
+ * @returns The error index within the code's category, or `undefined`
139
+ * if the code is not a non-negative integer.
140
+ *
141
+ * @public
142
+ *
143
+ * @example
144
+ * {@includeCode ../test/getSvtaErrorIndex.test.ts#example}
145
+ */
146
+ export declare function getSvtaErrorIndex(code: number): number | undefined;
149
147
  //#endregion
150
148
  //#region src/httpStatusToSvtaErrorCode.d.ts
151
149
  /**
152
- * Embed an HTTP response status code into the SVTA Network error
153
- * category, per the external code embedding rule of SVTA2070. HTTP 404
154
- * becomes 3404.
155
- *
156
- * Values outside the valid HTTP status range (integers 100-599) return
157
- * the unknown network error code (3000) rather than throwing, so error
158
- * reporting paths cannot fail.
159
- *
160
- * @param status - An HTTP response status code (100-599).
161
- * @returns The SVTA network error code embedding the status.
162
- *
163
- * @public
164
- *
165
- * @example
166
- * {@includeCode ../test/httpStatusToSvtaErrorCode.test.ts#example}
167
- */
168
- declare function httpStatusToSvtaErrorCode(status: number): number;
150
+ * Embed an HTTP response status code into the SVTA Network error
151
+ * category, per the external code embedding rule of SVTA2070. HTTP 404
152
+ * becomes 3404.
153
+ *
154
+ * Values outside the valid HTTP status range (integers 100-599) return
155
+ * the unknown network error code (3000) rather than throwing, so error
156
+ * reporting paths cannot fail.
157
+ *
158
+ * @param status - An HTTP response status code (100-599).
159
+ * @returns The SVTA network error code embedding the status.
160
+ *
161
+ * @public
162
+ *
163
+ * @example
164
+ * {@includeCode ../test/httpStatusToSvtaErrorCode.test.ts#example}
165
+ */
166
+ export declare function httpStatusToSvtaErrorCode(status: number): number;
169
167
  //#endregion
170
168
  //#region src/SvtaAccessibilityErrorCode.d.ts
171
169
  /**
172
- * SVTA 5 [Accessibility] 000: Unknown accessibility error
173
- *
174
- * @public
175
- */
176
- declare const SVTA_ACCESSIBILITY_UNKNOWN: 5000;
177
- /**
178
- * SVTA 5 [Accessibility] 001: Unable to parse timed text
179
- *
180
- * @public
181
- */
182
- declare const SVTA_TIMED_TEXT_PARSE_ERROR: 5001;
183
- /**
184
- * SVTA 5 [Accessibility] 002: Unable to render timed text
185
- *
186
- * @public
187
- */
188
- declare const SVTA_TIMED_TEXT_RENDER_ERROR: 5002;
189
- /**
190
- * SVTA 5 [Accessibility] 003: Timed text exceeds content duration
191
- *
192
- * @public
193
- */
194
- declare const SVTA_TIMED_TEXT_EXCEEDS_CONTENT_DURATION: 5003;
195
- /**
196
- * SVTA 5 [Accessibility] 004: Audio description exceeds content duration
197
- *
198
- * @public
199
- */
200
- declare const SVTA_AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION: 5004;
201
- /**
202
- * SVTA standardized error codes in the Accessibility category (5xxx):
203
- * defective captions or audio description.
204
- *
205
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
206
- *
207
- * @enum
208
- *
209
- * @public
210
- */
211
- declare const SvtaAccessibilityErrorCode: {
212
- /**
213
- * Unknown accessibility error
214
- */
170
+ * SVTA 5 [Accessibility] 000: Unknown accessibility error
171
+ *
172
+ * @public
173
+ */
174
+ export declare const SVTA_ACCESSIBILITY_UNKNOWN: 5000;
175
+ /**
176
+ * SVTA 5 [Accessibility] 001: Unable to parse timed text
177
+ *
178
+ * @public
179
+ */
180
+ export declare const SVTA_TIMED_TEXT_PARSE_ERROR: 5001;
181
+ /**
182
+ * SVTA 5 [Accessibility] 002: Unable to render timed text
183
+ *
184
+ * @public
185
+ */
186
+ export declare const SVTA_TIMED_TEXT_RENDER_ERROR: 5002;
187
+ /**
188
+ * SVTA 5 [Accessibility] 003: Timed text exceeds content duration
189
+ *
190
+ * @public
191
+ */
192
+ export declare const SVTA_TIMED_TEXT_EXCEEDS_CONTENT_DURATION: 5003;
193
+ /**
194
+ * SVTA 5 [Accessibility] 004: Audio description exceeds content duration
195
+ *
196
+ * @public
197
+ */
198
+ export declare const SVTA_AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION: 5004;
199
+ /**
200
+ * SVTA standardized error codes in the Accessibility category (5xxx):
201
+ * defective captions or audio description.
202
+ *
203
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
204
+ *
205
+ * @enum
206
+ *
207
+ * @public
208
+ */
209
+ export declare const SvtaAccessibilityErrorCode: {
210
+ /**
211
+ * Unknown accessibility error
212
+ */
215
213
  readonly UNKNOWN: typeof SVTA_ACCESSIBILITY_UNKNOWN;
216
214
  /**
217
- * Unable to parse timed text
218
- */
215
+ * Unable to parse timed text
216
+ */
219
217
  readonly TIMED_TEXT_PARSE_ERROR: typeof SVTA_TIMED_TEXT_PARSE_ERROR;
220
218
  /**
221
- * Unable to render timed text
222
- */
219
+ * Unable to render timed text
220
+ */
223
221
  readonly TIMED_TEXT_RENDER_ERROR: typeof SVTA_TIMED_TEXT_RENDER_ERROR;
224
222
  /**
225
- * Timed text exceeds content duration
226
- */
223
+ * Timed text exceeds content duration
224
+ */
227
225
  readonly TIMED_TEXT_EXCEEDS_CONTENT_DURATION: typeof SVTA_TIMED_TEXT_EXCEEDS_CONTENT_DURATION;
228
226
  /**
229
- * Audio description exceeds content duration
230
- */
227
+ * Audio description exceeds content duration
228
+ */
231
229
  readonly AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION: typeof SVTA_AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION;
232
230
  };
233
231
  /**
234
- * Union type of all {@link (SvtaAccessibilityErrorCode:variable)} values.
235
- *
236
- * @public
237
- */
238
- type SvtaAccessibilityErrorCode = ValueOf<typeof SvtaAccessibilityErrorCode>;
232
+ * Union type of all {@link (SvtaAccessibilityErrorCode:variable)} values.
233
+ *
234
+ * @public
235
+ */
236
+ export type SvtaAccessibilityErrorCode = ValueOf<typeof SvtaAccessibilityErrorCode>;
239
237
  //#endregion
240
238
  //#region src/SvtaAdvertisingErrorCode.d.ts
241
239
  /**
242
- * SVTA 7 [Advertising] 000: Unknown advertising error
243
- *
244
- * @public
245
- */
246
- declare const SVTA_ADVERTISING_UNKNOWN: 7000;
247
- /**
248
- * SVTA 7 [Advertising] 001: Ad blocker detected
249
- *
250
- * @public
251
- */
252
- declare const SVTA_AD_BLOCKER_DETECTED: 7001;
253
- /**
254
- * SVTA 7 [Advertising] 100: Unable to parse VAST XML
255
- *
256
- * @public
257
- */
258
- declare const SVTA_VAST_PARSE_ERROR: 7100;
259
- /**
260
- * SVTA 7 [Advertising] 101: Invalid VAST schema
261
- *
262
- * @public
263
- */
264
- declare const SVTA_VAST_SCHEMA_VALIDATION_ERROR: 7101;
265
- /**
266
- * SVTA 7 [Advertising] 102: VAST response version not supported
267
- *
268
- * @public
269
- */
270
- declare const SVTA_VAST_VERSION_UNSUPPORTED: 7102;
271
- /**
272
- * SVTA 7 [Advertising] 200: Video player expected different ad type
273
- *
274
- * @public
275
- */
276
- declare const SVTA_AD_TYPE_MISMATCH: 7200;
277
- /**
278
- * SVTA 7 [Advertising] 201: Creative has different linearity than player expected (non-fatal)
279
- *
280
- * @public
281
- */
282
- declare const SVTA_LINEARITY_MISMATCH: 7201;
283
- /**
284
- * SVTA 7 [Advertising] 202: Creative has different duration than player expected (non-fatal)
285
- *
286
- * @public
287
- */
288
- declare const SVTA_DURATION_MISMATCH: 7202;
289
- /**
290
- * SVTA 7 [Advertising] 203: Creative has different size than player expected (non-fatal)
291
- *
292
- * @public
293
- */
294
- declare const SVTA_SIZE_MISMATCH: 7203;
295
- /**
296
- * SVTA 7 [Advertising] 300: Wrapper failed to deliver VAST response for unknown reason
297
- *
298
- * @public
299
- */
300
- declare const SVTA_WRAPPER_ERROR: 7300;
301
- /**
302
- * SVTA 7 [Advertising] 301: VAST response redirect timed out
303
- *
304
- * @public
305
- */
306
- declare const SVTA_WRAPPER_TIMEOUT: 7301;
307
- /**
308
- * SVTA 7 [Advertising] 302: Wrapper limit reached (e.g. too many redirects)
309
- *
310
- * @public
311
- */
312
- declare const SVTA_WRAPPER_LIMIT_REACHED: 7302;
313
- /**
314
- * SVTA 7 [Advertising] 303: VAST response was empty
315
- *
316
- * @public
317
- */
318
- declare const SVTA_EMPTY_WRAPPER_RESPONSE: 7303;
319
- /**
320
- * SVTA 7 [Advertising] 400: Unable to display linear ad
321
- *
322
- * @public
323
- */
324
- declare const SVTA_LINEAR_AD_ERROR: 7400;
325
- /**
326
- * SVTA 7 [Advertising] 401: Media file not found
327
- *
328
- * @public
329
- */
330
- declare const SVTA_MEDIA_FILE_NOT_FOUND: 7401;
331
- /**
332
- * SVTA 7 [Advertising] 402: Media file unavailable
333
- *
334
- * @public
335
- */
336
- declare const SVTA_MEDIA_FILE_UNAVAILABLE: 7402;
337
- /**
338
- * SVTA 7 [Advertising] 403: VAST response contained no supported MIME types
339
- *
340
- * @public
341
- */
342
- declare const SVTA_NO_SUPPORTED_MEDIA_TYPE: 7403;
343
- /**
344
- * SVTA 7 [Advertising] 405: Unable to display media file
345
- *
346
- * @public
347
- */
348
- declare const SVTA_MEDIA_FILE_DISPLAY_ERROR: 7405;
349
- /**
350
- * SVTA 7 [Advertising] 406: Required mezzanine file missing
351
- *
352
- * @public
353
- */
354
- declare const SVTA_MEZZANINE_MISSING: 7406;
355
- /**
356
- * SVTA 7 [Advertising] 407: Mezzanine file was downloaded for the first time
357
- *
358
- * @public
359
- */
360
- declare const SVTA_MEZZANINE_DOWNLOADING: 7407;
361
- /**
362
- * SVTA 7 [Advertising] 408: VAST response contained rejected ad
363
- *
364
- * @public
365
- */
366
- declare const SVTA_REJECTED_AD: 7408;
367
- /**
368
- * SVTA 7 [Advertising] 409: Could not execute creative defined in interactiveCreativeFile
369
- *
370
- * @public
371
- */
372
- declare const SVTA_INTERACTIVE_CREATIVE_ERROR: 7409;
373
- /**
374
- * SVTA 7 [Advertising] 410: Could not execute code in verification node
375
- *
376
- * @public
377
- */
378
- declare const SVTA_VERIFICATION_ERROR: 7410;
379
- /**
380
- * SVTA 7 [Advertising] 500: Video player unable to display non-linear ad for unknown reason
381
- *
382
- * @public
383
- */
384
- declare const SVTA_NONLINEAR_AD_ERROR: 7500;
385
- /**
386
- * SVTA 7 [Advertising] 501: Non-linear ad dimensions did not match display area
387
- *
388
- * @public
389
- */
390
- declare const SVTA_NONLINEAR_DIMENSION_MISMATCH: 7501;
391
- /**
392
- * SVTA 7 [Advertising] 502: Unable to fetch non-linear ad resource
393
- *
394
- * @public
395
- */
396
- declare const SVTA_NONLINEAR_AD_FETCH_ERROR: 7502;
397
- /**
398
- * SVTA 7 [Advertising] 503: Non-linear ad did not contain a supported type
399
- *
400
- * @public
401
- */
402
- declare const SVTA_UNSUPPORTED_NONLINEAR_AD: 7503;
403
- /**
404
- * SVTA 7 [Advertising] 600: Could not display companion ad (non-fatal)
405
- *
406
- * @public
407
- */
408
- declare const SVTA_COMPANION_AD_ERROR: 7600;
409
- /**
410
- * SVTA 7 [Advertising] 601: Companion ad dimensions did not match display area
411
- *
412
- * @public
413
- */
414
- declare const SVTA_COMPANION_DIMENSION_MISMATCH: 7601;
415
- /**
416
- * SVTA 7 [Advertising] 602: Unable to display required companion ad
417
- *
418
- * @public
419
- */
420
- declare const SVTA_REQUIRED_COMPANION_AD_ERROR: 7602;
421
- /**
422
- * SVTA 7 [Advertising] 603: Unable to fetch companion ad resource
423
- *
424
- * @public
425
- */
426
- declare const SVTA_COMPANION_AD_FETCH_ERROR: 7603;
427
- /**
428
- * SVTA 7 [Advertising] 900: Undefined VAST error
429
- *
430
- * @public
431
- */
432
- declare const SVTA_UNDEFINED_VAST_ERROR: 7900;
433
- /**
434
- * SVTA 7 [Advertising] 901: Unknown VPAID error
435
- *
436
- * @public
437
- */
438
- declare const SVTA_VPAID_ERROR: 7901;
439
- /**
440
- * SVTA 7 [Advertising] 999: VAST response document was empty
441
- *
442
- * SVTA2070 maps the four-digit IAB VAST error 1009 to this code.
443
- *
444
- * @public
445
- */
446
- declare const SVTA_EMPTY_VAST_RESPONSE: 7999;
447
- /**
448
- * SVTA standardized error codes in the Advertising category (7xxx):
449
- * issues triggered by ad insertion.
450
- *
451
- * IAB VAST error codes embed into this category at indices 100 through
452
- * 999. `7301` is VAST error 301. See `vastErrorToSvtaErrorCode`.
453
- * VAST defines no error 404, so there is no `7404`. The four-digit VAST
454
- * error 1009 (empty VAST response) maps to `7999`.
455
- *
456
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
457
- * @see {@link https://www.iab.com/wp-content/uploads/2016/01/VAST_4-0_2016-01-21.pdf | IAB VAST 4.0 §2.3.6.3 Error Codes}
458
- *
459
- * @enum
460
- *
461
- * @public
462
- */
463
- declare const SvtaAdvertisingErrorCode: {
464
- /**
465
- * Unknown advertising error
466
- */
240
+ * SVTA 7 [Advertising] 000: Unknown advertising error
241
+ *
242
+ * @public
243
+ */
244
+ export declare const SVTA_ADVERTISING_UNKNOWN: 7000;
245
+ /**
246
+ * SVTA 7 [Advertising] 001: Ad blocker detected
247
+ *
248
+ * @public
249
+ */
250
+ export declare const SVTA_AD_BLOCKER_DETECTED: 7001;
251
+ /**
252
+ * SVTA 7 [Advertising] 100: Unable to parse VAST XML
253
+ *
254
+ * @public
255
+ */
256
+ export declare const SVTA_VAST_PARSE_ERROR: 7100;
257
+ /**
258
+ * SVTA 7 [Advertising] 101: Invalid VAST schema
259
+ *
260
+ * @public
261
+ */
262
+ export declare const SVTA_VAST_SCHEMA_VALIDATION_ERROR: 7101;
263
+ /**
264
+ * SVTA 7 [Advertising] 102: VAST response version not supported
265
+ *
266
+ * @public
267
+ */
268
+ export declare const SVTA_VAST_VERSION_UNSUPPORTED: 7102;
269
+ /**
270
+ * SVTA 7 [Advertising] 200: Video player expected different ad type
271
+ *
272
+ * @public
273
+ */
274
+ export declare const SVTA_AD_TYPE_MISMATCH: 7200;
275
+ /**
276
+ * SVTA 7 [Advertising] 201: Creative has different linearity than player expected (non-fatal)
277
+ *
278
+ * @public
279
+ */
280
+ export declare const SVTA_LINEARITY_MISMATCH: 7201;
281
+ /**
282
+ * SVTA 7 [Advertising] 202: Creative has different duration than player expected (non-fatal)
283
+ *
284
+ * @public
285
+ */
286
+ export declare const SVTA_DURATION_MISMATCH: 7202;
287
+ /**
288
+ * SVTA 7 [Advertising] 203: Creative has different size than player expected (non-fatal)
289
+ *
290
+ * @public
291
+ */
292
+ export declare const SVTA_SIZE_MISMATCH: 7203;
293
+ /**
294
+ * SVTA 7 [Advertising] 300: Wrapper failed to deliver VAST response for unknown reason
295
+ *
296
+ * @public
297
+ */
298
+ export declare const SVTA_WRAPPER_ERROR: 7300;
299
+ /**
300
+ * SVTA 7 [Advertising] 301: VAST response redirect timed out
301
+ *
302
+ * @public
303
+ */
304
+ export declare const SVTA_WRAPPER_TIMEOUT: 7301;
305
+ /**
306
+ * SVTA 7 [Advertising] 302: Wrapper limit reached (e.g. too many redirects)
307
+ *
308
+ * @public
309
+ */
310
+ export declare const SVTA_WRAPPER_LIMIT_REACHED: 7302;
311
+ /**
312
+ * SVTA 7 [Advertising] 303: VAST response was empty
313
+ *
314
+ * @public
315
+ */
316
+ export declare const SVTA_EMPTY_WRAPPER_RESPONSE: 7303;
317
+ /**
318
+ * SVTA 7 [Advertising] 400: Unable to display linear ad
319
+ *
320
+ * @public
321
+ */
322
+ export declare const SVTA_LINEAR_AD_ERROR: 7400;
323
+ /**
324
+ * SVTA 7 [Advertising] 401: Media file not found
325
+ *
326
+ * @public
327
+ */
328
+ export declare const SVTA_MEDIA_FILE_NOT_FOUND: 7401;
329
+ /**
330
+ * SVTA 7 [Advertising] 402: Media file unavailable
331
+ *
332
+ * @public
333
+ */
334
+ export declare const SVTA_MEDIA_FILE_UNAVAILABLE: 7402;
335
+ /**
336
+ * SVTA 7 [Advertising] 403: VAST response contained no supported MIME types
337
+ *
338
+ * @public
339
+ */
340
+ export declare const SVTA_NO_SUPPORTED_MEDIA_TYPE: 7403;
341
+ /**
342
+ * SVTA 7 [Advertising] 405: Unable to display media file
343
+ *
344
+ * @public
345
+ */
346
+ export declare const SVTA_MEDIA_FILE_DISPLAY_ERROR: 7405;
347
+ /**
348
+ * SVTA 7 [Advertising] 406: Required mezzanine file missing
349
+ *
350
+ * @public
351
+ */
352
+ export declare const SVTA_MEZZANINE_MISSING: 7406;
353
+ /**
354
+ * SVTA 7 [Advertising] 407: Mezzanine file was downloaded for the first time
355
+ *
356
+ * @public
357
+ */
358
+ export declare const SVTA_MEZZANINE_DOWNLOADING: 7407;
359
+ /**
360
+ * SVTA 7 [Advertising] 408: VAST response contained rejected ad
361
+ *
362
+ * @public
363
+ */
364
+ export declare const SVTA_REJECTED_AD: 7408;
365
+ /**
366
+ * SVTA 7 [Advertising] 409: Could not execute creative defined in interactiveCreativeFile
367
+ *
368
+ * @public
369
+ */
370
+ export declare const SVTA_INTERACTIVE_CREATIVE_ERROR: 7409;
371
+ /**
372
+ * SVTA 7 [Advertising] 410: Could not execute code in verification node
373
+ *
374
+ * @public
375
+ */
376
+ export declare const SVTA_VERIFICATION_ERROR: 7410;
377
+ /**
378
+ * SVTA 7 [Advertising] 500: Video player unable to display non-linear ad for unknown reason
379
+ *
380
+ * @public
381
+ */
382
+ export declare const SVTA_NONLINEAR_AD_ERROR: 7500;
383
+ /**
384
+ * SVTA 7 [Advertising] 501: Non-linear ad dimensions did not match display area
385
+ *
386
+ * @public
387
+ */
388
+ export declare const SVTA_NONLINEAR_DIMENSION_MISMATCH: 7501;
389
+ /**
390
+ * SVTA 7 [Advertising] 502: Unable to fetch non-linear ad resource
391
+ *
392
+ * @public
393
+ */
394
+ export declare const SVTA_NONLINEAR_AD_FETCH_ERROR: 7502;
395
+ /**
396
+ * SVTA 7 [Advertising] 503: Non-linear ad did not contain a supported type
397
+ *
398
+ * @public
399
+ */
400
+ export declare const SVTA_UNSUPPORTED_NONLINEAR_AD: 7503;
401
+ /**
402
+ * SVTA 7 [Advertising] 600: Could not display companion ad (non-fatal)
403
+ *
404
+ * @public
405
+ */
406
+ export declare const SVTA_COMPANION_AD_ERROR: 7600;
407
+ /**
408
+ * SVTA 7 [Advertising] 601: Companion ad dimensions did not match display area
409
+ *
410
+ * @public
411
+ */
412
+ export declare const SVTA_COMPANION_DIMENSION_MISMATCH: 7601;
413
+ /**
414
+ * SVTA 7 [Advertising] 602: Unable to display required companion ad
415
+ *
416
+ * @public
417
+ */
418
+ export declare const SVTA_REQUIRED_COMPANION_AD_ERROR: 7602;
419
+ /**
420
+ * SVTA 7 [Advertising] 603: Unable to fetch companion ad resource
421
+ *
422
+ * @public
423
+ */
424
+ export declare const SVTA_COMPANION_AD_FETCH_ERROR: 7603;
425
+ /**
426
+ * SVTA 7 [Advertising] 900: Undefined VAST error
427
+ *
428
+ * @public
429
+ */
430
+ export declare const SVTA_UNDEFINED_VAST_ERROR: 7900;
431
+ /**
432
+ * SVTA 7 [Advertising] 901: Unknown VPAID error
433
+ *
434
+ * @public
435
+ */
436
+ export declare const SVTA_VPAID_ERROR: 7901;
437
+ /**
438
+ * SVTA 7 [Advertising] 999: VAST response document was empty
439
+ *
440
+ * SVTA2070 maps the four-digit IAB VAST error 1009 to this code.
441
+ *
442
+ * @public
443
+ */
444
+ export declare const SVTA_EMPTY_VAST_RESPONSE: 7999;
445
+ /**
446
+ * SVTA standardized error codes in the Advertising category (7xxx):
447
+ * issues triggered by ad insertion.
448
+ *
449
+ * IAB VAST error codes embed into this category at indices 100 through
450
+ * 999. `7301` is VAST error 301. See `vastErrorToSvtaErrorCode`.
451
+ * VAST defines no error 404, so there is no `7404`. The four-digit VAST
452
+ * error 1009 (empty VAST response) maps to `7999`.
453
+ *
454
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
455
+ * @see {@link https://www.iab.com/wp-content/uploads/2016/01/VAST_4-0_2016-01-21.pdf | IAB VAST 4.0 §2.3.6.3 Error Codes}
456
+ *
457
+ * @enum
458
+ *
459
+ * @public
460
+ */
461
+ export declare const SvtaAdvertisingErrorCode: {
462
+ /**
463
+ * Unknown advertising error
464
+ */
467
465
  readonly UNKNOWN: typeof SVTA_ADVERTISING_UNKNOWN;
468
466
  /**
469
- * Ad blocker detected
470
- */
467
+ * Ad blocker detected
468
+ */
471
469
  readonly AD_BLOCKER_DETECTED: typeof SVTA_AD_BLOCKER_DETECTED;
472
470
  /**
473
- * Unable to parse VAST XML
474
- */
471
+ * Unable to parse VAST XML
472
+ */
475
473
  readonly VAST_PARSE_ERROR: typeof SVTA_VAST_PARSE_ERROR;
476
474
  /**
477
- * Invalid VAST schema
478
- */
475
+ * Invalid VAST schema
476
+ */
479
477
  readonly VAST_SCHEMA_VALIDATION_ERROR: typeof SVTA_VAST_SCHEMA_VALIDATION_ERROR;
480
478
  /**
481
- * VAST response version not supported
482
- */
479
+ * VAST response version not supported
480
+ */
483
481
  readonly VAST_VERSION_UNSUPPORTED: typeof SVTA_VAST_VERSION_UNSUPPORTED;
484
482
  /**
485
- * Video player expected different ad type
486
- */
483
+ * Video player expected different ad type
484
+ */
487
485
  readonly AD_TYPE_MISMATCH: typeof SVTA_AD_TYPE_MISMATCH;
488
486
  /**
489
- * Creative has different linearity than player expected (non-fatal)
490
- */
487
+ * Creative has different linearity than player expected (non-fatal)
488
+ */
491
489
  readonly LINEARITY_MISMATCH: typeof SVTA_LINEARITY_MISMATCH;
492
490
  /**
493
- * Creative has different duration than player expected (non-fatal)
494
- */
491
+ * Creative has different duration than player expected (non-fatal)
492
+ */
495
493
  readonly DURATION_MISMATCH: typeof SVTA_DURATION_MISMATCH;
496
494
  /**
497
- * Creative has different size than player expected (non-fatal)
498
- */
495
+ * Creative has different size than player expected (non-fatal)
496
+ */
499
497
  readonly SIZE_MISMATCH: typeof SVTA_SIZE_MISMATCH;
500
498
  /**
501
- * Wrapper failed to deliver VAST response for unknown reason
502
- */
499
+ * Wrapper failed to deliver VAST response for unknown reason
500
+ */
503
501
  readonly WRAPPER_ERROR: typeof SVTA_WRAPPER_ERROR;
504
502
  /**
505
- * VAST response redirect timed out
506
- */
503
+ * VAST response redirect timed out
504
+ */
507
505
  readonly WRAPPER_TIMEOUT: typeof SVTA_WRAPPER_TIMEOUT;
508
506
  /**
509
- * Wrapper limit reached (e.g. too many redirects)
510
- */
507
+ * Wrapper limit reached (e.g. too many redirects)
508
+ */
511
509
  readonly WRAPPER_LIMIT_REACHED: typeof SVTA_WRAPPER_LIMIT_REACHED;
512
510
  /**
513
- * VAST response was empty
514
- */
511
+ * VAST response was empty
512
+ */
515
513
  readonly EMPTY_WRAPPER_RESPONSE: typeof SVTA_EMPTY_WRAPPER_RESPONSE;
516
514
  /**
517
- * Unable to display linear ad
518
- */
515
+ * Unable to display linear ad
516
+ */
519
517
  readonly LINEAR_AD_ERROR: typeof SVTA_LINEAR_AD_ERROR;
520
518
  /**
521
- * Media file not found
522
- */
519
+ * Media file not found
520
+ */
523
521
  readonly MEDIA_FILE_NOT_FOUND: typeof SVTA_MEDIA_FILE_NOT_FOUND;
524
522
  /**
525
- * Media file unavailable
526
- */
523
+ * Media file unavailable
524
+ */
527
525
  readonly MEDIA_FILE_UNAVAILABLE: typeof SVTA_MEDIA_FILE_UNAVAILABLE;
528
526
  /**
529
- * VAST response contained no supported MIME types
530
- */
527
+ * VAST response contained no supported MIME types
528
+ */
531
529
  readonly NO_SUPPORTED_MEDIA_TYPE: typeof SVTA_NO_SUPPORTED_MEDIA_TYPE;
532
530
  /**
533
- * Unable to display media file
534
- */
531
+ * Unable to display media file
532
+ */
535
533
  readonly MEDIA_FILE_DISPLAY_ERROR: typeof SVTA_MEDIA_FILE_DISPLAY_ERROR;
536
534
  /**
537
- * Required mezzanine file missing
538
- */
535
+ * Required mezzanine file missing
536
+ */
539
537
  readonly MEZZANINE_MISSING: typeof SVTA_MEZZANINE_MISSING;
540
538
  /**
541
- * Mezzanine file was downloaded for the first time
542
- */
539
+ * Mezzanine file was downloaded for the first time
540
+ */
543
541
  readonly MEZZANINE_DOWNLOADING: typeof SVTA_MEZZANINE_DOWNLOADING;
544
542
  /**
545
- * VAST response contained rejected ad
546
- */
543
+ * VAST response contained rejected ad
544
+ */
547
545
  readonly REJECTED_AD: typeof SVTA_REJECTED_AD;
548
546
  /**
549
- * Could not execute creative defined in interactiveCreativeFile
550
- */
547
+ * Could not execute creative defined in interactiveCreativeFile
548
+ */
551
549
  readonly INTERACTIVE_CREATIVE_ERROR: typeof SVTA_INTERACTIVE_CREATIVE_ERROR;
552
550
  /**
553
- * Could not execute code in verification node
554
- */
551
+ * Could not execute code in verification node
552
+ */
555
553
  readonly VERIFICATION_ERROR: typeof SVTA_VERIFICATION_ERROR;
556
554
  /**
557
- * Video player unable to display non-linear ad for unknown reason
558
- */
555
+ * Video player unable to display non-linear ad for unknown reason
556
+ */
559
557
  readonly NONLINEAR_AD_ERROR: typeof SVTA_NONLINEAR_AD_ERROR;
560
558
  /**
561
- * Non-linear ad dimensions did not match display area
562
- */
559
+ * Non-linear ad dimensions did not match display area
560
+ */
563
561
  readonly NONLINEAR_DIMENSION_MISMATCH: typeof SVTA_NONLINEAR_DIMENSION_MISMATCH;
564
562
  /**
565
- * Unable to fetch non-linear ad resource
566
- */
563
+ * Unable to fetch non-linear ad resource
564
+ */
567
565
  readonly NONLINEAR_AD_FETCH_ERROR: typeof SVTA_NONLINEAR_AD_FETCH_ERROR;
568
566
  /**
569
- * Non-linear ad did not contain a supported type
570
- */
567
+ * Non-linear ad did not contain a supported type
568
+ */
571
569
  readonly UNSUPPORTED_NONLINEAR_AD: typeof SVTA_UNSUPPORTED_NONLINEAR_AD;
572
570
  /**
573
- * Could not display companion ad (non-fatal)
574
- */
571
+ * Could not display companion ad (non-fatal)
572
+ */
575
573
  readonly COMPANION_AD_ERROR: typeof SVTA_COMPANION_AD_ERROR;
576
574
  /**
577
- * Companion ad dimensions did not match display area
578
- */
575
+ * Companion ad dimensions did not match display area
576
+ */
579
577
  readonly COMPANION_DIMENSION_MISMATCH: typeof SVTA_COMPANION_DIMENSION_MISMATCH;
580
578
  /**
581
- * Unable to display required companion ad
582
- */
579
+ * Unable to display required companion ad
580
+ */
583
581
  readonly REQUIRED_COMPANION_AD_ERROR: typeof SVTA_REQUIRED_COMPANION_AD_ERROR;
584
582
  /**
585
- * Unable to fetch companion ad resource
586
- */
583
+ * Unable to fetch companion ad resource
584
+ */
587
585
  readonly COMPANION_AD_FETCH_ERROR: typeof SVTA_COMPANION_AD_FETCH_ERROR;
588
586
  /**
589
- * Undefined VAST error
590
- */
587
+ * Undefined VAST error
588
+ */
591
589
  readonly UNDEFINED_VAST_ERROR: typeof SVTA_UNDEFINED_VAST_ERROR;
592
590
  /**
593
- * Unknown VPAID error
594
- */
591
+ * Unknown VPAID error
592
+ */
595
593
  readonly VPAID_ERROR: typeof SVTA_VPAID_ERROR;
596
594
  /**
597
- * VAST response document was empty
598
- *
599
- * SVTA2070 maps the four-digit IAB VAST error 1009 to this code.
600
- */
595
+ * VAST response document was empty
596
+ *
597
+ * SVTA2070 maps the four-digit IAB VAST error 1009 to this code.
598
+ */
601
599
  readonly EMPTY_VAST_RESPONSE: typeof SVTA_EMPTY_VAST_RESPONSE;
602
600
  };
603
601
  /**
604
- * Union type of all {@link (SvtaAdvertisingErrorCode:variable)} values.
605
- *
606
- * @public
607
- */
608
- type SvtaAdvertisingErrorCode = ValueOf<typeof SvtaAdvertisingErrorCode>;
602
+ * Union type of all {@link (SvtaAdvertisingErrorCode:variable)} values.
603
+ *
604
+ * @public
605
+ */
606
+ export type SvtaAdvertisingErrorCode = ValueOf<typeof SvtaAdvertisingErrorCode>;
609
607
  //#endregion
610
608
  //#region src/SvtaContentProtectionErrorCode.d.ts
611
609
  /**
612
- * SVTA 4 [Content Protection] 000: Unknown content protection error
613
- *
614
- * @public
615
- */
616
- declare const SVTA_CONTENT_PROTECTION_UNKNOWN: 4000;
617
- /**
618
- * SVTA 4 [Content Protection] 001: Concurrent stream limit exceeded
619
- *
620
- * @public
621
- */
622
- declare const SVTA_CONCURRENT_STREAM_LIMIT_EXCEEDED: 4001;
623
- /**
624
- * SVTA 4 [Content Protection] 002: Entitlement refused
625
- *
626
- * @public
627
- */
628
- declare const SVTA_ENTITLEMENT_REFUSED: 4002;
629
- /**
630
- * SVTA 4 [Content Protection] 003: License expired
631
- *
632
- * @public
633
- */
634
- declare const SVTA_LICENSE_EXPIRED: 4003;
635
- /**
636
- * SVTA 4 [Content Protection] 004: Bad license request
637
- *
638
- * @public
639
- */
640
- declare const SVTA_BAD_LICENSE_REQUEST: 4004;
641
- /**
642
- * SVTA 4 [Content Protection] 005: License server timeout
643
- *
644
- * @public
645
- */
646
- declare const SVTA_LICENSE_SERVER_TIMEOUT: 4005;
647
- /**
648
- * SVTA 4 [Content Protection] 006: Insufficient DRM robustness level
649
- *
650
- * @public
651
- */
652
- declare const SVTA_INSUFFICIENT_DRM_ROBUSTNESS: 4006;
653
- /**
654
- * SVTA 4 [Content Protection] 007: Insufficient output protection
655
- *
656
- * @public
657
- */
658
- declare const SVTA_INSUFFICIENT_OUTPUT_PROTECTION: 4007;
659
- /**
660
- * SVTA 4 [Content Protection] 008: Unsupported or unavailable DRM system
661
- *
662
- * @public
663
- */
664
- declare const SVTA_UNSUPPORTED_DRM_SYSTEM: 4008;
665
- /**
666
- * SVTA 4 [Content Protection] 009: Access restricted due to unsupported geo
667
- *
668
- * @public
669
- */
670
- declare const SVTA_GEO_RESTRICTED: 4009;
671
- /**
672
- * SVTA 4 [Content Protection] 010: DRM initialization error
673
- *
674
- * @public
675
- */
676
- declare const SVTA_DRM_INITIALIZATION_ERROR: 4010;
677
- /**
678
- * SVTA 4 [Content Protection] 011: CDN unauthorized
679
- *
680
- * @public
681
- */
682
- declare const SVTA_CDN_UNAUTHORIZED: 4011;
683
- /**
684
- * SVTA 4 [Content Protection] 012: Invalid access token
685
- *
686
- * @public
687
- */
688
- declare const SVTA_INVALID_ACCESS_TOKEN: 4012;
689
- /**
690
- * SVTA 4 [Content Protection] 013: DRM certificate error
691
- *
692
- * @public
693
- */
694
- declare const SVTA_DRM_CERTIFICATE_ERROR: 4013;
695
- /**
696
- * SVTA 4 [Content Protection] 014: DRM session error
697
- *
698
- * @public
699
- */
700
- declare const SVTA_DRM_SESSION_ERROR: 4014;
701
- /**
702
- * SVTA 4 [Content Protection] 015: DRM initialization data or configuration missing
703
- *
704
- * @public
705
- */
706
- declare const SVTA_DRM_CONFIGURATION_MISSING: 4015;
707
- /**
708
- * SVTA 4 [Content Protection] 016: DRM license response rejected
709
- *
710
- * @public
711
- */
712
- declare const SVTA_LICENSE_RESPONSE_REJECTED: 4016;
713
- /**
714
- * SVTA 4 [Content Protection] 017: Persistent session DRM error
715
- *
716
- * @public
717
- */
718
- declare const SVTA_PERSISTENT_SESSION_ERROR: 4017;
719
- /**
720
- * SVTA 4 [Content Protection] 018: Required permission rejected
721
- *
722
- * @public
723
- */
724
- declare const SVTA_PERMISSION_REJECTED: 4018;
725
- /**
726
- * SVTA 4 [Content Protection] 019: Failed to load decryption key
727
- *
728
- * @public
729
- */
730
- declare const SVTA_KEY_LOAD_ERROR: 4019;
731
- /**
732
- * SVTA 4 [Content Protection] 020: Failed to decrypt segment
733
- *
734
- * @public
735
- */
736
- declare const SVTA_SEGMENT_DECRYPTION_ERROR: 4020;
737
- /**
738
- * SVTA 4 [Content Protection] 021: Failed to generate DRM license request
739
- *
740
- * @public
741
- */
742
- declare const SVTA_LICENSE_REQUEST_GENERATION_ERROR: 4021;
743
- /**
744
- * SVTA standardized error codes in the Content Protection category
745
- * (4xxx): security related errors, including authentication and
746
- * entitlement issues.
747
- *
748
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
749
- *
750
- * @enum
751
- *
752
- * @public
753
- */
754
- declare const SvtaContentProtectionErrorCode: {
755
- /**
756
- * Unknown content protection error
757
- */
610
+ * SVTA 4 [Content Protection] 000: Unknown content protection error
611
+ *
612
+ * @public
613
+ */
614
+ export declare const SVTA_CONTENT_PROTECTION_UNKNOWN: 4000;
615
+ /**
616
+ * SVTA 4 [Content Protection] 001: Concurrent stream limit exceeded
617
+ *
618
+ * @public
619
+ */
620
+ export declare const SVTA_CONCURRENT_STREAM_LIMIT_EXCEEDED: 4001;
621
+ /**
622
+ * SVTA 4 [Content Protection] 002: Entitlement refused
623
+ *
624
+ * @public
625
+ */
626
+ export declare const SVTA_ENTITLEMENT_REFUSED: 4002;
627
+ /**
628
+ * SVTA 4 [Content Protection] 003: License expired
629
+ *
630
+ * @public
631
+ */
632
+ export declare const SVTA_LICENSE_EXPIRED: 4003;
633
+ /**
634
+ * SVTA 4 [Content Protection] 004: Bad license request
635
+ *
636
+ * @public
637
+ */
638
+ export declare const SVTA_BAD_LICENSE_REQUEST: 4004;
639
+ /**
640
+ * SVTA 4 [Content Protection] 005: License server timeout
641
+ *
642
+ * @public
643
+ */
644
+ export declare const SVTA_LICENSE_SERVER_TIMEOUT: 4005;
645
+ /**
646
+ * SVTA 4 [Content Protection] 006: Insufficient DRM robustness level
647
+ *
648
+ * @public
649
+ */
650
+ export declare const SVTA_INSUFFICIENT_DRM_ROBUSTNESS: 4006;
651
+ /**
652
+ * SVTA 4 [Content Protection] 007: Insufficient output protection
653
+ *
654
+ * @public
655
+ */
656
+ export declare const SVTA_INSUFFICIENT_OUTPUT_PROTECTION: 4007;
657
+ /**
658
+ * SVTA 4 [Content Protection] 008: Unsupported or unavailable DRM system
659
+ *
660
+ * @public
661
+ */
662
+ export declare const SVTA_UNSUPPORTED_DRM_SYSTEM: 4008;
663
+ /**
664
+ * SVTA 4 [Content Protection] 009: Access restricted due to unsupported geo
665
+ *
666
+ * @public
667
+ */
668
+ export declare const SVTA_GEO_RESTRICTED: 4009;
669
+ /**
670
+ * SVTA 4 [Content Protection] 010: DRM initialization error
671
+ *
672
+ * @public
673
+ */
674
+ export declare const SVTA_DRM_INITIALIZATION_ERROR: 4010;
675
+ /**
676
+ * SVTA 4 [Content Protection] 011: CDN unauthorized
677
+ *
678
+ * @public
679
+ */
680
+ export declare const SVTA_CDN_UNAUTHORIZED: 4011;
681
+ /**
682
+ * SVTA 4 [Content Protection] 012: Invalid access token
683
+ *
684
+ * @public
685
+ */
686
+ export declare const SVTA_INVALID_ACCESS_TOKEN: 4012;
687
+ /**
688
+ * SVTA 4 [Content Protection] 013: DRM certificate error
689
+ *
690
+ * @public
691
+ */
692
+ export declare const SVTA_DRM_CERTIFICATE_ERROR: 4013;
693
+ /**
694
+ * SVTA 4 [Content Protection] 014: DRM session error
695
+ *
696
+ * @public
697
+ */
698
+ export declare const SVTA_DRM_SESSION_ERROR: 4014;
699
+ /**
700
+ * SVTA 4 [Content Protection] 015: DRM initialization data or configuration missing
701
+ *
702
+ * @public
703
+ */
704
+ export declare const SVTA_DRM_CONFIGURATION_MISSING: 4015;
705
+ /**
706
+ * SVTA 4 [Content Protection] 016: DRM license response rejected
707
+ *
708
+ * @public
709
+ */
710
+ export declare const SVTA_LICENSE_RESPONSE_REJECTED: 4016;
711
+ /**
712
+ * SVTA 4 [Content Protection] 017: Persistent session DRM error
713
+ *
714
+ * @public
715
+ */
716
+ export declare const SVTA_PERSISTENT_SESSION_ERROR: 4017;
717
+ /**
718
+ * SVTA 4 [Content Protection] 018: Required permission rejected
719
+ *
720
+ * @public
721
+ */
722
+ export declare const SVTA_PERMISSION_REJECTED: 4018;
723
+ /**
724
+ * SVTA 4 [Content Protection] 019: Failed to load decryption key
725
+ *
726
+ * @public
727
+ */
728
+ export declare const SVTA_KEY_LOAD_ERROR: 4019;
729
+ /**
730
+ * SVTA 4 [Content Protection] 020: Failed to decrypt segment
731
+ *
732
+ * @public
733
+ */
734
+ export declare const SVTA_SEGMENT_DECRYPTION_ERROR: 4020;
735
+ /**
736
+ * SVTA 4 [Content Protection] 021: Failed to generate DRM license request
737
+ *
738
+ * @public
739
+ */
740
+ export declare const SVTA_LICENSE_REQUEST_GENERATION_ERROR: 4021;
741
+ /**
742
+ * SVTA standardized error codes in the Content Protection category
743
+ * (4xxx): security related errors, including authentication and
744
+ * entitlement issues.
745
+ *
746
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
747
+ *
748
+ * @enum
749
+ *
750
+ * @public
751
+ */
752
+ export declare const SvtaContentProtectionErrorCode: {
753
+ /**
754
+ * Unknown content protection error
755
+ */
758
756
  readonly UNKNOWN: typeof SVTA_CONTENT_PROTECTION_UNKNOWN;
759
757
  /**
760
- * Concurrent stream limit exceeded
761
- */
758
+ * Concurrent stream limit exceeded
759
+ */
762
760
  readonly CONCURRENT_STREAM_LIMIT_EXCEEDED: typeof SVTA_CONCURRENT_STREAM_LIMIT_EXCEEDED;
763
761
  /**
764
- * Entitlement refused
765
- */
762
+ * Entitlement refused
763
+ */
766
764
  readonly ENTITLEMENT_REFUSED: typeof SVTA_ENTITLEMENT_REFUSED;
767
765
  /**
768
- * License expired
769
- */
766
+ * License expired
767
+ */
770
768
  readonly LICENSE_EXPIRED: typeof SVTA_LICENSE_EXPIRED;
771
769
  /**
772
- * Bad license request
773
- */
770
+ * Bad license request
771
+ */
774
772
  readonly BAD_LICENSE_REQUEST: typeof SVTA_BAD_LICENSE_REQUEST;
775
773
  /**
776
- * License server timeout
777
- */
774
+ * License server timeout
775
+ */
778
776
  readonly LICENSE_SERVER_TIMEOUT: typeof SVTA_LICENSE_SERVER_TIMEOUT;
779
777
  /**
780
- * Insufficient DRM robustness level
781
- */
778
+ * Insufficient DRM robustness level
779
+ */
782
780
  readonly INSUFFICIENT_DRM_ROBUSTNESS: typeof SVTA_INSUFFICIENT_DRM_ROBUSTNESS;
783
781
  /**
784
- * Insufficient output protection
785
- */
782
+ * Insufficient output protection
783
+ */
786
784
  readonly INSUFFICIENT_OUTPUT_PROTECTION: typeof SVTA_INSUFFICIENT_OUTPUT_PROTECTION;
787
785
  /**
788
- * Unsupported or unavailable DRM system
789
- */
786
+ * Unsupported or unavailable DRM system
787
+ */
790
788
  readonly UNSUPPORTED_DRM_SYSTEM: typeof SVTA_UNSUPPORTED_DRM_SYSTEM;
791
789
  /**
792
- * Access restricted due to unsupported geo
793
- */
790
+ * Access restricted due to unsupported geo
791
+ */
794
792
  readonly GEO_RESTRICTED: typeof SVTA_GEO_RESTRICTED;
795
793
  /**
796
- * DRM initialization error
797
- */
794
+ * DRM initialization error
795
+ */
798
796
  readonly DRM_INITIALIZATION_ERROR: typeof SVTA_DRM_INITIALIZATION_ERROR;
799
797
  /**
800
- * CDN unauthorized
801
- */
798
+ * CDN unauthorized
799
+ */
802
800
  readonly CDN_UNAUTHORIZED: typeof SVTA_CDN_UNAUTHORIZED;
803
801
  /**
804
- * Invalid access token
805
- */
802
+ * Invalid access token
803
+ */
806
804
  readonly INVALID_ACCESS_TOKEN: typeof SVTA_INVALID_ACCESS_TOKEN;
807
805
  /**
808
- * DRM certificate error
809
- */
806
+ * DRM certificate error
807
+ */
810
808
  readonly DRM_CERTIFICATE_ERROR: typeof SVTA_DRM_CERTIFICATE_ERROR;
811
809
  /**
812
- * DRM session error
813
- */
810
+ * DRM session error
811
+ */
814
812
  readonly DRM_SESSION_ERROR: typeof SVTA_DRM_SESSION_ERROR;
815
813
  /**
816
- * DRM initialization data or configuration missing
817
- */
814
+ * DRM initialization data or configuration missing
815
+ */
818
816
  readonly DRM_CONFIGURATION_MISSING: typeof SVTA_DRM_CONFIGURATION_MISSING;
819
817
  /**
820
- * DRM license response rejected
821
- */
818
+ * DRM license response rejected
819
+ */
822
820
  readonly LICENSE_RESPONSE_REJECTED: typeof SVTA_LICENSE_RESPONSE_REJECTED;
823
821
  /**
824
- * Persistent session DRM error
825
- */
822
+ * Persistent session DRM error
823
+ */
826
824
  readonly PERSISTENT_SESSION_ERROR: typeof SVTA_PERSISTENT_SESSION_ERROR;
827
825
  /**
828
- * Required permission rejected
829
- */
826
+ * Required permission rejected
827
+ */
830
828
  readonly PERMISSION_REJECTED: typeof SVTA_PERMISSION_REJECTED;
831
829
  /**
832
- * Failed to load decryption key
833
- */
830
+ * Failed to load decryption key
831
+ */
834
832
  readonly KEY_LOAD_ERROR: typeof SVTA_KEY_LOAD_ERROR;
835
833
  /**
836
- * Failed to decrypt segment
837
- */
834
+ * Failed to decrypt segment
835
+ */
838
836
  readonly SEGMENT_DECRYPTION_ERROR: typeof SVTA_SEGMENT_DECRYPTION_ERROR;
839
837
  /**
840
- * Failed to generate DRM license request
841
- */
838
+ * Failed to generate DRM license request
839
+ */
842
840
  readonly LICENSE_REQUEST_GENERATION_ERROR: typeof SVTA_LICENSE_REQUEST_GENERATION_ERROR;
843
841
  };
844
842
  /**
845
- * Union type of all {@link (SvtaContentProtectionErrorCode:variable)} values.
846
- *
847
- * @public
848
- */
849
- type SvtaContentProtectionErrorCode = ValueOf<typeof SvtaContentProtectionErrorCode>;
843
+ * Union type of all {@link (SvtaContentProtectionErrorCode:variable)} values.
844
+ *
845
+ * @public
846
+ */
847
+ export type SvtaContentProtectionErrorCode = ValueOf<typeof SvtaContentProtectionErrorCode>;
850
848
  //#endregion
851
849
  //#region src/SvtaCustomErrorCode.d.ts
852
850
  /**
853
- * SVTA 99 [Custom] 000: Unknown custom error
854
- *
855
- * @public
856
- */
857
- declare const SVTA_CUSTOM_UNKNOWN: 99000;
858
- /**
859
- * SVTA standardized error code in the Custom category (99xxx): the
860
- * category reserved for Publisher-defined errors. Codes 99001 through
861
- * 99999 are available for bespoke Publisher use.
862
- *
863
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
864
- *
865
- * @enum
866
- *
867
- * @public
868
- */
869
- declare const SvtaCustomErrorCode: {
870
- /**
871
- * Unknown custom error
872
- */
851
+ * SVTA 99 [Custom] 000: Unknown custom error
852
+ *
853
+ * @public
854
+ */
855
+ export declare const SVTA_CUSTOM_UNKNOWN: 99000;
856
+ /**
857
+ * SVTA standardized error code in the Custom category (99xxx): the
858
+ * category reserved for Publisher-defined errors. Codes 99001 through
859
+ * 99999 are available for bespoke Publisher use.
860
+ *
861
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
862
+ *
863
+ * @enum
864
+ *
865
+ * @public
866
+ */
867
+ export declare const SvtaCustomErrorCode: {
868
+ /**
869
+ * Unknown custom error
870
+ */
873
871
  readonly UNKNOWN: typeof SVTA_CUSTOM_UNKNOWN;
874
872
  };
875
873
  /**
876
- * Union type of all {@link (SvtaCustomErrorCode:variable)} values.
877
- *
878
- * @public
879
- */
880
- type SvtaCustomErrorCode = ValueOf<typeof SvtaCustomErrorCode>;
874
+ * Union type of all {@link (SvtaCustomErrorCode:variable)} values.
875
+ *
876
+ * @public
877
+ */
878
+ export type SvtaCustomErrorCode = ValueOf<typeof SvtaCustomErrorCode>;
881
879
  //#endregion
882
880
  //#region src/SvtaMediaContentErrorCode.d.ts
883
881
  /**
884
- * SVTA 1 [Media Content] 000: Unknown media content error
885
- *
886
- * @public
887
- */
888
- declare const SVTA_MEDIA_CONTENT_UNKNOWN: 1000;
889
- /**
890
- * SVTA 1 [Media Content] 001: Media unavailable
891
- *
892
- * @public
893
- */
894
- declare const SVTA_MEDIA_UNAVAILABLE: 1001;
895
- /**
896
- * SVTA 1 [Media Content] 002: Invalid manifest
897
- *
898
- * @public
899
- */
900
- declare const SVTA_INVALID_MANIFEST: 1002;
901
- /**
902
- * SVTA 1 [Media Content] 003: Track not available
903
- *
904
- * @public
905
- */
906
- declare const SVTA_TRACK_NOT_AVAILABLE: 1003;
907
- /**
908
- * SVTA 1 [Media Content] 004: Unsupported video format
909
- *
910
- * @public
911
- */
912
- declare const SVTA_UNSUPPORTED_VIDEO_FORMAT: 1004;
913
- /**
914
- * SVTA 1 [Media Content] 005: Unsupported audio format
915
- *
916
- * @public
917
- */
918
- declare const SVTA_UNSUPPORTED_AUDIO_FORMAT: 1005;
919
- /**
920
- * SVTA 1 [Media Content] 006: Unsupported text format
921
- *
922
- * @public
923
- */
924
- declare const SVTA_UNSUPPORTED_TEXT_FORMAT: 1006;
925
- /**
926
- * SVTA 1 [Media Content] 007: Invalid composition track segment time
927
- *
928
- * @public
929
- */
930
- declare const SVTA_INVALID_COMPOSITION_TRACK_SEGMENT_TIME: 1007;
931
- /**
932
- * SVTA 1 [Media Content] 008: Segment exceeds specified bitrate for track
933
- *
934
- * @public
935
- */
936
- declare const SVTA_SEGMENT_EXCEEDS_TRACK_BITRATE: 1008;
937
- /**
938
- * SVTA 1 [Media Content] 009: Misaligned track duration
939
- *
940
- * @public
941
- */
942
- declare const SVTA_MISALIGNED_TRACK_DURATION: 1009;
943
- /**
944
- * SVTA standardized error codes in the Media Content category (1xxx):
945
- * issues with the content itself.
946
- *
947
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
948
- *
949
- * @enum
950
- *
951
- * @public
952
- */
953
- declare const SvtaMediaContentErrorCode: {
954
- /**
955
- * Unknown media content error
956
- */
882
+ * SVTA 1 [Media Content] 000: Unknown media content error
883
+ *
884
+ * @public
885
+ */
886
+ export declare const SVTA_MEDIA_CONTENT_UNKNOWN: 1000;
887
+ /**
888
+ * SVTA 1 [Media Content] 001: Media unavailable
889
+ *
890
+ * @public
891
+ */
892
+ export declare const SVTA_MEDIA_UNAVAILABLE: 1001;
893
+ /**
894
+ * SVTA 1 [Media Content] 002: Invalid manifest
895
+ *
896
+ * @public
897
+ */
898
+ export declare const SVTA_INVALID_MANIFEST: 1002;
899
+ /**
900
+ * SVTA 1 [Media Content] 003: Track not available
901
+ *
902
+ * @public
903
+ */
904
+ export declare const SVTA_TRACK_NOT_AVAILABLE: 1003;
905
+ /**
906
+ * SVTA 1 [Media Content] 004: Unsupported video format
907
+ *
908
+ * @public
909
+ */
910
+ export declare const SVTA_UNSUPPORTED_VIDEO_FORMAT: 1004;
911
+ /**
912
+ * SVTA 1 [Media Content] 005: Unsupported audio format
913
+ *
914
+ * @public
915
+ */
916
+ export declare const SVTA_UNSUPPORTED_AUDIO_FORMAT: 1005;
917
+ /**
918
+ * SVTA 1 [Media Content] 006: Unsupported text format
919
+ *
920
+ * @public
921
+ */
922
+ export declare const SVTA_UNSUPPORTED_TEXT_FORMAT: 1006;
923
+ /**
924
+ * SVTA 1 [Media Content] 007: Invalid composition track segment time
925
+ *
926
+ * @public
927
+ */
928
+ export declare const SVTA_INVALID_COMPOSITION_TRACK_SEGMENT_TIME: 1007;
929
+ /**
930
+ * SVTA 1 [Media Content] 008: Segment exceeds specified bitrate for track
931
+ *
932
+ * @public
933
+ */
934
+ export declare const SVTA_SEGMENT_EXCEEDS_TRACK_BITRATE: 1008;
935
+ /**
936
+ * SVTA 1 [Media Content] 009: Misaligned track duration
937
+ *
938
+ * @public
939
+ */
940
+ export declare const SVTA_MISALIGNED_TRACK_DURATION: 1009;
941
+ /**
942
+ * SVTA standardized error codes in the Media Content category (1xxx):
943
+ * issues with the content itself.
944
+ *
945
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
946
+ *
947
+ * @enum
948
+ *
949
+ * @public
950
+ */
951
+ export declare const SvtaMediaContentErrorCode: {
952
+ /**
953
+ * Unknown media content error
954
+ */
957
955
  readonly UNKNOWN: typeof SVTA_MEDIA_CONTENT_UNKNOWN;
958
956
  /**
959
- * Media unavailable
960
- */
957
+ * Media unavailable
958
+ */
961
959
  readonly MEDIA_UNAVAILABLE: typeof SVTA_MEDIA_UNAVAILABLE;
962
960
  /**
963
- * Invalid manifest
964
- */
961
+ * Invalid manifest
962
+ */
965
963
  readonly INVALID_MANIFEST: typeof SVTA_INVALID_MANIFEST;
966
964
  /**
967
- * Track not available
968
- */
965
+ * Track not available
966
+ */
969
967
  readonly TRACK_NOT_AVAILABLE: typeof SVTA_TRACK_NOT_AVAILABLE;
970
968
  /**
971
- * Unsupported video format
972
- */
969
+ * Unsupported video format
970
+ */
973
971
  readonly UNSUPPORTED_VIDEO_FORMAT: typeof SVTA_UNSUPPORTED_VIDEO_FORMAT;
974
972
  /**
975
- * Unsupported audio format
976
- */
973
+ * Unsupported audio format
974
+ */
977
975
  readonly UNSUPPORTED_AUDIO_FORMAT: typeof SVTA_UNSUPPORTED_AUDIO_FORMAT;
978
976
  /**
979
- * Unsupported text format
980
- */
977
+ * Unsupported text format
978
+ */
981
979
  readonly UNSUPPORTED_TEXT_FORMAT: typeof SVTA_UNSUPPORTED_TEXT_FORMAT;
982
980
  /**
983
- * Invalid composition track segment time
984
- */
981
+ * Invalid composition track segment time
982
+ */
985
983
  readonly INVALID_COMPOSITION_TRACK_SEGMENT_TIME: typeof SVTA_INVALID_COMPOSITION_TRACK_SEGMENT_TIME;
986
984
  /**
987
- * Segment exceeds specified bitrate for track
988
- */
985
+ * Segment exceeds specified bitrate for track
986
+ */
989
987
  readonly SEGMENT_EXCEEDS_TRACK_BITRATE: typeof SVTA_SEGMENT_EXCEEDS_TRACK_BITRATE;
990
988
  /**
991
- * Misaligned track duration
992
- */
989
+ * Misaligned track duration
990
+ */
993
991
  readonly MISALIGNED_TRACK_DURATION: typeof SVTA_MISALIGNED_TRACK_DURATION;
994
992
  };
995
993
  /**
996
- * Union type of all {@link (SvtaMediaContentErrorCode:variable)} values.
997
- *
998
- * @public
999
- */
1000
- type SvtaMediaContentErrorCode = ValueOf<typeof SvtaMediaContentErrorCode>;
994
+ * Union type of all {@link (SvtaMediaContentErrorCode:variable)} values.
995
+ *
996
+ * @public
997
+ */
998
+ export type SvtaMediaContentErrorCode = ValueOf<typeof SvtaMediaContentErrorCode>;
1001
999
  //#endregion
1002
1000
  //#region src/SvtaNetworkErrorCode.d.ts
1003
1001
  /**
1004
- * SVTA 3 [Network] 000: Unknown network error
1005
- *
1006
- * @public
1007
- */
1008
- declare const SVTA_NETWORK_UNKNOWN: 3000;
1009
- /**
1010
- * SVTA 3 [Network] 001: No network connection
1011
- *
1012
- * @public
1013
- */
1014
- declare const SVTA_NO_NETWORK_CONNECTION: 3001;
1015
- /**
1016
- * SVTA 3 [Network] 002: HTTP timeout
1017
- *
1018
- * @public
1019
- */
1020
- declare const SVTA_HTTP_TIMEOUT: 3002;
1021
- /**
1022
- * SVTA 3 [Network] 003: Unable to resolve host
1023
- *
1024
- * @public
1025
- */
1026
- declare const SVTA_HOST_RESOLUTION_ERROR: 3003;
1027
- /**
1028
- * SVTA 3 [Network] 004: Resource not found
1029
- *
1030
- * @public
1031
- */
1032
- declare const SVTA_RESOURCE_NOT_FOUND: 3004;
1033
- /**
1034
- * SVTA 3 [Network] 005: Invalid URI
1035
- *
1036
- * @public
1037
- */
1038
- declare const SVTA_INVALID_URI: 3005;
1039
- /**
1040
- * SVTA 3 [Network] 006: Unsupported URI scheme
1041
- *
1042
- * @public
1043
- */
1044
- declare const SVTA_UNSUPPORTED_URI_SCHEME: 3006;
1045
- /**
1046
- * SVTA 3 [Network] 007: Download error
1047
- *
1048
- * @public
1049
- */
1050
- declare const SVTA_DOWNLOAD_ERROR: 3007;
1051
- /**
1052
- * SVTA 3 [Network] 008: Max retries have been exceeded
1053
- *
1054
- * @public
1055
- */
1056
- declare const SVTA_MAX_RETRIES_EXCEEDED: 3008;
1057
- /**
1058
- * SVTA 3 [Network] 009: Insufficient bandwidth to support playback of current presentation
1059
- *
1060
- * @public
1061
- */
1062
- declare const SVTA_INSUFFICIENT_BANDWIDTH: 3009;
1063
- /**
1064
- * SVTA 3 [Network] 010: Resource denied
1065
- *
1066
- * @public
1067
- */
1068
- declare const SVTA_RESOURCE_DENIED: 3010;
1069
- /**
1070
- * SVTA 3 [Network] 011: Invalid HTTP content type value
1071
- *
1072
- * @public
1073
- */
1074
- declare const SVTA_INVALID_HTTP_CONTENT_TYPE: 3011;
1075
- /**
1076
- * SVTA standardized error codes in the Network category (3xxx): issues
1077
- * on the network, including unavailable resources.
1078
- *
1079
- * HTTP response status codes embed into this category at indices 100
1080
- * through 599. `3404` is an HTTP 404 response. See
1081
- * `httpStatusToSvtaErrorCode`.
1082
- *
1083
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1084
- *
1085
- * @enum
1086
- *
1087
- * @public
1088
- */
1089
- declare const SvtaNetworkErrorCode: {
1090
- /**
1091
- * Unknown network error
1092
- */
1002
+ * SVTA 3 [Network] 000: Unknown network error
1003
+ *
1004
+ * @public
1005
+ */
1006
+ export declare const SVTA_NETWORK_UNKNOWN: 3000;
1007
+ /**
1008
+ * SVTA 3 [Network] 001: No network connection
1009
+ *
1010
+ * @public
1011
+ */
1012
+ export declare const SVTA_NO_NETWORK_CONNECTION: 3001;
1013
+ /**
1014
+ * SVTA 3 [Network] 002: HTTP timeout
1015
+ *
1016
+ * @public
1017
+ */
1018
+ export declare const SVTA_HTTP_TIMEOUT: 3002;
1019
+ /**
1020
+ * SVTA 3 [Network] 003: Unable to resolve host
1021
+ *
1022
+ * @public
1023
+ */
1024
+ export declare const SVTA_HOST_RESOLUTION_ERROR: 3003;
1025
+ /**
1026
+ * SVTA 3 [Network] 004: Resource not found
1027
+ *
1028
+ * @public
1029
+ */
1030
+ export declare const SVTA_RESOURCE_NOT_FOUND: 3004;
1031
+ /**
1032
+ * SVTA 3 [Network] 005: Invalid URI
1033
+ *
1034
+ * @public
1035
+ */
1036
+ export declare const SVTA_INVALID_URI: 3005;
1037
+ /**
1038
+ * SVTA 3 [Network] 006: Unsupported URI scheme
1039
+ *
1040
+ * @public
1041
+ */
1042
+ export declare const SVTA_UNSUPPORTED_URI_SCHEME: 3006;
1043
+ /**
1044
+ * SVTA 3 [Network] 007: Download error
1045
+ *
1046
+ * @public
1047
+ */
1048
+ export declare const SVTA_DOWNLOAD_ERROR: 3007;
1049
+ /**
1050
+ * SVTA 3 [Network] 008: Max retries have been exceeded
1051
+ *
1052
+ * @public
1053
+ */
1054
+ export declare const SVTA_MAX_RETRIES_EXCEEDED: 3008;
1055
+ /**
1056
+ * SVTA 3 [Network] 009: Insufficient bandwidth to support playback of current presentation
1057
+ *
1058
+ * @public
1059
+ */
1060
+ export declare const SVTA_INSUFFICIENT_BANDWIDTH: 3009;
1061
+ /**
1062
+ * SVTA 3 [Network] 010: Resource denied
1063
+ *
1064
+ * @public
1065
+ */
1066
+ export declare const SVTA_RESOURCE_DENIED: 3010;
1067
+ /**
1068
+ * SVTA 3 [Network] 011: Invalid HTTP content type value
1069
+ *
1070
+ * @public
1071
+ */
1072
+ export declare const SVTA_INVALID_HTTP_CONTENT_TYPE: 3011;
1073
+ /**
1074
+ * SVTA standardized error codes in the Network category (3xxx): issues
1075
+ * on the network, including unavailable resources.
1076
+ *
1077
+ * HTTP response status codes embed into this category at indices 100
1078
+ * through 599. `3404` is an HTTP 404 response. See
1079
+ * `httpStatusToSvtaErrorCode`.
1080
+ *
1081
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1082
+ *
1083
+ * @enum
1084
+ *
1085
+ * @public
1086
+ */
1087
+ export declare const SvtaNetworkErrorCode: {
1088
+ /**
1089
+ * Unknown network error
1090
+ */
1093
1091
  readonly UNKNOWN: typeof SVTA_NETWORK_UNKNOWN;
1094
1092
  /**
1095
- * No network connection
1096
- */
1093
+ * No network connection
1094
+ */
1097
1095
  readonly NO_NETWORK_CONNECTION: typeof SVTA_NO_NETWORK_CONNECTION;
1098
1096
  /**
1099
- * HTTP timeout
1100
- */
1097
+ * HTTP timeout
1098
+ */
1101
1099
  readonly HTTP_TIMEOUT: typeof SVTA_HTTP_TIMEOUT;
1102
1100
  /**
1103
- * Unable to resolve host
1104
- */
1101
+ * Unable to resolve host
1102
+ */
1105
1103
  readonly HOST_RESOLUTION_ERROR: typeof SVTA_HOST_RESOLUTION_ERROR;
1106
1104
  /**
1107
- * Resource not found
1108
- */
1105
+ * Resource not found
1106
+ */
1109
1107
  readonly RESOURCE_NOT_FOUND: typeof SVTA_RESOURCE_NOT_FOUND;
1110
1108
  /**
1111
- * Invalid URI
1112
- */
1109
+ * Invalid URI
1110
+ */
1113
1111
  readonly INVALID_URI: typeof SVTA_INVALID_URI;
1114
1112
  /**
1115
- * Unsupported URI scheme
1116
- */
1113
+ * Unsupported URI scheme
1114
+ */
1117
1115
  readonly UNSUPPORTED_URI_SCHEME: typeof SVTA_UNSUPPORTED_URI_SCHEME;
1118
1116
  /**
1119
- * Download error
1120
- */
1117
+ * Download error
1118
+ */
1121
1119
  readonly DOWNLOAD_ERROR: typeof SVTA_DOWNLOAD_ERROR;
1122
1120
  /**
1123
- * Max retries have been exceeded
1124
- */
1121
+ * Max retries have been exceeded
1122
+ */
1125
1123
  readonly MAX_RETRIES_EXCEEDED: typeof SVTA_MAX_RETRIES_EXCEEDED;
1126
1124
  /**
1127
- * Insufficient bandwidth to support playback of current presentation
1128
- */
1125
+ * Insufficient bandwidth to support playback of current presentation
1126
+ */
1129
1127
  readonly INSUFFICIENT_BANDWIDTH: typeof SVTA_INSUFFICIENT_BANDWIDTH;
1130
1128
  /**
1131
- * Resource denied
1132
- */
1129
+ * Resource denied
1130
+ */
1133
1131
  readonly RESOURCE_DENIED: typeof SVTA_RESOURCE_DENIED;
1134
1132
  /**
1135
- * Invalid HTTP content type value
1136
- */
1133
+ * Invalid HTTP content type value
1134
+ */
1137
1135
  readonly INVALID_HTTP_CONTENT_TYPE: typeof SVTA_INVALID_HTTP_CONTENT_TYPE;
1138
1136
  };
1139
1137
  /**
1140
- * Union type of all {@link (SvtaNetworkErrorCode:variable)} values.
1141
- *
1142
- * @public
1143
- */
1144
- type SvtaNetworkErrorCode = ValueOf<typeof SvtaNetworkErrorCode>;
1138
+ * Union type of all {@link (SvtaNetworkErrorCode:variable)} values.
1139
+ *
1140
+ * @public
1141
+ */
1142
+ export type SvtaNetworkErrorCode = ValueOf<typeof SvtaNetworkErrorCode>;
1145
1143
  //#endregion
1146
1144
  //#region src/SvtaPlaybackErrorCode.d.ts
1147
1145
  /**
1148
- * SVTA 2 [Playback] 000: Unknown playback error
1149
- *
1150
- * @public
1151
- */
1152
- declare const SVTA_PLAYBACK_UNKNOWN: 2000;
1153
- /**
1154
- * SVTA 2 [Playback] 001: Video buffer underrun
1155
- *
1156
- * @public
1157
- */
1158
- declare const SVTA_VIDEO_BUFFER_UNDERRUN: 2001;
1159
- /**
1160
- * SVTA 2 [Playback] 002: Audio buffer underrun
1161
- *
1162
- * @public
1163
- */
1164
- declare const SVTA_AUDIO_BUFFER_UNDERRUN: 2002;
1165
- /**
1166
- * SVTA 2 [Playback] 003: Video buffering timeout
1167
- *
1168
- * @public
1169
- */
1170
- declare const SVTA_VIDEO_BUFFERING_TIMEOUT: 2003;
1171
- /**
1172
- * SVTA 2 [Playback] 004: Audio buffering timeout
1173
- *
1174
- * @public
1175
- */
1176
- declare const SVTA_AUDIO_BUFFERING_TIMEOUT: 2004;
1177
- /**
1178
- * SVTA 2 [Playback] 005: Unable to parse manifest
1179
- *
1180
- * @public
1181
- */
1182
- declare const SVTA_MANIFEST_PARSE_ERROR: 2005;
1183
- /**
1184
- * SVTA 2 [Playback] 006: Segment parse error
1185
- *
1186
- * @public
1187
- */
1188
- declare const SVTA_SEGMENT_PARSE_ERROR: 2006;
1189
- /**
1190
- * SVTA 2 [Playback] 007: Unable to decode video
1191
- *
1192
- * @public
1193
- */
1194
- declare const SVTA_VIDEO_DECODE_ERROR: 2007;
1195
- /**
1196
- * SVTA 2 [Playback] 008: Unable to decode audio
1197
- *
1198
- * @public
1199
- */
1200
- declare const SVTA_AUDIO_DECODE_ERROR: 2008;
1201
- /**
1202
- * SVTA 2 [Playback] 009: Video dropped frame count exceeds threshold
1203
- *
1204
- * @public
1205
- */
1206
- declare const SVTA_VIDEO_DROPPED_FRAMES_EXCEEDED: 2009;
1207
- /**
1208
- * SVTA 2 [Playback] 010: Playhead exceeds content duration
1209
- *
1210
- * @public
1211
- */
1212
- declare const SVTA_PLAYHEAD_EXCEEDS_CONTENT_DURATION: 2010;
1213
- /**
1214
- * SVTA 2 [Playback] 011: No supported video track
1215
- *
1216
- * @public
1217
- */
1218
- declare const SVTA_NO_SUPPORTED_VIDEO_TRACK: 2011;
1219
- /**
1220
- * SVTA 2 [Playback] 012: No supported audio track
1221
- *
1222
- * @public
1223
- */
1224
- declare const SVTA_NO_SUPPORTED_AUDIO_TRACK: 2012;
1225
- /**
1226
- * SVTA 2 [Playback] 013: No matching codec / profile / level
1227
- *
1228
- * @public
1229
- */
1230
- declare const SVTA_NO_MATCHING_CODEC: 2013;
1231
- /**
1232
- * SVTA 2 [Playback] 014: Primary manifest load error
1233
- *
1234
- * @public
1235
- */
1236
- declare const SVTA_PRIMARY_MANIFEST_LOAD_ERROR: 2014;
1237
- /**
1238
- * SVTA 2 [Playback] 015: Primary manifest load timeout
1239
- *
1240
- * @public
1241
- */
1242
- declare const SVTA_PRIMARY_MANIFEST_LOAD_TIMEOUT: 2015;
1243
- /**
1244
- * SVTA 2 [Playback] 016: Unable to parse track from manifest
1245
- *
1246
- * @public
1247
- */
1248
- declare const SVTA_MANIFEST_TRACK_PARSE_ERROR: 2016;
1249
- /**
1250
- * SVTA 2 [Playback] 017: Secondary manifest / asset list load error
1251
- *
1252
- * @public
1253
- */
1254
- declare const SVTA_SECONDARY_MANIFEST_LOAD_ERROR: 2017;
1255
- /**
1256
- * SVTA 2 [Playback] 018: Unable to parse secondary manifest / asset list
1257
- *
1258
- * @public
1259
- */
1260
- declare const SVTA_SECONDARY_MANIFEST_PARSE_ERROR: 2018;
1261
- /**
1262
- * SVTA 2 [Playback] 019: Unable to switch tracks
1263
- *
1264
- * @public
1265
- */
1266
- declare const SVTA_TRACK_SWITCH_ERROR: 2019;
1267
- /**
1268
- * SVTA 2 [Playback] 020: Track load error
1269
- *
1270
- * @public
1271
- */
1272
- declare const SVTA_TRACK_LOAD_ERROR: 2020;
1273
- /**
1274
- * SVTA 2 [Playback] 021: Remux issue
1275
- *
1276
- * @public
1277
- */
1278
- declare const SVTA_REMUX_ERROR: 2021;
1279
- /**
1280
- * SVTA 2 [Playback] 022: Buffer initialization error
1281
- *
1282
- * @public
1283
- */
1284
- declare const SVTA_BUFFER_INITIALIZATION_ERROR: 2022;
1285
- /**
1286
- * SVTA 2 [Playback] 023: Buffer append error
1287
- *
1288
- * @public
1289
- */
1290
- declare const SVTA_BUFFER_APPEND_ERROR: 2023;
1291
- /**
1292
- * SVTA 2 [Playback] 024: Buffer remove error
1293
- *
1294
- * @public
1295
- */
1296
- declare const SVTA_BUFFER_REMOVE_ERROR: 2024;
1297
- /**
1298
- * SVTA 2 [Playback] 025: Buffer full error
1299
- *
1300
- * @public
1301
- */
1302
- declare const SVTA_BUFFER_FULL_ERROR: 2025;
1303
- /**
1304
- * SVTA 2 [Playback] 026: Buffer seek over hole
1305
- *
1306
- * @public
1307
- */
1308
- declare const SVTA_BUFFER_SEEK_OVER_HOLE: 2026;
1309
- /**
1310
- * SVTA 2 [Playback] 027: Buffer nudge on stall
1311
- *
1312
- * @public
1313
- */
1314
- declare const SVTA_BUFFER_NUDGE_ON_STALL: 2027;
1315
- /**
1316
- * SVTA 2 [Playback] 028: Out of memory
1317
- *
1318
- * @public
1319
- */
1320
- declare const SVTA_OUT_OF_MEMORY: 2028;
1321
- /**
1322
- * SVTA 2 [Playback] 029: Segment load error
1323
- *
1324
- * @public
1325
- */
1326
- declare const SVTA_SEGMENT_LOAD_ERROR: 2029;
1327
- /**
1328
- * SVTA 2 [Playback] 030: Segment timeout error
1329
- *
1330
- * @public
1331
- */
1332
- declare const SVTA_SEGMENT_TIMEOUT_ERROR: 2030;
1333
- /**
1334
- * SVTA 2 [Playback] 031: Initialization segment error
1335
- *
1336
- * @public
1337
- */
1338
- declare const SVTA_INITIALIZATION_SEGMENT_ERROR: 2031;
1339
- /**
1340
- * SVTA 2 [Playback] 032: Time sync failed error
1341
- *
1342
- * @public
1343
- */
1344
- declare const SVTA_TIME_SYNC_ERROR: 2032;
1345
- /**
1346
- * SVTA 2 [Playback] 033: Fragment load error
1347
- *
1348
- * @public
1349
- */
1350
- declare const SVTA_FRAGMENT_LOAD_ERROR: 2033;
1351
- /**
1352
- * SVTA 2 [Playback] 034: Fragment timeout error
1353
- *
1354
- * @public
1355
- */
1356
- declare const SVTA_FRAGMENT_TIMEOUT_ERROR: 2034;
1357
- /**
1358
- * SVTA 2 [Playback] 035: Live timeshifting content out of bounds
1359
- *
1360
- * @public
1361
- */
1362
- declare const SVTA_LIVE_TIMESHIFT_OUT_OF_BOUNDS: 2035;
1363
- /**
1364
- * SVTA 2 [Playback] 036: Switched to higher latency
1365
- *
1366
- * @public
1367
- */
1368
- declare const SVTA_SWITCHED_TO_HIGHER_LATENCY: 2036;
1369
- /**
1370
- * SVTA 2 [Playback] 037: Unable to switch to fullscreen
1371
- *
1372
- * @public
1373
- */
1374
- declare const SVTA_FULLSCREEN_ERROR: 2037;
1375
- /**
1376
- * SVTA 2 [Playback] 038: Unable to present picture-in-picture
1377
- *
1378
- * @public
1379
- */
1380
- declare const SVTA_PICTURE_IN_PICTURE_ERROR: 2038;
1381
- /**
1382
- * SVTA 2 [Playback] 039: Manifest feature unsupported
1383
- *
1384
- * @public
1385
- */
1386
- declare const SVTA_MANIFEST_FEATURE_UNSUPPORTED: 2039;
1387
- /**
1388
- * SVTA 2 [Playback] 040: Content steering manifest load error
1389
- *
1390
- * @public
1391
- */
1392
- declare const SVTA_CONTENT_STEERING_MANIFEST_LOAD_ERROR: 2040;
1393
- /**
1394
- * SVTA 2 [Playback] 041: Unable to parse content steering manifest
1395
- *
1396
- * @public
1397
- */
1398
- declare const SVTA_CONTENT_STEERING_MANIFEST_PARSE_ERROR: 2041;
1399
- /**
1400
- * SVTA standardized error codes in the Playback category (2xxx): the
1401
- * player is unable to sustain the playback experience.
1402
- *
1403
- * When signalling a buffer event for a track the player cannot identify,
1404
- * the spec designates `VIDEO_BUFFER_UNDERRUN` (2001) as the default.
1405
- *
1406
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1407
- *
1408
- * @enum
1409
- *
1410
- * @public
1411
- */
1412
- declare const SvtaPlaybackErrorCode: {
1413
- /**
1414
- * Unknown playback error
1415
- */
1146
+ * SVTA 2 [Playback] 000: Unknown playback error
1147
+ *
1148
+ * @public
1149
+ */
1150
+ export declare const SVTA_PLAYBACK_UNKNOWN: 2000;
1151
+ /**
1152
+ * SVTA 2 [Playback] 001: Video buffer underrun
1153
+ *
1154
+ * @public
1155
+ */
1156
+ export declare const SVTA_VIDEO_BUFFER_UNDERRUN: 2001;
1157
+ /**
1158
+ * SVTA 2 [Playback] 002: Audio buffer underrun
1159
+ *
1160
+ * @public
1161
+ */
1162
+ export declare const SVTA_AUDIO_BUFFER_UNDERRUN: 2002;
1163
+ /**
1164
+ * SVTA 2 [Playback] 003: Video buffering timeout
1165
+ *
1166
+ * @public
1167
+ */
1168
+ export declare const SVTA_VIDEO_BUFFERING_TIMEOUT: 2003;
1169
+ /**
1170
+ * SVTA 2 [Playback] 004: Audio buffering timeout
1171
+ *
1172
+ * @public
1173
+ */
1174
+ export declare const SVTA_AUDIO_BUFFERING_TIMEOUT: 2004;
1175
+ /**
1176
+ * SVTA 2 [Playback] 005: Unable to parse manifest
1177
+ *
1178
+ * @public
1179
+ */
1180
+ export declare const SVTA_MANIFEST_PARSE_ERROR: 2005;
1181
+ /**
1182
+ * SVTA 2 [Playback] 006: Segment parse error
1183
+ *
1184
+ * @public
1185
+ */
1186
+ export declare const SVTA_SEGMENT_PARSE_ERROR: 2006;
1187
+ /**
1188
+ * SVTA 2 [Playback] 007: Unable to decode video
1189
+ *
1190
+ * @public
1191
+ */
1192
+ export declare const SVTA_VIDEO_DECODE_ERROR: 2007;
1193
+ /**
1194
+ * SVTA 2 [Playback] 008: Unable to decode audio
1195
+ *
1196
+ * @public
1197
+ */
1198
+ export declare const SVTA_AUDIO_DECODE_ERROR: 2008;
1199
+ /**
1200
+ * SVTA 2 [Playback] 009: Video dropped frame count exceeds threshold
1201
+ *
1202
+ * @public
1203
+ */
1204
+ export declare const SVTA_VIDEO_DROPPED_FRAMES_EXCEEDED: 2009;
1205
+ /**
1206
+ * SVTA 2 [Playback] 010: Playhead exceeds content duration
1207
+ *
1208
+ * @public
1209
+ */
1210
+ export declare const SVTA_PLAYHEAD_EXCEEDS_CONTENT_DURATION: 2010;
1211
+ /**
1212
+ * SVTA 2 [Playback] 011: No supported video track
1213
+ *
1214
+ * @public
1215
+ */
1216
+ export declare const SVTA_NO_SUPPORTED_VIDEO_TRACK: 2011;
1217
+ /**
1218
+ * SVTA 2 [Playback] 012: No supported audio track
1219
+ *
1220
+ * @public
1221
+ */
1222
+ export declare const SVTA_NO_SUPPORTED_AUDIO_TRACK: 2012;
1223
+ /**
1224
+ * SVTA 2 [Playback] 013: No matching codec / profile / level
1225
+ *
1226
+ * @public
1227
+ */
1228
+ export declare const SVTA_NO_MATCHING_CODEC: 2013;
1229
+ /**
1230
+ * SVTA 2 [Playback] 014: Primary manifest load error
1231
+ *
1232
+ * @public
1233
+ */
1234
+ export declare const SVTA_PRIMARY_MANIFEST_LOAD_ERROR: 2014;
1235
+ /**
1236
+ * SVTA 2 [Playback] 015: Primary manifest load timeout
1237
+ *
1238
+ * @public
1239
+ */
1240
+ export declare const SVTA_PRIMARY_MANIFEST_LOAD_TIMEOUT: 2015;
1241
+ /**
1242
+ * SVTA 2 [Playback] 016: Unable to parse track from manifest
1243
+ *
1244
+ * @public
1245
+ */
1246
+ export declare const SVTA_MANIFEST_TRACK_PARSE_ERROR: 2016;
1247
+ /**
1248
+ * SVTA 2 [Playback] 017: Secondary manifest / asset list load error
1249
+ *
1250
+ * @public
1251
+ */
1252
+ export declare const SVTA_SECONDARY_MANIFEST_LOAD_ERROR: 2017;
1253
+ /**
1254
+ * SVTA 2 [Playback] 018: Unable to parse secondary manifest / asset list
1255
+ *
1256
+ * @public
1257
+ */
1258
+ export declare const SVTA_SECONDARY_MANIFEST_PARSE_ERROR: 2018;
1259
+ /**
1260
+ * SVTA 2 [Playback] 019: Unable to switch tracks
1261
+ *
1262
+ * @public
1263
+ */
1264
+ export declare const SVTA_TRACK_SWITCH_ERROR: 2019;
1265
+ /**
1266
+ * SVTA 2 [Playback] 020: Track load error
1267
+ *
1268
+ * @public
1269
+ */
1270
+ export declare const SVTA_TRACK_LOAD_ERROR: 2020;
1271
+ /**
1272
+ * SVTA 2 [Playback] 021: Remux issue
1273
+ *
1274
+ * @public
1275
+ */
1276
+ export declare const SVTA_REMUX_ERROR: 2021;
1277
+ /**
1278
+ * SVTA 2 [Playback] 022: Buffer initialization error
1279
+ *
1280
+ * @public
1281
+ */
1282
+ export declare const SVTA_BUFFER_INITIALIZATION_ERROR: 2022;
1283
+ /**
1284
+ * SVTA 2 [Playback] 023: Buffer append error
1285
+ *
1286
+ * @public
1287
+ */
1288
+ export declare const SVTA_BUFFER_APPEND_ERROR: 2023;
1289
+ /**
1290
+ * SVTA 2 [Playback] 024: Buffer remove error
1291
+ *
1292
+ * @public
1293
+ */
1294
+ export declare const SVTA_BUFFER_REMOVE_ERROR: 2024;
1295
+ /**
1296
+ * SVTA 2 [Playback] 025: Buffer full error
1297
+ *
1298
+ * @public
1299
+ */
1300
+ export declare const SVTA_BUFFER_FULL_ERROR: 2025;
1301
+ /**
1302
+ * SVTA 2 [Playback] 026: Buffer seek over hole
1303
+ *
1304
+ * @public
1305
+ */
1306
+ export declare const SVTA_BUFFER_SEEK_OVER_HOLE: 2026;
1307
+ /**
1308
+ * SVTA 2 [Playback] 027: Buffer nudge on stall
1309
+ *
1310
+ * @public
1311
+ */
1312
+ export declare const SVTA_BUFFER_NUDGE_ON_STALL: 2027;
1313
+ /**
1314
+ * SVTA 2 [Playback] 028: Out of memory
1315
+ *
1316
+ * @public
1317
+ */
1318
+ export declare const SVTA_OUT_OF_MEMORY: 2028;
1319
+ /**
1320
+ * SVTA 2 [Playback] 029: Segment load error
1321
+ *
1322
+ * @public
1323
+ */
1324
+ export declare const SVTA_SEGMENT_LOAD_ERROR: 2029;
1325
+ /**
1326
+ * SVTA 2 [Playback] 030: Segment timeout error
1327
+ *
1328
+ * @public
1329
+ */
1330
+ export declare const SVTA_SEGMENT_TIMEOUT_ERROR: 2030;
1331
+ /**
1332
+ * SVTA 2 [Playback] 031: Initialization segment error
1333
+ *
1334
+ * @public
1335
+ */
1336
+ export declare const SVTA_INITIALIZATION_SEGMENT_ERROR: 2031;
1337
+ /**
1338
+ * SVTA 2 [Playback] 032: Time sync failed error
1339
+ *
1340
+ * @public
1341
+ */
1342
+ export declare const SVTA_TIME_SYNC_ERROR: 2032;
1343
+ /**
1344
+ * SVTA 2 [Playback] 033: Fragment load error
1345
+ *
1346
+ * @public
1347
+ */
1348
+ export declare const SVTA_FRAGMENT_LOAD_ERROR: 2033;
1349
+ /**
1350
+ * SVTA 2 [Playback] 034: Fragment timeout error
1351
+ *
1352
+ * @public
1353
+ */
1354
+ export declare const SVTA_FRAGMENT_TIMEOUT_ERROR: 2034;
1355
+ /**
1356
+ * SVTA 2 [Playback] 035: Live timeshifting content out of bounds
1357
+ *
1358
+ * @public
1359
+ */
1360
+ export declare const SVTA_LIVE_TIMESHIFT_OUT_OF_BOUNDS: 2035;
1361
+ /**
1362
+ * SVTA 2 [Playback] 036: Switched to higher latency
1363
+ *
1364
+ * @public
1365
+ */
1366
+ export declare const SVTA_SWITCHED_TO_HIGHER_LATENCY: 2036;
1367
+ /**
1368
+ * SVTA 2 [Playback] 037: Unable to switch to fullscreen
1369
+ *
1370
+ * @public
1371
+ */
1372
+ export declare const SVTA_FULLSCREEN_ERROR: 2037;
1373
+ /**
1374
+ * SVTA 2 [Playback] 038: Unable to present picture-in-picture
1375
+ *
1376
+ * @public
1377
+ */
1378
+ export declare const SVTA_PICTURE_IN_PICTURE_ERROR: 2038;
1379
+ /**
1380
+ * SVTA 2 [Playback] 039: Manifest feature unsupported
1381
+ *
1382
+ * @public
1383
+ */
1384
+ export declare const SVTA_MANIFEST_FEATURE_UNSUPPORTED: 2039;
1385
+ /**
1386
+ * SVTA 2 [Playback] 040: Content steering manifest load error
1387
+ *
1388
+ * @public
1389
+ */
1390
+ export declare const SVTA_CONTENT_STEERING_MANIFEST_LOAD_ERROR: 2040;
1391
+ /**
1392
+ * SVTA 2 [Playback] 041: Unable to parse content steering manifest
1393
+ *
1394
+ * @public
1395
+ */
1396
+ export declare const SVTA_CONTENT_STEERING_MANIFEST_PARSE_ERROR: 2041;
1397
+ /**
1398
+ * SVTA standardized error codes in the Playback category (2xxx): the
1399
+ * player is unable to sustain the playback experience.
1400
+ *
1401
+ * When signalling a buffer event for a track the player cannot identify,
1402
+ * the spec designates `VIDEO_BUFFER_UNDERRUN` (2001) as the default.
1403
+ *
1404
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1405
+ *
1406
+ * @enum
1407
+ *
1408
+ * @public
1409
+ */
1410
+ export declare const SvtaPlaybackErrorCode: {
1411
+ /**
1412
+ * Unknown playback error
1413
+ */
1416
1414
  readonly UNKNOWN: typeof SVTA_PLAYBACK_UNKNOWN;
1417
1415
  /**
1418
- * Video buffer underrun
1419
- */
1416
+ * Video buffer underrun
1417
+ */
1420
1418
  readonly VIDEO_BUFFER_UNDERRUN: typeof SVTA_VIDEO_BUFFER_UNDERRUN;
1421
1419
  /**
1422
- * Audio buffer underrun
1423
- */
1420
+ * Audio buffer underrun
1421
+ */
1424
1422
  readonly AUDIO_BUFFER_UNDERRUN: typeof SVTA_AUDIO_BUFFER_UNDERRUN;
1425
1423
  /**
1426
- * Video buffering timeout
1427
- */
1424
+ * Video buffering timeout
1425
+ */
1428
1426
  readonly VIDEO_BUFFERING_TIMEOUT: typeof SVTA_VIDEO_BUFFERING_TIMEOUT;
1429
1427
  /**
1430
- * Audio buffering timeout
1431
- */
1428
+ * Audio buffering timeout
1429
+ */
1432
1430
  readonly AUDIO_BUFFERING_TIMEOUT: typeof SVTA_AUDIO_BUFFERING_TIMEOUT;
1433
1431
  /**
1434
- * Unable to parse manifest
1435
- */
1432
+ * Unable to parse manifest
1433
+ */
1436
1434
  readonly MANIFEST_PARSE_ERROR: typeof SVTA_MANIFEST_PARSE_ERROR;
1437
1435
  /**
1438
- * Segment parse error
1439
- */
1436
+ * Segment parse error
1437
+ */
1440
1438
  readonly SEGMENT_PARSE_ERROR: typeof SVTA_SEGMENT_PARSE_ERROR;
1441
1439
  /**
1442
- * Unable to decode video
1443
- */
1440
+ * Unable to decode video
1441
+ */
1444
1442
  readonly VIDEO_DECODE_ERROR: typeof SVTA_VIDEO_DECODE_ERROR;
1445
1443
  /**
1446
- * Unable to decode audio
1447
- */
1444
+ * Unable to decode audio
1445
+ */
1448
1446
  readonly AUDIO_DECODE_ERROR: typeof SVTA_AUDIO_DECODE_ERROR;
1449
1447
  /**
1450
- * Video dropped frame count exceeds threshold
1451
- */
1448
+ * Video dropped frame count exceeds threshold
1449
+ */
1452
1450
  readonly VIDEO_DROPPED_FRAMES_EXCEEDED: typeof SVTA_VIDEO_DROPPED_FRAMES_EXCEEDED;
1453
1451
  /**
1454
- * Playhead exceeds content duration
1455
- */
1452
+ * Playhead exceeds content duration
1453
+ */
1456
1454
  readonly PLAYHEAD_EXCEEDS_CONTENT_DURATION: typeof SVTA_PLAYHEAD_EXCEEDS_CONTENT_DURATION;
1457
1455
  /**
1458
- * No supported video track
1459
- */
1456
+ * No supported video track
1457
+ */
1460
1458
  readonly NO_SUPPORTED_VIDEO_TRACK: typeof SVTA_NO_SUPPORTED_VIDEO_TRACK;
1461
1459
  /**
1462
- * No supported audio track
1463
- */
1460
+ * No supported audio track
1461
+ */
1464
1462
  readonly NO_SUPPORTED_AUDIO_TRACK: typeof SVTA_NO_SUPPORTED_AUDIO_TRACK;
1465
1463
  /**
1466
- * No matching codec / profile / level
1467
- */
1464
+ * No matching codec / profile / level
1465
+ */
1468
1466
  readonly NO_MATCHING_CODEC: typeof SVTA_NO_MATCHING_CODEC;
1469
1467
  /**
1470
- * Primary manifest load error
1471
- */
1468
+ * Primary manifest load error
1469
+ */
1472
1470
  readonly PRIMARY_MANIFEST_LOAD_ERROR: typeof SVTA_PRIMARY_MANIFEST_LOAD_ERROR;
1473
1471
  /**
1474
- * Primary manifest load timeout
1475
- */
1472
+ * Primary manifest load timeout
1473
+ */
1476
1474
  readonly PRIMARY_MANIFEST_LOAD_TIMEOUT: typeof SVTA_PRIMARY_MANIFEST_LOAD_TIMEOUT;
1477
1475
  /**
1478
- * Unable to parse track from manifest
1479
- */
1476
+ * Unable to parse track from manifest
1477
+ */
1480
1478
  readonly MANIFEST_TRACK_PARSE_ERROR: typeof SVTA_MANIFEST_TRACK_PARSE_ERROR;
1481
1479
  /**
1482
- * Secondary manifest / asset list load error
1483
- */
1480
+ * Secondary manifest / asset list load error
1481
+ */
1484
1482
  readonly SECONDARY_MANIFEST_LOAD_ERROR: typeof SVTA_SECONDARY_MANIFEST_LOAD_ERROR;
1485
1483
  /**
1486
- * Unable to parse secondary manifest / asset list
1487
- */
1484
+ * Unable to parse secondary manifest / asset list
1485
+ */
1488
1486
  readonly SECONDARY_MANIFEST_PARSE_ERROR: typeof SVTA_SECONDARY_MANIFEST_PARSE_ERROR;
1489
1487
  /**
1490
- * Unable to switch tracks
1491
- */
1488
+ * Unable to switch tracks
1489
+ */
1492
1490
  readonly TRACK_SWITCH_ERROR: typeof SVTA_TRACK_SWITCH_ERROR;
1493
1491
  /**
1494
- * Track load error
1495
- */
1492
+ * Track load error
1493
+ */
1496
1494
  readonly TRACK_LOAD_ERROR: typeof SVTA_TRACK_LOAD_ERROR;
1497
1495
  /**
1498
- * Remux issue
1499
- */
1496
+ * Remux issue
1497
+ */
1500
1498
  readonly REMUX_ERROR: typeof SVTA_REMUX_ERROR;
1501
1499
  /**
1502
- * Buffer initialization error
1503
- */
1500
+ * Buffer initialization error
1501
+ */
1504
1502
  readonly BUFFER_INITIALIZATION_ERROR: typeof SVTA_BUFFER_INITIALIZATION_ERROR;
1505
1503
  /**
1506
- * Buffer append error
1507
- */
1504
+ * Buffer append error
1505
+ */
1508
1506
  readonly BUFFER_APPEND_ERROR: typeof SVTA_BUFFER_APPEND_ERROR;
1509
1507
  /**
1510
- * Buffer remove error
1511
- */
1508
+ * Buffer remove error
1509
+ */
1512
1510
  readonly BUFFER_REMOVE_ERROR: typeof SVTA_BUFFER_REMOVE_ERROR;
1513
1511
  /**
1514
- * Buffer full error
1515
- */
1512
+ * Buffer full error
1513
+ */
1516
1514
  readonly BUFFER_FULL_ERROR: typeof SVTA_BUFFER_FULL_ERROR;
1517
1515
  /**
1518
- * Buffer seek over hole
1519
- */
1516
+ * Buffer seek over hole
1517
+ */
1520
1518
  readonly BUFFER_SEEK_OVER_HOLE: typeof SVTA_BUFFER_SEEK_OVER_HOLE;
1521
1519
  /**
1522
- * Buffer nudge on stall
1523
- */
1520
+ * Buffer nudge on stall
1521
+ */
1524
1522
  readonly BUFFER_NUDGE_ON_STALL: typeof SVTA_BUFFER_NUDGE_ON_STALL;
1525
1523
  /**
1526
- * Out of memory
1527
- */
1524
+ * Out of memory
1525
+ */
1528
1526
  readonly OUT_OF_MEMORY: typeof SVTA_OUT_OF_MEMORY;
1529
1527
  /**
1530
- * Segment load error
1531
- */
1528
+ * Segment load error
1529
+ */
1532
1530
  readonly SEGMENT_LOAD_ERROR: typeof SVTA_SEGMENT_LOAD_ERROR;
1533
1531
  /**
1534
- * Segment timeout error
1535
- */
1532
+ * Segment timeout error
1533
+ */
1536
1534
  readonly SEGMENT_TIMEOUT_ERROR: typeof SVTA_SEGMENT_TIMEOUT_ERROR;
1537
1535
  /**
1538
- * Initialization segment error
1539
- */
1536
+ * Initialization segment error
1537
+ */
1540
1538
  readonly INITIALIZATION_SEGMENT_ERROR: typeof SVTA_INITIALIZATION_SEGMENT_ERROR;
1541
1539
  /**
1542
- * Time sync failed error
1543
- */
1540
+ * Time sync failed error
1541
+ */
1544
1542
  readonly TIME_SYNC_ERROR: typeof SVTA_TIME_SYNC_ERROR;
1545
1543
  /**
1546
- * Fragment load error
1547
- */
1544
+ * Fragment load error
1545
+ */
1548
1546
  readonly FRAGMENT_LOAD_ERROR: typeof SVTA_FRAGMENT_LOAD_ERROR;
1549
1547
  /**
1550
- * Fragment timeout error
1551
- */
1548
+ * Fragment timeout error
1549
+ */
1552
1550
  readonly FRAGMENT_TIMEOUT_ERROR: typeof SVTA_FRAGMENT_TIMEOUT_ERROR;
1553
1551
  /**
1554
- * Live timeshifting content out of bounds
1555
- */
1552
+ * Live timeshifting content out of bounds
1553
+ */
1556
1554
  readonly LIVE_TIMESHIFT_OUT_OF_BOUNDS: typeof SVTA_LIVE_TIMESHIFT_OUT_OF_BOUNDS;
1557
1555
  /**
1558
- * Switched to higher latency
1559
- */
1556
+ * Switched to higher latency
1557
+ */
1560
1558
  readonly SWITCHED_TO_HIGHER_LATENCY: typeof SVTA_SWITCHED_TO_HIGHER_LATENCY;
1561
1559
  /**
1562
- * Unable to switch to fullscreen
1563
- */
1560
+ * Unable to switch to fullscreen
1561
+ */
1564
1562
  readonly FULLSCREEN_ERROR: typeof SVTA_FULLSCREEN_ERROR;
1565
1563
  /**
1566
- * Unable to present picture-in-picture
1567
- */
1564
+ * Unable to present picture-in-picture
1565
+ */
1568
1566
  readonly PICTURE_IN_PICTURE_ERROR: typeof SVTA_PICTURE_IN_PICTURE_ERROR;
1569
1567
  /**
1570
- * Manifest feature unsupported
1571
- */
1568
+ * Manifest feature unsupported
1569
+ */
1572
1570
  readonly MANIFEST_FEATURE_UNSUPPORTED: typeof SVTA_MANIFEST_FEATURE_UNSUPPORTED;
1573
1571
  /**
1574
- * Content steering manifest load error
1575
- */
1572
+ * Content steering manifest load error
1573
+ */
1576
1574
  readonly CONTENT_STEERING_MANIFEST_LOAD_ERROR: typeof SVTA_CONTENT_STEERING_MANIFEST_LOAD_ERROR;
1577
1575
  /**
1578
- * Unable to parse content steering manifest
1579
- */
1576
+ * Unable to parse content steering manifest
1577
+ */
1580
1578
  readonly CONTENT_STEERING_MANIFEST_PARSE_ERROR: typeof SVTA_CONTENT_STEERING_MANIFEST_PARSE_ERROR;
1581
1579
  };
1582
1580
  /**
1583
- * Union type of all {@link (SvtaPlaybackErrorCode:variable)} values.
1584
- *
1585
- * @public
1586
- */
1587
- type SvtaPlaybackErrorCode = ValueOf<typeof SvtaPlaybackErrorCode>;
1581
+ * Union type of all {@link (SvtaPlaybackErrorCode:variable)} values.
1582
+ *
1583
+ * @public
1584
+ */
1585
+ export type SvtaPlaybackErrorCode = ValueOf<typeof SvtaPlaybackErrorCode>;
1588
1586
  //#endregion
1589
1587
  //#region src/SvtaRemotePlayErrorCode.d.ts
1590
1588
  /**
1591
- * SVTA 6 [Remote Play] 000: Unknown remote play error
1592
- *
1593
- * @public
1594
- */
1595
- declare const SVTA_REMOTE_PLAY_UNKNOWN: 6000;
1596
- /**
1597
- * SVTA 6 [Remote Play] 001: Sender unable to initialize remote play
1598
- *
1599
- * @public
1600
- */
1601
- declare const SVTA_SENDER_INITIALIZATION_ERROR: 6001;
1602
- /**
1603
- * SVTA 6 [Remote Play] 002: Sender unable to make a connection to the receiver
1604
- *
1605
- * @public
1606
- */
1607
- declare const SVTA_SENDER_CONNECTION_ERROR: 6002;
1608
- /**
1609
- * SVTA 6 [Remote Play] 003: Receiver does not exist or is unavailable
1610
- *
1611
- * @public
1612
- */
1613
- declare const SVTA_RECEIVER_UNAVAILABLE: 6003;
1614
- /**
1615
- * SVTA 6 [Remote Play] 004: Receiver refused remote play connection
1616
- *
1617
- * @public
1618
- */
1619
- declare const SVTA_RECEIVER_CONNECTION_REFUSED: 6004;
1620
- /**
1621
- * SVTA 6 [Remote Play] 005: Connection to the receiver lost
1622
- *
1623
- * @public
1624
- */
1625
- declare const SVTA_RECEIVER_CONNECTION_LOST: 6005;
1626
- /**
1627
- * SVTA 6 [Remote Play] 006: Connection to the sender lost
1628
- *
1629
- * @public
1630
- */
1631
- declare const SVTA_SENDER_CONNECTION_LOST: 6006;
1632
- /**
1633
- * SVTA 6 [Remote Play] 007: Receiver is not supported to playback this stream
1634
- *
1635
- * @public
1636
- */
1637
- declare const SVTA_RECEIVER_UNSUPPORTED_STREAM: 6007;
1638
- /**
1639
- * SVTA 6 [Remote Play] 008: Receiver is already in remote play
1640
- *
1641
- * @public
1642
- */
1643
- declare const SVTA_RECEIVER_ALREADY_IN_REMOTE_PLAY: 6008;
1644
- /**
1645
- * SVTA 6 [Remote Play] 009: Receiver terminated playback because of an error
1646
- *
1647
- * @public
1648
- */
1649
- declare const SVTA_RECEIVER_PLAYBACK_ERROR: 6009;
1650
- /**
1651
- * SVTA standardized error codes in the Remote Play category (6xxx): the
1652
- * framework supporting play out of the stream on a second device.
1653
- *
1654
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1655
- *
1656
- * @enum
1657
- *
1658
- * @public
1659
- */
1660
- declare const SvtaRemotePlayErrorCode: {
1661
- /**
1662
- * Unknown remote play error
1663
- */
1589
+ * SVTA 6 [Remote Play] 000: Unknown remote play error
1590
+ *
1591
+ * @public
1592
+ */
1593
+ export declare const SVTA_REMOTE_PLAY_UNKNOWN: 6000;
1594
+ /**
1595
+ * SVTA 6 [Remote Play] 001: Sender unable to initialize remote play
1596
+ *
1597
+ * @public
1598
+ */
1599
+ export declare const SVTA_SENDER_INITIALIZATION_ERROR: 6001;
1600
+ /**
1601
+ * SVTA 6 [Remote Play] 002: Sender unable to make a connection to the receiver
1602
+ *
1603
+ * @public
1604
+ */
1605
+ export declare const SVTA_SENDER_CONNECTION_ERROR: 6002;
1606
+ /**
1607
+ * SVTA 6 [Remote Play] 003: Receiver does not exist or is unavailable
1608
+ *
1609
+ * @public
1610
+ */
1611
+ export declare const SVTA_RECEIVER_UNAVAILABLE: 6003;
1612
+ /**
1613
+ * SVTA 6 [Remote Play] 004: Receiver refused remote play connection
1614
+ *
1615
+ * @public
1616
+ */
1617
+ export declare const SVTA_RECEIVER_CONNECTION_REFUSED: 6004;
1618
+ /**
1619
+ * SVTA 6 [Remote Play] 005: Connection to the receiver lost
1620
+ *
1621
+ * @public
1622
+ */
1623
+ export declare const SVTA_RECEIVER_CONNECTION_LOST: 6005;
1624
+ /**
1625
+ * SVTA 6 [Remote Play] 006: Connection to the sender lost
1626
+ *
1627
+ * @public
1628
+ */
1629
+ export declare const SVTA_SENDER_CONNECTION_LOST: 6006;
1630
+ /**
1631
+ * SVTA 6 [Remote Play] 007: Receiver is not supported to playback this stream
1632
+ *
1633
+ * @public
1634
+ */
1635
+ export declare const SVTA_RECEIVER_UNSUPPORTED_STREAM: 6007;
1636
+ /**
1637
+ * SVTA 6 [Remote Play] 008: Receiver is already in remote play
1638
+ *
1639
+ * @public
1640
+ */
1641
+ export declare const SVTA_RECEIVER_ALREADY_IN_REMOTE_PLAY: 6008;
1642
+ /**
1643
+ * SVTA 6 [Remote Play] 009: Receiver terminated playback because of an error
1644
+ *
1645
+ * @public
1646
+ */
1647
+ export declare const SVTA_RECEIVER_PLAYBACK_ERROR: 6009;
1648
+ /**
1649
+ * SVTA standardized error codes in the Remote Play category (6xxx): the
1650
+ * framework supporting play out of the stream on a second device.
1651
+ *
1652
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1653
+ *
1654
+ * @enum
1655
+ *
1656
+ * @public
1657
+ */
1658
+ export declare const SvtaRemotePlayErrorCode: {
1659
+ /**
1660
+ * Unknown remote play error
1661
+ */
1664
1662
  readonly UNKNOWN: typeof SVTA_REMOTE_PLAY_UNKNOWN;
1665
1663
  /**
1666
- * Sender unable to initialize remote play
1667
- */
1664
+ * Sender unable to initialize remote play
1665
+ */
1668
1666
  readonly SENDER_INITIALIZATION_ERROR: typeof SVTA_SENDER_INITIALIZATION_ERROR;
1669
1667
  /**
1670
- * Sender unable to make a connection to the receiver
1671
- */
1668
+ * Sender unable to make a connection to the receiver
1669
+ */
1672
1670
  readonly SENDER_CONNECTION_ERROR: typeof SVTA_SENDER_CONNECTION_ERROR;
1673
1671
  /**
1674
- * Receiver does not exist or is unavailable
1675
- */
1672
+ * Receiver does not exist or is unavailable
1673
+ */
1676
1674
  readonly RECEIVER_UNAVAILABLE: typeof SVTA_RECEIVER_UNAVAILABLE;
1677
1675
  /**
1678
- * Receiver refused remote play connection
1679
- */
1676
+ * Receiver refused remote play connection
1677
+ */
1680
1678
  readonly RECEIVER_CONNECTION_REFUSED: typeof SVTA_RECEIVER_CONNECTION_REFUSED;
1681
1679
  /**
1682
- * Connection to the receiver lost
1683
- */
1680
+ * Connection to the receiver lost
1681
+ */
1684
1682
  readonly RECEIVER_CONNECTION_LOST: typeof SVTA_RECEIVER_CONNECTION_LOST;
1685
1683
  /**
1686
- * Connection to the sender lost
1687
- */
1684
+ * Connection to the sender lost
1685
+ */
1688
1686
  readonly SENDER_CONNECTION_LOST: typeof SVTA_SENDER_CONNECTION_LOST;
1689
1687
  /**
1690
- * Receiver is not supported to playback this stream
1691
- */
1688
+ * Receiver is not supported to playback this stream
1689
+ */
1692
1690
  readonly RECEIVER_UNSUPPORTED_STREAM: typeof SVTA_RECEIVER_UNSUPPORTED_STREAM;
1693
1691
  /**
1694
- * Receiver is already in remote play
1695
- */
1692
+ * Receiver is already in remote play
1693
+ */
1696
1694
  readonly RECEIVER_ALREADY_IN_REMOTE_PLAY: typeof SVTA_RECEIVER_ALREADY_IN_REMOTE_PLAY;
1697
1695
  /**
1698
- * Receiver terminated playback because of an error
1699
- */
1696
+ * Receiver terminated playback because of an error
1697
+ */
1700
1698
  readonly RECEIVER_PLAYBACK_ERROR: typeof SVTA_RECEIVER_PLAYBACK_ERROR;
1701
1699
  };
1702
1700
  /**
1703
- * Union type of all {@link (SvtaRemotePlayErrorCode:variable)} values.
1704
- *
1705
- * @public
1706
- */
1707
- type SvtaRemotePlayErrorCode = ValueOf<typeof SvtaRemotePlayErrorCode>;
1701
+ * Union type of all {@link (SvtaRemotePlayErrorCode:variable)} values.
1702
+ *
1703
+ * @public
1704
+ */
1705
+ export type SvtaRemotePlayErrorCode = ValueOf<typeof SvtaRemotePlayErrorCode>;
1708
1706
  //#endregion
1709
1707
  //#region src/SvtaUnknownErrorCode.d.ts
1710
1708
  /**
1711
- * SVTA 0 [Unknown] 999: Unknown error
1712
- *
1713
- * @public
1714
- */
1715
- declare const SVTA_UNKNOWN: 999;
1716
- /**
1717
- * SVTA standardized error code in the Unknown category: the error is
1718
- * entirely unclassified. `999` is the only code below 1000, so fully
1719
- * unknown errors can be filtered by returning codes less than 1000.
1720
- *
1721
- * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1722
- *
1723
- * @enum
1724
- *
1725
- * @public
1726
- */
1727
- declare const SvtaUnknownErrorCode: {
1728
- /**
1729
- * Unknown error
1730
- */
1709
+ * SVTA 0 [Unknown] 999: Unknown error
1710
+ *
1711
+ * @public
1712
+ */
1713
+ export declare const SVTA_UNKNOWN: 999;
1714
+ /**
1715
+ * SVTA standardized error code in the Unknown category: the error is
1716
+ * entirely unclassified. `999` is the only code below 1000, so fully
1717
+ * unknown errors can be filtered by returning codes less than 1000.
1718
+ *
1719
+ * @see {@link https://www.svta.org/product/svta2070/ | SVTA2070: Standardized Error Codes}
1720
+ *
1721
+ * @enum
1722
+ *
1723
+ * @public
1724
+ */
1725
+ export declare const SvtaUnknownErrorCode: {
1726
+ /**
1727
+ * Unknown error
1728
+ */
1731
1729
  readonly UNKNOWN: typeof SVTA_UNKNOWN;
1732
1730
  };
1733
1731
  /**
1734
- * Union type of all {@link (SvtaUnknownErrorCode:variable)} values.
1735
- *
1736
- * @public
1737
- */
1738
- type SvtaUnknownErrorCode = ValueOf<typeof SvtaUnknownErrorCode>;
1732
+ * Union type of all {@link (SvtaUnknownErrorCode:variable)} values.
1733
+ *
1734
+ * @public
1735
+ */
1736
+ export type SvtaUnknownErrorCode = ValueOf<typeof SvtaUnknownErrorCode>;
1739
1737
  //#endregion
1740
1738
  //#region src/SvtaErrorCode.d.ts
1741
1739
  /**
1742
- * Union of every named SVTA standardized error code.
1743
- *
1744
- * Spec-valid codes exist outside this union. HTTP response status codes
1745
- * embed into the Network category (3100-3599), and Publisher-defined
1746
- * codes occupy the Custom category (99001-99999). APIs that accept
1747
- * open-ended SVTA error codes should accept `number`.
1748
- *
1749
- * @public
1750
- */
1740
+ * Union of every named SVTA standardized error code.
1741
+ *
1742
+ * Spec-valid codes exist outside this union. HTTP response status codes
1743
+ * embed into the Network category (3100-3599), and Publisher-defined
1744
+ * codes occupy the Custom category (99001-99999). APIs that accept
1745
+ * open-ended SVTA error codes should accept `number`.
1746
+ *
1747
+ * @public
1748
+ */
1751
1749
  type SvtaErrorCode = SvtaAccessibilityErrorCode | SvtaAdvertisingErrorCode | SvtaContentProtectionErrorCode | SvtaCustomErrorCode | SvtaMediaContentErrorCode | SvtaNetworkErrorCode | SvtaPlaybackErrorCode | SvtaRemotePlayErrorCode | SvtaUnknownErrorCode;
1752
1750
  //#endregion
1753
1751
  //#region src/vastErrorToSvtaErrorCode.d.ts
1754
1752
  /**
1755
- * Embed an IAB VAST error code into the SVTA Advertising error category,
1756
- * per the external code embedding rule of SVTA2070. VAST error 301
1757
- * becomes 7301. The four-digit VAST error 1009 (empty VAST response)
1758
- * does not fit a three-digit index, so SVTA2070 maps it to 7999.
1759
- *
1760
- * Values outside the valid VAST error code range (integers 100-999, or
1761
- * 1009) return the unknown advertising error code (7000) rather than
1762
- * throwing, so error reporting paths cannot fail.
1763
- *
1764
- * @param vastError - An IAB VAST error code (100-999, or 1009).
1765
- * @returns The SVTA advertising error code embedding the VAST error.
1766
- *
1767
- * @public
1768
- *
1769
- * @example
1770
- * {@includeCode ../test/vastErrorToSvtaErrorCode.test.ts#example}
1771
- */
1772
- declare function vastErrorToSvtaErrorCode(vastError: number): number;
1753
+ * Embed an IAB VAST error code into the SVTA Advertising error category,
1754
+ * per the external code embedding rule of SVTA2070. VAST error 301
1755
+ * becomes 7301. The four-digit VAST error 1009 (empty VAST response)
1756
+ * does not fit a three-digit index, so SVTA2070 maps it to 7999.
1757
+ *
1758
+ * Values outside the valid VAST error code range (integers 100-999, or
1759
+ * 1009) return the unknown advertising error code (7000) rather than
1760
+ * throwing, so error reporting paths cannot fail.
1761
+ *
1762
+ * @param vastError - An IAB VAST error code (100-999, or 1009).
1763
+ * @returns The SVTA advertising error code embedding the VAST error.
1764
+ *
1765
+ * @public
1766
+ *
1767
+ * @example
1768
+ * {@includeCode ../test/vastErrorToSvtaErrorCode.test.ts#example}
1769
+ */
1770
+ export declare function vastErrorToSvtaErrorCode(vastError: number): number;
1773
1771
  //#endregion
1774
- export { SVTA_ACCESSIBILITY_UNKNOWN, SVTA_ADVERTISING_UNKNOWN, SVTA_AD_BLOCKER_DETECTED, SVTA_AD_TYPE_MISMATCH, SVTA_AUDIO_BUFFERING_TIMEOUT, SVTA_AUDIO_BUFFER_UNDERRUN, SVTA_AUDIO_DECODE_ERROR, SVTA_AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION, SVTA_BAD_LICENSE_REQUEST, SVTA_BUFFER_APPEND_ERROR, SVTA_BUFFER_FULL_ERROR, SVTA_BUFFER_INITIALIZATION_ERROR, SVTA_BUFFER_NUDGE_ON_STALL, SVTA_BUFFER_REMOVE_ERROR, SVTA_BUFFER_SEEK_OVER_HOLE, SVTA_CDN_UNAUTHORIZED, SVTA_COMPANION_AD_ERROR, SVTA_COMPANION_AD_FETCH_ERROR, SVTA_COMPANION_DIMENSION_MISMATCH, SVTA_CONCURRENT_STREAM_LIMIT_EXCEEDED, SVTA_CONTENT_PROTECTION_UNKNOWN, SVTA_CONTENT_STEERING_MANIFEST_LOAD_ERROR, SVTA_CONTENT_STEERING_MANIFEST_PARSE_ERROR, SVTA_CUSTOM_UNKNOWN, SVTA_DOWNLOAD_ERROR, SVTA_DRM_CERTIFICATE_ERROR, SVTA_DRM_CONFIGURATION_MISSING, SVTA_DRM_INITIALIZATION_ERROR, SVTA_DRM_SESSION_ERROR, SVTA_DURATION_MISMATCH, SVTA_EMPTY_VAST_RESPONSE, SVTA_EMPTY_WRAPPER_RESPONSE, SVTA_ENTITLEMENT_REFUSED, SVTA_ERROR_CATEGORY_ACCESSIBILITY, SVTA_ERROR_CATEGORY_ADVERTISING, SVTA_ERROR_CATEGORY_CONTENT_PROTECTION, SVTA_ERROR_CATEGORY_CUSTOM, SVTA_ERROR_CATEGORY_MEDIA_CONTENT, SVTA_ERROR_CATEGORY_NETWORK, SVTA_ERROR_CATEGORY_PLAYBACK, SVTA_ERROR_CATEGORY_REMOTE_PLAY, SVTA_ERROR_CATEGORY_UNKNOWN, SVTA_FRAGMENT_LOAD_ERROR, SVTA_FRAGMENT_TIMEOUT_ERROR, SVTA_FULLSCREEN_ERROR, SVTA_GEO_RESTRICTED, SVTA_HOST_RESOLUTION_ERROR, SVTA_HTTP_TIMEOUT, SVTA_INITIALIZATION_SEGMENT_ERROR, SVTA_INSUFFICIENT_BANDWIDTH, SVTA_INSUFFICIENT_DRM_ROBUSTNESS, SVTA_INSUFFICIENT_OUTPUT_PROTECTION, SVTA_INTERACTIVE_CREATIVE_ERROR, SVTA_INVALID_ACCESS_TOKEN, SVTA_INVALID_COMPOSITION_TRACK_SEGMENT_TIME, SVTA_INVALID_HTTP_CONTENT_TYPE, SVTA_INVALID_MANIFEST, SVTA_INVALID_URI, SVTA_KEY_LOAD_ERROR, SVTA_LICENSE_EXPIRED, SVTA_LICENSE_REQUEST_GENERATION_ERROR, SVTA_LICENSE_RESPONSE_REJECTED, SVTA_LICENSE_SERVER_TIMEOUT, SVTA_LINEARITY_MISMATCH, SVTA_LINEAR_AD_ERROR, SVTA_LIVE_TIMESHIFT_OUT_OF_BOUNDS, SVTA_MANIFEST_FEATURE_UNSUPPORTED, SVTA_MANIFEST_PARSE_ERROR, SVTA_MANIFEST_TRACK_PARSE_ERROR, SVTA_MAX_RETRIES_EXCEEDED, SVTA_MEDIA_CONTENT_UNKNOWN, SVTA_MEDIA_FILE_DISPLAY_ERROR, SVTA_MEDIA_FILE_NOT_FOUND, SVTA_MEDIA_FILE_UNAVAILABLE, SVTA_MEDIA_UNAVAILABLE, SVTA_MEZZANINE_DOWNLOADING, SVTA_MEZZANINE_MISSING, SVTA_MISALIGNED_TRACK_DURATION, SVTA_NETWORK_UNKNOWN, SVTA_NONLINEAR_AD_ERROR, SVTA_NONLINEAR_AD_FETCH_ERROR, SVTA_NONLINEAR_DIMENSION_MISMATCH, SVTA_NO_MATCHING_CODEC, SVTA_NO_NETWORK_CONNECTION, SVTA_NO_SUPPORTED_AUDIO_TRACK, SVTA_NO_SUPPORTED_MEDIA_TYPE, SVTA_NO_SUPPORTED_VIDEO_TRACK, SVTA_OUT_OF_MEMORY, SVTA_PERMISSION_REJECTED, SVTA_PERSISTENT_SESSION_ERROR, SVTA_PICTURE_IN_PICTURE_ERROR, SVTA_PLAYBACK_UNKNOWN, SVTA_PLAYHEAD_EXCEEDS_CONTENT_DURATION, SVTA_PRIMARY_MANIFEST_LOAD_ERROR, SVTA_PRIMARY_MANIFEST_LOAD_TIMEOUT, SVTA_RECEIVER_ALREADY_IN_REMOTE_PLAY, SVTA_RECEIVER_CONNECTION_LOST, SVTA_RECEIVER_CONNECTION_REFUSED, SVTA_RECEIVER_PLAYBACK_ERROR, SVTA_RECEIVER_UNAVAILABLE, SVTA_RECEIVER_UNSUPPORTED_STREAM, SVTA_REJECTED_AD, SVTA_REMOTE_PLAY_UNKNOWN, SVTA_REMUX_ERROR, SVTA_REQUIRED_COMPANION_AD_ERROR, SVTA_RESOURCE_DENIED, SVTA_RESOURCE_NOT_FOUND, SVTA_SECONDARY_MANIFEST_LOAD_ERROR, SVTA_SECONDARY_MANIFEST_PARSE_ERROR, SVTA_SEGMENT_DECRYPTION_ERROR, SVTA_SEGMENT_EXCEEDS_TRACK_BITRATE, SVTA_SEGMENT_LOAD_ERROR, SVTA_SEGMENT_PARSE_ERROR, SVTA_SEGMENT_TIMEOUT_ERROR, SVTA_SENDER_CONNECTION_ERROR, SVTA_SENDER_CONNECTION_LOST, SVTA_SENDER_INITIALIZATION_ERROR, SVTA_SIZE_MISMATCH, SVTA_SWITCHED_TO_HIGHER_LATENCY, SVTA_TIMED_TEXT_EXCEEDS_CONTENT_DURATION, SVTA_TIMED_TEXT_PARSE_ERROR, SVTA_TIMED_TEXT_RENDER_ERROR, SVTA_TIME_SYNC_ERROR, SVTA_TRACK_LOAD_ERROR, SVTA_TRACK_NOT_AVAILABLE, SVTA_TRACK_SWITCH_ERROR, SVTA_UNDEFINED_VAST_ERROR, SVTA_UNKNOWN, SVTA_UNSUPPORTED_AUDIO_FORMAT, SVTA_UNSUPPORTED_DRM_SYSTEM, SVTA_UNSUPPORTED_NONLINEAR_AD, SVTA_UNSUPPORTED_TEXT_FORMAT, SVTA_UNSUPPORTED_URI_SCHEME, SVTA_UNSUPPORTED_VIDEO_FORMAT, SVTA_VAST_PARSE_ERROR, SVTA_VAST_SCHEMA_VALIDATION_ERROR, SVTA_VAST_VERSION_UNSUPPORTED, SVTA_VERIFICATION_ERROR, SVTA_VIDEO_BUFFERING_TIMEOUT, SVTA_VIDEO_BUFFER_UNDERRUN, SVTA_VIDEO_DECODE_ERROR, SVTA_VIDEO_DROPPED_FRAMES_EXCEEDED, SVTA_VPAID_ERROR, SVTA_WRAPPER_ERROR, SVTA_WRAPPER_LIMIT_REACHED, SVTA_WRAPPER_TIMEOUT, SvtaAccessibilityErrorCode, SvtaAdvertisingErrorCode, SvtaContentProtectionErrorCode, SvtaCustomErrorCode, SvtaErrorCategory, SvtaErrorCode, SvtaMediaContentErrorCode, SvtaNetworkErrorCode, SvtaPlaybackErrorCode, SvtaRemotePlayErrorCode, SvtaUnknownErrorCode, getSvtaErrorCategory, getSvtaErrorIndex, httpStatusToSvtaErrorCode, vastErrorToSvtaErrorCode };
1772
+ export type { SvtaErrorCode };
1775
1773
  //# sourceMappingURL=index.d.ts.map