Document audio/video track usage #3295

Closed
wants to merge 2 commits into
from

Projects

None yet

3 participants

@BrandonOCasey
Contributor
BrandonOCasey commented May 3, 2016 edited

Description

Document the recently added Video/Audio Track functionality

Specific Changes proposed

  • add the documentation to the guides folder
  • move tracks guide to text-tracks
  • changed index.md entry for tracks.md to make sense
  • updated tracks.md to point to text-tracks, video-tracks, and audio-tracks

Requirements Checklist

  • Feature implemented / Bug fixed
  • Reviewed by Two Core Contributors
@BrandonOCasey BrandonOCasey document audio/video track usage
move tracks to text-tracks
update tracks and index to use new track specific docs
f216df6
@nickygerritsen nickygerritsen commented on an outdated diff May 3, 2016
docs/guides/audio-tracks.md
@@ -0,0 +1,69 @@
+# Audio Tracks
+
+Audio Tracks are a function of HTML5 video for providing time triggered text to the viewer. Video.js makes audio tracks work across all browsers. There are currently five types of tracks:
@nickygerritsen
nickygerritsen May 3, 2016 Contributor

triggered text? Guess you mean something else?

@nickygerritsen nickygerritsen and 1 other commented on an outdated diff May 3, 2016
docs/guides/video-tracks.md
@@ -0,0 +1,70 @@
+# Video Tracks
+
+Video Tracks are a function of HTML5 video for providing time triggered text to the viewer. Video.js makes video tracks work across all browsers. There are currently six types of tracks:
@nickygerritsen
nickygerritsen May 3, 2016 Contributor

Here as well triggered text?

@BrandonOCasey
BrandonOCasey May 3, 2016 Contributor

good catch on these, copy pasted the format of text-track but never updated this section

@nickygerritsen
Contributor

Sorry typed one comment at a wrong place but deleted it again :)

@BrandonOCasey BrandonOCasey updated the first section of video/audio tracks to read correctly
2062498
@nickygerritsen
Contributor

OK LGTM now :)

@BrandonOCasey
Contributor

well this was a quick one! thanks!

@gkatsev gkatsev added the confirmed label May 3, 2016
@gkatsev
Member
gkatsev commented May 3, 2016

LGTM

@BrandonOCasey BrandonOCasey deleted the BrandonOCasey:chore/audio-video-track-documentation branch May 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment