Skip to content

Commit a63fa1b

Browse files
committed
2 parents 12d93af + 36b7e4f commit a63fa1b

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
A browser based tool for running JavaScript code at specific frames of an audio track. This is useful for creating interactive music videos, making subtitles, or anything else where audiovisual synchronization is required.
44

5+
## Demo
6+
7+
[Minimal Demo](http://gridav.net/codekeyframes-demo)
8+
59
## How-To
610

711
1. Include the js file and the css file from the repository:
8-
- [codeKeyframes.min.js](https://github.com/gridwalk/codekeyframes/releases/download/v1.0.1/codeKeyframes.min.js)
9-
- [codeKeyframes.css](https://github.com/gridwalk/codekeyframes/releases/download/v1.0.1/codeKeyframes.css)
12+
- [codeKeyframes.min.js](https://github.com/gridwalk/codekeyframes/releases/latest)
13+
- [codeKeyframes.css](https://github.com/gridwalk/codekeyframes/releases/latest)
1014

1115
2. Initialize an instance of CodeKeyframes:
1216

@@ -17,7 +21,14 @@ var ckf = new CodeKeyframes({
1721
waveColor: '#3AEAD2',
1822
progressColor: '#0c9fa7',
1923
bgColor: '#222',
20-
keyframes:[] // paste in after exporting keyframes
24+
label: 'Text that appears at the top left of the waveform.',
25+
keyframes: [], // paste in after exporting keyframes
26+
autoplay: false, // doesn't always work due to browser limitations
27+
onCanPlay: function(){
28+
// playback can start now
29+
// call this to start playback:
30+
// ckf.wavesurfer.play()
31+
}
2132
})
2233
```
2334

@@ -36,8 +47,8 @@ Make sure you click the waveform before using keyboard controls. This choice was
3647
`Up & Down` : Zoom waveform<br>
3748
`Space` : Play / Pause<br>
3849
`Enter` : Add keyframe<br>
39-
`Page Up & Page Down` : Jump between keyframes
40-
`[ and ]` : Jump between keyframes
50+
`Page Up & Page Down` : Jump between keyframes<br>
51+
`[ and ]` : Jump between keyframes<br>
4152
`Alt + Left or Right` : Nudge active keyframe
4253

4354
## Acknowledgements

0 commit comments

Comments
 (0)