chore: update v7.0.0 documentation (#435)

videojs · Jul 24, 2023 · 21e55aa · 21e55aa
1 parent 1322105
commit 21e55aa
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,27 @@
 * update collaborator guide md ([51b3ed4](https://github.com/videojs/mux.js/commit/51b3ed4))
 * update git push suggestion in collaborator guide md ([73a5b60](https://github.com/videojs/mux.js/commit/73a5b60))
 
+### BREAKING CHANGES
+
+* In the case of CEA-608 captions, mux.js will now be returning captions in the form of caption sets.
+This means that rather then returning a single text of combined caption cues, an array of caption cues is returned in the `content` property.
+
+```js
+transmuxer.on('data', function (segment) {
+  // create a VTTCue for all the parsed CEA-608 captions:>
+  segment.captions.forEach(function(captionSet) {
+    // Caption sets contains multiple captions with text and position data.
+    captionSet.content.forEach(function(cue) {
+      const newCue = new VTTCue(cue.startTime, cue.endTime, cue.text);
+      newCue.line = cue.line;
+      newCue.position = cue.position;
+
+      captionTextTrack.addCue(newCue);
+    });
+  });
+});
+```
+
 <a name="6.3.0"></a>
 # [6.3.0](https://github.com/videojs/mux.js/compare/v6.2.0...v6.3.0) (2023-02-22)
 

diff --git a/README.md b/README.md
@@ -333,8 +333,15 @@ transmuxer.on('data', function (segment) {
     metadataTextTrack.addCue(new VTTCue(time, time, frame.value));
   });
   // create a VTTCue for all the parsed CEA-608 captions:>
-  segment.captions.forEach(function(cue) {
-    captionTextTrack.addCue(new VTTCue(cue.startTime, cue.endTime, cue.text));
+  segment.captions.forEach(function(captionSet) {
+    // Caption sets contains multiple caption cues with text and position data.
+    captionSet.content.forEach(function(cue) {
+      const newCue = new VTTCue(cue.startTime, cue.endTime, cue.text);
+      newCue.line = cue.line;
+      newCue.position = cue.position;
+
+      captionTextTrack.addCue(newCue);
+    });
   });
 });
 ```