feat: allow transcript from url (#737)

* feat: allow transcript url * chore: transcript analytics * chore: transcript analytics
cloudinary · Nov 26, 2024 · 6cd4bc8 · 6cd4bc8
1 parent 69dfde2
commit 6cd4bc8
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 53 deletions.
diff --git a/docs/subtitles-and-captions.html b/docs/subtitles-and-captions.html
@@ -117,9 +117,7 @@
 
       // Paced
       const pacedPlayer = cloudinary.videoPlayer('paced', {
-        cloudName: 'demo',
-        autoplay: true,
-        muted: true
+        cloudName: 'demo'
       });
 
       const publicId = 'lincoln';
@@ -180,9 +178,7 @@
 
       // Karaoke
       const karaokePlayer = cloudinary.videoPlayer('karaoke', {
-        cloudName: 'demo',
-        autoplay: true,
-        muted: true
+        cloudName: 'demo'
       });
 
       karaokePlayer.source('lincoln', {
@@ -212,6 +208,22 @@
           }
         }
       });
+
+      // Transcript from URL
+      const urlTranscriptPlayer = cloudinary.videoPlayer('url-transcript', {
+        cloudName: 'demo'
+      });
+
+      urlTranscriptPlayer.source('elephants', {
+        textTracks: {
+          captions: {
+            label: "Lincoln's Transcript",
+            url: 'https://res.cloudinary.com/demo/raw/upload/lincoln.transcript',
+            wordHighlight: true,
+            maxWords: 8
+          }
+        }
+      });
     }, false);
   </script>
 </head>
@@ -227,8 +239,6 @@ <h3 class="mb-4">Subtitles & Captions</h3>
       id="player"
       playsinline
       controls
-      muted
-      autoplay
       class="cld-video-player cld-fluid"
       crossorigin="anonymous"
       width="500"
@@ -240,7 +250,6 @@ <h4 class="mt-4 mb-2">Playlist Subtitles (switch per source)</h4>
       id="playlist"
       playsinline
       controls
-      muted
       class="cld-video-player cld-fluid"
       crossorigin="anonymous"
       width="500"
@@ -290,7 +299,6 @@ <h4 class="mt-4 mb-2">Paced & Styled Captions</h4>
       id="paced"
       playsinline
       controls
-      muted
       class="cld-video-player cld-fluid"
       crossorigin="anonymous"
       width="500"
@@ -302,7 +310,17 @@ <h4 class="mt-4 mb-2">Karaoke player</h4>
       id="karaoke"
       playsinline
       controls
-      muted
+      class="cld-video-player cld-fluid"
+      crossorigin="anonymous"
+      width="500"
+    ></video>
+
+    <h4 class="mt-4 mb-2">Transcript from URL</h4>
+
+    <video
+      id="url-transcript"
+      playsinline
+      controls
       class="cld-video-player cld-fluid"
       crossorigin="anonymous"
       width="500"
@@ -318,45 +336,16 @@ <h3 class="mt-4">Example Code:</h3>
         &lt;video
           id="player"
           controls
-          muted
-          autoplay
-          class="cld-video-player"
-          crossorigin="anonymous"
-          width="500">
-        &lt;/video&gt;
-
-        &lt;video
-          id="playlist"
-          controls
-          muted
           class="cld-video-player"
           crossorigin="anonymous"
           width="500"&gt;
         &lt;/video&gt;
 
-        &lt;video
-          id="paced"
-          controls
-          muted
-          autoplay
-          class="cld-video-player"
-          crossorigin="anonymous"
-          width="500">
-        &lt;/video&gt;
-
-        &lt;video
-          id="karaoke"
-          controls
-          muted
-          autoplay
-          class="cld-video-player"
-          crossorigin="anonymous"
-          width="500">
-        &lt;/video&gt;
+        &lt;!-- ... a few more &lt;video&gt; tags --&gt;
       </code>
       <code class="language-javascript">
 
