Merge pull request #11 from apivideo/fix-stop-when-not-started

Fix stop() when not started

Author: olivier-lando

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.5] - 2022-05-31
+- Add `getMediaRecorderState()` method
+- Fix `stop()` method when the recorder is not started
+
 ## [1.0.4] - 2022-05-24
 - Prevent last uploaded part to be empty
 

README.md

@@ -26,7 +26,8 @@
   - [Methods](#methods)
     - [`start(options?: { timeslice?: number })`](#startoptions--timeslice-number-)
       - [Options](#options-1)
-    - [`stop()`](#stop)
+    - [`stop(): Promise<VideoUploadResponse>`](#stop-promisevideouploadresponse)
+    - [`getMediaRecorderState(): RecordingState`](#getmediarecorderstate-recordingstate)
 - [Full example](#full-example)
 
 # Project description
@@ -173,10 +174,14 @@ The start() method starts the upload of the content retrieved from the MediaStre
     // mediaRecorder.start({ timeslice: 2000 });
 ```
 
-### `stop()`
+### `stop(): Promise<VideoUploadResponse>`
 
 The start() method stops the media recording. It upload the last part of content retrieved from the MediaStream (this will start the aggregation of the video parts on the api.video side). It takes no parameter. It returns a Promise that resolves with the newly created video.
 
+### `getMediaRecorderState(): RecordingState`
+
+Return the state of the underlaying [MediaRecorder](https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder).
+
 **Example**
 
 ```javascript

dist/index.js

@@ -1,5 +1,5 @@
 import { ProgressiveUploaderOptionsWithUploadToken, ProgressiveUploaderOptionsWithAccessToken, VideoUploadResponse } from "@api.video/video-uploader";
-export { ProgressiveUploaderOptionsWithAccessToken, ProgressiveUploaderOptionsWithUploadToken } from "@api.video/video-uploader";
+export { ProgressiveUploaderOptionsWithAccessToken, ProgressiveUploaderOptionsWithUploadToken, VideoUploadResponse } from "@api.video/video-uploader";
 export interface Options {
     title?: string;
 }
@@ -12,6 +12,7 @@ export declare class ApiVideoMediaRecorder {
     start(options?: {
         timeslice?: number;
     }): void;
+    getMediaRecorderState(): RecordingState;
     stop(): Promise<VideoUploadResponse>;
     pause(): void;
     private getSupportedMimeTypes;

dist/src/index.d.ts

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

package-lock.json

@@ -1,6 +1,6 @@
 import { ProgressiveUploader, ProgressiveUploaderOptionsWithUploadToken, ProgressiveUploaderOptionsWithAccessToken, VideoUploadResponse } from "@api.video/video-uploader";
 
-export { ProgressiveUploaderOptionsWithAccessToken, ProgressiveUploaderOptionsWithUploadToken } from "@api.video/video-uploader";
+export { ProgressiveUploaderOptionsWithAccessToken, ProgressiveUploaderOptionsWithUploadToken, VideoUploadResponse } from "@api.video/video-uploader";
 
 export interface Options {
     title?: string;
@@ -45,9 +45,13 @@ export class ApiVideoMediaRecorder {
         this.mediaRecorder.start(options?.timeslice || 5000);
     }
 
+    public getMediaRecorderState(): RecordingState {
+        return this.mediaRecorder.state;
+    }
+
     public stop(): Promise<VideoUploadResponse> {
-        this.mediaRecorder.stop();
         return new Promise((resolve, reject) => {
+            this.mediaRecorder.stop();
             this.onVideoAvailable = (v) => resolve(v)
         })
     }