New openvidu-hello-world tutorial. openvidu-browser to 1.0.4-beta.3

openvidu-getaroom/web/index.html

@@ -17,7 +17,7 @@
 	<!-- Bootstrap -->
 
 	<link rel="styleSheet" href="style.css" type="text/css" media="screen">
-	<script src="openvidu-browser-1.0.3-beta.3.js"></script>
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
 	<script src="app.js"></script>
 </head>
 

openvidu-hello-world/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

openvidu-hello-world/README.md

@@ -0,0 +1,3 @@
+# openvidu-hello-world
+
+This is the simplest demo you can try to get started with OpenVidu. It has the minimum set of features to make a video-call. You will only need a few minutes to get your first application working.

openvidu-hello-world/web/app.js

@@ -0,0 +1,133 @@
+/* OPENVIDU METHODS */
+
+var OV;
+var session;
+
+function joinSession() {
+
+	var sessionId = document.getElementById("sessionId").value;
+	var userName = document.getElementById("userName").value;
+
+	// --- 1) Get an OpenVidu object and init a session with a sessionId ---
+
+	// Init OpenVidu object
+	OV = new OpenVidu();
+	
+	// We will join the video-call "sessionId". As there's no server, this parameter must start with the URL of 
+	// OpenVidu Server (with secure websocket protocol: "wss://") and must include the OpenVidu secret at the end
+	session = OV.initSession("wss://" + location.hostname + ":8443/" + sessionId + '?secret=MY_SECRET');
+
+
+	// --- 2) Specify the actions when events take place ---
+
+	// On every new Stream received...
+	session.on('streamCreated', function (event) {
+
+		// Subscribe to the Stream to receive it. A video will be appended to element with id 'subscriber'
+		var subscriber = session.subscribe(event.stream, 'subscriber');
+
+		// When the video has been appended to DOM...
+		subscriber.on('videoElementCreated', function (event) {
+			// Add a new HTML element for the user's nickname
+			appendUserData(event.element, subscriber.stream.connection);
+		});
+	});
+
+	// On every Stream destroyed...
+	session.on('streamDestroyed', function (event) {
+		// Delete the HTML element with the user's nickname
+		removeUserData(event.stream.connection);
+	});
+
+
+	// --- 3) Connect to the session ---
+
+	// First param irrelevant if your app has no server-side. Second param will be received by every user
+	// in Stream.connection.data property, which will be appended to DOM as the user's nickname
+	session.connect(null, '{"clientData": "' + userName + '"}', function (error) {
+
+		// If the connection is successful, initialize a publisher and publish to the session
+		if (!error) {
+
+			// --- 4) Get your own camera stream with the desired resolution ---
+
+			// Your video will be appended to element with id 'publisher'
+			var publisher = OV.initPublisher('publisher', {
+				audio: true,
+				video: true,
+				quality: 'MEDIUM'
+			});
+
+			// --- 5) Publish your stream ---
+
+			session.publish(publisher);
+
+		} else {
+			console.log('There was an error connecting to the session:', error.code, error.message);
+		}
+	});
+
+	// Show Session page
+	document.getElementById('session-header').innerText = sessionId;
+	document.getElementById('join').style.display = 'none';
+	document.getElementById('session').style.display = 'block';
+
+	return false;
+}
+
+
+function leaveSession() {
+
+	// --- 6) Leave the session by calling 'disconnect' method over the Session object ---
+
+	session.disconnect();
+
+	// Removing all HTML elements with the user's nicknames
+	removeAllUserData();
+
+	// Show Join Session page
+	document.getElementById('join').style.display = 'block';
+	document.getElementById('session').style.display = 'none';
+}
+
+/* OPENVIDU METHODS */
+
+
+
+/* APPLICATION SPECIFIC METHODS */
+
+window.addEventListener('load', function () {
+	generateParticipantInfo();
+});
+
+window.onbeforeunload = function () {
+	session.disconnect()
+};
+
+function generateParticipantInfo() {
+	document.getElementById("sessionId").value = "SessionA";
+	document.getElementById("userName").value = "Participant" + Math.floor(Math.random() * 100);
+}
+
+function appendUserData(videoElement, connection) {
+	var clientDataJSON = JSON.parse(connection.data);
+	var dataNode = document.createElement('p');
+	dataNode.className = "data-node";
+	dataNode.id = "data-" + connection.connectionId;
+	dataNode.innerHTML = clientDataJSON.clientData;
+	videoElement.parentNode.insertBefore(dataNode, videoElement.nextSibling);
+}
+
+function removeUserData(connection) {
+	var dataNode = document.getElementById("data-" + connection.connectionId);
+	dataNode.parentNode.removeChild(dataNode);
+}
+
+function removeAllUserData() {
+	var nicknameElements = document.getElementsByClassName('data-node');
+	while (nicknameElements[0]) {
+		nicknameElements[0].parentNode.removeChild(nicknameElements[0]);
+	}
+}
+
+/* APPLICATION SPECIFIC METHODS */

