PlayKit JS Transcript - plugin for the [PlayKit JS Player]


PlayKit JS Transcript is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].

[typescript]: https://www.typescriptlang.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io

Getting Started

$3

The plugin requires [Kaltura Player] to be loaded first.

[kaltura player]: https://github.com/kaltura/kaltura-player-js

$3

First, clone and run [yarn] to install dependencies:

[yarn]: https://yarnpkg.com/lang/en/

``
git clone https://github.com/kaltura/playkit-js-transcript.git
cd playkit-js-transcript
yarn install
`

$3

Then, build the plugin

`javascript
yarn run build
`

$3

The plugin uses cypress tool for e2e tests

`javascript
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.

$3

Finally, add the bundle as a script tag in your page, and initialize the player

`html











`

Documentation

Transcript plugin configuration can been found here:

- Configuration

Transcript plugin dependencies can been found here:

- Dependencies

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details

Commands

Run dev server: yarn dev;

Bump version: yarn release;





Configuration

#### 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
>




Dependencies

Plugin dependencies:

Cue Points

UI Managers

$3

Node version: up to 14+

If nvm installed: nvm use change version of current terminal to required.


$3

Install dependencies with npm install --target_arch=x64` set target arch for running it through Rosetta (requires Rosetta installation).