bitmovin-analytics 2.31.2 → 2.32.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/bitmovin-analytics.d.ts
CHANGED
|
@@ -11,6 +11,8 @@ export interface CollectorConfig {
|
|
|
11
11
|
}
|
|
12
12
|
export interface AnalyticsConfig {
|
|
13
13
|
debug?: boolean | AnalyticsDebugConfig;
|
|
14
|
+
deviceType?: string;
|
|
15
|
+
deviceClass?: "Console" | "Desktop" | "Phone" | "STB" | "TV" | "Tablet" | "Wearable" | "Other";
|
|
14
16
|
key?: string;
|
|
15
17
|
playerKey?: string;
|
|
16
18
|
player?: string;
|
|
@@ -280,76 +282,80 @@ export interface VideoStartFailedEvent extends AnalyticsEventBase {
|
|
|
280
282
|
reason: VideoStartFailedReason;
|
|
281
283
|
}
|
|
282
284
|
export interface Sample extends CustomDataValues {
|
|
283
|
-
platform: string;
|
|
284
|
-
sequenceNumber?: number;
|
|
285
|
-
domain?: any;
|
|
286
|
-
path?: string;
|
|
287
|
-
language?: string;
|
|
288
|
-
userAgent?: string;
|
|
289
|
-
screenWidth?: number;
|
|
290
|
-
screenHeight?: number;
|
|
291
|
-
isLive?: boolean;
|
|
292
|
-
isCasting?: boolean;
|
|
293
|
-
castTech?: string;
|
|
294
|
-
videoDuration?: number;
|
|
295
|
-
size?: string;
|
|
296
|
-
time?: number;
|
|
297
|
-
videoWindowWidth?: number;
|
|
298
|
-
videoWindowHeight?: number;
|
|
299
|
-
droppedFrames?: number;
|
|
300
|
-
played?: number;
|
|
301
|
-
buffered?: number;
|
|
302
|
-
paused?: number;
|
|
303
285
|
ad?: number;
|
|
304
|
-
|
|
305
|
-
videoPlaybackWidth?: number;
|
|
306
|
-
videoPlaybackHeight?: number;
|
|
307
|
-
videoBitrate?: number;
|
|
286
|
+
analyticsVersion?: any;
|
|
308
287
|
audioBitrate?: number;
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
288
|
+
audioCodec?: string;
|
|
289
|
+
audioLanguage?: string;
|
|
290
|
+
autoplay?: any;
|
|
291
|
+
buffered?: number;
|
|
292
|
+
castTech?: string;
|
|
293
|
+
cdnProvider?: any;
|
|
294
|
+
completed?: number;
|
|
295
|
+
completedTotal?: number;
|
|
296
|
+
customUserId?: string;
|
|
297
|
+
deviceInformation?: {
|
|
298
|
+
model?: string;
|
|
299
|
+
deviceClass?: string;
|
|
300
|
+
};
|
|
301
|
+
domain?: any;
|
|
302
|
+
downloadSpeedInfo?: DownloadSpeedInfo;
|
|
303
|
+
drmLoadTime?: number;
|
|
304
|
+
drmType?: string;
|
|
305
|
+
droppedFrames?: number;
|
|
312
306
|
duration?: number;
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
307
|
+
errorCode?: any;
|
|
308
|
+
errorData?: string;
|
|
309
|
+
errorMessage?: any;
|
|
310
|
+
errorSegments?: any[];
|
|
311
|
+
impressionId?: string;
|
|
312
|
+
isCasting?: boolean;
|
|
313
|
+
isLive?: boolean;
|
|
318
314
|
isMuted?: boolean;
|
|
319
|
-
|
|
315
|
+
key?: string;
|
|
316
|
+
language?: string;
|
|
320
317
|
m3u8Url?: string;
|
|
321
318
|
mpdUrl?: string;
|
|
322
|
-
|
|
323
|
-
|
|
319
|
+
pageLoadTime: number;
|
|
320
|
+
pageLoadType: number;
|
|
321
|
+
path?: string;
|
|
322
|
+
paused?: number;
|
|
323
|
+
platform: string;
|
|
324
|
+
played?: number;
|
|
324
325
|
player?: any;
|
|
326
|
+
playerKey?: any;
|
|
327
|
+
playerStartupTime: number;
|
|
328
|
+
playerTech?: string;
|
|
329
|
+
progUrl?: string;
|
|
330
|
+
screenHeight?: number;
|
|
331
|
+
screenWidth?: number;
|
|
332
|
+
seeked?: number;
|
|
333
|
+
sequenceNumber?: number;
|
|
334
|
+
size?: string;
|
|
335
|
+
startupTime?: number;
|
|
325
336
|
state?: string;
|
|
326
|
-
|
|
337
|
+
streamFormat?: string;
|
|
338
|
+
subtitleEnabled?: boolean;
|
|
339
|
+
subtitleLanguage?: string;
|
|
340
|
+
supportedVideoCodecs?: string[];
|
|
341
|
+
time?: number;
|
|
342
|
+
userAgent?: string;
|
|
327
343
|
userId?: string;
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
344
|
+
version?: string;
|
|
345
|
+
videoBitrate?: number;
|
|
346
|
+
videoCodec?: string;
|
|
347
|
+
videoDuration?: number;
|
|
348
|
+
videoId?: string;
|
|
349
|
+
videoPlaybackHeight?: number;
|
|
350
|
+
videoPlaybackWidth?: number;
|
|
331
351
|
videoStartFailed?: boolean;
|
|
332
352
|
videoStartFailedReason?: string;
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
playerKey?: any;
|
|
337
|
-
cdnProvider?: any;
|
|
338
|
-
videoId?: string;
|
|
353
|
+
videoStartupTime?: number;
|
|
354
|
+
videoTimeEnd?: number;
|
|
355
|
+
videoTimeStart?: number;
|
|
339
356
|
videoTitle?: string;
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
drmLoadTime?: number;
|
|
343
|
-
subtitleEnabled?: boolean;
|
|
344
|
-
subtitleLanguage?: string;
|
|
345
|
-
downloadSpeedInfo?: DownloadSpeedInfo;
|
|
346
|
-
errorSegments?: any[];
|
|
347
|
-
audioCodec?: string;
|
|
348
|
-
videoCodec?: string;
|
|
349
|
-
supportedVideoCodecs?: string[];
|
|
350
|
-
audioLanguage?: string;
|
|
351
|
-
completed?: number;
|
|
352
|
-
completedTotal?: number;
|
|
357
|
+
videoWindowHeight?: number;
|
|
358
|
+
videoWindowWidth?: number;
|
|
353
359
|
}
|
|
354
360
|
export interface StateMachineCallbacks {
|
|
355
361
|
setup: (duration: number, state: string) => void;
|
|
@@ -459,15 +465,6 @@ export interface ErrorDetailTrackingSettingsProvider {
|
|
|
459
465
|
readonly impressionId: string;
|
|
460
466
|
readonly collectorConfig?: CollectorConfig;
|
|
461
467
|
}
|
|
462
|
-
export interface CastClientConfig {
|
|
463
|
-
config: any;
|
|
464
|
-
domain: any;
|
|
465
|
-
path: string;
|
|
466
|
-
language: string;
|
|
467
|
-
userAgent: string;
|
|
468
|
-
impressionId: string;
|
|
469
|
-
userId: string;
|
|
470
|
-
}
|
|
471
468
|
export interface Backend {
|
|
472
469
|
sendRequest(sample: Sample): any;
|
|
473
470
|
sendUnloadRequest(sample: Sample): any;
|
|
@@ -492,9 +489,6 @@ declare class BackendFactory {
|
|
|
492
489
|
declare class Analytics {
|
|
493
490
|
get version(): string;
|
|
494
491
|
static version: string;
|
|
495
|
-
static LICENSE_CALL_PENDING_TIMEOUT: number;
|
|
496
|
-
static PAGE_LOAD_TYPE_TIMEOUT: number;
|
|
497
|
-
static CAST_RECEIVER_CONFIG_MESSAGE: string;
|
|
498
492
|
pageLoadTime: number;
|
|
499
493
|
playerStartupTime: number;
|
|
500
494
|
videoStartupTime: number;
|
|
@@ -519,11 +513,9 @@ declare class Analytics {
|
|
|
519
513
|
version: string;
|
|
520
514
|
playerTech: string;
|
|
521
515
|
};
|
|
522
|
-
updateSamplesToCastClientConfig(samples: Sample[], castClientConfig: CastClientConfig): void;
|
|
523
|
-
updateSampleToCastClientConfig(sample: Sample, castClientConfig: CastClientConfig): void;
|
|
524
516
|
init(): void;
|
|
525
517
|
release(): void;
|
|
526
|
-
setConfigParameters(
|
|
518
|
+
setConfigParameters(): void;
|
|
527
519
|
generateNewImpressionId(): void;
|
|
528
520
|
setUserId(): void;
|
|
529
521
|
setupStateMachineCallbacks(): void;
|