@brandbrigade/ott-bb-player 1.0.43 → 1.0.45

package/LICENCE

@@ -0,0 +1,29 @@
+ 
+Copyright 2021, GFXFundamentals.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of GFXFundamentals. nor the names of his
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,218 +1,266 @@
-# OTT-BB-Player
-
-Welcome to OTT-BB-Player! This README provides information about the project, including installation instructions and a changelog.
-
-## Table of Contents
-
-- [Overview](#Overview)
-- [Installation](#installation)
-- [HowTo](#HowTo)
-- [Example](#example)
-- [Changelog](#changelog)
-## Overview
-
-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.
-
-## Installation
-
-To install My Project, follow these steps:
-1. Login into npmjs repo if you are not logged in
-```bash
-npm login
-```
-2. Use npm to install the package
-```bash
-npm install @brandbrigade/ott-bb-player --prefix .
-```
-
-## HowTo
-### Initialization
-To initialize the SDK, one should provide:
-
-1. Video Tag: You should submit the video element (the one that is submitted to the MK player by wmcMgr.setContainer(video))
-
-2. Frame rate 
-(In the future this parameter will be omitted and fetched internally with the MediaKind API)
-
-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
-
-4. A channel name: The  programmatic emulation channel to demonstrate the targeted ad
-```
-bbPlayer = new BB.OTTPlayer(
-  video, //Video Tag
-  30000/1001, // frame rate
-  { gameId:<game id>,//game id
-    augmentation:{“channelName”:”nba”}});//channel name
-```
-
-## Example
-**sample.html** is an example page showing usage of OTT-BB-Player
-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)
-
-The inital configuration on the config json on the top of the sample.html page, requires:
-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)
-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. 
-3. A Channel for the programmatic ads simulation. For a test case use “nba”
-Example:
-```
-var config = {
-  "url":"https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8",
-  "gameId":"“arena_nba_BB_test_Lakers_long”,
-  "channel":"nba"
-};
-```
-To get Timecode information AMC_EVENT_PLAYER_METADATA and AMC_EVENT_PLAYER_SEGMENT_PLAYBACK events should be forwarded to OTTPlayer
-```
-	function onNewMetadata(eventObj) {
-		bbPlayer.onNewMetadata(eventObj)
-	};
-	function onNewSegment(eventObj) {
-		bbPlayer.onNewSegment(eventObj);
-	};
-	wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_METADATA, onNewMetadata);
-	wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_SEGMENT_PLAYBACK, onNewSegment);
-
-```
-
-### Control
-To toggle the SDK on off, use the SDK Toggle method with a boolean:
-```
-bbPlayer.Toggle({true|false});
-```
-
-
-## Changelog
-
-### Version 1.0.0
-Initial version
-
-### Version 1.0.1
-Initial version
-
-### Version 1.0.2
-Initial version
-
-### Version 1.0.3
-Added readme.md
-
-### Version 1.0.4
-Added support of 59.94 streams
-
-Added interface functions to get sync timecodes from MK MetadataEvents
-
-### Version 1.0.5
-Added support of Safari on Mac
-
-### Version 1.0.6
-Enabled support of Safari on Mac
-
-### Version 1.0.7
-Fixed Safari issue.
-Improved Chrome rendering
-
-### Version 1.0.8
-Added usage of TimeCodesSync service
-
-### Version 1.0.9
-Bug fix
-
-### Version 1.0.10
-Bug fix
-
-### Version 1.0.11
-Bug fix
-
-### Version 1.0.12
-All is packed to one file
-
-### Version 1.0.13
-Chrome on MK REF App support
-
-### Version 1.0.14
-Safari on MK REF App support
-
-### Version 1.0.15
-MK REF App DEV stream support
-
-### Version 1.0.16
-Improvements
-
-### Version 1.0.17
-Improvements
-
-### Version 1.0.18
-Improvements
-
-### Version v1.0.19 
-Chrome-Mac support
-
-### Version v1.0.20 
-Improvements### Version v1.0.21 
-test26 
- 
-### Version v1.0.22 
-test26 
- 
-### Version v1.0.23 
-test_v_1.0.23 
-
-### Version v1.0.24 
-test 
- 
-### Version v1.0.25 
-test 
- 
-### Version v1.0.26 
-test 
- 
-### Version v1.0.27 
-test 
- 
-### Version v1.0.28 
-test 
- 
-### Version v1.0.29 
-test 
- 
-### Version v1.0.30 
-test 
- 
-### Version v1.0.31 
-test 
- 
-### Version v1.0.32 
-QA_newAPi_funcNames 
- 
-### Version v1.0.33 
-mac_any_screenFPS 
- 
-### Version v1.0.34 
-29_fps_support_in_chrome_windows 
- 
-### Version v1.0.35 
-added_more_debug_to_virtualott 
- 
-### Version v1.0.36 
-mac_chrome_correction_disable 
- 
-### Version v1.0.37 
-one_of_jitters_fixed_on_safari_mac 
- 
-### Version v1.0.38 
-one_of_jitters_fixed_on_safari_mac_2 
- 
-### Version v1.0.39 
-dual_mac_chrome_safari 
- 
-### Version v1.0.40 
-added_fps_checks 
- 
-### Version v1.0.41 
-chrome_mac_mkRefApp_jitter_fix 
- 
-### Version v1.0.42 
-chrome_mac_safari_antialiasing_fix
- 
-### Version v1.0.43
-chrome_mac_29fps_enabled
- 
+# OTT-BB-Player
+
+Welcome to OTT-BB-Player! This README provides information about the project, including installation instructions and a changelog.
+
+## Table of Contents
+
+- [Overview](#Overview)
+- [Installation](#installation)
+- [HowTo](#HowTo)
+- [Example](#example)
+- [Changelog](#changelog)
+
+## Overview
+
+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.
+
+## Installation
+
+To install My Project, follow these steps:
+
+1. Login into npmjs repo if you are not logged in
+
+```bash
+npm login
+```
+
+2. Use npm to install the package
+
+```bash
+npm install @brandbrigade/ott-bb-player --prefix .
+```
+
+## HowTo
+
+### Initialization
+
+To initialize the SDK, one should provide:
+
+1. Video Tag: You should submit the video element (the one that is submitted to the MK player by wmcMgr.setContainer(video))
+
+2. Frame rate
+   (In the future this parameter will be omitted and fetched internally with the MediaKind API)
+
+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
+
+4. A channel name: The programmatic emulation channel to demonstrate the targeted ad
+
+```
+bbPlayer = new BB.OTTPlayer(
+  video, //Video Tag
+  30000/1001, // frame rate
+  { gameId:<game id>,//game id
+    augmentation:{“channelName”:”nba”}});//channel name
+```
+
+## Example
+
+**sample.html** is an example page showing usage of OTT-BB-Player
+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)
+
+The inital configuration on the config json on the top of the sample.html page, requires:
+
+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)
+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.
+3. A Channel for the programmatic ads simulation. For a test case use “nba”
+   Example:
+
+```
+var config = {
+  "url":"https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8",
+  "gameId":"“arena_nba_BB_test_Lakers_long”,
+  "channel":"nba"
+};
+```
+
+To get Timecode information AMC_EVENT_PLAYER_METADATA and AMC_EVENT_PLAYER_SEGMENT_PLAYBACK events should be forwarded to OTTPlayer
+
+```
+	function onNewMetadata(eventObj) {
+		bbPlayer.onNewMetadata(eventObj)
+	};
+	function onNewSegment(eventObj) {
+		bbPlayer.onNewSegment(eventObj);
+	};
+	wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_METADATA, onNewMetadata);
+	wmcMgr.addEventListener(wmcEvents.AMC_EVENT_PLAYER_SEGMENT_PLAYBACK, onNewSegment);
+
+```
+
+### Control
+
+To toggle the SDK on off, use the SDK Toggle method with a boolean:
+
+```
+bbPlayer.Toggle({true|false});
+```
+
+## Changelog
+
+### Version 1.0.0
+
+Initial version
+
+### Version 1.0.1
+
+Initial version
+
+### Version 1.0.2
+
+Initial version
+
+### Version 1.0.3
+
+Added readme.md
+
+### Version 1.0.4
+
+Added support of 59.94 streams
+
+Added interface functions to get sync timecodes from MK MetadataEvents
+
+### Version 1.0.5
+
+Added support of Safari on Mac
+
+### Version 1.0.6
+
+Enabled support of Safari on Mac
+
+### Version 1.0.7
+
+Fixed Safari issue.
+Improved Chrome rendering
+
+### Version 1.0.8
+
+Added usage of TimeCodesSync service
+
+### Version 1.0.9
+
+Bug fix
+
+### Version 1.0.10
+
+Bug fix
+
+### Version 1.0.11
+
+Bug fix
+
+### Version 1.0.12
+
+All is packed to one file
+
+### Version 1.0.13
+
+Chrome on MK REF App support
+
+### Version 1.0.14
+
+Safari on MK REF App support
+
+### Version 1.0.15
+
+MK REF App DEV stream support
+
+### Version 1.0.16
+
+Improvements
+
+### Version 1.0.17
+
+Improvements
+
+### Version 1.0.18
+
+Improvements
+
+### Version v1.0.19
+
+Chrome-Mac support
+
+### Version v1.0.20
+
+Improvements### Version v1.0.21
+test26
+
+### Version v1.0.22
+
+test26
+
+### Version v1.0.23
+
+test_v_1.0.23
+
+### Version v1.0.24
+
+test
+
+### Version v1.0.25
+
+test
+
+### Version v1.0.26
+
+test
+
+### Version v1.0.27
+
+test
+
+### Version v1.0.28
+
+test
+
+### Version v1.0.29
+
+test
+
+### Version v1.0.30
+
+test
+
+### Version v1.0.31
+
+test
+
+### Version v1.0.32
+
+QA_newAPi_funcNames
+
+### Version v1.0.33
+
+mac_any_screenFPS
+
+### Version v1.0.34
+
+29_fps_support_in_chrome_windows
+
+### Version v1.0.35
+
+added_more_debug_to_virtualott
+
+### Version v1.0.36
+
+mac_chrome_correction_disable
+
+### Version v1.0.37
+
+one_of_jitters_fixed_on_safari_mac
+
+### Version v1.0.38
+
+one_of_jitters_fixed_on_safari_mac_2
+
+### Version v1.0.39
+
+dual_mac_chrome_safari
+
+### Version v1.0.40
+
+added_fps_checks
+
+### Version v1.0.41
+
+chrome_mac_mkRefApp_jitter_fix