Merge pull request #13 from apivideo/feat/example/custom_file_name

feat: Allow custom video name
apivideo · Oct 10, 2022 · e050eb3 · e050eb3
2 parents 7704532 + a379764
commit e050eb3
Show file tree

Hide file tree

Showing 10 changed files with 104 additions and 149 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 node_modules
+dist
diff --git a/.npmignore b/.npmignore
@@ -3,4 +3,6 @@ tslint.json
 webpack.config.js
 node_modules
 test
-dist/test
+dist/test
+.github
+sample
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.7] - 2022-10-10
+- Allow the user to customize the recorded video's name
+
 ## [1.0.6] - 2022-07-06
 - Update dependancies
 - Add origin headers

diff --git a/README.md b/README.md
@@ -138,10 +138,11 @@ Using delegated upload tokens for authentication is best options when uploading
 #### Common options
 
 
-| Option name | Mandatory | Type   | Description                                           |
-| ----------: | --------- | ------ | ----------------------------------------------------- |
-|     apiHost | no        | string | api.video host (default: ws.api.video)                |
-|     retries | no        | number | number of retries when an API call fails (default: 5) |
+| Option name | Mandatory | Type   | Description                                                         |
+| ----------: | --------- | ------ | ------------------------------------------------------------------- |
+|     apiHost | no        | string | api.video host (default: ws.api.video)                              |
+|     retries | no        | number | number of retries when an API call fails (default: 5)               |
+|   videoName | no        | string | the name of your recorded video (overrides the default "file" name) |
 
 
 ### Example

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/src/index.d.ts b/dist/src/index.d.ts
diff --git a/dist/test/index.test.d.ts b/dist/test/index.test.d.ts
diff --git a/examples/index.html b/examples/index.html
@@ -27,6 +27,7 @@
         <div>
             <button id="start" disabled>start recording</button>
             <button id="stop" disabled>stop recording</button>
+            <input type="text" id="VideoName" />
         </div>
         <div>
             <p>Video link: <span id="video-link"><i>will be displayed when the recording is finished</i></span></p>
@@ -53,8 +54,10 @@
         });
 
         document.getElementById("start").addEventListener("click", () => {
+            const videoName = document.getElementById("VideoName").value
             recorder = new ApiVideoMediaRecorder(stream, {
-                uploadToken: "UPLOAD_TOKEN"
+                uploadToken: "UPLOAD_TOKEN",
+                videoName: videoName
             });
 
             recorder.start();

diff --git a/package-lock.json b/package-lock.json