Add download() method

Author: olivier-lando

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All changes to this project will be documented in this file.
 
+## [1.2.33] - 2024-08-21
+
+- Add `download()` method
+
 ## [1.2.32] - 2024-07-16
 
 - Add `isFullScreen` in `fullscreenchange` event

README.md

@@ -429,6 +429,11 @@ Retrieve the playback rate.
 
 Check whether the video is a live stream.
 
+**`download(filename?: string): void`**
+
+Download the video. If a filename is not provided, the default name 'video.mp4' will be used.
+An exception will be thrown if the video cannot be downloaded.
+
 **`destroy()`**
 
 Destroy the player instance.

index.ts

@@ -376,6 +376,26 @@ export class PlayerSdk {
   getLoop(callback?: (loop: boolean) => void): Promise<boolean> {
     return this.postMessage({ message: "getLoop" }, callback);
   }
+  download(filename?: string) {
+    this.postMessage({ message: "getMp4Url" }, (res) => {
+      if (!res) {
+        throw new Error("This video is not downloadable");
+      }
+      fetch(res as string).then((response) => {
+        response.blob().then((blob) => {
+          const url = URL.createObjectURL(blob);
+
+          const link = document.createElement("a");
+          link.href = url;
+          link.download = filename || "video.mp4";
+          link.target = "_blank";
+          link.click();
+
+          URL.revokeObjectURL(url);
+        });
+      });
+    });
+  }
   getVideoSize(
     callback?: (size: { width: number; height: number }) => void
   ): Promise<{ width: number; height: number }> {
@@ -638,6 +658,22 @@ export class PlayerSdk {
     });
   }
 
+  private appendQueryParamIfMissing = (
+    url: string,
+    name: string,
+    value: string
+  ): string => {
+    const urlObj = new URL(url, document.location.href);
+    const urlSearchParams = new URLSearchParams(urlObj.search);
+    if (urlSearchParams.has(name)) {
+      return url;
+    }
+
+    urlSearchParams.append(name, value);
+    urlObj.search = urlSearchParams.toString();
+    return urlObj.toString();
+  };
+
   private makeId(length: number) {
     const characters =
       "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@api.video/player-sdk",
-  "version": "1.2.32",
+  "version": "1.2.33",
   "description": "api.video player SDK",
   "repository": {
     "type": "git",