@amplitude/analytics-browser 2.46.0-video-analytics-2.0 → 2.46.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/README.md +1 -1
- package/lib/cjs/browser-client.js +1 -1
- package/lib/cjs/browser-client.js.map +1 -1
- package/lib/cjs/config.d.ts +2 -10
- package/lib/cjs/config.d.ts.map +1 -1
- package/lib/cjs/config.js +4 -30
- package/lib/cjs/config.js.map +1 -1
- package/lib/cjs/constants.d.ts +0 -2
- package/lib/cjs/constants.d.ts.map +1 -1
- package/lib/cjs/constants.js +1 -3
- package/lib/cjs/constants.js.map +1 -1
- package/lib/cjs/version.d.ts +1 -1
- package/lib/cjs/version.d.ts.map +1 -1
- package/lib/cjs/version.js +1 -1
- package/lib/cjs/version.js.map +1 -1
- package/lib/cjs/video-capture/video-capture.d.ts +10 -32
- package/lib/cjs/video-capture/video-capture.d.ts.map +1 -1
- package/lib/cjs/video-capture/video-capture.js +14 -91
- package/lib/cjs/video-capture/video-capture.js.map +1 -1
- package/lib/esm/browser-client.js +1 -1
- package/lib/esm/browser-client.js.map +1 -1
- package/lib/esm/config.d.ts +2 -10
- package/lib/esm/config.d.ts.map +1 -1
- package/lib/esm/config.js +3 -28
- package/lib/esm/config.js.map +1 -1
- package/lib/esm/constants.d.ts +0 -2
- package/lib/esm/constants.d.ts.map +1 -1
- package/lib/esm/constants.js +0 -2
- package/lib/esm/constants.js.map +1 -1
- package/lib/esm/version.d.ts +1 -1
- package/lib/esm/version.d.ts.map +1 -1
- package/lib/esm/version.js +1 -1
- package/lib/esm/version.js.map +1 -1
- package/lib/esm/video-capture/video-capture.d.ts +10 -32
- package/lib/esm/video-capture/video-capture.d.ts.map +1 -1
- package/lib/esm/video-capture/video-capture.js +15 -92
- package/lib/esm/video-capture/video-capture.js.map +1 -1
- package/lib/scripts/amplitude-bookmarklet-snippet-min.js +1 -1
- package/lib/scripts/amplitude-bookmarklet.html +1 -1
- package/lib/scripts/amplitude-gtm-min.js +1 -1
- package/lib/scripts/amplitude-gtm-min.js.gz +0 -0
- package/lib/scripts/amplitude-gtm-min.js.map +1 -1
- package/lib/scripts/amplitude-gtm-snippet-min.js +1 -1
- package/lib/scripts/amplitude-min.js +1 -1
- package/lib/scripts/amplitude-min.js.gz +0 -0
- package/lib/scripts/amplitude-min.js.map +1 -1
- package/lib/scripts/amplitude-min.umd.js +1 -1
- package/lib/scripts/amplitude-min.umd.js.gz +0 -0
- package/lib/scripts/amplitude-snippet-instructions.html +1 -1
- package/lib/scripts/amplitude-snippet-min.js +1 -1
- package/lib/scripts/config.d.ts +2 -10
- package/lib/scripts/config.d.ts.map +1 -1
- package/lib/scripts/constants.d.ts +0 -2
- package/lib/scripts/constants.d.ts.map +1 -1
- package/lib/scripts/version.d.ts +1 -1
- package/lib/scripts/version.d.ts.map +1 -1
- package/lib/scripts/video-capture/video-capture.d.ts +10 -32
- package/lib/scripts/video-capture/video-capture.d.ts.map +1 -1
- package/package.json +9 -9
package/lib/cjs/constants.js
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DEFAULT_SERVER_ZONE = exports.DEFAULT_IDENTITY_STORAGE = exports.FORM_DESTINATION = exports.FORM_NAME = exports.FORM_ID = exports.LINK_URL = exports.LINK_TEXT = exports.LINK_ID = exports.FILE_NAME = exports.FILE_EXTENSION = exports.DEFAULT_SESSION_END_EVENT = exports.DEFAULT_SESSION_START_EVENT = exports.
|
|
3
|
+
exports.DEFAULT_SERVER_ZONE = exports.DEFAULT_IDENTITY_STORAGE = exports.FORM_DESTINATION = exports.FORM_NAME = exports.FORM_ID = exports.LINK_URL = exports.LINK_TEXT = exports.LINK_ID = exports.FILE_NAME = exports.FILE_EXTENSION = exports.DEFAULT_SESSION_END_EVENT = exports.DEFAULT_SESSION_START_EVENT = exports.DEFAULT_FILE_DOWNLOAD_EVENT = exports.DEFAULT_FORM_SUBMIT_EVENT = exports.DEFAULT_FORM_START_EVENT = exports.DEFAULT_PAGE_VIEW_EVENT = exports.DEFAULT_EVENT_PREFIX = void 0;
|
|
4
4
|
exports.DEFAULT_EVENT_PREFIX = '[Amplitude]';
|
|
5
5
|
exports.DEFAULT_PAGE_VIEW_EVENT = "".concat(exports.DEFAULT_EVENT_PREFIX, " Page Viewed");
|
|
6
6
|
exports.DEFAULT_FORM_START_EVENT = "".concat(exports.DEFAULT_EVENT_PREFIX, " Form Started");
|
|
7
7
|
exports.DEFAULT_FORM_SUBMIT_EVENT = "".concat(exports.DEFAULT_EVENT_PREFIX, " Form Submitted");
|
|
8
8
|
exports.DEFAULT_FILE_DOWNLOAD_EVENT = "".concat(exports.DEFAULT_EVENT_PREFIX, " File Downloaded");
|
|
9
|
-
exports.DEFAULT_CONTENT_STARTED_EVENT = "".concat(exports.DEFAULT_EVENT_PREFIX, " Content Started");
|
|
10
|
-
exports.DEFAULT_CONTENT_STOPPED_EVENT = "".concat(exports.DEFAULT_EVENT_PREFIX, " Content Stopped");
|
|
11
9
|
exports.DEFAULT_SESSION_START_EVENT = 'session_start';
|
|
12
10
|
exports.DEFAULT_SESSION_END_EVENT = 'session_end';
|
|
13
11
|
exports.FILE_EXTENSION = "".concat(exports.DEFAULT_EVENT_PREFIX, " File Extension");
|
package/lib/cjs/constants.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG,aAAa,CAAC;AAErC,QAAA,uBAAuB,GAAG,UAAG,4BAAoB,iBAAc,CAAC;AAChE,QAAA,wBAAwB,GAAG,UAAG,4BAAoB,kBAAe,CAAC;AAClE,QAAA,yBAAyB,GAAG,UAAG,4BAAoB,oBAAiB,CAAC;AACrE,QAAA,2BAA2B,GAAG,UAAG,4BAAoB,qBAAkB,CAAC;AACxE,QAAA,
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG,aAAa,CAAC;AAErC,QAAA,uBAAuB,GAAG,UAAG,4BAAoB,iBAAc,CAAC;AAChE,QAAA,wBAAwB,GAAG,UAAG,4BAAoB,kBAAe,CAAC;AAClE,QAAA,yBAAyB,GAAG,UAAG,4BAAoB,oBAAiB,CAAC;AACrE,QAAA,2BAA2B,GAAG,UAAG,4BAAoB,qBAAkB,CAAC;AACxE,QAAA,2BAA2B,GAAG,eAAe,CAAC;AAC9C,QAAA,yBAAyB,GAAG,aAAa,CAAC;AAE1C,QAAA,cAAc,GAAG,UAAG,4BAAoB,oBAAiB,CAAC;AAC1D,QAAA,SAAS,GAAG,UAAG,4BAAoB,eAAY,CAAC;AAChD,QAAA,OAAO,GAAG,UAAG,4BAAoB,aAAU,CAAC;AAC5C,QAAA,SAAS,GAAG,UAAG,4BAAoB,eAAY,CAAC;AAChD,QAAA,QAAQ,GAAG,UAAG,4BAAoB,cAAW,CAAC;AAE9C,QAAA,OAAO,GAAG,UAAG,4BAAoB,aAAU,CAAC;AAC5C,QAAA,SAAS,GAAG,UAAG,4BAAoB,eAAY,CAAC;AAChD,QAAA,gBAAgB,GAAG,UAAG,4BAAoB,sBAAmB,CAAC;AAE9D,QAAA,wBAAwB,GAAwB,QAAQ,CAAC;AACzD,QAAA,mBAAmB,GAAmB,IAAI,CAAC","sourcesContent":["import { IdentityStorageType, ServerZoneType } from '@amplitude/analytics-core';\n\nexport const DEFAULT_EVENT_PREFIX = '[Amplitude]';\n\nexport const DEFAULT_PAGE_VIEW_EVENT = `${DEFAULT_EVENT_PREFIX} Page Viewed`;\nexport const DEFAULT_FORM_START_EVENT = `${DEFAULT_EVENT_PREFIX} Form Started`;\nexport const DEFAULT_FORM_SUBMIT_EVENT = `${DEFAULT_EVENT_PREFIX} Form Submitted`;\nexport const DEFAULT_FILE_DOWNLOAD_EVENT = `${DEFAULT_EVENT_PREFIX} File Downloaded`;\nexport const DEFAULT_SESSION_START_EVENT = 'session_start';\nexport const DEFAULT_SESSION_END_EVENT = 'session_end';\n\nexport const FILE_EXTENSION = `${DEFAULT_EVENT_PREFIX} File Extension`;\nexport const FILE_NAME = `${DEFAULT_EVENT_PREFIX} File Name`;\nexport const LINK_ID = `${DEFAULT_EVENT_PREFIX} Link ID`;\nexport const LINK_TEXT = `${DEFAULT_EVENT_PREFIX} Link Text`;\nexport const LINK_URL = `${DEFAULT_EVENT_PREFIX} Link URL`;\n\nexport const FORM_ID = `${DEFAULT_EVENT_PREFIX} Form ID`;\nexport const FORM_NAME = `${DEFAULT_EVENT_PREFIX} Form Name`;\nexport const FORM_DESTINATION = `${DEFAULT_EVENT_PREFIX} Form Destination`;\n\nexport const DEFAULT_IDENTITY_STORAGE: IdentityStorageType = 'cookie';\nexport const DEFAULT_SERVER_ZONE: ServerZoneType = 'US';\n"]}
|
package/lib/cjs/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "2.46.0
|
|
1
|
+
export declare const VERSION = "2.46.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/lib/cjs/version.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
|
package/lib/cjs/version.js
CHANGED
package/lib/cjs/version.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC","sourcesContent":["export const VERSION = '2.46.0';\n"]}
|
|
@@ -1,24 +1,20 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BrowserClient, EmbeddedVideoPlayer, VideoVendor } from '@amplitude/analytics-core';
|
|
2
2
|
export declare class VideoCapture {
|
|
3
3
|
private readonly amplitude;
|
|
4
4
|
private videoEl;
|
|
5
|
-
private heartbeat;
|
|
6
5
|
private embeddedVideoPlayer;
|
|
7
6
|
private vendor?;
|
|
8
7
|
private extraEventProperties;
|
|
9
|
-
private stopEvent;
|
|
10
8
|
private listeners;
|
|
11
9
|
private onRemoveListeners;
|
|
12
|
-
private playId;
|
|
13
|
-
private playStartTime;
|
|
14
10
|
constructor(amplitude: BrowserClient);
|
|
15
11
|
/**
|
|
16
|
-
* Specify a video
|
|
12
|
+
* Specify a video element to capture events from
|
|
17
13
|
*
|
|
18
|
-
* @param videoEl - The HTML video
|
|
14
|
+
* @param videoEl - The HTML video element to capture events from.
|
|
19
15
|
* @returns The VideoCapture instance.
|
|
20
16
|
*/
|
|
21
|
-
withVideoElement(videoEl:
|
|
17
|
+
withVideoElement(videoEl: HTMLVideoElement): VideoCapture;
|
|
22
18
|
/**
|
|
23
19
|
* Specify an embedded video player.js instance to capture events from
|
|
24
20
|
* @param player - The embedded video player.js instance to capture events from.
|
|
@@ -40,40 +36,22 @@ export declare class VideoCapture {
|
|
|
40
36
|
*/
|
|
41
37
|
withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture;
|
|
42
38
|
/**
|
|
43
|
-
* Track a "
|
|
39
|
+
* Track a "Video Content Started" event every time the video starts playing
|
|
44
40
|
* @returns The VideoCapture instance.
|
|
45
41
|
*/
|
|
46
42
|
captureVideoStarted(): VideoCapture;
|
|
47
43
|
/**
|
|
48
|
-
* Track a "
|
|
44
|
+
* Track a "Video Content Stopped" event every time the video stops playing
|
|
49
45
|
* @returns The VideoCapture instance.
|
|
50
46
|
*/
|
|
51
47
|
captureVideoStopped(): VideoCapture;
|
|
52
|
-
/**
|
|
53
|
-
* End the current play session by ingesting its queued delayed stop event immediately.
|
|
54
|
-
*
|
|
55
|
-
* The heartbeat is shared by every capture on the same Amplitude client, so the event is
|
|
56
|
-
* flushed rather than the heartbeat stopped, which would discard other captures' events.
|
|
57
|
-
* Flushing also drops the event from the heartbeat queue once ingested, so the interval
|
|
58
|
-
* winds down on its own. No-op when no play session is in progress.
|
|
59
|
-
*/
|
|
60
|
-
private flushStopEvent;
|
|
61
48
|
/**
|
|
62
49
|
* Start capturing analytics events for the video element
|
|
63
50
|
* @returns The VideoCapture instance.
|
|
64
51
|
* @throws An error if the video element is not specified.
|
|
65
52
|
*/
|
|
66
53
|
start(): VideoCapture;
|
|
67
|
-
/**
|
|
68
|
-
* Stop capturing analytics events for the video element.
|
|
69
|
-
*
|
|
70
|
-
* Observers are detached first so no playback state change can race with the final
|
|
71
|
-
* event, then any in-progress play session is closed out.
|
|
72
|
-
*/
|
|
73
54
|
stop(): void;
|
|
74
|
-
parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean>;
|
|
75
|
-
private getDeliveryMode;
|
|
76
|
-
parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean>;
|
|
77
55
|
}
|
|
78
56
|
export type VideoCaptureOptions = {
|
|
79
57
|
vendor?: VideoVendor;
|
|
@@ -82,16 +60,16 @@ export type VideoCaptureOptions = {
|
|
|
82
60
|
type UntrackVideoResult = () => void;
|
|
83
61
|
export type TrackVideoResult = UntrackVideoResult | Error;
|
|
84
62
|
/**
|
|
85
|
-
* Track video analytics events for an HTML video
|
|
63
|
+
* Track video analytics events for an HTML video element or embedded video player.js instance.
|
|
86
64
|
*
|
|
87
|
-
* Captures
|
|
65
|
+
* Captures Video Started and Video Stopped events.
|
|
88
66
|
*
|
|
89
67
|
* @experimental This function is experimental and may not be stable.
|
|
90
68
|
* @param amplitude - The Amplitude client instance.
|
|
91
|
-
* @param videoEl - The HTML video
|
|
69
|
+
* @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
|
|
92
70
|
* @param options - The options for the video capture.
|
|
93
71
|
* @returns A function to stop the video capture.
|
|
94
72
|
*/
|
|
95
|
-
export declare function trackVideo(amplitude: BrowserClient, videoEl:
|
|
73
|
+
export declare function trackVideo(amplitude: BrowserClient, videoEl: HTMLVideoElement | EmbeddedVideoPlayer, options?: VideoCaptureOptions): TrackVideoResult;
|
|
96
74
|
export {};
|
|
97
75
|
//# sourceMappingURL=video-capture.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"video-capture.d.ts","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"video-capture.d.ts","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EACb,mBAAmB,EACnB,WAAW,EAEZ,MAAM,2BAA2B,CAAC;AAEnC,qBAAa,YAAY;IASX,OAAO,CAAC,QAAQ,CAAC,SAAS;IARtC,OAAO,CAAC,OAAO,CAAiC;IAChD,OAAO,CAAC,mBAAmB,CAAoC;IAC/D,OAAO,CAAC,MAAM,CAAC,CAAc;IAC7B,OAAO,CAAC,oBAAoB,CAAiD;IAE7E,OAAO,CAAC,SAAS,CAAsE;IACvF,OAAO,CAAC,iBAAiB,CAAsB;gBAElB,SAAS,EAAE,aAAa;IAErD;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,YAAY;IAKzD;;;;OAIG;IACH,kBAAkB,CAAC,MAAM,EAAE,mBAAmB,GAAG,YAAY;IAK7D;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY;IAK7C;;;;;OAKG;IACH,wBAAwB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,YAAY;IAK7F;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAanC;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAkBnC;;;;OAIG;IACH,KAAK,IAAI,YAAY;IA2BrB,IAAI;CAIL;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CAClE,CAAC;AAEF,KAAK,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAErC,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,GAAG,KAAK,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,SAAS,EAAE,aAAa,EACxB,OAAO,EAAE,gBAAgB,GAAG,mBAAmB,EAC/C,OAAO,GAAE,mBAAwB,GAChC,gBAAgB,CA0BlB"}
|
|
@@ -3,26 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.trackVideo = exports.VideoCapture = void 0;
|
|
4
4
|
var tslib_1 = require("tslib");
|
|
5
5
|
var analytics_core_1 = require("@amplitude/analytics-core");
|
|
6
|
-
var constants_1 = require("../constants");
|
|
7
|
-
/** Playback states where a view session is still in progress (e.g. buffering). */
|
|
8
|
-
var ACTIVE_PLAYBACK_STATES = new Set(['playing', 'waiting']);
|
|
9
6
|
var VideoCapture = /** @class */ (function () {
|
|
10
7
|
function VideoCapture(amplitude) {
|
|
11
8
|
this.amplitude = amplitude;
|
|
12
9
|
this.videoEl = null;
|
|
13
10
|
this.embeddedVideoPlayer = null;
|
|
14
11
|
this.extraEventProperties = {};
|
|
15
|
-
this.stopEvent = null;
|
|
16
12
|
this.listeners = [];
|
|
17
13
|
this.onRemoveListeners = [];
|
|
18
|
-
this.playId = null;
|
|
19
|
-
this.playStartTime = null;
|
|
20
|
-
this.heartbeat = (0, analytics_core_1.getHeartbeatInstance)(this.amplitude);
|
|
21
14
|
}
|
|
22
15
|
/**
|
|
23
|
-
* Specify a video
|
|
16
|
+
* Specify a video element to capture events from
|
|
24
17
|
*
|
|
25
|
-
* @param videoEl - The HTML video
|
|
18
|
+
* @param videoEl - The HTML video element to capture events from.
|
|
26
19
|
* @returns The VideoCapture instance.
|
|
27
20
|
*/
|
|
28
21
|
VideoCapture.prototype.withVideoElement = function (videoEl) {
|
|
@@ -59,71 +52,33 @@ var VideoCapture = /** @class */ (function () {
|
|
|
59
52
|
return this;
|
|
60
53
|
};
|
|
61
54
|
/**
|
|
62
|
-
* Track a "
|
|
55
|
+
* Track a "Video Content Started" event every time the video starts playing
|
|
63
56
|
* @returns The VideoCapture instance.
|
|
64
57
|
*/
|
|
65
58
|
VideoCapture.prototype.captureVideoStarted = function () {
|
|
66
59
|
var _this = this;
|
|
67
60
|
this.listeners.push(function (previousState, nextState) {
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
_this.
|
|
71
|
-
/* istanbul ignore next */
|
|
72
|
-
_this.playStartTime = (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.start_time) !== null && _b !== void 0 ? _b : 0;
|
|
73
|
-
var now = new Date().getTime();
|
|
74
|
-
var startEvent = {
|
|
75
|
-
insert_id: (0, analytics_core_1.UUID)(),
|
|
76
|
-
event_type: constants_1.DEFAULT_CONTENT_STARTED_EVENT,
|
|
77
|
-
time: now,
|
|
78
|
-
event_properties: tslib_1.__assign(tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, nextState.lastEvent), _this.parseStartEventProperties(nextState)), _this.extraEventProperties), { play_id: _this.playId }),
|
|
79
|
-
};
|
|
80
|
-
_this.stopEvent = tslib_1.__assign(tslib_1.__assign({}, startEvent), { insert_id: (0, analytics_core_1.UUID)(), event_type: constants_1.DEFAULT_CONTENT_STOPPED_EVENT, time: now + 1, event_properties: tslib_1.__assign(tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, nextState.lastEvent), _this.parseStopEventProperties(nextState)), _this.extraEventProperties), { stop_reason: 'timeout', play_id: _this.playId }) });
|
|
81
|
-
_this.heartbeat.trackNoDelay(startEvent).catch(_this.stop.bind(_this));
|
|
82
|
-
_this.heartbeat.track(_this.stopEvent).catch(_this.stop.bind(_this));
|
|
61
|
+
if (previousState.playbackState !== 'playing' && nextState.playbackState === 'playing') {
|
|
62
|
+
// TODO: placeholder for Heartbeat Start Event
|
|
63
|
+
_this.amplitude.track('Video Content Started', tslib_1.__assign(tslib_1.__assign({}, nextState.lastEvent), _this.extraEventProperties));
|
|
83
64
|
}
|
|
84
65
|
});
|
|
85
66
|
return this;
|
|
86
67
|
};
|
|
87
68
|
/**
|
|
88
|
-
* Track a "
|
|
69
|
+
* Track a "Video Content Stopped" event every time the video stops playing
|
|
89
70
|
* @returns The VideoCapture instance.
|
|
90
71
|
*/
|
|
91
72
|
VideoCapture.prototype.captureVideoStopped = function () {
|
|
92
73
|
var _this = this;
|
|
93
74
|
this.listeners.push(function (previousState, nextState) {
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
_this.stopEvent.event_properties = tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, _this.stopEvent.event_properties), _this.parseStopEventProperties(nextState)), _this.extraEventProperties);
|
|
98
|
-
_this.stopEvent.time = new Date().getTime();
|
|
99
|
-
void _this.heartbeat.update(_this.stopEvent);
|
|
100
|
-
}
|
|
101
|
-
if (ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) &&
|
|
102
|
-
!ACTIVE_PLAYBACK_STATES.has(nextState.playbackState)) {
|
|
103
|
-
_this.flushStopEvent(nextState.playbackState);
|
|
75
|
+
if (previousState.playbackState === 'playing' && nextState.playbackState !== 'playing') {
|
|
76
|
+
// placeholder for Heartbeat Stop Event
|
|
77
|
+
_this.amplitude.track('Video Content Stopped', tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, nextState.lastEvent), { watch_duration: nextState.watchTime }), _this.extraEventProperties));
|
|
104
78
|
}
|
|
105
79
|
});
|
|
106
80
|
return this;
|
|
107
81
|
};
|
|
108
|
-
/**
|
|
109
|
-
* End the current play session by ingesting its queued delayed stop event immediately.
|
|
110
|
-
*
|
|
111
|
-
* The heartbeat is shared by every capture on the same Amplitude client, so the event is
|
|
112
|
-
* flushed rather than the heartbeat stopped, which would discard other captures' events.
|
|
113
|
-
* Flushing also drops the event from the heartbeat queue once ingested, so the interval
|
|
114
|
-
* winds down on its own. No-op when no play session is in progress.
|
|
115
|
-
*/
|
|
116
|
-
VideoCapture.prototype.flushStopEvent = function (stopReason) {
|
|
117
|
-
var stopEvent = this.stopEvent;
|
|
118
|
-
if (!stopEvent) {
|
|
119
|
-
return;
|
|
120
|
-
}
|
|
121
|
-
// the next play queues a fresh delayed stop event
|
|
122
|
-
this.stopEvent = null;
|
|
123
|
-
this.playStartTime = null;
|
|
124
|
-
stopEvent.event_properties = tslib_1.__assign(tslib_1.__assign({}, stopEvent.event_properties), { stop_reason: stopReason });
|
|
125
|
-
this.heartbeat.trackNoDelay(stopEvent).catch(this.stop.bind(this));
|
|
126
|
-
};
|
|
127
82
|
// Placeholder: may need a generic state change listener to capture unusual events or to have
|
|
128
83
|
// more control over the event tracking.
|
|
129
84
|
// withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {
|
|
@@ -155,53 +110,21 @@ var VideoCapture = /** @class */ (function () {
|
|
|
155
110
|
});
|
|
156
111
|
return this;
|
|
157
112
|
};
|
|
158
|
-
/**
|
|
159
|
-
* Stop capturing analytics events for the video element.
|
|
160
|
-
*
|
|
161
|
-
* Observers are detached first so no playback state change can race with the final
|
|
162
|
-
* event, then any in-progress play session is closed out.
|
|
163
|
-
*/
|
|
164
113
|
VideoCapture.prototype.stop = function () {
|
|
165
114
|
this.onRemoveListeners.forEach(function (listener) { return listener(); });
|
|
166
115
|
this.onRemoveListeners = [];
|
|
167
|
-
this.flushStopEvent('untracked');
|
|
168
|
-
};
|
|
169
|
-
VideoCapture.prototype.parseStartEventProperties = function (nextState) {
|
|
170
|
-
var _a, _b, _c, _d, _e;
|
|
171
|
-
return {
|
|
172
|
-
duration: (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.duration) !== null && _b !== void 0 ? _b : 0,
|
|
173
|
-
start_time: (_d = (_c = nextState.lastEvent) === null || _c === void 0 ? void 0 : _c.start_time) !== null && _d !== void 0 ? _d : 0,
|
|
174
|
-
position: (_e = nextState.position) !== null && _e !== void 0 ? _e : 0,
|
|
175
|
-
delivery_mode: this.getDeliveryMode(),
|
|
176
|
-
};
|
|
177
|
-
};
|
|
178
|
-
VideoCapture.prototype.getDeliveryMode = function () {
|
|
179
|
-
return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';
|
|
180
|
-
};
|
|
181
|
-
VideoCapture.prototype.parseStopEventProperties = function (nextState) {
|
|
182
|
-
var _a, _b, _c, _d, _e, _f, _g;
|
|
183
|
-
return tslib_1.__assign(tslib_1.__assign({}, this.parseStartEventProperties(nextState)), {
|
|
184
|
-
// lastEvent.start_time is the playhead at the time of the event, which for a stop event is
|
|
185
|
-
// where playback ended, so the position captured when the play session began is preferred.
|
|
186
|
-
start_time: (_c = (_a = this.playStartTime) !== null && _a !== void 0 ? _a : (_b = nextState.lastEvent) === null || _b === void 0 ? void 0 : _b.start_time) !== null && _c !== void 0 ? _c : 0, watch_duration: (_d = nextState.watchTime) !== null && _d !== void 0 ? _d : 0, percent_completed: calculatePercentCompleted((_e = nextState.position) !== null && _e !== void 0 ? _e : 0, (_g = (_f = nextState.lastEvent) === null || _f === void 0 ? void 0 : _f.duration) !== null && _g !== void 0 ? _g : 0) });
|
|
187
116
|
};
|
|
188
117
|
return VideoCapture;
|
|
189
118
|
}());
|
|
190
119
|
exports.VideoCapture = VideoCapture;
|
|
191
|
-
function calculatePercentCompleted(currentTime, duration) {
|
|
192
|
-
if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {
|
|
193
|
-
return 0;
|
|
194
|
-
}
|
|
195
|
-
return Math.min(100, Math.max(0, (currentTime / duration) * 100));
|
|
196
|
-
}
|
|
197
120
|
/**
|
|
198
|
-
* Track video analytics events for an HTML video
|
|
121
|
+
* Track video analytics events for an HTML video element or embedded video player.js instance.
|
|
199
122
|
*
|
|
200
|
-
* Captures
|
|
123
|
+
* Captures Video Started and Video Stopped events.
|
|
201
124
|
*
|
|
202
125
|
* @experimental This function is experimental and may not be stable.
|
|
203
126
|
* @param amplitude - The Amplitude client instance.
|
|
204
|
-
* @param videoEl - The HTML video
|
|
127
|
+
* @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
|
|
205
128
|
* @param options - The options for the video capture.
|
|
206
129
|
* @returns A function to stop the video capture.
|
|
207
130
|
*/
|
|
@@ -209,7 +132,7 @@ function trackVideo(amplitude, videoEl, options) {
|
|
|
209
132
|
var _a;
|
|
210
133
|
if (options === void 0) { options = {}; }
|
|
211
134
|
var videoCapture = new VideoCapture(amplitude);
|
|
212
|
-
if (videoEl instanceof
|
|
135
|
+
if (videoEl instanceof HTMLVideoElement) {
|
|
213
136
|
videoCapture.withVideoElement(videoEl);
|
|
214
137
|
}
|
|
215
138
|
else {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"video-capture.js","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":";;;;AAAA,4DASmC;AACnC,0CAA4F;AAE5F,kFAAkF;AAClF,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAA8B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAE5F;IAYE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAX7C,YAAO,GAA4B,IAAI,CAAC;QAExC,wBAAmB,GAA+B,IAAI,CAAC;QAEvD,yBAAoB,GAA8C,EAAE,CAAC;QACrE,cAAS,GAAqB,IAAI,CAAC;QACnC,cAAS,GAAmE,EAAE,CAAC;QAC/E,sBAAiB,GAAmB,EAAE,CAAC;QACvC,WAAM,GAAkB,IAAI,CAAC;QAC7B,kBAAa,GAAkB,IAAI,CAAC;QAG1C,IAAI,CAAC,SAAS,GAAG,IAAA,qCAAoB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,uCAAgB,GAAhB,UAAiB,OAAyB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,yCAAkB,GAAlB,UAAmB,MAA2B;QAC5C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAU,GAAV,UAAW,MAAmB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,+CAAwB,GAAxB,UAAyB,UAAqD;QAC5E,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAoCC;QAnCC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;;YAC3C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACrG,KAAI,CAAC,MAAM,GAAG,IAAA,qBAAI,GAAE,CAAC;gBACrB,0BAA0B;gBAC1B,KAAI,CAAC,aAAa,GAAG,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC,CAAC;gBAC1D,IAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAM,UAAU,GAAc;oBAC5B,SAAS,EAAE,IAAA,qBAAI,GAAE;oBACjB,UAAU,EAAE,yCAA6B;oBACzC,IAAI,EAAE,GAAG;oBACT,gBAAgB,0EACX,SAAS,CAAC,SAAS,GACnB,KAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,GACzC,KAAI,CAAC,oBAAoB,KAC5B,OAAO,EAAE,KAAI,CAAC,MAAM,GACrB;iBACF,CAAC;gBACF,KAAI,CAAC,SAAS,yCACT,UAAU,KACb,SAAS,EAAE,IAAA,qBAAI,GAAE,EACjB,UAAU,EAAE,yCAA6B,EACzC,IAAI,EAAE,GAAG,GAAG,CAAC,EACb,gBAAgB,0EACX,SAAS,CAAC,SAAS,GACnB,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,KAC5B,WAAW,EAAE,SAAS,EACtB,OAAO,EAAE,KAAI,CAAC,MAAM,MAEvB,CAAC;gBACF,KAAI,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,KAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,CAAC;gBACpE,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,CAAC;aAClE;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAqBC;QApBC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,8CAA8C;YAC9C,6BAA6B;YAC7B,IAAI,KAAI,CAAC,SAAS,EAAE;gBAClB,KAAI,CAAC,SAAS,CAAC,gBAAgB,0DAC1B,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAC/B,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,CAC7B,CAAC;gBACF,KAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC3C,KAAK,KAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;aAC5C;YACD,IACE,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,CAAC;gBACvD,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,EACpD;gBACA,KAAI,CAAC,cAAc,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACK,qCAAc,GAAtB,UAAuB,UAAkB;QACvC,IAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QACD,kDAAkD;QAClD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,SAAS,CAAC,gBAAgB,yCACrB,SAAS,CAAC,gBAAgB,KAC7B,WAAW,EAAE,UAAU,GACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,6FAA6F;IAC7F,wCAAwC;IACxC,gHAAgH;IAEhH;;;;OAIG;IACH,4BAAK,GAAL;QAAA,iBAyBC;;QAxBC,IAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,mBAAmB,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;SACH;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;SACH;QACD,IAAM,aAAa,GAAG,IAAI,8BAAa,CAAC;YACtC,OAAO,SAAA;YACP,aAAa,EAAE,UAAC,aAAa,EAAE,SAAS;gBACtC,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,EAAlC,CAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,2BAAI,GAAJ;QACE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,EAAE,EAAV,CAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED,gDAAyB,GAAzB,UAA0B,SAAqB;;QAC7C,OAAO;YACL,QAAQ,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC;YAC5C,UAAU,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC;YAChD,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC;YACjC,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE;SACtC,CAAC;IACJ,CAAC;IAEO,sCAAe,GAAvB;QACE,OAAO,IAAI,CAAC,OAAO,YAAY,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,+CAAwB,GAAxB,UAAyB,SAAqB;;QAC5C,6CACK,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC;YAC5C,2FAA2F;YAC3F,2FAA2F;YAC3F,UAAU,EAAE,MAAA,MAAA,IAAI,CAAC,aAAa,mCAAI,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC,EACtE,cAAc,EAAE,MAAA,SAAS,CAAC,SAAS,mCAAI,CAAC,EACxC,iBAAiB,EAAE,yBAAyB,CAAC,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC,CAAC,IACzG;IACJ,CAAC;IACH,mBAAC;AAAD,CAAC,AA9ND,IA8NC;AA9NY,oCAAY;AAgOzB,SAAS,yBAAyB,CAAC,WAAmB,EAAE,QAAgB;IACtE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,CAAC,EAAE;QAChF,OAAO,CAAC,CAAC;KACV;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACpE,CAAC;AAWD;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,SAAwB,EACxB,OAA+C,EAC/C,OAAiC;;IAAjC,wBAAA,EAAA,YAAiC;IAEjC,IAAM,YAAY,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,OAAO,YAAY,gBAAgB,EAAE;QACvC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACxC;SAAM;QACL,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KACzC;IACD,IAAM,oBAAoB,GAAG,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;IAEhE,IAAI;QACF,YAAY;aACT,wBAAwB,oBACvB,eAAe,EAAE,IAAA,qBAAI,GAAE,IACpB,oBAAoB,EACvB;aACD,mBAAmB,EAAE;aACrB,mBAAmB,EAAE;aACrB,KAAK,EAAE,CAAC;KACZ;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAc,CAAC;KACvB;IAED,OAAO,cAAM,OAAA,YAAY,CAAC,IAAI,EAAE,EAAnB,CAAmB,CAAC;AACnC,CAAC;AA9BD,gCA8BC","sourcesContent":["import {\n VideoState,\n VideoObserver,\n BrowserClient,\n EmbeddedVideoPlayer,\n VideoVendor,\n UUID,\n BaseEvent,\n getHeartbeatInstance,\n} from '@amplitude/analytics-core';\nimport { DEFAULT_CONTENT_STARTED_EVENT, DEFAULT_CONTENT_STOPPED_EVENT } from '../constants';\n\n/** Playback states where a view session is still in progress (e.g. buffering). */\nconst ACTIVE_PLAYBACK_STATES = new Set<VideoState['playbackState']>(['playing', 'waiting']);\n\nexport class VideoCapture {\n private videoEl: HTMLMediaElement | null = null;\n private heartbeat: ReturnType<typeof getHeartbeatInstance>;\n private embeddedVideoPlayer: EmbeddedVideoPlayer | null = null;\n private vendor?: VideoVendor;\n private extraEventProperties: Record<string, string | number | boolean> = {};\n private stopEvent: BaseEvent | null = null;\n private listeners: ((previousState: VideoState, nextState: VideoState) => void)[] = [];\n private onRemoveListeners: (() => void)[] = [];\n private playId: string | null = null;\n private playStartTime: number | null = null;\n\n constructor(private readonly amplitude: BrowserClient) {\n this.heartbeat = getHeartbeatInstance(this.amplitude);\n }\n\n /**\n * Specify a video or audio element to capture events from\n *\n * @param videoEl - The HTML video or audio element to capture events from.\n * @returns The VideoCapture instance.\n */\n withVideoElement(videoEl: HTMLMediaElement): VideoCapture {\n this.videoEl = videoEl;\n return this;\n }\n\n /**\n * Specify an embedded video player.js instance to capture events from\n * @param player - The embedded video player.js instance to capture events from.\n * @returns The VideoCapture instance.\n */\n withEmbeddedPlayer(player: EmbeddedVideoPlayer): VideoCapture {\n this.embeddedVideoPlayer = player;\n return this;\n }\n\n /**\n * Specify a vendor to capture extra vendor-specific event properties\n *\n * @param vendor - The vendor of the video player. Currently only \"mux\" is supported.\n * @returns The VideoCapture instance.\n */\n withVendor(vendor: VideoVendor): VideoCapture {\n this.vendor = vendor;\n return this;\n }\n\n /**\n * Specify extra event properties to include in all captured events\n *\n * @param properties - The extra event properties to include in the Amplitude event.\n * @returns The VideoCapture instance.\n */\n withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture {\n this.extraEventProperties = properties;\n return this;\n }\n\n /**\n * Track a \"[Amplitude] Content Started\" event every time the video starts playing\n * @returns The VideoCapture instance.\n */\n captureVideoStarted(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (!ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) && nextState.playbackState === 'playing') {\n this.playId = UUID();\n /* istanbul ignore next */\n this.playStartTime = nextState.lastEvent?.start_time ?? 0;\n const now = new Date().getTime();\n const startEvent: BaseEvent = {\n insert_id: UUID(),\n event_type: DEFAULT_CONTENT_STARTED_EVENT,\n time: now,\n event_properties: {\n ...nextState.lastEvent,\n ...this.parseStartEventProperties(nextState),\n ...this.extraEventProperties,\n play_id: this.playId,\n },\n };\n this.stopEvent = {\n ...startEvent,\n insert_id: UUID(),\n event_type: DEFAULT_CONTENT_STOPPED_EVENT,\n time: now + 1,\n event_properties: {\n ...nextState.lastEvent,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n stop_reason: 'timeout',\n play_id: this.playId,\n },\n };\n this.heartbeat.trackNoDelay(startEvent).catch(this.stop.bind(this));\n this.heartbeat.track(this.stopEvent).catch(this.stop.bind(this));\n }\n });\n return this;\n }\n\n /**\n * Track a \"[Amplitude] Content Stopped\" event every time the video stops playing\n * @returns The VideoCapture instance.\n */\n captureVideoStopped(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n // update the delayed event properties to have\n // the most up-to-date values\n if (this.stopEvent) {\n this.stopEvent.event_properties = {\n ...this.stopEvent.event_properties,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n };\n this.stopEvent.time = new Date().getTime();\n void this.heartbeat.update(this.stopEvent);\n }\n if (\n ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) &&\n !ACTIVE_PLAYBACK_STATES.has(nextState.playbackState)\n ) {\n this.flushStopEvent(nextState.playbackState);\n }\n });\n return this;\n }\n\n /**\n * End the current play session by ingesting its queued delayed stop event immediately.\n *\n * The heartbeat is shared by every capture on the same Amplitude client, so the event is\n * flushed rather than the heartbeat stopped, which would discard other captures' events.\n * Flushing also drops the event from the heartbeat queue once ingested, so the interval\n * winds down on its own. No-op when no play session is in progress.\n */\n private flushStopEvent(stopReason: string) {\n const stopEvent = this.stopEvent;\n if (!stopEvent) {\n return;\n }\n // the next play queues a fresh delayed stop event\n this.stopEvent = null;\n this.playStartTime = null;\n stopEvent.event_properties = {\n ...stopEvent.event_properties,\n stop_reason: stopReason,\n };\n this.heartbeat.trackNoDelay(stopEvent).catch(this.stop.bind(this));\n }\n\n // Placeholder: may need a generic state change listener to capture unusual events or to have\n // more control over the event tracking.\n // withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {\n\n /**\n * Start capturing analytics events for the video element\n * @returns The VideoCapture instance.\n * @throws An error if the video element is not specified.\n */\n start(): VideoCapture {\n const videoEl = this.videoEl ?? this.embeddedVideoPlayer;\n if (!videoEl) {\n throw new Error(\n 'Video element not specified. Use withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n if (this.videoEl && this.embeddedVideoPlayer) {\n throw new Error(\n 'Both video element and embedded video player specified. Use only one of withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n const videoObserver = new VideoObserver({\n videoEl,\n onStateChange: (previousState, nextState) => {\n this.listeners.forEach((listener) => listener(previousState, nextState));\n },\n vendor: this.vendor,\n isEmbedded: !!this.embeddedVideoPlayer,\n });\n\n this.onRemoveListeners.push(() => {\n videoObserver.destroy();\n });\n return this;\n }\n\n /**\n * Stop capturing analytics events for the video element.\n *\n * Observers are detached first so no playback state change can race with the final\n * event, then any in-progress play session is closed out.\n */\n stop() {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n this.flushStopEvent('untracked');\n }\n\n parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n return {\n duration: nextState.lastEvent?.duration ?? 0,\n start_time: nextState.lastEvent?.start_time ?? 0,\n position: nextState.position ?? 0,\n delivery_mode: this.getDeliveryMode(),\n };\n }\n\n private getDeliveryMode(): 'video' | 'audio' {\n return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';\n }\n\n parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n return {\n ...this.parseStartEventProperties(nextState),\n // lastEvent.start_time is the playhead at the time of the event, which for a stop event is\n // where playback ended, so the position captured when the play session began is preferred.\n start_time: this.playStartTime ?? nextState.lastEvent?.start_time ?? 0,\n watch_duration: nextState.watchTime ?? 0,\n percent_completed: calculatePercentCompleted(nextState.position ?? 0, nextState.lastEvent?.duration ?? 0),\n };\n }\n}\n\nfunction calculatePercentCompleted(currentTime: number, duration: number) {\n if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {\n return 0;\n }\n return Math.min(100, Math.max(0, (currentTime / duration) * 100));\n}\n\nexport type VideoCaptureOptions = {\n vendor?: VideoVendor;\n extraEventProperties?: Record<string, string | number | boolean>;\n};\n\ntype UntrackVideoResult = () => void;\n\nexport type TrackVideoResult = UntrackVideoResult | Error;\n\n/**\n * Track video analytics events for an HTML video or audio element or embedded video player.js instance.\n *\n * Captures [Amplitude] Content Started and [Amplitude] Content Stopped events.\n *\n * @experimental This function is experimental and may not be stable.\n * @param amplitude - The Amplitude client instance.\n * @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.\n * @param options - The options for the video capture.\n * @returns A function to stop the video capture.\n */\nexport function trackVideo(\n amplitude: BrowserClient,\n videoEl: HTMLMediaElement | EmbeddedVideoPlayer,\n options: VideoCaptureOptions = {},\n): TrackVideoResult {\n const videoCapture = new VideoCapture(amplitude);\n if (videoEl instanceof HTMLMediaElement) {\n videoCapture.withVideoElement(videoEl);\n } else {\n videoCapture.withEmbeddedPlayer(videoEl);\n }\n if (options.vendor) {\n videoCapture.withVendor(options.vendor);\n }\n const extraEventProperties = options.extraEventProperties ?? {};\n\n try {\n videoCapture\n .withExtraEventProperties({\n view_session_id: UUID(),\n ...extraEventProperties,\n })\n .captureVideoStarted()\n .captureVideoStopped()\n .start();\n } catch (error) {\n return error as Error;\n }\n\n return () => videoCapture.stop();\n}\n"]}
|
|
1
|
+
{"version":3,"file":"video-capture.js","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":";;;;AAAA,4DAOmC;AAEnC;IASE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAR7C,YAAO,GAA4B,IAAI,CAAC;QACxC,wBAAmB,GAA+B,IAAI,CAAC;QAEvD,yBAAoB,GAA8C,EAAE,CAAC;QAErE,cAAS,GAAmE,EAAE,CAAC;QAC/E,sBAAiB,GAAmB,EAAE,CAAC;IAES,CAAC;IAEzD;;;;;OAKG;IACH,uCAAgB,GAAhB,UAAiB,OAAyB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,yCAAkB,GAAlB,UAAmB,MAA2B;QAC5C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAU,GAAV,UAAW,MAAmB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,+CAAwB,GAAxB,UAAyB,UAAqD;QAC5E,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAWC;QAVC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,aAAa,CAAC,aAAa,KAAK,SAAS,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtF,8CAA8C;gBAC9C,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,uBAAuB,wCACvC,SAAS,CAAC,SAAS,GACnB,KAAI,CAAC,oBAAoB,EAC5B,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAYC;QAXC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,aAAa,CAAC,aAAa,KAAK,SAAS,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtF,uCAAuC;gBACvC,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,uBAAuB,yDACvC,SAAS,CAAC,SAAS,KACtB,cAAc,EAAE,SAAS,CAAC,SAAS,KAChC,KAAI,CAAC,oBAAoB,EAC5B,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6FAA6F;IAC7F,wCAAwC;IACxC,gHAAgH;IAEhH;;;;OAIG;IACH,4BAAK,GAAL;QAAA,iBAyBC;;QAxBC,IAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,mBAAmB,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;SACH;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;SACH;QACD,IAAM,aAAa,GAAG,IAAI,8BAAa,CAAC;YACtC,OAAO,SAAA;YACP,aAAa,EAAE,UAAC,aAAa,EAAE,SAAS;gBACtC,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,EAAlC,CAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAAI,GAAJ;QACE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,EAAE,EAAV,CAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;IACH,mBAAC;AAAD,CAAC,AAjID,IAiIC;AAjIY,oCAAY;AA4IzB;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,SAAwB,EACxB,OAA+C,EAC/C,OAAiC;;IAAjC,wBAAA,EAAA,YAAiC;IAEjC,IAAM,YAAY,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,OAAO,YAAY,gBAAgB,EAAE;QACvC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACxC;SAAM;QACL,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KACzC;IACD,IAAM,oBAAoB,GAAG,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;IAEhE,IAAI;QACF,YAAY;aACT,wBAAwB,oBACvB,eAAe,EAAE,IAAA,qBAAI,GAAE,IACpB,oBAAoB,EACvB;aACD,mBAAmB,EAAE;aACrB,mBAAmB,EAAE;aACrB,KAAK,EAAE,CAAC;KACZ;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAc,CAAC;KACvB;IAED,OAAO,cAAM,OAAA,YAAY,CAAC,IAAI,EAAE,EAAnB,CAAmB,CAAC;AACnC,CAAC;AA9BD,gCA8BC","sourcesContent":["import {\n VideoState,\n VideoObserver,\n BrowserClient,\n EmbeddedVideoPlayer,\n VideoVendor,\n UUID,\n} from '@amplitude/analytics-core';\n\nexport class VideoCapture {\n private videoEl: HTMLVideoElement | null = null;\n private embeddedVideoPlayer: EmbeddedVideoPlayer | null = null;\n private vendor?: VideoVendor;\n private extraEventProperties: Record<string, string | number | boolean> = {};\n\n private listeners: ((previousState: VideoState, nextState: VideoState) => void)[] = [];\n private onRemoveListeners: (() => void)[] = [];\n\n constructor(private readonly amplitude: BrowserClient) {}\n\n /**\n * Specify a video element to capture events from\n *\n * @param videoEl - The HTML video element to capture events from.\n * @returns The VideoCapture instance.\n */\n withVideoElement(videoEl: HTMLVideoElement): VideoCapture {\n this.videoEl = videoEl;\n return this;\n }\n\n /**\n * Specify an embedded video player.js instance to capture events from\n * @param player - The embedded video player.js instance to capture events from.\n * @returns The VideoCapture instance.\n */\n withEmbeddedPlayer(player: EmbeddedVideoPlayer): VideoCapture {\n this.embeddedVideoPlayer = player;\n return this;\n }\n\n /**\n * Specify a vendor to capture extra vendor-specific event properties\n *\n * @param vendor - The vendor of the video player. Currently only \"mux\" is supported.\n * @returns The VideoCapture instance.\n */\n withVendor(vendor: VideoVendor): VideoCapture {\n this.vendor = vendor;\n return this;\n }\n\n /**\n * Specify extra event properties to include in all captured events\n *\n * @param properties - The extra event properties to include in the Amplitude event.\n * @returns The VideoCapture instance.\n */\n withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture {\n this.extraEventProperties = properties;\n return this;\n }\n\n /**\n * Track a \"Video Content Started\" event every time the video starts playing\n * @returns The VideoCapture instance.\n */\n captureVideoStarted(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (previousState.playbackState !== 'playing' && nextState.playbackState === 'playing') {\n // TODO: placeholder for Heartbeat Start Event\n this.amplitude.track('Video Content Started', {\n ...nextState.lastEvent,\n ...this.extraEventProperties,\n });\n }\n });\n return this;\n }\n\n /**\n * Track a \"Video Content Stopped\" event every time the video stops playing\n * @returns The VideoCapture instance.\n */\n captureVideoStopped(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (previousState.playbackState === 'playing' && nextState.playbackState !== 'playing') {\n // placeholder for Heartbeat Stop Event\n this.amplitude.track('Video Content Stopped', {\n ...nextState.lastEvent,\n watch_duration: nextState.watchTime,\n ...this.extraEventProperties,\n });\n }\n });\n return this;\n }\n\n // Placeholder: may need a generic state change listener to capture unusual events or to have\n // more control over the event tracking.\n // withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {\n\n /**\n * Start capturing analytics events for the video element\n * @returns The VideoCapture instance.\n * @throws An error if the video element is not specified.\n */\n start(): VideoCapture {\n const videoEl = this.videoEl ?? this.embeddedVideoPlayer;\n if (!videoEl) {\n throw new Error(\n 'Video element not specified. Use withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n if (this.videoEl && this.embeddedVideoPlayer) {\n throw new Error(\n 'Both video element and embedded video player specified. Use only one of withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n const videoObserver = new VideoObserver({\n videoEl,\n onStateChange: (previousState, nextState) => {\n this.listeners.forEach((listener) => listener(previousState, nextState));\n },\n vendor: this.vendor,\n isEmbedded: !!this.embeddedVideoPlayer,\n });\n\n this.onRemoveListeners.push(() => {\n videoObserver.destroy();\n });\n return this;\n }\n\n stop() {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n }\n}\n\nexport type VideoCaptureOptions = {\n vendor?: VideoVendor;\n extraEventProperties?: Record<string, string | number | boolean>;\n};\n\ntype UntrackVideoResult = () => void;\n\nexport type TrackVideoResult = UntrackVideoResult | Error;\n\n/**\n * Track video analytics events for an HTML video element or embedded video player.js instance.\n *\n * Captures Video Started and Video Stopped events.\n *\n * @experimental This function is experimental and may not be stable.\n * @param amplitude - The Amplitude client instance.\n * @param videoEl - The HTML video element or embedded video player.js instance to capture events from.\n * @param options - The options for the video capture.\n * @returns A function to stop the video capture.\n */\nexport function trackVideo(\n amplitude: BrowserClient,\n videoEl: HTMLVideoElement | EmbeddedVideoPlayer,\n options: VideoCaptureOptions = {},\n): TrackVideoResult {\n const videoCapture = new VideoCapture(amplitude);\n if (videoEl instanceof HTMLVideoElement) {\n videoCapture.withVideoElement(videoEl);\n } else {\n videoCapture.withEmbeddedPlayer(videoEl);\n }\n if (options.vendor) {\n videoCapture.withVendor(options.vendor);\n }\n const extraEventProperties = options.extraEventProperties ?? {};\n\n try {\n videoCapture\n .withExtraEventProperties({\n view_session_id: UUID(),\n ...extraEventProperties,\n })\n .captureVideoStarted()\n .captureVideoStopped()\n .start();\n } catch (error) {\n return error as Error;\n }\n\n return () => videoCapture.stop();\n}\n"]}
|
|
@@ -206,7 +206,7 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
|
|
|
206
206
|
});
|
|
207
207
|
}); });
|
|
208
208
|
}
|
|
209
|
-
connector = getAnalyticsConnector(
|
|
209
|
+
connector = getAnalyticsConnector(this.config.instanceName);
|
|
210
210
|
connector.identityStore.setIdentity({
|
|
211
211
|
userId: this.config.userId,
|
|
212
212
|
deviceId: this.config.deviceId,
|