@svta/cml-error-codes 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE.md +2 -0
- package/README.md +56 -0
- package/dist/index.d.ts +1775 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1285 -0
- package/dist/index.js.map +1 -0
- package/dist/tsdoc-metadata.json +11 -0
- package/package.json +58 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,1775 @@
|
|
|
1
|
+
import { ValueOf } from "@svta/cml-utils";
|
|
2
|
+
|
|
3
|
+
//#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
|
+
*/
|
|
74
|
+
readonly UNKNOWN: typeof SVTA_ERROR_CATEGORY_UNKNOWN;
|
|
75
|
+
/**
|
|
76
|
+
* Issues with the content itself, such as an unsupported format
|
|
77
|
+
*/
|
|
78
|
+
readonly MEDIA_CONTENT: typeof SVTA_ERROR_CATEGORY_MEDIA_CONTENT;
|
|
79
|
+
/**
|
|
80
|
+
* Player unable to sustain the experience
|
|
81
|
+
*/
|
|
82
|
+
readonly PLAYBACK: typeof SVTA_ERROR_CATEGORY_PLAYBACK;
|
|
83
|
+
/**
|
|
84
|
+
* Issues on the network, including unavailable resources
|
|
85
|
+
*/
|
|
86
|
+
readonly NETWORK: typeof SVTA_ERROR_CATEGORY_NETWORK;
|
|
87
|
+
/**
|
|
88
|
+
* Security related error, including authentication or entitlement issues
|
|
89
|
+
*/
|
|
90
|
+
readonly CONTENT_PROTECTION: typeof SVTA_ERROR_CATEGORY_CONTENT_PROTECTION;
|
|
91
|
+
/**
|
|
92
|
+
* Defective captions or audio description
|
|
93
|
+
*/
|
|
94
|
+
readonly ACCESSIBILITY: typeof SVTA_ERROR_CATEGORY_ACCESSIBILITY;
|
|
95
|
+
/**
|
|
96
|
+
* Framework supporting the play out of the stream on a second device
|
|
97
|
+
*/
|
|
98
|
+
readonly REMOTE_PLAY: typeof SVTA_ERROR_CATEGORY_REMOTE_PLAY;
|
|
99
|
+
/**
|
|
100
|
+
* Issues triggered by ad insertion
|
|
101
|
+
*/
|
|
102
|
+
readonly ADVERTISING: typeof SVTA_ERROR_CATEGORY_ADVERTISING;
|
|
103
|
+
/**
|
|
104
|
+
* Reserved category for Publisher-defined errors
|
|
105
|
+
*/
|
|
106
|
+
readonly CUSTOM: typeof SVTA_ERROR_CATEGORY_CUSTOM;
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* Union type of all {@link (SvtaErrorCategory:variable)} values.
|
|
110
|
+
*
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
type SvtaErrorCategory = ValueOf<typeof SvtaErrorCategory>;
|
|
114
|
+
//#endregion
|
|
115
|
+
//#region src/getSvtaErrorCategory.d.ts
|
|
116
|
+
/**
|
|
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;
|
|
131
|
+
//#endregion
|
|
132
|
+
//#region src/getSvtaErrorIndex.d.ts
|
|
133
|
+
/**
|
|
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;
|
|
149
|
+
//#endregion
|
|
150
|
+
//#region src/httpStatusToSvtaErrorCode.d.ts
|
|
151
|
+
/**
|
|
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;
|
|
169
|
+
//#endregion
|
|
170
|
+
//#region src/SvtaAccessibilityErrorCode.d.ts
|
|
171
|
+
/**
|
|
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
|
+
*/
|
|
215
|
+
readonly UNKNOWN: typeof SVTA_ACCESSIBILITY_UNKNOWN;
|
|
216
|
+
/**
|
|
217
|
+
* Unable to parse timed text
|
|
218
|
+
*/
|
|
219
|
+
readonly TIMED_TEXT_PARSE_ERROR: typeof SVTA_TIMED_TEXT_PARSE_ERROR;
|
|
220
|
+
/**
|
|
221
|
+
* Unable to render timed text
|
|
222
|
+
*/
|
|
223
|
+
readonly TIMED_TEXT_RENDER_ERROR: typeof SVTA_TIMED_TEXT_RENDER_ERROR;
|
|
224
|
+
/**
|
|
225
|
+
* Timed text exceeds content duration
|
|
226
|
+
*/
|
|
227
|
+
readonly TIMED_TEXT_EXCEEDS_CONTENT_DURATION: typeof SVTA_TIMED_TEXT_EXCEEDS_CONTENT_DURATION;
|
|
228
|
+
/**
|
|
229
|
+
* Audio description exceeds content duration
|
|
230
|
+
*/
|
|
231
|
+
readonly AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION: typeof SVTA_AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Union type of all {@link (SvtaAccessibilityErrorCode:variable)} values.
|
|
235
|
+
*
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
type SvtaAccessibilityErrorCode = ValueOf<typeof SvtaAccessibilityErrorCode>;
|
|
239
|
+
//#endregion
|
|
240
|
+
//#region src/SvtaAdvertisingErrorCode.d.ts
|
|
241
|
+
/**
|
|
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
|
+
*/
|
|
467
|
+
readonly UNKNOWN: typeof SVTA_ADVERTISING_UNKNOWN;
|
|
468
|
+
/**
|
|
469
|
+
* Ad blocker detected
|
|
470
|
+
*/
|
|
471
|
+
readonly AD_BLOCKER_DETECTED: typeof SVTA_AD_BLOCKER_DETECTED;
|
|
472
|
+
/**
|
|
473
|
+
* Unable to parse VAST XML
|
|
474
|
+
*/
|
|
475
|
+
readonly VAST_PARSE_ERROR: typeof SVTA_VAST_PARSE_ERROR;
|
|
476
|
+
/**
|
|
477
|
+
* Invalid VAST schema
|
|
478
|
+
*/
|
|
479
|
+
readonly VAST_SCHEMA_VALIDATION_ERROR: typeof SVTA_VAST_SCHEMA_VALIDATION_ERROR;
|
|
480
|
+
/**
|
|
481
|
+
* VAST response version not supported
|
|
482
|
+
*/
|
|
483
|
+
readonly VAST_VERSION_UNSUPPORTED: typeof SVTA_VAST_VERSION_UNSUPPORTED;
|
|
484
|
+
/**
|
|
485
|
+
* Video player expected different ad type
|
|
486
|
+
*/
|
|
487
|
+
readonly AD_TYPE_MISMATCH: typeof SVTA_AD_TYPE_MISMATCH;
|
|
488
|
+
/**
|
|
489
|
+
* Creative has different linearity than player expected (non-fatal)
|
|
490
|
+
*/
|
|
491
|
+
readonly LINEARITY_MISMATCH: typeof SVTA_LINEARITY_MISMATCH;
|
|
492
|
+
/**
|
|
493
|
+
* Creative has different duration than player expected (non-fatal)
|
|
494
|
+
*/
|
|
495
|
+
readonly DURATION_MISMATCH: typeof SVTA_DURATION_MISMATCH;
|
|
496
|
+
/**
|
|
497
|
+
* Creative has different size than player expected (non-fatal)
|
|
498
|
+
*/
|
|
499
|
+
readonly SIZE_MISMATCH: typeof SVTA_SIZE_MISMATCH;
|
|
500
|
+
/**
|
|
501
|
+
* Wrapper failed to deliver VAST response for unknown reason
|
|
502
|
+
*/
|
|
503
|
+
readonly WRAPPER_ERROR: typeof SVTA_WRAPPER_ERROR;
|
|
504
|
+
/**
|
|
505
|
+
* VAST response redirect timed out
|
|
506
|
+
*/
|
|
507
|
+
readonly WRAPPER_TIMEOUT: typeof SVTA_WRAPPER_TIMEOUT;
|
|
508
|
+
/**
|
|
509
|
+
* Wrapper limit reached (e.g. too many redirects)
|
|
510
|
+
*/
|
|
511
|
+
readonly WRAPPER_LIMIT_REACHED: typeof SVTA_WRAPPER_LIMIT_REACHED;
|
|
512
|
+
/**
|
|
513
|
+
* VAST response was empty
|
|
514
|
+
*/
|
|
515
|
+
readonly EMPTY_WRAPPER_RESPONSE: typeof SVTA_EMPTY_WRAPPER_RESPONSE;
|
|
516
|
+
/**
|
|
517
|
+
* Unable to display linear ad
|
|
518
|
+
*/
|
|
519
|
+
readonly LINEAR_AD_ERROR: typeof SVTA_LINEAR_AD_ERROR;
|
|
520
|
+
/**
|
|
521
|
+
* Media file not found
|
|
522
|
+
*/
|
|
523
|
+
readonly MEDIA_FILE_NOT_FOUND: typeof SVTA_MEDIA_FILE_NOT_FOUND;
|
|
524
|
+
/**
|
|
525
|
+
* Media file unavailable
|
|
526
|
+
*/
|
|
527
|
+
readonly MEDIA_FILE_UNAVAILABLE: typeof SVTA_MEDIA_FILE_UNAVAILABLE;
|
|
528
|
+
/**
|
|
529
|
+
* VAST response contained no supported MIME types
|
|
530
|
+
*/
|
|
531
|
+
readonly NO_SUPPORTED_MEDIA_TYPE: typeof SVTA_NO_SUPPORTED_MEDIA_TYPE;
|
|
532
|
+
/**
|
|
533
|
+
* Unable to display media file
|
|
534
|
+
*/
|
|
535
|
+
readonly MEDIA_FILE_DISPLAY_ERROR: typeof SVTA_MEDIA_FILE_DISPLAY_ERROR;
|
|
536
|
+
/**
|
|
537
|
+
* Required mezzanine file missing
|
|
538
|
+
*/
|
|
539
|
+
readonly MEZZANINE_MISSING: typeof SVTA_MEZZANINE_MISSING;
|
|
540
|
+
/**
|
|
541
|
+
* Mezzanine file was downloaded for the first time
|
|
542
|
+
*/
|
|
543
|
+
readonly MEZZANINE_DOWNLOADING: typeof SVTA_MEZZANINE_DOWNLOADING;
|
|
544
|
+
/**
|
|
545
|
+
* VAST response contained rejected ad
|
|
546
|
+
*/
|
|
547
|
+
readonly REJECTED_AD: typeof SVTA_REJECTED_AD;
|
|
548
|
+
/**
|
|
549
|
+
* Could not execute creative defined in interactiveCreativeFile
|
|
550
|
+
*/
|
|
551
|
+
readonly INTERACTIVE_CREATIVE_ERROR: typeof SVTA_INTERACTIVE_CREATIVE_ERROR;
|
|
552
|
+
/**
|
|
553
|
+
* Could not execute code in verification node
|
|
554
|
+
*/
|
|
555
|
+
readonly VERIFICATION_ERROR: typeof SVTA_VERIFICATION_ERROR;
|
|
556
|
+
/**
|
|
557
|
+
* Video player unable to display non-linear ad for unknown reason
|
|
558
|
+
*/
|
|
559
|
+
readonly NONLINEAR_AD_ERROR: typeof SVTA_NONLINEAR_AD_ERROR;
|
|
560
|
+
/**
|
|
561
|
+
* Non-linear ad dimensions did not match display area
|
|
562
|
+
*/
|
|
563
|
+
readonly NONLINEAR_DIMENSION_MISMATCH: typeof SVTA_NONLINEAR_DIMENSION_MISMATCH;
|
|
564
|
+
/**
|
|
565
|
+
* Unable to fetch non-linear ad resource
|
|
566
|
+
*/
|
|
567
|
+
readonly NONLINEAR_AD_FETCH_ERROR: typeof SVTA_NONLINEAR_AD_FETCH_ERROR;
|
|
568
|
+
/**
|
|
569
|
+
* Non-linear ad did not contain a supported type
|
|
570
|
+
*/
|
|
571
|
+
readonly UNSUPPORTED_NONLINEAR_AD: typeof SVTA_UNSUPPORTED_NONLINEAR_AD;
|
|
572
|
+
/**
|
|
573
|
+
* Could not display companion ad (non-fatal)
|
|
574
|
+
*/
|
|
575
|
+
readonly COMPANION_AD_ERROR: typeof SVTA_COMPANION_AD_ERROR;
|
|
576
|
+
/**
|
|
577
|
+
* Companion ad dimensions did not match display area
|
|
578
|
+
*/
|
|
579
|
+
readonly COMPANION_DIMENSION_MISMATCH: typeof SVTA_COMPANION_DIMENSION_MISMATCH;
|
|
580
|
+
/**
|
|
581
|
+
* Unable to display required companion ad
|
|
582
|
+
*/
|
|
583
|
+
readonly REQUIRED_COMPANION_AD_ERROR: typeof SVTA_REQUIRED_COMPANION_AD_ERROR;
|
|
584
|
+
/**
|
|
585
|
+
* Unable to fetch companion ad resource
|
|
586
|
+
*/
|
|
587
|
+
readonly COMPANION_AD_FETCH_ERROR: typeof SVTA_COMPANION_AD_FETCH_ERROR;
|
|
588
|
+
/**
|
|
589
|
+
* Undefined VAST error
|
|
590
|
+
*/
|
|
591
|
+
readonly UNDEFINED_VAST_ERROR: typeof SVTA_UNDEFINED_VAST_ERROR;
|
|
592
|
+
/**
|
|
593
|
+
* Unknown VPAID error
|
|
594
|
+
*/
|
|
595
|
+
readonly VPAID_ERROR: typeof SVTA_VPAID_ERROR;
|
|
596
|
+
/**
|
|
597
|
+
* VAST response document was empty
|
|
598
|
+
*
|
|
599
|
+
* SVTA2070 maps the four-digit IAB VAST error 1009 to this code.
|
|
600
|
+
*/
|
|
601
|
+
readonly EMPTY_VAST_RESPONSE: typeof SVTA_EMPTY_VAST_RESPONSE;
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* Union type of all {@link (SvtaAdvertisingErrorCode:variable)} values.
|
|
605
|
+
*
|
|
606
|
+
* @public
|
|
607
|
+
*/
|
|
608
|
+
type SvtaAdvertisingErrorCode = ValueOf<typeof SvtaAdvertisingErrorCode>;
|
|
609
|
+
//#endregion
|
|
610
|
+
//#region src/SvtaContentProtectionErrorCode.d.ts
|
|
611
|
+
/**
|
|
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
|
+
*/
|
|
758
|
+
readonly UNKNOWN: typeof SVTA_CONTENT_PROTECTION_UNKNOWN;
|
|
759
|
+
/**
|
|
760
|
+
* Concurrent stream limit exceeded
|
|
761
|
+
*/
|
|
762
|
+
readonly CONCURRENT_STREAM_LIMIT_EXCEEDED: typeof SVTA_CONCURRENT_STREAM_LIMIT_EXCEEDED;
|
|
763
|
+
/**
|
|
764
|
+
* Entitlement refused
|
|
765
|
+
*/
|
|
766
|
+
readonly ENTITLEMENT_REFUSED: typeof SVTA_ENTITLEMENT_REFUSED;
|
|
767
|
+
/**
|
|
768
|
+
* License expired
|
|
769
|
+
*/
|
|
770
|
+
readonly LICENSE_EXPIRED: typeof SVTA_LICENSE_EXPIRED;
|
|
771
|
+
/**
|
|
772
|
+
* Bad license request
|
|
773
|
+
*/
|
|
774
|
+
readonly BAD_LICENSE_REQUEST: typeof SVTA_BAD_LICENSE_REQUEST;
|
|
775
|
+
/**
|
|
776
|
+
* License server timeout
|
|
777
|
+
*/
|
|
778
|
+
readonly LICENSE_SERVER_TIMEOUT: typeof SVTA_LICENSE_SERVER_TIMEOUT;
|
|
779
|
+
/**
|
|
780
|
+
* Insufficient DRM robustness level
|
|
781
|
+
*/
|
|
782
|
+
readonly INSUFFICIENT_DRM_ROBUSTNESS: typeof SVTA_INSUFFICIENT_DRM_ROBUSTNESS;
|
|
783
|
+
/**
|
|
784
|
+
* Insufficient output protection
|
|
785
|
+
*/
|
|
786
|
+
readonly INSUFFICIENT_OUTPUT_PROTECTION: typeof SVTA_INSUFFICIENT_OUTPUT_PROTECTION;
|
|
787
|
+
/**
|
|
788
|
+
* Unsupported or unavailable DRM system
|
|
789
|
+
*/
|
|
790
|
+
readonly UNSUPPORTED_DRM_SYSTEM: typeof SVTA_UNSUPPORTED_DRM_SYSTEM;
|
|
791
|
+
/**
|
|
792
|
+
* Access restricted due to unsupported geo
|
|
793
|
+
*/
|
|
794
|
+
readonly GEO_RESTRICTED: typeof SVTA_GEO_RESTRICTED;
|
|
795
|
+
/**
|
|
796
|
+
* DRM initialization error
|
|
797
|
+
*/
|
|
798
|
+
readonly DRM_INITIALIZATION_ERROR: typeof SVTA_DRM_INITIALIZATION_ERROR;
|
|
799
|
+
/**
|
|
800
|
+
* CDN unauthorized
|
|
801
|
+
*/
|
|
802
|
+
readonly CDN_UNAUTHORIZED: typeof SVTA_CDN_UNAUTHORIZED;
|
|
803
|
+
/**
|
|
804
|
+
* Invalid access token
|
|
805
|
+
*/
|
|
806
|
+
readonly INVALID_ACCESS_TOKEN: typeof SVTA_INVALID_ACCESS_TOKEN;
|
|
807
|
+
/**
|
|
808
|
+
* DRM certificate error
|
|
809
|
+
*/
|
|
810
|
+
readonly DRM_CERTIFICATE_ERROR: typeof SVTA_DRM_CERTIFICATE_ERROR;
|
|
811
|
+
/**
|
|
812
|
+
* DRM session error
|
|
813
|
+
*/
|
|
814
|
+
readonly DRM_SESSION_ERROR: typeof SVTA_DRM_SESSION_ERROR;
|
|
815
|
+
/**
|
|
816
|
+
* DRM initialization data or configuration missing
|
|
817
|
+
*/
|
|
818
|
+
readonly DRM_CONFIGURATION_MISSING: typeof SVTA_DRM_CONFIGURATION_MISSING;
|
|
819
|
+
/**
|
|
820
|
+
* DRM license response rejected
|
|
821
|
+
*/
|
|
822
|
+
readonly LICENSE_RESPONSE_REJECTED: typeof SVTA_LICENSE_RESPONSE_REJECTED;
|
|
823
|
+
/**
|
|
824
|
+
* Persistent session DRM error
|
|
825
|
+
*/
|
|
826
|
+
readonly PERSISTENT_SESSION_ERROR: typeof SVTA_PERSISTENT_SESSION_ERROR;
|
|
827
|
+
/**
|
|
828
|
+
* Required permission rejected
|
|
829
|
+
*/
|
|
830
|
+
readonly PERMISSION_REJECTED: typeof SVTA_PERMISSION_REJECTED;
|
|
831
|
+
/**
|
|
832
|
+
* Failed to load decryption key
|
|
833
|
+
*/
|
|
834
|
+
readonly KEY_LOAD_ERROR: typeof SVTA_KEY_LOAD_ERROR;
|
|
835
|
+
/**
|
|
836
|
+
* Failed to decrypt segment
|
|
837
|
+
*/
|
|
838
|
+
readonly SEGMENT_DECRYPTION_ERROR: typeof SVTA_SEGMENT_DECRYPTION_ERROR;
|
|
839
|
+
/**
|
|
840
|
+
* Failed to generate DRM license request
|
|
841
|
+
*/
|
|
842
|
+
readonly LICENSE_REQUEST_GENERATION_ERROR: typeof SVTA_LICENSE_REQUEST_GENERATION_ERROR;
|
|
843
|
+
};
|
|
844
|
+
/**
|
|
845
|
+
* Union type of all {@link (SvtaContentProtectionErrorCode:variable)} values.
|
|
846
|
+
*
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
type SvtaContentProtectionErrorCode = ValueOf<typeof SvtaContentProtectionErrorCode>;
|
|
850
|
+
//#endregion
|
|
851
|
+
//#region src/SvtaCustomErrorCode.d.ts
|
|
852
|
+
/**
|
|
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
|
+
*/
|
|
873
|
+
readonly UNKNOWN: typeof SVTA_CUSTOM_UNKNOWN;
|
|
874
|
+
};
|
|
875
|
+
/**
|
|
876
|
+
* Union type of all {@link (SvtaCustomErrorCode:variable)} values.
|
|
877
|
+
*
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
type SvtaCustomErrorCode = ValueOf<typeof SvtaCustomErrorCode>;
|
|
881
|
+
//#endregion
|
|
882
|
+
//#region src/SvtaMediaContentErrorCode.d.ts
|
|
883
|
+
/**
|
|
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
|
+
*/
|
|
957
|
+
readonly UNKNOWN: typeof SVTA_MEDIA_CONTENT_UNKNOWN;
|
|
958
|
+
/**
|
|
959
|
+
* Media unavailable
|
|
960
|
+
*/
|
|
961
|
+
readonly MEDIA_UNAVAILABLE: typeof SVTA_MEDIA_UNAVAILABLE;
|
|
962
|
+
/**
|
|
963
|
+
* Invalid manifest
|
|
964
|
+
*/
|
|
965
|
+
readonly INVALID_MANIFEST: typeof SVTA_INVALID_MANIFEST;
|
|
966
|
+
/**
|
|
967
|
+
* Track not available
|
|
968
|
+
*/
|
|
969
|
+
readonly TRACK_NOT_AVAILABLE: typeof SVTA_TRACK_NOT_AVAILABLE;
|
|
970
|
+
/**
|
|
971
|
+
* Unsupported video format
|
|
972
|
+
*/
|
|
973
|
+
readonly UNSUPPORTED_VIDEO_FORMAT: typeof SVTA_UNSUPPORTED_VIDEO_FORMAT;
|
|
974
|
+
/**
|
|
975
|
+
* Unsupported audio format
|
|
976
|
+
*/
|
|
977
|
+
readonly UNSUPPORTED_AUDIO_FORMAT: typeof SVTA_UNSUPPORTED_AUDIO_FORMAT;
|
|
978
|
+
/**
|
|
979
|
+
* Unsupported text format
|
|
980
|
+
*/
|
|
981
|
+
readonly UNSUPPORTED_TEXT_FORMAT: typeof SVTA_UNSUPPORTED_TEXT_FORMAT;
|
|
982
|
+
/**
|
|
983
|
+
* Invalid composition track segment time
|
|
984
|
+
*/
|
|
985
|
+
readonly INVALID_COMPOSITION_TRACK_SEGMENT_TIME: typeof SVTA_INVALID_COMPOSITION_TRACK_SEGMENT_TIME;
|
|
986
|
+
/**
|
|
987
|
+
* Segment exceeds specified bitrate for track
|
|
988
|
+
*/
|
|
989
|
+
readonly SEGMENT_EXCEEDS_TRACK_BITRATE: typeof SVTA_SEGMENT_EXCEEDS_TRACK_BITRATE;
|
|
990
|
+
/**
|
|
991
|
+
* Misaligned track duration
|
|
992
|
+
*/
|
|
993
|
+
readonly MISALIGNED_TRACK_DURATION: typeof SVTA_MISALIGNED_TRACK_DURATION;
|
|
994
|
+
};
|
|
995
|
+
/**
|
|
996
|
+
* Union type of all {@link (SvtaMediaContentErrorCode:variable)} values.
|
|
997
|
+
*
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
type SvtaMediaContentErrorCode = ValueOf<typeof SvtaMediaContentErrorCode>;
|
|
1001
|
+
//#endregion
|
|
1002
|
+
//#region src/SvtaNetworkErrorCode.d.ts
|
|
1003
|
+
/**
|
|
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
|
+
*/
|
|
1093
|
+
readonly UNKNOWN: typeof SVTA_NETWORK_UNKNOWN;
|
|
1094
|
+
/**
|
|
1095
|
+
* No network connection
|
|
1096
|
+
*/
|
|
1097
|
+
readonly NO_NETWORK_CONNECTION: typeof SVTA_NO_NETWORK_CONNECTION;
|
|
1098
|
+
/**
|
|
1099
|
+
* HTTP timeout
|
|
1100
|
+
*/
|
|
1101
|
+
readonly HTTP_TIMEOUT: typeof SVTA_HTTP_TIMEOUT;
|
|
1102
|
+
/**
|
|
1103
|
+
* Unable to resolve host
|
|
1104
|
+
*/
|
|
1105
|
+
readonly HOST_RESOLUTION_ERROR: typeof SVTA_HOST_RESOLUTION_ERROR;
|
|
1106
|
+
/**
|
|
1107
|
+
* Resource not found
|
|
1108
|
+
*/
|
|
1109
|
+
readonly RESOURCE_NOT_FOUND: typeof SVTA_RESOURCE_NOT_FOUND;
|
|
1110
|
+
/**
|
|
1111
|
+
* Invalid URI
|
|
1112
|
+
*/
|
|
1113
|
+
readonly INVALID_URI: typeof SVTA_INVALID_URI;
|
|
1114
|
+
/**
|
|
1115
|
+
* Unsupported URI scheme
|
|
1116
|
+
*/
|
|
1117
|
+
readonly UNSUPPORTED_URI_SCHEME: typeof SVTA_UNSUPPORTED_URI_SCHEME;
|
|
1118
|
+
/**
|
|
1119
|
+
* Download error
|
|
1120
|
+
*/
|
|
1121
|
+
readonly DOWNLOAD_ERROR: typeof SVTA_DOWNLOAD_ERROR;
|
|
1122
|
+
/**
|
|
1123
|
+
* Max retries have been exceeded
|
|
1124
|
+
*/
|
|
1125
|
+
readonly MAX_RETRIES_EXCEEDED: typeof SVTA_MAX_RETRIES_EXCEEDED;
|
|
1126
|
+
/**
|
|
1127
|
+
* Insufficient bandwidth to support playback of current presentation
|
|
1128
|
+
*/
|
|
1129
|
+
readonly INSUFFICIENT_BANDWIDTH: typeof SVTA_INSUFFICIENT_BANDWIDTH;
|
|
1130
|
+
/**
|
|
1131
|
+
* Resource denied
|
|
1132
|
+
*/
|
|
1133
|
+
readonly RESOURCE_DENIED: typeof SVTA_RESOURCE_DENIED;
|
|
1134
|
+
/**
|
|
1135
|
+
* Invalid HTTP content type value
|
|
1136
|
+
*/
|
|
1137
|
+
readonly INVALID_HTTP_CONTENT_TYPE: typeof SVTA_INVALID_HTTP_CONTENT_TYPE;
|
|
1138
|
+
};
|
|
1139
|
+
/**
|
|
1140
|
+
* Union type of all {@link (SvtaNetworkErrorCode:variable)} values.
|
|
1141
|
+
*
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
type SvtaNetworkErrorCode = ValueOf<typeof SvtaNetworkErrorCode>;
|
|
1145
|
+
//#endregion
|
|
1146
|
+
//#region src/SvtaPlaybackErrorCode.d.ts
|
|
1147
|
+
/**
|
|
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
|
+
*/
|
|
1416
|
+
readonly UNKNOWN: typeof SVTA_PLAYBACK_UNKNOWN;
|
|
1417
|
+
/**
|
|
1418
|
+
* Video buffer underrun
|
|
1419
|
+
*/
|
|
1420
|
+
readonly VIDEO_BUFFER_UNDERRUN: typeof SVTA_VIDEO_BUFFER_UNDERRUN;
|
|
1421
|
+
/**
|
|
1422
|
+
* Audio buffer underrun
|
|
1423
|
+
*/
|
|
1424
|
+
readonly AUDIO_BUFFER_UNDERRUN: typeof SVTA_AUDIO_BUFFER_UNDERRUN;
|
|
1425
|
+
/**
|
|
1426
|
+
* Video buffering timeout
|
|
1427
|
+
*/
|
|
1428
|
+
readonly VIDEO_BUFFERING_TIMEOUT: typeof SVTA_VIDEO_BUFFERING_TIMEOUT;
|
|
1429
|
+
/**
|
|
1430
|
+
* Audio buffering timeout
|
|
1431
|
+
*/
|
|
1432
|
+
readonly AUDIO_BUFFERING_TIMEOUT: typeof SVTA_AUDIO_BUFFERING_TIMEOUT;
|
|
1433
|
+
/**
|
|
1434
|
+
* Unable to parse manifest
|
|
1435
|
+
*/
|
|
1436
|
+
readonly MANIFEST_PARSE_ERROR: typeof SVTA_MANIFEST_PARSE_ERROR;
|
|
1437
|
+
/**
|
|
1438
|
+
* Segment parse error
|
|
1439
|
+
*/
|
|
1440
|
+
readonly SEGMENT_PARSE_ERROR: typeof SVTA_SEGMENT_PARSE_ERROR;
|
|
1441
|
+
/**
|
|
1442
|
+
* Unable to decode video
|
|
1443
|
+
*/
|
|
1444
|
+
readonly VIDEO_DECODE_ERROR: typeof SVTA_VIDEO_DECODE_ERROR;
|
|
1445
|
+
/**
|
|
1446
|
+
* Unable to decode audio
|
|
1447
|
+
*/
|
|
1448
|
+
readonly AUDIO_DECODE_ERROR: typeof SVTA_AUDIO_DECODE_ERROR;
|
|
1449
|
+
/**
|
|
1450
|
+
* Video dropped frame count exceeds threshold
|
|
1451
|
+
*/
|
|
1452
|
+
readonly VIDEO_DROPPED_FRAMES_EXCEEDED: typeof SVTA_VIDEO_DROPPED_FRAMES_EXCEEDED;
|
|
1453
|
+
/**
|
|
1454
|
+
* Playhead exceeds content duration
|
|
1455
|
+
*/
|
|
1456
|
+
readonly PLAYHEAD_EXCEEDS_CONTENT_DURATION: typeof SVTA_PLAYHEAD_EXCEEDS_CONTENT_DURATION;
|
|
1457
|
+
/**
|
|
1458
|
+
* No supported video track
|
|
1459
|
+
*/
|
|
1460
|
+
readonly NO_SUPPORTED_VIDEO_TRACK: typeof SVTA_NO_SUPPORTED_VIDEO_TRACK;
|
|
1461
|
+
/**
|
|
1462
|
+
* No supported audio track
|
|
1463
|
+
*/
|
|
1464
|
+
readonly NO_SUPPORTED_AUDIO_TRACK: typeof SVTA_NO_SUPPORTED_AUDIO_TRACK;
|
|
1465
|
+
/**
|
|
1466
|
+
* No matching codec / profile / level
|
|
1467
|
+
*/
|
|
1468
|
+
readonly NO_MATCHING_CODEC: typeof SVTA_NO_MATCHING_CODEC;
|
|
1469
|
+
/**
|
|
1470
|
+
* Primary manifest load error
|
|
1471
|
+
*/
|
|
1472
|
+
readonly PRIMARY_MANIFEST_LOAD_ERROR: typeof SVTA_PRIMARY_MANIFEST_LOAD_ERROR;
|
|
1473
|
+
/**
|
|
1474
|
+
* Primary manifest load timeout
|
|
1475
|
+
*/
|
|
1476
|
+
readonly PRIMARY_MANIFEST_LOAD_TIMEOUT: typeof SVTA_PRIMARY_MANIFEST_LOAD_TIMEOUT;
|
|
1477
|
+
/**
|
|
1478
|
+
* Unable to parse track from manifest
|
|
1479
|
+
*/
|
|
1480
|
+
readonly MANIFEST_TRACK_PARSE_ERROR: typeof SVTA_MANIFEST_TRACK_PARSE_ERROR;
|
|
1481
|
+
/**
|
|
1482
|
+
* Secondary manifest / asset list load error
|
|
1483
|
+
*/
|
|
1484
|
+
readonly SECONDARY_MANIFEST_LOAD_ERROR: typeof SVTA_SECONDARY_MANIFEST_LOAD_ERROR;
|
|
1485
|
+
/**
|
|
1486
|
+
* Unable to parse secondary manifest / asset list
|
|
1487
|
+
*/
|
|
1488
|
+
readonly SECONDARY_MANIFEST_PARSE_ERROR: typeof SVTA_SECONDARY_MANIFEST_PARSE_ERROR;
|
|
1489
|
+
/**
|
|
1490
|
+
* Unable to switch tracks
|
|
1491
|
+
*/
|
|
1492
|
+
readonly TRACK_SWITCH_ERROR: typeof SVTA_TRACK_SWITCH_ERROR;
|
|
1493
|
+
/**
|
|
1494
|
+
* Track load error
|
|
1495
|
+
*/
|
|
1496
|
+
readonly TRACK_LOAD_ERROR: typeof SVTA_TRACK_LOAD_ERROR;
|
|
1497
|
+
/**
|
|
1498
|
+
* Remux issue
|
|
1499
|
+
*/
|
|
1500
|
+
readonly REMUX_ERROR: typeof SVTA_REMUX_ERROR;
|
|
1501
|
+
/**
|
|
1502
|
+
* Buffer initialization error
|
|
1503
|
+
*/
|
|
1504
|
+
readonly BUFFER_INITIALIZATION_ERROR: typeof SVTA_BUFFER_INITIALIZATION_ERROR;
|
|
1505
|
+
/**
|
|
1506
|
+
* Buffer append error
|
|
1507
|
+
*/
|
|
1508
|
+
readonly BUFFER_APPEND_ERROR: typeof SVTA_BUFFER_APPEND_ERROR;
|
|
1509
|
+
/**
|
|
1510
|
+
* Buffer remove error
|
|
1511
|
+
*/
|
|
1512
|
+
readonly BUFFER_REMOVE_ERROR: typeof SVTA_BUFFER_REMOVE_ERROR;
|
|
1513
|
+
/**
|
|
1514
|
+
* Buffer full error
|
|
1515
|
+
*/
|
|
1516
|
+
readonly BUFFER_FULL_ERROR: typeof SVTA_BUFFER_FULL_ERROR;
|
|
1517
|
+
/**
|
|
1518
|
+
* Buffer seek over hole
|
|
1519
|
+
*/
|
|
1520
|
+
readonly BUFFER_SEEK_OVER_HOLE: typeof SVTA_BUFFER_SEEK_OVER_HOLE;
|
|
1521
|
+
/**
|
|
1522
|
+
* Buffer nudge on stall
|
|
1523
|
+
*/
|
|
1524
|
+
readonly BUFFER_NUDGE_ON_STALL: typeof SVTA_BUFFER_NUDGE_ON_STALL;
|
|
1525
|
+
/**
|
|
1526
|
+
* Out of memory
|
|
1527
|
+
*/
|
|
1528
|
+
readonly OUT_OF_MEMORY: typeof SVTA_OUT_OF_MEMORY;
|
|
1529
|
+
/**
|
|
1530
|
+
* Segment load error
|
|
1531
|
+
*/
|
|
1532
|
+
readonly SEGMENT_LOAD_ERROR: typeof SVTA_SEGMENT_LOAD_ERROR;
|
|
1533
|
+
/**
|
|
1534
|
+
* Segment timeout error
|
|
1535
|
+
*/
|
|
1536
|
+
readonly SEGMENT_TIMEOUT_ERROR: typeof SVTA_SEGMENT_TIMEOUT_ERROR;
|
|
1537
|
+
/**
|
|
1538
|
+
* Initialization segment error
|
|
1539
|
+
*/
|
|
1540
|
+
readonly INITIALIZATION_SEGMENT_ERROR: typeof SVTA_INITIALIZATION_SEGMENT_ERROR;
|
|
1541
|
+
/**
|
|
1542
|
+
* Time sync failed error
|
|
1543
|
+
*/
|
|
1544
|
+
readonly TIME_SYNC_ERROR: typeof SVTA_TIME_SYNC_ERROR;
|
|
1545
|
+
/**
|
|
1546
|
+
* Fragment load error
|
|
1547
|
+
*/
|
|
1548
|
+
readonly FRAGMENT_LOAD_ERROR: typeof SVTA_FRAGMENT_LOAD_ERROR;
|
|
1549
|
+
/**
|
|
1550
|
+
* Fragment timeout error
|
|
1551
|
+
*/
|
|
1552
|
+
readonly FRAGMENT_TIMEOUT_ERROR: typeof SVTA_FRAGMENT_TIMEOUT_ERROR;
|
|
1553
|
+
/**
|
|
1554
|
+
* Live timeshifting content out of bounds
|
|
1555
|
+
*/
|
|
1556
|
+
readonly LIVE_TIMESHIFT_OUT_OF_BOUNDS: typeof SVTA_LIVE_TIMESHIFT_OUT_OF_BOUNDS;
|
|
1557
|
+
/**
|
|
1558
|
+
* Switched to higher latency
|
|
1559
|
+
*/
|
|
1560
|
+
readonly SWITCHED_TO_HIGHER_LATENCY: typeof SVTA_SWITCHED_TO_HIGHER_LATENCY;
|
|
1561
|
+
/**
|
|
1562
|
+
* Unable to switch to fullscreen
|
|
1563
|
+
*/
|
|
1564
|
+
readonly FULLSCREEN_ERROR: typeof SVTA_FULLSCREEN_ERROR;
|
|
1565
|
+
/**
|
|
1566
|
+
* Unable to present picture-in-picture
|
|
1567
|
+
*/
|
|
1568
|
+
readonly PICTURE_IN_PICTURE_ERROR: typeof SVTA_PICTURE_IN_PICTURE_ERROR;
|
|
1569
|
+
/**
|
|
1570
|
+
* Manifest feature unsupported
|
|
1571
|
+
*/
|
|
1572
|
+
readonly MANIFEST_FEATURE_UNSUPPORTED: typeof SVTA_MANIFEST_FEATURE_UNSUPPORTED;
|
|
1573
|
+
/**
|
|
1574
|
+
* Content steering manifest load error
|
|
1575
|
+
*/
|
|
1576
|
+
readonly CONTENT_STEERING_MANIFEST_LOAD_ERROR: typeof SVTA_CONTENT_STEERING_MANIFEST_LOAD_ERROR;
|
|
1577
|
+
/**
|
|
1578
|
+
* Unable to parse content steering manifest
|
|
1579
|
+
*/
|
|
1580
|
+
readonly CONTENT_STEERING_MANIFEST_PARSE_ERROR: typeof SVTA_CONTENT_STEERING_MANIFEST_PARSE_ERROR;
|
|
1581
|
+
};
|
|
1582
|
+
/**
|
|
1583
|
+
* Union type of all {@link (SvtaPlaybackErrorCode:variable)} values.
|
|
1584
|
+
*
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
type SvtaPlaybackErrorCode = ValueOf<typeof SvtaPlaybackErrorCode>;
|
|
1588
|
+
//#endregion
|
|
1589
|
+
//#region src/SvtaRemotePlayErrorCode.d.ts
|
|
1590
|
+
/**
|
|
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
|
+
*/
|
|
1664
|
+
readonly UNKNOWN: typeof SVTA_REMOTE_PLAY_UNKNOWN;
|
|
1665
|
+
/**
|
|
1666
|
+
* Sender unable to initialize remote play
|
|
1667
|
+
*/
|
|
1668
|
+
readonly SENDER_INITIALIZATION_ERROR: typeof SVTA_SENDER_INITIALIZATION_ERROR;
|
|
1669
|
+
/**
|
|
1670
|
+
* Sender unable to make a connection to the receiver
|
|
1671
|
+
*/
|
|
1672
|
+
readonly SENDER_CONNECTION_ERROR: typeof SVTA_SENDER_CONNECTION_ERROR;
|
|
1673
|
+
/**
|
|
1674
|
+
* Receiver does not exist or is unavailable
|
|
1675
|
+
*/
|
|
1676
|
+
readonly RECEIVER_UNAVAILABLE: typeof SVTA_RECEIVER_UNAVAILABLE;
|
|
1677
|
+
/**
|
|
1678
|
+
* Receiver refused remote play connection
|
|
1679
|
+
*/
|
|
1680
|
+
readonly RECEIVER_CONNECTION_REFUSED: typeof SVTA_RECEIVER_CONNECTION_REFUSED;
|
|
1681
|
+
/**
|
|
1682
|
+
* Connection to the receiver lost
|
|
1683
|
+
*/
|
|
1684
|
+
readonly RECEIVER_CONNECTION_LOST: typeof SVTA_RECEIVER_CONNECTION_LOST;
|
|
1685
|
+
/**
|
|
1686
|
+
* Connection to the sender lost
|
|
1687
|
+
*/
|
|
1688
|
+
readonly SENDER_CONNECTION_LOST: typeof SVTA_SENDER_CONNECTION_LOST;
|
|
1689
|
+
/**
|
|
1690
|
+
* Receiver is not supported to playback this stream
|
|
1691
|
+
*/
|
|
1692
|
+
readonly RECEIVER_UNSUPPORTED_STREAM: typeof SVTA_RECEIVER_UNSUPPORTED_STREAM;
|
|
1693
|
+
/**
|
|
1694
|
+
* Receiver is already in remote play
|
|
1695
|
+
*/
|
|
1696
|
+
readonly RECEIVER_ALREADY_IN_REMOTE_PLAY: typeof SVTA_RECEIVER_ALREADY_IN_REMOTE_PLAY;
|
|
1697
|
+
/**
|
|
1698
|
+
* Receiver terminated playback because of an error
|
|
1699
|
+
*/
|
|
1700
|
+
readonly RECEIVER_PLAYBACK_ERROR: typeof SVTA_RECEIVER_PLAYBACK_ERROR;
|
|
1701
|
+
};
|
|
1702
|
+
/**
|
|
1703
|
+
* Union type of all {@link (SvtaRemotePlayErrorCode:variable)} values.
|
|
1704
|
+
*
|
|
1705
|
+
* @public
|
|
1706
|
+
*/
|
|
1707
|
+
type SvtaRemotePlayErrorCode = ValueOf<typeof SvtaRemotePlayErrorCode>;
|
|
1708
|
+
//#endregion
|
|
1709
|
+
//#region src/SvtaUnknownErrorCode.d.ts
|
|
1710
|
+
/**
|
|
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
|
+
*/
|
|
1731
|
+
readonly UNKNOWN: typeof SVTA_UNKNOWN;
|
|
1732
|
+
};
|
|
1733
|
+
/**
|
|
1734
|
+
* Union type of all {@link (SvtaUnknownErrorCode:variable)} values.
|
|
1735
|
+
*
|
|
1736
|
+
* @public
|
|
1737
|
+
*/
|
|
1738
|
+
type SvtaUnknownErrorCode = ValueOf<typeof SvtaUnknownErrorCode>;
|
|
1739
|
+
//#endregion
|
|
1740
|
+
//#region src/SvtaErrorCode.d.ts
|
|
1741
|
+
/**
|
|
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
|
+
*/
|
|
1751
|
+
type SvtaErrorCode = SvtaAccessibilityErrorCode | SvtaAdvertisingErrorCode | SvtaContentProtectionErrorCode | SvtaCustomErrorCode | SvtaMediaContentErrorCode | SvtaNetworkErrorCode | SvtaPlaybackErrorCode | SvtaRemotePlayErrorCode | SvtaUnknownErrorCode;
|
|
1752
|
+
//#endregion
|
|
1753
|
+
//#region src/vastErrorToSvtaErrorCode.d.ts
|
|
1754
|
+
/**
|
|
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;
|
|
1773
|
+
//#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 };
|
|
1775
|
+
//# sourceMappingURL=index.d.ts.map
|