PlayKit JS Transcript is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.
The plugin requires Kaltura Player to be loaded first.
First, clone and run yarn to install dependencies:
git clone https://github.com/kaltura/playkit-js-transcript.git
cd playkit-js-transcript
yarn install
Then, build the plugin
yarn run build
The plugin uses cypress
tool for e2e tests
yarn run test
UI conf file (cypress/public/ui-conf.js
) contains Kaltura player and plugin dependencies.
Keep Kaltura player and dependency versinos aligned to currently released versions.
Finally, add the bundle as a script tag in your page, and initialize the player
<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">
<script type="text/javascript">
var playerContainer = document.querySelector("#player-placeholder");
var config = {
...
targetId: 'player-placeholder',
plugins: {
'playkit-js-transcript': { ... },
uiManagers: { ... },
kalturaCuepoints: { ... },
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia(...);
</script>
</div>
Transcript plugin configuration can been found here:
Transcript plugin dependencies can been found here:
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details
Run dev server: yarn dev
;
Bump version: yarn release
;
//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
}
Default:
alongside
;(‘alongside', ‘hidden’, 'over’)
Plugin dependencies:
Cue Points
UI Managers
Node version: up to 14+
If nvm installed: nvm use
change version of current terminal to required.
Install dependencies with npm install --target_arch=x64
set target arch for running it through Rosetta (requires Rosetta installation).