Include duration in previews

Author: binarykitchen

src/index.ts

@@ -1,5 +1,5 @@
 import VideomailClient from "./client";
-import { Command, CommandArgs } from "./types/command";
+import { Command, VideomailCommandArgs } from "./types/command";
 import DeliveryRecord from "./types/DeliveryRecord";
 import { EmailAddress, EmailAddresses } from "./types/EmailAddress";
 import { FullVideomailErrorData, VideomailErrorData } from "./types/error";
@@ -11,7 +11,6 @@ import { VideoType, VideoTypeType } from "./types/VideoType";
 
 export type {
   Command,
-  CommandArgs,
   DeliveryRecord,
   EmailAddress,
   EmailAddresses,
@@ -20,6 +19,7 @@ export type {
   RecordingStats,
   Videomail,
   VideomailClientOptions,
+  VideomailCommandArgs,
   VideomailErrorData,
   VideomailEvents,
   VideoTypeType,

src/types/command.ts

@@ -2,16 +2,17 @@ import { ErrorObject } from "serialize-error";
 
 // Do not trust what we receive from server side.
 // Therefore, all of them can be undefined and require additional checks
-export interface CommandArgs {
+export interface VideomailCommandArgs {
   frame?: number;
   key?: string | undefined;
   err?: ErrorObject;
   sample?: number;
   mp4?: string;
   webm?: string;
+  duration?: number;
 }
 
 export interface Command {
   command: string;
-  args?: CommandArgs;
+  args?: VideomailCommandArgs;
 }

src/types/events/index.ts

@@ -29,11 +29,12 @@ export interface ProgressParams {
   sampleProgress?: string | undefined;
 }
 
-export interface PreviewParams {
+export interface VideomailPreviewParams {
   key?: string | undefined;
-  width?: number | undefined;
-  height?: number | undefined;
+  width: number | undefined;
+  height: number | undefined;
   hasAudio: boolean;
+  duration: number;
 }
 
 export interface StoppedParams {
@@ -103,7 +104,7 @@ interface VideomailEvents {
   // recording is being paused
   PAUSED: () => void;
   // video preview is set
-  PREVIEW: (params?: PreviewParams) => void;
+  PREVIEW: (params?: VideomailPreviewParams) => void;
   // video preview is shown
   PREVIEW_SHOWN: () => void;
   // start sending

src/wrappers/form.ts

@@ -1,6 +1,6 @@
 import getFormData from "get-form-data";
 
-import { ErrorParams, PreviewParams } from "../types/events";
+import { ErrorParams, VideomailPreviewParams } from "../types/events";
 import { VideomailClientOptions } from "../types/options";
 import Videomail, { PartialVideomail } from "../types/Videomail";
 import Despot from "../util/Despot";
@@ -243,7 +243,7 @@ class Form extends Despot {
       }
     }
 
-    this.on("PREVIEW", (params?: PreviewParams) => {
+    this.on("PREVIEW", (params?: VideomailPreviewParams) => {
       /*
        * Beware that preview doesn't always come with a key, i.E.
        * container.show() can emit PREVIEW without a key when a replay already exists

src/wrappers/visuals/recorder.ts

@@ -5,7 +5,7 @@ import { deserializeError } from "serialize-error";
 import websocket from "websocket-stream";
 
 import Constants from "../../constants";
-import { Command, CommandArgs } from "../../types/command";
+import { Command, VideomailCommandArgs } from "../../types/command";
 import { UserMediaReadyParams } from "../../types/events";
 import { VideomailClientOptions } from "../../types/options";
 import RecordingStats from "../../types/RecordingStats";
@@ -248,7 +248,7 @@ class Recorder extends Despot {
     });
   }
 
-  private updateFrameProgress(args?: CommandArgs) {
+  private updateFrameProgress(args?: VideomailCommandArgs) {
     if (!args) {
       throw createError({
         message: "Arguments are missing for updating the frame progress",
@@ -268,7 +268,7 @@ class Recorder extends Despot {
     this.updateOverallProgress();
   }
 
-  private updateSampleProgress(args?: CommandArgs) {
+  private updateSampleProgress(args?: VideomailCommandArgs) {
     if (!args) {
       throw createError({
         message: "Arguments are missing for updating the audio sample progress",
@@ -288,7 +288,7 @@ class Recorder extends Despot {
     this.updateOverallProgress();
   }
 
-  private preview(args?: CommandArgs) {
+  private preview(args?: VideomailCommandArgs) {
     if (!args) {
       throw createError({
         message: "Preview arguments are missing.",
@@ -331,7 +331,7 @@ class Recorder extends Despot {
     const width = this.getRecorderWidth(true);
     const height = this.getRecorderHeight(true);
 
-    this.emit("PREVIEW", { key: this.key, width, height, hasAudio });
+    this.emit("PREVIEW", { key: this.key, width, height, hasAudio, duration: -1 });
 
     // keep it for recording stats
     if (this.stopTime) {

src/wrappers/visuals/replay.ts

@@ -1,4 +1,4 @@
-import { PreviewParams } from "../../types/events";
+import { VideomailPreviewParams } from "../../types/events";
 import { VideomailClientOptions } from "../../types/options";
 import Videomail from "../../types/Videomail";
 import { VideoType } from "../../types/VideoType";
@@ -263,7 +263,7 @@ class Replay extends Despot {
 
     if (!this.built) {
       if (!this.isStandalone()) {
-        this.on("PREVIEW", (params?: PreviewParams) => {
+        this.on("PREVIEW", (params?: VideomailPreviewParams) => {
           this.show(params?.width, params?.height, params?.hasAudio);
         });
       }