add typedocs on local and remote stream methods

team-telnyx · Dec 15, 2020 · 7edbc5e · 7edbc5e
1 parent 9b1b5f9
commit 7edbc5e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/packages/js/src/Modules/Verto/BrowserSession.ts b/packages/js/src/Modules/Verto/BrowserSession.ts
@@ -635,7 +635,7 @@ export default abstract class BrowserSession extends BaseSession {
   }
 
   /**
-   * Sets the local html element to receive the local stream.
+   * Sets the local html element that will receive the local stream.
    *
    * @example
    *
@@ -667,7 +667,7 @@ export default abstract class BrowserSession extends BaseSession {
   }
 
   /**
-   * Sets the remote html element to receive the remote stream.
+   * Sets the remote html element that will receive the remote stream.
    *
    * @example
    *

diff --git a/packages/js/src/Modules/Verto/webrtc/BaseCall.ts b/packages/js/src/Modules/Verto/webrtc/BaseCall.ts
@@ -138,10 +138,32 @@ export default abstract class BaseCall implements IWebRTCCall {
     this._targetNodeId = what;
   }
 
+  /**
+   * Gets the local stream of the call.
+   * This can be used in a video/audio element to play the local media.
+   * [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).
+   *
+   * @examples
+   *
+   * ```js
+   * call.localStream();
+   * ```
+   */
   get localStream() {
     return this.options.localStream;
   }
 
+  /**
+   * Gets the remote stream of the call.
+   * This can be used in a video/audio element to play the local media.
+   * [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).
+   *
+   * @examples
+   *
+   * ```js
+   * call.remoteStream();
+   * ```
+   */
   get remoteStream() {
     return this.options.remoteStream;
   }