@playkit-js/rapt 0.4.25 → 0.4.26-canary.0-f991fd5
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/CHANGELOG.md +4 -0
- package/domain-blueprint.json +135 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
{
|
|
2
|
+
"repositoryName": "kaltura-interactive-player",
|
|
3
|
+
"packageName": "@playkit-js/rapt",
|
|
4
|
+
"coreResponsibility": "Interactive video player (Rapt engine wrapper) that enables branching video experiences with hotspot navigation, multi-player management, video buffering, and decision-based playback switching within the Kaltura Player ecosystem.",
|
|
5
|
+
"domainAndLogicOwnership": {
|
|
6
|
+
"featureOwnership": [
|
|
7
|
+
"Interactive video playback (branching/non-linear video)",
|
|
8
|
+
"Hotspot interaction and click handling",
|
|
9
|
+
"Multi-player instance management and switching",
|
|
10
|
+
"Video pre-buffering and caching for seamless transitions",
|
|
11
|
+
"Node-based video graph navigation",
|
|
12
|
+
"Rapt Engine layer integration and rendering",
|
|
13
|
+
"Fullscreen mode management",
|
|
14
|
+
"Playback state persistence across video nodes (volume, captions, audio track, playback rate)",
|
|
15
|
+
"Custom UI presets for interactive playback controls",
|
|
16
|
+
"Cue point event triggering",
|
|
17
|
+
"Analytics interception for KAVA (Kaltura Video Analytics)",
|
|
18
|
+
"Project lifecycle management (load, ready, start, ended, replay, reset)"
|
|
19
|
+
],
|
|
20
|
+
"dataHandling": [
|
|
21
|
+
"Rapt graph data (nodes, hotspots, settings)",
|
|
22
|
+
"Interactive project metadata and configuration",
|
|
23
|
+
"Node navigation state (current node, previous node, next nodes)",
|
|
24
|
+
"Player buffering state and buffer list management",
|
|
25
|
+
"Hotspot objects with positions, styles, and click actions",
|
|
26
|
+
"Cue points with custom data",
|
|
27
|
+
"Video playback persistence (mute, volume, captions, audio track, playback rate)",
|
|
28
|
+
"Analytics model with rootEntryId, nodeId, entryId"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"integrationPoints": {
|
|
32
|
+
"upstream": [
|
|
33
|
+
"Kaltura Backend API (cdnapisec.kaltura.com) - for Rapt data, file assets, playlists, and interactivity data",
|
|
34
|
+
"Rapt Media Composer - source of interactive video project definitions",
|
|
35
|
+
"MediaSpace (KMS) - generates player uiconf configurations"
|
|
36
|
+
],
|
|
37
|
+
"downstream": [
|
|
38
|
+
"Kaltura Player JS (playkit-js) - consumed as a bundled plugin",
|
|
39
|
+
"Web applications embedding Kaltura interactive videos",
|
|
40
|
+
"MediaSpace player embeds"
|
|
41
|
+
],
|
|
42
|
+
"externalApis": [
|
|
43
|
+
"Kaltura API v3 (playlist.get, fileAsset.list, fileAsset.serve, interactivity.get, session.startWidgetSession)",
|
|
44
|
+
"kaltura-typescript-client library",
|
|
45
|
+
"Rapt Engine SDK (engineWithNodeId.min.js)",
|
|
46
|
+
"Google Analytics (optional tracking integration)",
|
|
47
|
+
"KAVA (Kaltura Video Analytics) - analytics interception"
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
"technicalStack": {
|
|
51
|
+
"primaryLanguages": ["TypeScript", "JavaScript", "SCSS"],
|
|
52
|
+
"frameworks": ["Webpack", "playkit-js (Kaltura Player)"],
|
|
53
|
+
"buildTools": ["webpack", "ts-loader", "sass-loader"],
|
|
54
|
+
"entryPoints": [
|
|
55
|
+
{
|
|
56
|
+
"file": "src/Kip.ts",
|
|
57
|
+
"description": "Main entry point - exports setup() function to initialize KalturaInteractiveVideo"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"file": "src/KalturaInteractiveVideo.ts",
|
|
61
|
+
"description": "Core class managing the interactive video experience, API exposure, and project lifecycle"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"file": "src/PlayersManager.ts",
|
|
65
|
+
"description": "Manages multiple Kaltura Player instances, Rapt engine integration, and node switching"
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"file": "src/KipClient.ts",
|
|
69
|
+
"description": "Backend API client for loading Rapt data from Kaltura services"
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"file": "src/PlayersBufferManager.ts",
|
|
73
|
+
"description": "Handles video pre-buffering for seamless transitions between nodes"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"file": "src/PlayersFactory.ts",
|
|
77
|
+
"description": "Factory for creating and configuring Kaltura Player instances"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"file": "src/PlayersDomManager.ts",
|
|
81
|
+
"description": "DOM management for player containers and Rapt engine layer"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"file": "src/ui/PlaybackPreset.ts",
|
|
85
|
+
"description": "Custom UI presets for interactive video controls"
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
"outputArtifact": "dist/playkit-rapt.js"
|
|
89
|
+
},
|
|
90
|
+
"triageKeywords": [
|
|
91
|
+
"interactive video",
|
|
92
|
+
"rapt",
|
|
93
|
+
"rapt player",
|
|
94
|
+
"KIP",
|
|
95
|
+
"kaltura interactive player",
|
|
96
|
+
"hotspot",
|
|
97
|
+
"hotspot click",
|
|
98
|
+
"branching video",
|
|
99
|
+
"node switching",
|
|
100
|
+
"node:enter",
|
|
101
|
+
"node:exit",
|
|
102
|
+
"node:ended",
|
|
103
|
+
"project:load",
|
|
104
|
+
"project:ready",
|
|
105
|
+
"playlistId",
|
|
106
|
+
"PathKalturaPlayer",
|
|
107
|
+
"playkit-rapt",
|
|
108
|
+
"cue:forward",
|
|
109
|
+
"cue:reverse",
|
|
110
|
+
"video buffering rapt",
|
|
111
|
+
"prebuffer",
|
|
112
|
+
"raptMedia",
|
|
113
|
+
"graph data",
|
|
114
|
+
"GRAPH_DATA file asset",
|
|
115
|
+
"interactivity.get"
|
|
116
|
+
],
|
|
117
|
+
"errorKeywordsAndPatterns": [
|
|
118
|
+
"missing rapt project id",
|
|
119
|
+
"Missing data. Could not retrieve attached file assets",
|
|
120
|
+
"Error with generating widget session KS",
|
|
121
|
+
"missing data interactivity",
|
|
122
|
+
"raptDataLoadError",
|
|
123
|
+
"firstPlayError",
|
|
124
|
+
"missingFirstNode",
|
|
125
|
+
"BufferManager is not available",
|
|
126
|
+
"could not destroy player",
|
|
127
|
+
"Failed to merge local config and uiconf"
|
|
128
|
+
],
|
|
129
|
+
"version": "0.4.25",
|
|
130
|
+
"license": "AGPL-3.0",
|
|
131
|
+
"relatedRepositories": [
|
|
132
|
+
"kaltura/playkit-js",
|
|
133
|
+
"kaltura/kaltura-player-js"
|
|
134
|
+
]
|
|
135
|
+
}
|