openvidu-hello-world/web/index.html

@@ -0,0 +1,39 @@
+<html>
+
+<head>
+	<title>openvidu-hello-world</title>
+	<meta charset="utf-8">
+	<link rel="styleSheet" href="style.css" type="text/css" media="screen">
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
+	<script src="app.js"></script>
+</head>
+
+<body>
+	<div id="join">
+		<h1>Join a video session</h1>
+		<form onsubmit="return joinSession()" accept-charset="UTF-8">
+			<p>
+				<label>Participant:</label>
+				<input type="text" id="userName" required>
+			</p>
+			<p>
+				<label>Session:</label>
+				<input type="text" id="sessionId" required>
+			</p>
+			<p>
+				<input type="submit" name="commit" value="JOIN">
+			</p>
+		</form>
+	</div>
+
+	<div id="session" style="display: none;">
+		<h1 id="session-header"></h1>
+		<input type="button" id="buttonLeaveSession" onmouseup="leaveSession()" value="LEAVE">
+		<div>
+			<div id="publisher"><h3>YOU</h3></div>
+			<div id="subscriber"><h3>OTHERS</h3></div>
+		</div>
+	</div>
+</body>
+
+</html>

openvidu-hello-world/web/style.css

@@ -0,0 +1,32 @@
+html, body {
+    height: 100%;
+    font-family: "Open Sans", sans-serif;
+}
+
+html {
+    display: table;
+    margin: auto;
+}
+
+body {
+    display: table-cell;
+	vertical-align: middle;
+	text-align: center;
+}
+
+#publisher {
+	float: left;
+	margin: 10px;
+    width: 40%;
+}
+
+#subscriber {
+	float: right;
+    margin: 10px;
+    width: 40%;
+}
+
+video {
+	width: 70%;
+	margin-top: 10px;
+}

openvidu-insecure-angular/package.json

@@ -21,7 +21,7 @@
     "@angular/platform-browser-dynamic": "^2.4.0",
     "@angular/router": "^3.4.0",
     "core-js": "^2.4.1",
