https://github.com/walsh9/videojs-transcript
▶️📃 Interactive transcript plugin for video.js
https://github.com/walsh9/videojs-transcript
transcript videojs
Last synced: 5 months ago
JSON representation
▶️📃 Interactive transcript plugin for video.js
- Host: GitHub
- URL: https://github.com/walsh9/videojs-transcript
- Owner: walsh9
- License: mit
- Created: 2014-09-09T00:42:20.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-04T20:06:17.000Z (over 8 years ago)
- Last Synced: 2025-07-22T05:16:58.649Z (6 months ago)
- Topics: transcript, videojs
- Language: JavaScript
- Homepage: https://walsh9.github.io/videojs-transcript/example.html
- Size: 109 KB
- Stars: 142
- Watchers: 16
- Forks: 56
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Video.js Transcript
Creates interactive transcripts from text tracks.
## Alpha Release 3
Please report any issues or feature requests on the tracker. Thank you!
## Getting Started
Once you've added the plugin script to your page, you can use it with any video:
```html
var video = videojs('video').ready(function(){
// Set up any options.
var options = {
showTitle: false,
showTrackSelector: false,
};
// Initialize the plugin.
var transcript = this.transcript(options);
// Then attach the widget to the page.
var transcriptContainer = document.querySelector('#transcript');
transcriptContainer.appendChild(transcript.el());
});
```
There's also a [working example](https://walsh9.github.io/videojs-transcript/example.html) of the plugin you can check out if you're having trouble.
You'll also want to include one of the css files.
You can style the plugin as you like but there are a few examples in the /css folder to get you started.
## Documentation
### Plugin Options
You may pass in an options object to the plugin upon initialization. This
object may contain any of the following properties:
#### autoscroll
**Default:** true
Set to false to disable autoscrolling.
#### scrollToCenter
**Default:** false
By default current row shows on the bottom on autoscrolling. Set to true to show it in the center
#### clickArea
**Default:** 'line'
Set which elements in the transcript are clickable.
Options are 'timestamp', 'text', the whole 'line', or 'none'.
#### showTitle
**Default:** true
Show a title with the transcript widget.
(Currently the title only says 'Transcript')
#### showTrackSelector
**Default:** true
Show a track selector with the transcript widget.
#### followPlayerTrack
**Default:** true
When you change the caption track on the video, the transcript changes tracks as well.
#### stopScrollWhenInUse
**Default:** true
Don't autoscroll the transcript when the user is trying to scroll it.
(This probably still has a few glitches to work out on touch screens and stuff right now)
### Plugin Methods
**el()**
Returns the DOM element containing the html transcript widget. You'll need to append this to your page.
## Release History
##### 0.8.0: Alpha Release 3
* Updated for video.js 5.x
##### 0.7.2: Alpha Release 2
* Updated for video.js 4.12
##### 0.7.1: Alpha Release 1
* First release