docs(video): adding doc blocks (#893)

packages/video/__tests__/__dataSets__/video.ts

@@ -1,7 +1,7 @@
 import { ExperienceComposerResolution } from '../../lib/enums/ExperienceComposerResolution';
-import { ExperienceComposerOptions } from '../../lib/interfaces/ExperienceComposerOptions';
-import { CaptionOptions } from '../../lib/interfaces/CaptionOptions';
-import { SIPCallOptions } from '../../lib/interfaces/SIPCallOptions';
+import { ExperienceComposerOptions } from '../../lib/types/ExperienceComposerOptions';
+import { CaptionOptions } from '../../lib/types/CaptionOptions';
+import { SIPCallOptions } from '../../lib/types/SIPCallOptions';
 
 const renderInformation = {
   id: '1248e7070b81464c9789f46ad10e7764',

packages/video/lib/enums/ArchiveOutputMode.ts

@@ -1,4 +1,14 @@
+/**
+ * Enum representing different output modes for video archives.
+ */
 export enum ArchiveOutputMode {
+  /**
+   * Represents the composed output mode where all streams are mixed into one.
+   */
   COMPOSED = 'composed',
+
+  /**
+   * Represents the individual output mode where each stream is recorded separately.
+   */
   INDIVIDUAL = 'individual',
 }

packages/video/lib/enums/AudioRate.ts

@@ -1,4 +1,14 @@
+/**
+ * Enum representing different audio sample rates.
+ */
 export enum AudioRate {
+  /**
+   * Represents an audio sample rate of 16 kHz.
+   */
     "16KHZ" = 16000,
+
+  /**
+   * Represents an audio sample rate of 8 kHz.
+   */
     "8KHZ" = 8000
-}
+}

packages/video/lib/enums/CaptionStatus.ts

@@ -1,6 +1,24 @@
+/**
+ * Enum representing different captioning status.
+ */
 export enum CaptionStatus {
-    STARTED = "started",
-    STOPPED = "stopped",
-    PAUSED = "paused",
-    FAILED = "failed"
-}
+  /**
+   * Indicates that captioning has started.
+   */
+  STARTED = "started",
+
+  /**
+   * Indicates that captioning has stopped.
+   */
+  STOPPED = "stopped",
+
+  /**
+   * Indicates that captioning has been paused.
+   */
+  PAUSED = "paused",
+
+  /**
+   * Indicates that captioning has failed.
+   */
+  FAILED = "failed"
+}

packages/video/lib/enums/ExperienceComposerResolution.ts

@@ -1,8 +1,26 @@
 import { Resolution } from "./Resolution";
 
+/**
+ * Enum representing different resolutions for an experience composer.
+ */
 export enum ExperienceComposerResolution {
-    SD_LANDSCAPE = Resolution.SD_LANDSCAPE,
-    SD_PORTRAIT = Resolution.SD_PORTRAIT,
-    HD_LANDSCAPE = Resolution.HD_LANDSCAPE,
-    HD_PORTRAIT = Resolution.HD_PORTRAIT,
-}
+  /**
+   * Standard definition landscape resolution.
+   */
+  SD_LANDSCAPE = Resolution.SD_LANDSCAPE,
+
+  /**
+   * Standard definition portrait resolution.
+   */
+  SD_PORTRAIT = Resolution.SD_PORTRAIT,
+
+  /**
+   * High definition landscape resolution.
+   */
+  HD_LANDSCAPE = Resolution.HD_LANDSCAPE,
+
+  /**
+   * High definition portrait resolution.
+   */
+  HD_PORTRAIT = Resolution.HD_PORTRAIT,
+}

packages/video/lib/enums/LayoutType.ts

@@ -1,7 +1,29 @@
+/**
+ * Enum representing different layout types for live streaming broadcasts.
+ */
 export enum LayoutType {
+  /**
+   * Automatically determine the best fit layout.
+   */
   BEST_FIT = 'bestFit',
+
+  /**
+   * Use a custom layout for the broadcast.
+   */
   CUSTOM = 'custom',
+
+  /**
+   * Horizontal presentation layout.
+   */
   HORIZONTAL_PRESENTATION = 'horizontalPresentation',
+
+  /**
+   * Picture-in-picture (PIP) layout.
+   */
   PIP = 'pip',
+
+  /**
+   * Vertical presentation layout.
+   */
   VERTICAL_PRESENTATION = 'verticalPresentation',
 }

packages/video/lib/enums/MediaMode.ts

@@ -0,0 +1,14 @@
+/**
+ * Enum representing media modes for a session.
+ */
+export enum MediaMode {
+  /**
+   * Routed mode where media is disabled.
+   */
+  ROUTED = 'disabled',
+
+  /**
+   * Relayed mode where media is enabled.
+   */
+  RELAYED = 'enabled',
+}

packages/video/lib/enums/Resolution.ts

@@ -1,8 +1,34 @@
+/**
+ * Enum representing different video resolutions for live streaming broadcasts.
+ */
 export enum Resolution {
+  /**
+   * Full HD landscape resolution (1920x1080 pixels).
+   */
   FHD_LANDSCAPE = '1920x1080',
+
+  /**
+   * Full HD portrait resolution (1080x1920 pixels).
+   */
   FHD_PORTRAIT = '1080x1920',
+
+  /**
+   * HD landscape resolution (1280x720 pixels).
+   */
   HD_LANDSCAPE = '1280x720',
+
+  /**
+   * HD portrait resolution (720x1280 pixels).
+   */
   HD_PORTRAIT = '720x1280',
+
+  /**
+   * Standard definition landscape resolution (640x480 pixels).
+   */
   SD_LANDSCAPE = '640x480',
+
+  /**
+   * Standard definition portrait resolution (480x640 pixels).
+   */
   SD_PORTRAIT = '480x640',
 }

packages/video/lib/enums/StreamMode.ts

@@ -1,4 +1,14 @@
+/**
+ * Enum representing different stream modes for live streaming broadcasts.
+ */
 export enum StreamMode {
+  /**
+   * Streams are selected automatically based on session rules.
+   */
   AUTO = 'auto',
+
+  /**
+   * Streams are manually selected for inclusion in the broadcast.
+   */
   MANUAL = 'manual',
 }

packages/video/lib/enums/index.ts

@@ -5,3 +5,4 @@ export * from './ExperienceComposerResolution';
 export * from './LayoutType';
 export * from './Resolution';
 export * from './StreamMode';
+export * from './MediaMode';

packages/video/lib/index.ts

@@ -1,4 +1,4 @@
 export * from './enums';
-export * from './interfaces';
+export * from './types';
 export * from './parameters';
 export * from './video';