@brandbrigade/ott-bb-player 1.0.57 → 1.0.58

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +303 -299
  2. package/dist/OTTPlayer.js +7 -7
  3. package/package.json +34 -34
package/README.md CHANGED
@@ -1,299 +1,303 @@
1
- # OTT-BB-Player
2
-
3
- Welcome to OTT-BB-Player! This README provides information about the project, including installation instructions and a changelog.
4
-
5
- ## Table of Contents
6
-
7
- - [Overview](#Overview)
8
- - [Installation](#installation)
9
- - [HowTo](#HowTo)
10
- - [Example](#example)
11
- - [Changelog](#changelog)
12
-
13
- ## Overview
14
-
15
- The SDK allows to augment targeted ads on top of DRM1 stream, providing that the same content is/was augmetned by BrandBrigade and the augmentation metadata is stored in the BrandBrigade cloud Smart-Feed, and providing that the stream contains embeded timecodes that match in a frame-accurate manner the timecode embedded in the smart feed.
16
-
17
- ## Installation
18
-
19
- To install My Project, follow these steps:
20
-
21
- 1. Login into npmjs repo if you are not logged in
22
-
23
- ```bash
24
- npm login
25
- ```
26
-
27
- 2. Use npm to install the package
28
-
29
- ```bash
30
- npm install @brandbrigade/ott-bb-player --prefix .
31
- ```
32
-
33
- ## HowTo
34
-
35
- ### Initialization
36
-
37
- To initialize the SDK, one should provide:
38
-
39
- 1. Video Tag: You should submit the video element (the one that is submitted to the MK player by wmcMgr.setContainer(video))
40
-
41
- 2. Frame rate
42
- (In the future this parameter will be omitted and fetched internally with the MediaKind API)
43
-
44
- 3. A game id: This is an identifier for the game which is shared between the NBA app and the BB DTC client to define the appropriate smart feed to be accessed
45
-
46
- 4. A channel name: The programmatic emulation channel to demonstrate the targeted ad
47
-
48
- ```
49
- bbPlayer = new BB.OTTPlayer(
50
- video, //Video Tag
51
- 30000/1001, // frame rate
52
- { gameId:<game id>,//game id
53
- augmentation:{“channelName”:”nba”}});//channel name
54
- ```
55
-
56
- ## Example
57
-
58
- **sample.html** is an example page showing usage of OTT-BB-Player
59
- A test page hosted on the BB server can be accessed [here](http://bb-ott-player.s3-website-us-east-1.amazonaws.com/demo/node_modules/@brandbrigade/ott-bb-player/sample.html)
60
-
61
- The inital configuration on the config json on the top of the sample.html page, requires:
62
-
63
- 1. A Stream URL. An example stream can be accessed at [this link](https://nbablpng.akamaized.net/live/hls-itc/bbtest49/v0-121.m3u8?stSecret=rj12sw543terw32422334swees) (MK Stream with MetadataEvents) or [here](https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8) (BB Stream without MetadataEvents)
64
- 2. The game id. For a test case use “arena_nba_BB_test_Lakers_long”. The game id is a convention to be agreed between the NBA App and the BrandBrigade SDK to identify the playing game.
65
- 3. A Channel for the programmatic ads simulation. For a test case use “nba”
66
- Example:
67
-
68
- ```
69
- var config = {
70
- "url":"https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8",
71
- "gameId":"“arena_nba_BB_test_Lakers_long”,
72
- "channel":"nba"
73
- };
74
- ```
75
-
76
- To get Timecode information AMC_EVENT_PLAYER_METADATA and AMC_EVENT_PLAYER_SEGMENT_PLAYBACK events should be forwarded to OTTPlayer
77
-
78
- ```
79
- function onNewMetadata(eventObj) {
80
- bbPlayer.onNewMetadata(eventObj)
81
- };
82
- function onNewSegment(eventObj) {
83
- bbPlayer.onNewSegment(eventObj);
84
- };
85
- wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_METADATA, onNewMetadata);
86
- wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_SEGMENT_PLAYBACK, onNewSegment);
87
-
88
- ```
89
-
90
- ### Control
91
-
92
- To toggle the SDK on off, use the SDK Toggle method with a boolean:
93
-
94
- ```
95
- bbPlayer.Toggle({true|false});
96
- ```
97
-
98
- ## Changelog
99
-
100
- ### Version 1.0.0
101
-
102
- Initial version
103
-
104
- ### Version 1.0.1
105
-
106
- Initial version
107
-
108
- ### Version 1.0.2
109
-
110
- Initial version
111
-
112
- ### Version 1.0.3
113
-
114
- Added readme.md
115
-
116
- ### Version 1.0.4
117
-
118
- Added support of 59.94 streams
119
-
120
- Added interface functions to get sync timecodes from MK MetadataEvents
121
-
122
- ### Version 1.0.5
123
-
124
- Added support of Safari on Mac
125
-
126
- ### Version 1.0.6
127
-
128
- Enabled support of Safari on Mac
129
-
130
- ### Version 1.0.7
131
-
132
- Fixed Safari issue.
133
- Improved Chrome rendering
134
-
135
- ### Version 1.0.8
136
-
137
- Added usage of TimeCodesSync service
138
-
139
- ### Version 1.0.9
140
-
141
- Bug fix
142
-
143
- ### Version 1.0.10
144
-
145
- Bug fix
146
-
147
- ### Version 1.0.11
148
-
149
- Bug fix
150
-
151
- ### Version 1.0.12
152
-
153
- All is packed to one file
154
-
155
- ### Version 1.0.13
156
-
157
- Chrome on MK REF App support
158
-
159
- ### Version 1.0.14
160
-
161
- Safari on MK REF App support
162
-
163
- ### Version 1.0.15
164
-
165
- MK REF App DEV stream support
166
-
167
- ### Version 1.0.16
168
-
169
- Improvements
170
-
171
- ### Version 1.0.17
172
-
173
- Improvements
174
-
175
- ### Version 1.0.18
176
-
177
- Improvements
178
-
179
- ### Version v1.0.19
180
-
181
- Chrome-Mac support
182
-
183
- ### Version v1.0.20
184
-
185
- Improvements### Version v1.0.21
186
- test26
187
-
188
- ### Version v1.0.22
189
-
190
- test26
191
-
192
- ### Version v1.0.23
193
-
194
- test_v_1.0.23
195
-
196
- ### Version v1.0.24
197
-
198
- test
199
-
200
- ### Version v1.0.25
201
-
202
- test
203
-
204
- ### Version v1.0.26
205
-
206
- test
207
-
208
- ### Version v1.0.27
209
-
210
- test
211
-
212
- ### Version v1.0.28
213
-
214
- test
215
-
216
- ### Version v1.0.29
217
-
218
- test
219
-
220
- ### Version v1.0.30
221
-
222
- test
223
-
224
- ### Version v1.0.31
225
-
226
- test
227
-
228
- ### Version v1.0.32
229
-
230
- QA_newAPi_funcNames
231
-
232
- ### Version v1.0.33
233
-
234
- mac_any_screenFPS
235
-
236
- ### Version v1.0.34
237
-
238
- 29_fps_support_in_chrome_windows
239
-
240
- ### Version v1.0.35
241
-
242
- added_more_debug_to_virtualott
243
-
244
- ### Version v1.0.36
245
-
246
- mac_chrome_correction_disable
247
-
248
- ### Version v1.0.37
249
-
250
- one_of_jitters_fixed_on_safari_mac
251
-
252
- ### Version v1.0.38
253
-
254
- one_of_jitters_fixed_on_safari_mac_2
255
-
256
- ### Version v1.0.39
257
-
258
- dual_mac_chrome_safari
259
-
260
- ### Version v1.0.40
261
-
262
- added_fps_checks
263
-
264
- ### Version v1.0.41
265
-
266
- chrome_mac_mkRefApp_jitter_fix
267
-
268
- ### Version v1.0.47
269
-
270
- OTT Web rebuild, supports Chrome Mac
271
-
272
- ### Version v1.0.49
273
-
274
- Fixed augmentation size bug,
275
- Updated configurations
276
-
277
- ### Version v1.0.50
278
-
279
- Fixed multiple instances of OTT Player,
280
- Applied SetInterval in Adepter,
281
- Added OTTActions support
282
-
283
- ### Version v1.0.52
284
-
285
- Adapter, Downloader and Decoder Settings added to global player options
286
-
287
- ### Version v1.0.53
288
-
289
- More debug metrix added,
290
- Pixel tickers color changed to dark gray
291
-
292
- ### Version v1.0.55
293
-
294
- Pattern tracking based renderer calls implemented
295
-
296
- ### Version v1.0.57
297
-
298
- Added support for Windows Chrome,
299
- Updated logging
1
+ # OTT-BB-Player
2
+
3
+ Welcome to OTT-BB-Player! This README provides information about the project, including installation instructions and a changelog.
4
+
5
+ ## Table of Contents
6
+
7
+ - [Overview](#Overview)
8
+ - [Installation](#installation)
9
+ - [HowTo](#HowTo)
10
+ - [Example](#example)
11
+ - [Changelog](#changelog)
12
+
13
+ ## Overview
14
+
15
+ The SDK allows to augment targeted ads on top of DRM1 stream, providing that the same content is/was augmetned by BrandBrigade and the augmentation metadata is stored in the BrandBrigade cloud Smart-Feed, and providing that the stream contains embeded timecodes that match in a frame-accurate manner the timecode embedded in the smart feed.
16
+
17
+ ## Installation
18
+
19
+ To install My Project, follow these steps:
20
+
21
+ 1. Login into npmjs repo if you are not logged in
22
+
23
+ ```bash
24
+ npm login
25
+ ```
26
+
27
+ 2. Use npm to install the package
28
+
29
+ ```bash
30
+ npm install @brandbrigade/ott-bb-player --prefix .
31
+ ```
32
+
33
+ ## HowTo
34
+
35
+ ### Initialization
36
+
37
+ To initialize the SDK, one should provide:
38
+
39
+ 1. Video Tag: You should submit the video element (the one that is submitted to the MK player by wmcMgr.setContainer(video))
40
+
41
+ 2. Frame rate
42
+ (In the future this parameter will be omitted and fetched internally with the MediaKind API)
43
+
44
+ 3. A game id: This is an identifier for the game which is shared between the NBA app and the BB DTC client to define the appropriate smart feed to be accessed
45
+
46
+ 4. A channel name: The programmatic emulation channel to demonstrate the targeted ad
47
+
48
+ ```
49
+ bbPlayer = new BB.OTTPlayer(
50
+ video, //Video Tag
51
+ 30000/1001, // frame rate
52
+ { gameId:<game id>,//game id
53
+ augmentation:{“channelName”:”nba”}});//channel name
54
+ ```
55
+
56
+ ## Example
57
+
58
+ **sample.html** is an example page showing usage of OTT-BB-Player
59
+ A test page hosted on the BB server can be accessed [here](http://bb-ott-player.s3-website-us-east-1.amazonaws.com/demo/node_modules/@brandbrigade/ott-bb-player/sample.html)
60
+
61
+ The inital configuration on the config json on the top of the sample.html page, requires:
62
+
63
+ 1. A Stream URL. An example stream can be accessed at [this link](https://nbablpng.akamaized.net/live/hls-itc/bbtest49/v0-121.m3u8?stSecret=rj12sw543terw32422334swees) (MK Stream with MetadataEvents) or [here](https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8) (BB Stream without MetadataEvents)
64
+ 2. The game id. For a test case use “arena_nba_BB_test_Lakers_long”. The game id is a convention to be agreed between the NBA App and the BrandBrigade SDK to identify the playing game.
65
+ 3. A Channel for the programmatic ads simulation. For a test case use “nba”
66
+ Example:
67
+
68
+ ```
69
+ var config = {
70
+ "url":"https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8",
71
+ "gameId":"“arena_nba_BB_test_Lakers_long”,
72
+ "channel":"nba"
73
+ };
74
+ ```
75
+
76
+ To get Timecode information AMC_EVENT_PLAYER_METADATA and AMC_EVENT_PLAYER_SEGMENT_PLAYBACK events should be forwarded to OTTPlayer
77
+
78
+ ```
79
+ function onNewMetadata(eventObj) {
80
+ bbPlayer.onNewMetadata(eventObj)
81
+ };
82
+ function onNewSegment(eventObj) {
83
+ bbPlayer.onNewSegment(eventObj);
84
+ };
85
+ wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_METADATA, onNewMetadata);
86
+ wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_SEGMENT_PLAYBACK, onNewSegment);
87
+
88
+ ```
89
+
90
+ ### Control
91
+
92
+ To toggle the SDK on off, use the SDK Toggle method with a boolean:
93
+
94
+ ```
95
+ bbPlayer.Toggle({true|false});
96
+ ```
97
+
98
+ ## Changelog
99
+
100
+ ### Version 1.0.0
101
+
102
+ Initial version
103
+
104
+ ### Version 1.0.1
105
+
106
+ Initial version
107
+
108
+ ### Version 1.0.2
109
+
110
+ Initial version
111
+
112
+ ### Version 1.0.3
113
+
114
+ Added readme.md
115
+
116
+ ### Version 1.0.4
117
+
118
+ Added support of 59.94 streams
119
+
120
+ Added interface functions to get sync timecodes from MK MetadataEvents
121
+
122
+ ### Version 1.0.5
123
+
124
+ Added support of Safari on Mac
125
+
126
+ ### Version 1.0.6
127
+
128
+ Enabled support of Safari on Mac
129
+
130
+ ### Version 1.0.7
131
+
132
+ Fixed Safari issue.
133
+ Improved Chrome rendering
134
+
135
+ ### Version 1.0.8
136
+
137
+ Added usage of TimeCodesSync service
138
+
139
+ ### Version 1.0.9
140
+
141
+ Bug fix
142
+
143
+ ### Version 1.0.10
144
+
145
+ Bug fix
146
+
147
+ ### Version 1.0.11
148
+
149
+ Bug fix
150
+
151
+ ### Version 1.0.12
152
+
153
+ All is packed to one file
154
+
155
+ ### Version 1.0.13
156
+
157
+ Chrome on MK REF App support
158
+
159
+ ### Version 1.0.14
160
+
161
+ Safari on MK REF App support
162
+
163
+ ### Version 1.0.15
164
+
165
+ MK REF App DEV stream support
166
+
167
+ ### Version 1.0.16
168
+
169
+ Improvements
170
+
171
+ ### Version 1.0.17
172
+
173
+ Improvements
174
+
175
+ ### Version 1.0.18
176
+
177
+ Improvements
178
+
179
+ ### Version v1.0.19
180
+
181
+ Chrome-Mac support
182
+
183
+ ### Version v1.0.20
184
+
185
+ Improvements### Version v1.0.21
186
+ test26
187
+
188
+ ### Version v1.0.22
189
+
190
+ test26
191
+
192
+ ### Version v1.0.23
193
+
194
+ test_v_1.0.23
195
+
196
+ ### Version v1.0.24
197
+
198
+ test
199
+
200
+ ### Version v1.0.25
201
+
202
+ test
203
+
204
+ ### Version v1.0.26
205
+
206
+ test
207
+
208
+ ### Version v1.0.27
209
+
210
+ test
211
+
212
+ ### Version v1.0.28
213
+
214
+ test
215
+
216
+ ### Version v1.0.29
217
+
218
+ test
219
+
220
+ ### Version v1.0.30
221
+
222
+ test
223
+
224
+ ### Version v1.0.31
225
+
226
+ test
227
+
228
+ ### Version v1.0.32
229
+
230
+ QA_newAPi_funcNames
231
+
232
+ ### Version v1.0.33
233
+
234
+ mac_any_screenFPS
235
+
236
+ ### Version v1.0.34
237
+
238
+ 29_fps_support_in_chrome_windows
239
+
240
+ ### Version v1.0.35
241
+
242
+ added_more_debug_to_virtualott
243
+
244
+ ### Version v1.0.36
245
+
246
+ mac_chrome_correction_disable
247
+
248
+ ### Version v1.0.37
249
+
250
+ one_of_jitters_fixed_on_safari_mac
251
+
252
+ ### Version v1.0.38
253
+
254
+ one_of_jitters_fixed_on_safari_mac_2
255
+
256
+ ### Version v1.0.39
257
+
258
+ dual_mac_chrome_safari
259
+
260
+ ### Version v1.0.40
261
+
262
+ added_fps_checks
263
+
264
+ ### Version v1.0.41
265
+
266
+ chrome_mac_mkRefApp_jitter_fix
267
+
268
+ ### Version v1.0.47
269
+
270
+ OTT Web rebuild, supports Chrome Mac
271
+
272
+ ### Version v1.0.49
273
+
274
+ Fixed augmentation size bug,
275
+ Updated configurations
276
+
277
+ ### Version v1.0.50
278
+
279
+ Fixed multiple instances of OTT Player,
280
+ Applied SetInterval in Adepter,
281
+ Added OTTActions support
282
+
283
+ ### Version v1.0.52
284
+
285
+ Adapter, Downloader and Decoder Settings added to global player options
286
+
287
+ ### Version v1.0.53
288
+
289
+ More debug metrix added,
290
+ Pixel tickers color changed to dark gray
291
+
292
+ ### Version v1.0.55
293
+
294
+ Pattern tracking based renderer calls implemented
295
+
296
+ ### Version v1.0.57
297
+
298
+ Added support for Windows Chrome,
299
+ Updated logging
300
+
301
+ ### Version v1.0.58
302
+
303
+ Improve support for Windows Chrome