Merge pull request #47 from oslabs-beta/doc

Doc

Author: fraisai

dist/src/components/VideoCall.d.ts

@@ -1,5 +1,9 @@
 /// <reference types="react" />
 /**
+ * @func VideoCall
+ * @param {String} props.URL - ws or wss link that establishes a connection between the WebSocket object and the server
+ * @param {object} props.mediaOptions video embed attributes
+ 
  * @desc Wrapper component containing the logic necessary for peer connections using WebRTC APIs (RTCPeerConnect API + MediaSession API) and WebSockets.
  *
  * ws, localVideo, remoteVideo, peerRef, localStream, otherUser, senders are all mutable ref objects that are created using the useRef hook. The useRef hook allows you to persist values between renders and it is used to store a mutable value that does NOT cause a re-render when updated.
@@ -11,9 +15,6 @@
  * @type {state} username - username state stores the name the client enters. All users (see getUsers) will be able to see an updated list of all other users whenever a new user logs in or leaves.
  * @type {state} users - users state is the list of connected users that is rendered on the frontend.
  *
- * @param {Object} props
- * @param {String} props.URL - ws or wss link
- * @param {object} props.mediaOptions video embed attributes
  * @returns A component that renders two VideoComponents,
  */
 declare const VideoCall: ({ URL, mediaOptions }: {

dist/src/components/VideoCall.js

@@ -1,11 +1,9 @@
 /**
    *
-   * @type {Object} A MediaStreamConstraints object is used when calling getUserMedia() to specify what kinds of tracks
+   * @type {Object} A MediaStreamConstraints object is used when the openUserMedia function is invoked and it calls the WebRTC API method of getUserMedia() to specify what kinds of tracks
    * should be included in the returned MediaStream and to establish video and audio constraints for
    * these tracks' settings.
-   * @property {object} video - The video constraint provides the constraints that must be met by the video track that is
-   * included in the returned MediaStream (essentially it gives constraints for the quality of the video
-   * streams returned by the users's webcams).
+   * @property {object} video - The video constraint provides the constraints that must be met by the video track that is included in the returned MediaStream (essentially it gives constraints for the quality of the video streams returned by the users's webcams).
    * @property {object} video.width - video width constraint (min:640, ideal:1920, max:1920)
    * @property {object} video.height - video height constraint (min:480, ideal:1080, max:1080)
    * @property {boolean} audio - audio constraint that indicates whether or not an audio track is requested.

dist/src/constants/mediaStreamConstraints.d.ts

@@ -2,12 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
    *
-   * @type {Object} A MediaStreamConstraints object is used when calling getUserMedia() to specify what kinds of tracks
+   * @type {Object} A MediaStreamConstraints object is used when the openUserMedia function is invoked and it calls the WebRTC API method of getUserMedia() to specify what kinds of tracks
    * should be included in the returned MediaStream and to establish video and audio constraints for
    * these tracks' settings.
-   * @property {object} video - The video constraint provides the constraints that must be met by the video track that is
-   * included in the returned MediaStream (essentially it gives constraints for the quality of the video
-   * streams returned by the users's webcams).
+   * @property {object} video - The video constraint provides the constraints that must be met by the video track that is included in the returned MediaStream (essentially it gives constraints for the quality of the video streams returned by the users's webcams).
    * @property {object} video.width - video width constraint (min:640, ideal:1920, max:1920)
    * @property {object} video.height - video height constraint (min:480, ideal:1080, max:1080)
    * @property {boolean} audio - audio constraint that indicates whether or not an audio track is requested.

dist/src/constants/mediaStreamConstraints.js

@@ -0,0 +1,35 @@
+"use strict";
+// https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/srcObject
+/*
+const openUserMedia = async (): Promise<void> => {
+  try {
+    if (localVideo.current){
+      localStream.current = localVideo.current.srcObject = await navigator.mediaDevices.getUserMedia(constraints);
+    }
+  } catch (error) {
+    console.log('Error in openUserMedia: ', error);
+  }
+};
+
+
+// In this example, a MediaStream from a camera is assigned to a newly-created <video> element.
+const mediaStream = await navigator.mediaDevices.getUserMedia({video: true});
+const video = document.createElement('video');
+video.srcObject = mediaStream;
+
+
+// In this example, a new MediaSource is assigned to a newly-created <video> element.
+const mediaSource = new MediaSource();
+const video = document.createElement('video');
+video.srcObject = mediaSource;
+
+// First, a MediaStream from a camera is assigned to a newly-created <video> element, with fallback for older browsers.
+const mediaStream = await navigator.mediaDevices.getUserMedia({video: true});
+const video = document.createElement('video');
+if ('srcObject' in video) {
+  video.srcObject = mediaStream;
+} else {
+  // Avoid using this in new browsers, as it is going away.
+  video.src = URL.createObjectURL(mediaStream);
+}
+*/