-        // Initialize player
+        // Initialize players
         var player = cloudinary.videoPlayer('player', { cloud_name: 'demo' });
 
         player.source(
@@ -443,9 +432,7 @@ <h3 class="mt-4">Example Code:</h3>
 
         // Paced
         const pacedPlayer = cloudinary.videoPlayer('paced', {
-          cloudName: 'demo',
-          autoplay: true,
-          muted: true
+          cloudName: 'demo'
         });
 
         pacedPlayer.source('lincoln', {
@@ -488,9 +475,7 @@ <h3 class="mt-4">Example Code:</h3>
 
         // Karaoke
         const karaokePlayer = cloudinary.videoPlayer('karaoke', {
-          cloudName: 'demo',
-          autoplay: true,
-          muted: true
+          cloudName: 'demo'
         });
 
         karaokePlayer.source('lincoln', {
@@ -521,6 +506,22 @@ <h3 class="mt-4">Example Code:</h3>
           }
         });
 
+        // Transcript from URL
+        const urlTranscriptPlayer = cloudinary.videoPlayer('url-transcript', {
+          cloudName: 'demo'
+        });
+
+        urlTranscriptPlayer.source('elephants', {
+          textTracks: {
+            captions: {
+              label: "Lincoln's Transcript",
+              url: 'https://res.cloudinary.com/demo/raw/upload/lincoln.transcript',
+              wordHighlight: true,
+              maxWords: 8
+            }
+          }
+        });
+
       </code>
     </pre>
   </div>

diff --git a/src/utils/cloudinary.js b/src/utils/cloudinary.js
@@ -101,13 +101,13 @@ const isKeyInTransformation = (transformation, key) => {
 
 const addTextTracks = (tracks, videojs) => {
   tracks.forEach(track => {
-    if (track.src) {
+    if (track.src && track.src.endsWith('.vtt')) {
       fetch(track.src, GET_ERROR_DEFAULT_REQUEST).then(r => {
         if (r.status >= 200 && r.status <= 399) {
           videojs.addRemoteTextTrack(track, true);
         }
       });
-    } else if (videojs.pacedTranscript) {
+    } else if (videojs.pacedTranscript && (!track.src || track.src.endsWith('.transcript'))) {
       videojs.pacedTranscript(track);
     }
   });

diff --git a/src/utils/get-analytics-player-options.js b/src/utils/get-analytics-player-options.js
@@ -19,6 +19,19 @@ const getCloudinaryOptions = (cloudinaryOptions = {}) => ({
   posterOptionsPublicId: cloudinaryOptions.posterOptions && hasConfig(cloudinaryOptions.posterOptions.publicId)
 });
 
+const getTranscriptOptions = (textTracks = {}) => {
+  const tracksArr = [textTracks.captions, ...textTracks.subtitles];
+  return {
+    textTracks: hasConfig(textTracks),
+    pacedTextTracks: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"maxWords":') || null,
+    wordHighlight: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"wordHighlight":') || null,
+    transcriptAutoLoaded: tracksArr.some((track) => !track.url) || null,
+    transcriptFromURl: tracksArr.some((track) => track.url?.endsWith('.transcript')) || null,
+    transcriptLanguages: tracksArr.filter((track) =>  !track.url).map((track) => track.language || '').join(',') || null,
+    vttFromUrl: tracksArr.some((track) => track.url?.endsWith('.vtt')) || null
+  };
+};
+
 const getSourceOptions = (sourceOptions = {}) => ({
   chapters: sourceOptions.chapters && (sourceOptions.chapters.url ? 'url' : 'inline-chapters'),
   recommendations: sourceOptions.recommendations && sourceOptions.recommendations.length,
@@ -30,9 +43,7 @@ const getSourceOptions = (sourceOptions = {}) => ({
     sourceInfoDescription: sourceOptions.info.description
   } : {}),
   ...(sourceOptions.textTracks ? {
-    textTracks: hasConfig(sourceOptions.textTracks),
-    pacedTextTracks: hasConfig(sourceOptions.textTracks) && JSON.stringify(sourceOptions.textTracks || {}).includes('"maxWords":'),
-    wordHighlight: hasConfig(sourceOptions.textTracks) && JSON.stringify(sourceOptions.textTracks || {}).includes('"wordHighlight":'),
+    ...(hasConfig(sourceOptions.textTracks) && getTranscriptOptions(sourceOptions.textTracks)),
     ...(sourceOptions.textTracks.options ? {
       styledTextTracksTheme: sourceOptions.textTracks.options.theme,
       styledTextTracksFont: sourceOptions.textTracks.options.fontFace,