Skip to content

Commit

Permalink
add typedocs on local and remote stream methods
Browse files Browse the repository at this point in the history
  • Loading branch information
DeividVeloso committed Dec 15, 2020
1 parent 9b1b5f9 commit 50a2228
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions packages/js/src/Modules/Verto/webrtc/BaseCall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down

0 comments on commit 50a2228

Please sign in to comment.