chore: deprecate video methods

team-telnyx · Oct 14, 2024 · 99336fa · 99336fa
1 parent b9b2756
commit 99336fa
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/packages/js/src/Modules/Verto/BrowserSession.ts b/packages/js/src/Modules/Verto/BrowserSession.ts
@@ -247,6 +247,7 @@ export default abstract class BrowserSession extends BaseSession {
    * ```
    *
    * @returns Promise with an array of MediaDeviceInfo
+   * @deprecated
    */
   getVideoDevices(): Promise<MediaDeviceInfo[]> {
     return getDevices(DeviceType.Video).catch((error) => {
@@ -391,6 +392,7 @@ export default abstract class BrowserSession extends BaseSession {
    *   console.log(result);
    * });
    * ```
+   * @deprecated
    */
   async getDeviceResolutions(deviceId: string) {
     try {
@@ -545,6 +547,7 @@ export default abstract class BrowserSession extends BaseSession {
    *  height: 720
    * })
    * ```
+   * @deprecated
    */
   async setVideoSettings(settings: IVideoSettings) {
     if (!settings) {
@@ -586,6 +589,7 @@ export default abstract class BrowserSession extends BaseSession {
    *
    * client.disableWebcam();
    * ```
+   * @deprecated
    */
   disableWebcam() {
     this._videoConstraints = false;
@@ -604,6 +608,7 @@ export default abstract class BrowserSession extends BaseSession {
    *
    * client.enableWebcam();
    * ```
+   * @deprecated
    */
   enableWebcam() {
     this._videoConstraints = true;

diff --git a/packages/js/src/Modules/Verto/webrtc/BaseCall.ts b/packages/js/src/Modules/Verto/webrtc/BaseCall.ts
@@ -590,6 +590,7 @@ export default abstract class BaseCall implements IWebRTCCall {
    * ```js
    * call.muteVideo();
    * ```
+   * @deprecated
    */
   muteVideo() {
     disableVideoTracks(this.options.localStream);
@@ -604,6 +605,7 @@ export default abstract class BaseCall implements IWebRTCCall {
    * ```js
    * call.unmuteVideo();
    * ```
+   * @deprecated
    */
   unmuteVideo() {
     enableVideoTracks(this.options.localStream);
@@ -617,6 +619,7 @@ export default abstract class BaseCall implements IWebRTCCall {
    * ```js
    * call.toggleVideoMute();
    * ```
+   * @deprecated
    */
   toggleVideoMute() {
     toggleVideoTracks(this.options.localStream);
@@ -653,6 +656,7 @@ export default abstract class BaseCall implements IWebRTCCall {
    *
    * @param deviceId the target video device ID
    * @returns Promise that resolves if the video device has been updated
+   * @deprecated
    */
   async setVideoDevice(deviceId: string): Promise<void> {
     const { instance } = this.peer;

diff --git a/packages/js/src/Modules/Verto/webrtc/Call.ts b/packages/js/src/Modules/Verto/webrtc/Call.ts
@@ -53,7 +53,6 @@ import { IVertoCallOptions } from './interfaces';
 export class Call extends BaseCall {
   public screenShare: Call;
 
-
   private _statsInterval: any = null;
 
   hangup(params: any = {}, execute: boolean = true) {
@@ -63,6 +62,10 @@ export class Call extends BaseCall {
     super.hangup(params, execute);
   }
 
+  /**
+   * @deprecated
+   * @private
+   */
   async startScreenShare(opts?: IVertoCallOptions) {
     const displayStream: MediaStream = await getDisplayMedia({ video: true });
     displayStream.getTracks().forEach((t) => {
@@ -89,6 +92,10 @@ export class Call extends BaseCall {
     return this.screenShare;
   }
 
+  /**
+   * @deprecated
+   * @private
+   */
   stopScreenShare() {
     if (this.screenShare instanceof Call) {
       this.screenShare.hangup();