@playkit-js/transcript 2.1.5-canary.27-d3cdc03 → 2.1.5-canary.30-eb358ab

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [2.1.5-canary.27-d3cdc03](https://github.com/kaltura/playkit-js-transcript/compare/v2.1.4...v2.1.5-canary.27-d3cdc03) (2022-08-30)
+### [2.1.5-canary.30-eb358ab](https://github.com/kaltura/playkit-js-transcript/compare/v2.1.4...v2.1.5-canary.30-eb358ab) (2022-09-13)
 
 
 ### Bug Fixes
@@ -16,6 +16,7 @@ All notable changes to this project will be documented in this file. See [standa
 * **FEV-1362:** resolve race condition between API call and FirstPlaying event ([#103](https://github.com/kaltura/playkit-js-transcript/issues/103)) ([e28422e](https://github.com/kaltura/playkit-js-transcript/commit/e28422ef5822aee23f193e9f9ddd49ad49195a1b))
 * **FEV-1362:** use 1st language from list if captions switched to "off" ([a954dce](https://github.com/kaltura/playkit-js-transcript/commit/a954dcefa22660e29ef5e68a2384d01859436133))
 * **FEV-1363:** disable transcript plugin for live entries ([1ea40a3](https://github.com/kaltura/playkit-js-transcript/commit/1ea40a3f23c181d42e7cce84183c22b64fe457e2))
+* **FEV-1419:** register to player ready event instead of plugin ready event ([#106](https://github.com/kaltura/playkit-js-transcript/issues/106)) ([8163cc8](https://github.com/kaltura/playkit-js-transcript/commit/8163cc89e8868a2c5eb2e50c89dd167165a75940))
 
 ### [2.1.4](https://github.com/kaltura/playkit-js-transcript/compare/v2.1.3...v2.1.4) (2022-01-19)
 

package/README.md

@@ -41,6 +41,10 @@ Finally, add the bundle as a script tag in your page, and initialize the player
 ```html
 <script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
 <!--Kaltura player-->
+<script type="text/javascript" src="/PATH/TO/FILE/playkit-kaltura-cuepoints.js"></script>
+<!--PlayKit cuepoints plugin-->
+<script type="text/javascript" src="/PATH/TO/FILE/playkit-ui-managers.js"></script>
+<!--PlayKit ui-managers plugin-->
 <script type="text/javascript" src="/PATH/TO/FILE/playkit-transcript.js"></script>
 <!--PlayKit transcript plugin-->
 <div id="player-placeholder" style="height:360px; width:640px">
@@ -50,8 +54,9 @@ Finally, add the bundle as a script tag in your page, and initialize the player
      ...
      targetId: 'player-placeholder',
      plugins: {
-       transcript: { ... },
-       kalturaCuepoints: {}
+      transcript: { ... },
+      uiManagers: { ... },
+      kalturaCuepoints: { ... },
      }
      ...
     };
@@ -63,25 +68,13 @@ Finally, add the bundle as a script tag in your page, and initialize the player
 
 ## Documentation
 
-TBD
+Transcript plugin configuration can been found here:
 
-## Running the tests
+- **[Configuration](#configuration)**
 
-Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari
+Transcript plugin dependencies can been found here:
 
-[karma]: https://karma-runner.github.io/1.0/index.html
-
-```
-yarn run test
-```
-
-You can test individual browsers:
-
-```
-yarn run test:chrome
-yarn run test:firefox
-yarn run test:safari
-```
+- **[Dependencies](#dependencies)**
 
 ### And coding style tests
 
@@ -91,10 +84,6 @@ See [ESLint config](.eslintrc.json) for full configuration.
 
 We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
 
-## Compatibility
-
-TBD
-
 ## Contributing
 
 Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
@@ -109,20 +98,121 @@ This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICEN
 
 ## Commands
 
-Run dev server: `npm run serve`;<br/>
-Update contrib: `npm run infra:latest`;<br/>
-Bump version: `npm run deploy:prepare`;<br/>
+Run dev server: `yarn dev`;<br/>
+Bump version: `yarn release`;<br/>
 
+<a name="configuration"></a>
 ## Configuration
 
-Plugin configuration:<br/> > `expandOnFirstPlay`: boolean - if plugin should automatically opens on first play (default true);<br/> > `forceChaptersThumb`: boolean - force to use chapters thumbnails (default false);<br/> > `expandMode`: string - expand mode of kitchensink (AlongSideTheVideo|OverTheVideo, default "AlongSideTheVideo");<br/> > `userRole`: string - use session userId as identificator of user (anonymousRole|unmoderatedAdminRole, default "anonymousRole");<br/> > `itemsOrder`: object< string, number > - define order of Tabs (min value at the left) and Items inside group (min value at the top).<br/> itemsOrder also uses as tabs filter (all items that not included in "itemsOrder" object will be filtered out) (default:
-` { "All": 0, "Chapter": 1, "Slide": 2, "Hotspot": 3, "AnswerOnAir": 4, } ); `
-
-## Troubleshooting
+#### Configuration Structure
+
+```js
+//Default configuration
+"transcript" = {};
+//Plugin params
+"transcript" = {
+  expandMode?: string, // optional
+  expandOnFirstPlay?: boolean, // optional
+  showTime?: boolean, // optional
+  position?: string, // optional
+  scrollOffset?: number // optional
+  searchDebounceTimeout?: number // optional
+  searchNextPrevDebounceTimeout?: number // optional
+  downloadDisabled?: boolean // optional
+  printDisabled?: boolean // optional
+}
+```
+##
+
+> ### config.expandMode
+>
+> ##### Type: `string`
+>
+> ##### Default: `alongside`;(‘alongside', ‘hidden’, 'over’)
+>
+
+##
+
+> ### config.expandOnFirstPlay
+>
+> ##### Type: `boolean`
+>
+> ##### Default: `true`
+>
+
+##
+
+> ### config.showTime
+>
+> ##### Type: `boolean`
+>
+> ##### Default: `true`
+>
+
+##
+
+> ### config.position
+>
+> ##### Type: `string`
+>
+> ##### Default: `bottom`;(‘left’, ‘right', ‘top’, 'bottom’)
+>
+
+##
+
+> ### config.scrollOffset
+>
+> ##### Type: `number`
+>
+> ##### Default: `0`
+>
+
+##
+
+> ### config.searchDebounceTimeout
+>
+> ##### Type: `number`
+>
+> ##### Default: `250`
+>
+
+##
+
+> ### config.searchNextPrevDebounceTimeout
+>
+> ##### Type: `number`
+>
+> ##### Default: `100`
+>
+
+##
+
+> ### config.downloadDisabled
+>
+> ##### Type: `boolean`
+>
+> ##### Default: `false`
+>
+
+##
+
+> ### config.printDisabled
+>
+> ##### Type: `boolean`
+>
+> ##### Default: `false`
+>
+
+<a name="dependencies"></a>
+## Dependencies
+
+Plugin dependencies:<br/>
+<a href="https://github.com/kaltura/playkit-js-kaltura-cuepoints">Cue Points</a><br/>
+<a href="https://github.com/kaltura/playkit-js-ui-managers">UI Managers</a>
 
 ### Dev env
 
-Node version: up to 14.18.1<br/>
+Node version: up to 14+<br/>
 If nvm installed: `nvm use` change version of current terminal to required.<br/>
 
 ### ARM Architecture support