-    "openvidu-browser": "1.0.3-beta.3",
+    "openvidu-browser": "1.0.4-beta.3",
     "zone.js": "^0.7.6"
   },
   "devDependencies": {

openvidu-insecure-angular/src/app/app.component.html

@@ -6,7 +6,7 @@
 			<form class="form-group" (submit)="joinSession()">
 				<p>
 					<label>Participant</label>
-					<input class="form-control" type="text" id="participantId" name="participantId" [(ngModel)]="token" required>
+					<input class="form-control" type="text" id="userName" name="userName" [(ngModel)]="userName" required>
 				</p>
 				<p>
 					<label>Session</label>

openvidu-insecure-angular/src/app/app.component.ts

@@ -18,7 +18,7 @@ export class AppComponent {
 
   // Join form
   sessionId: string;
-  token: string;
+  userName: string;
 
   // Main video of the page, will be 'localStream' or one of the 'remoteStreams',
   // updated by an Output event of StreamComponent children
@@ -77,11 +77,11 @@ export class AppComponent {
 
     // --- 3) Connect to the session ---
 
-    // 'token' param irrelevant when using insecure version of OpenVidu. Second param will be received by every user
+    // First param irrelevant if your app has no server-side. Second param will be received by every user
     // in Stream.connection.data property, which will be appended to DOM as the user's nickname
-    this.session.connect(this.token, '{"clientData": "' + this.token + '"}', (error) => {
+    this.session.connect(null, '{"clientData": "' + this.userName + '"}', (error) => {
 
-     // If connection successful, initialize a publisher and publish to the session
+      // If connection successful, initialize a publisher and publish to the session
       if (!error) {
 
         // --- 4) Get your own camera stream with the desired resolution ---
@@ -128,7 +128,7 @@ export class AppComponent {
   private generateParticipantInfo() {
     // Random user nickname and sessionId
     this.sessionId = 'SessionA';
-    this.token = 'Participant' + Math.floor(Math.random() * 100);
+    this.userName = 'Participant' + Math.floor(Math.random() * 100);
   }
 
   private deleteRemoteStream(stream: Stream): void {

openvidu-insecure-js/docker/Dockerfile

@@ -43,6 +43,7 @@ RUN set -x \
 
 EXPOSE 5000
 EXPOSE 4040
+EXPOSE 8443
 
 # Exec supervisord
 CMD ["/usr/bin/supervisord"]

openvidu-insecure-js/web/app.js

@@ -45,7 +45,7 @@ function joinSession() {
 
 	// --- 3) Connect to the session ---
 
-	// 'token' param irrelevant when using insecure version of OpenVidu. Second param will be received by every user
+	// First param irrelevant if your app has no server-side. Second param will be received by every user
 	// in Stream.connection.data property, which will be appended to DOM as the user's nickname
 	session.connect(token, '{"clientData": "' + token + '"}', function (error) {
 

openvidu-insecure-js/web/index.html

@@ -17,7 +17,7 @@
 	<!-- Bootstrap -->
 
 	<link rel="stylesheet" href="style.css" type="text/css" media="screen">
-	<script src="openvidu-browser-1.0.3-beta.3.js"></script>
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
 	<script src="app.js"></script>
 </head>
 

openvidu-js-java/src/main/resources/static/index.html

@@ -17,7 +17,7 @@
 	<!-- Bootstrap -->
 
 	<link rel="styleSheet" href="style.css" type="text/css" media="screen">
-	<script src="openvidu-browser-1.0.3-beta.3.js"></script>
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
 	<script src="app.js"></script>
 	<script>
 		$(document).ready(function () {

openvidu-js-node/public/index.html

@@ -17,7 +17,7 @@
 	<!-- Bootstrap -->
 
 	<link rel="styleSheet" href="style.css" type="text/css" media="screen">
-	<script src="openvidu-browser-1.0.3-beta.3.js"></script>
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
 	<script src="app.js"></script>
 	<script>
 		$(document).ready(function () {

openvidu-mvc-java/src/main/resources/templates/session.html

@@ -17,7 +17,7 @@
 	<!-- Bootstrap -->
 
 	<link rel="styleSheet" href="style.css" type="text/css" media="screen"></link>
-	<script src="openvidu-browser-1.0.3-beta.3.js"></script>
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
 </head>
 
 <body>

openvidu-mvc-node/views/session.ejs

@@ -17,7 +17,7 @@
 	<!-- Bootstrap -->
 
 	<link rel="styleSheet" href="style.css" type="text/css" media="screen"></link>
-	<script src="openvidu-browser-1.0.3-beta.3.js"></script>
+	<script src="openvidu-browser-1.0.4-beta.3.js"></script>
 </head>
 
 <body>