@brandbrigade/ott-bb-player 1.0.1 → 1.0.3
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 +87 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
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
|
+
## Overview
|
|
13
|
+
|
|
14
|
+
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.
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
To install My Project, follow these steps:
|
|
19
|
+
1. Login into npmjs repo if you are not logged in
|
|
20
|
+
```bash
|
|
21
|
+
npm login
|
|
22
|
+
```
|
|
23
|
+
2. Use npm to install the package
|
|
24
|
+
```bash
|
|
25
|
+
npm install @brandbrigade/ott-bb-player --prefix .
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## HowTo
|
|
29
|
+
### Initialization
|
|
30
|
+
To initialize the SDK, one should provide:
|
|
31
|
+
|
|
32
|
+
1. Video Tag: You should submit the video element (the one that is submitted to the MK player by wmcMgr.setContainer(video))
|
|
33
|
+
|
|
34
|
+
2. Frame rate
|
|
35
|
+
(In the future this parameter will be omitted and fetched internally with the MediaKind API)
|
|
36
|
+
|
|
37
|
+
3. MKPlayer instance (aka wmcMgr)
|
|
38
|
+
|
|
39
|
+
4. 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
|
|
40
|
+
|
|
41
|
+
5. A channel name: The programmatic emulation channel to demonstrate the targeted ad
|
|
42
|
+
```
|
|
43
|
+
bbPlayer = new BB.OTTPlayer(
|
|
44
|
+
video, //Video Tag
|
|
45
|
+
30000/1001, // frame rate
|
|
46
|
+
wmcMgr,//MKPlayer instance
|
|
47
|
+
{ gameId:<game id>,//game id
|
|
48
|
+
augmentation:{“channelName”:”nba”}});//channel name
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Example
|
|
52
|
+
**sample.html** is an example page showing usage of OTT-BB-Player
|
|
53
|
+
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)
|
|
54
|
+
|
|
55
|
+
The inital configuration on the config json on the top of the sample.html page, requires:
|
|
56
|
+
1. A Stream URL. An example stream can be accessed at [this link](https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8)
|
|
57
|
+
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.
|
|
58
|
+
3. A Channel for the programmatic ads simulation. For a test case use “nba”
|
|
59
|
+
Example:
|
|
60
|
+
```
|
|
61
|
+
var config = {
|
|
62
|
+
"url":"https://injecto-streams.s3-accelerate.amazonaws.com/hls_fileTest_tmp/index_test.m3u8",
|
|
63
|
+
"gameId":"“arena_nba_BB_test_Lakers_long”,
|
|
64
|
+
"channel":"nba"
|
|
65
|
+
};
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Control
|
|
69
|
+
To toggle the SDK on off, use the SDK Toggle method with a boolean:
|
|
70
|
+
```
|
|
71
|
+
bbPlayer.Toggle({true|false});
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## Changelog
|
|
76
|
+
|
|
77
|
+
### Version 1.0.0
|
|
78
|
+
Initial version
|
|
79
|
+
|
|
80
|
+
### Version 1.0.1
|
|
81
|
+
Initial version
|
|
82
|
+
|
|
83
|
+
### Version 1.0.2
|
|
84
|
+
Initial version
|
|
85
|
+
|
|
86
|
+
### Version 1.0.3
|
|
87
|
+
Added readme.md
|