Merge pull request #4 from apivideo/make-timeslice-customizable

Make start() timeslice parameter customizable

Author: olivier-lando

.github/workflows/create-release-from-changelog.yml

@@ -0,0 +1,16 @@
+name: Create draft release if needed
+on:
+  push:
+    branches:
+      - main
+jobs:
+  create-draft-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Create draft release if needed
+        uses: apivideo/[email protected]
+        with:
+          github-auth-token: ${{ secrets.GITHUB_TOKEN }}
+          prefix: v
+   

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 name: Release package to npmjs
 on:
   release:
-    types: [created]
+    types: [published]
 jobs:
   deploy:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.2] - 2022-03-07
+- Make the start() timeslice parameter customizable
+
 ## [1.0.1] - 2021-11-25
 - Bump dependancies
 

README.md

@@ -24,7 +24,8 @@
       - [Common options](#common-options)
     - [Example](#example)
   - [Methods](#methods)
-    - [`start()`](#start)
+    - [`start(options?: { timeslice?: number })`](#startoptions--timeslice-number-)
+      - [Options](#options-1)
     - [`stop()`](#stop)
 - [Full example](#full-example)
 
@@ -135,10 +136,10 @@ 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) |
 
 
 ### Example
@@ -152,16 +153,24 @@ Using delegated upload tokens for authentication is best options when uploading
 
 ## Methods
 
-### `start()`
+### `start(options?: { timeslice?: number })`
+
+The start() method starts the upload of the content retrieved from the MediaStream. It takes an optionnal `options` parameter.
+
+#### Options
+| Option name | Mandatory          | Type   | Description                                          |
+| ----------: | ------------------ | ------ | ---------------------------------------------------- |
+|   timeslice | no (default: 5000) | number | The number of milliseconds to record into each Blob. |
 
-The start() method starts the upload of the content retrieved from the MediaStream. It takes no parameter.
 
 **Example**
 
 ```javascript
     // ... mediaRecorder instanciation
 
     mediaRecorder.start();
+    // or, with a 2 seconds timeslice:
+    // mediaRecorder.start({ timeslice: 2000 });
 ```
 
 ### `stop()`

dist/index.js

@@ -8,7 +8,9 @@ export declare class ApiVideoMediaRecorder {
     private onVideoAvailable?;
     constructor(mediaStream: MediaStream, options: ProgressiveUploaderOptionsWithUploadToken | ProgressiveUploaderOptionsWithAccessToken);
     private onDataAvailable;
-    start(): void;
+    start(options?: {
+        timeslice?: number;
+    }): void;
     stop(): Promise<unknown>;
     pause(): void;
     private getSupportedMimeTypes;

dist/src/index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@api.video/media-recorder",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "api.video media recorder - upload video from your webcam with ease",
   "repository": {
     "type": "git",

package-lock.json

@@ -36,8 +36,8 @@ export class ApiVideoMediaRecorder {
         }
     }
 
-    public start() {
-        this.mediaRecorder.start(5000);
+    public start(options?: { timeslice?: number }) {
+        this.mediaRecorder.start(options?.timeslice || 5000);
     }
 
     public stop() {