Merge pull request #420 from steveseguin/iframe-api-docs

Create IFRAME.md

IFRAME.md

@@ -0,0 +1,215 @@
+## OBS.Ninja  - iFrame API documentation
+
+OBS.Ninja (OBSN) is offers here a simple and free solution to quickly enable real-time video streaming in their websites. OBSN wishes to make live video streaming development accessible to any developer, even novices, yet still remain flexible and powerful.
+
+While OBS.Ninja does offer source-code to customize the application and UI at a low level, this isn't for beginners and it is rather hard to maintain. As well, due to the complexity of video streaming in the web, typical approaches for offering API access isn't quite feasible either.
+
+The solution decided on isn't an SDK framework, but rather the use of embeddable *IFrames* and a corresponding bi-directional iframe API. An [iframe](https://www.w3schools.com/tags/tag_iframe.ASP) allows us to embed a webpage inside a webpage, including OBS.Ninja into your own website.
+
+Modern web browsers allow the parent website to communicate with the child webpage, giving a high-level of control to a developer, while also abstracting the complex code and hosting requirements. Functionality, we can make an OBSN video stream act much like an HTML video element tag, where you can issue commands like play, pause, or change video sources with ease.
+
+Creating an OBSN iframe can be done in HTML or programmatically with Javascript like so:
+
+	var iframe = document.createElement("iframe");
+	iframe.allow="autoplay;camera;microphone";
+	iframe.allowtransparency="false"
+	iframe.src = "https://obs.ninja/?webcam";
+
+Adding that iframe to the DOM will reveal a simple page accessing for a user to select and share their webcam.  For a developer wishing to access a remote guest's stream, this makes the ingestion of that stream into production software like OBS Studios very easy. The level of customization and control opens up opportunities, such as a pay-to-join audience option for a streaming interactive broadcast experience.
+
+An example of how this API is used by OBS.Ninja is with its Internet Speedtest, which has two OBS.Ninja IFrames on a single page. One iframe feeds video to the other iframe, and the speed at which it does this is a measure of the system's performance. Detailed stats of the connection are made available to the parent window, which displays the results.
+https://obs.ninja/speedtest
+
+A sandbox of options is available at this page, too: https://obs.ninja/iframe  You can enter an OBS.Ninja URL in the input box to start using it.  For developers, viewing the source of that page will reveal examples of how all the available functions work, along with a way to test and play with each of them. You can also see here for the source-code on GitHub: https://github.com/steveseguin/obsninja/blob/master/iframe.html
+
+One thing to note about this iframe API is that it is a mix of URL parameters given to the iframe *src* URL, but also the postMessage and addEventListener methods of the browser. The later is used to dynamically control OBS.Ninja, while the former is used to initiate the instance to a desired state.
+
+For more information on the URL parameters thare are available, please see: https://github.com/steveseguin/obsninja/wiki/Advanced-Settings
+
+Some of the more interesting ones primarily for iframe users might include:
+
+ - &webcam
+ - &screenshare
+ - &videodevice=1 or 0
+ - &audiodevice=1 or 0
+ - &autostart
+ - &chroma
+ - &transparency
+ -   
+As for API, allow for dynamic messaging, below are examples of the options available:
+
+ - Mute Speaker
+ - Mute Mic
+ - Disconnect
+ - Change Video Bitrate
+ - Reload the page
+ - Change the volume
+ - Request detailed connection stats
+ - Access the loudness level of the audio
+ - Send/Recieve a chat message to other connected guests
+ - Get notified when there is a video connection
+
+As for the actually details for methods and options available to dynamically control child OBSN iframe, they are primarily kept up to  via the iframe.html file that is mentioned previously. see: *iframe.html*.  Below is a snippet from that file:
+	
+		var button = document.createElement("button");
+		button.innerHTML = "Mute Speaker";
+		button.onclick = function(){iframe.contentWindow.postMessage({"mute":true}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Un-Mute Speaker";
+		button.onclick = function(){iframe.contentWindow.postMessage({"mute":false}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Toggle Speaker";
+		button.onclick = function(){iframe.contentWindow.postMessage({"mute":"toggle"}, '*');}
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Mute Mic";
+		button.onclick = function(){iframe.contentWindow.postMessage({"mic":false}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Un-Mute Mic";
+		button.onclick = function(){iframe.contentWindow.postMessage({"mic":true}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Toggle Mic";
+		button.onclick = function(){iframe.contentWindow.postMessage({"mic":"toggle"}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Disconnect";
+		button.onclick = function(){iframe.contentWindow.postMessage({"close":true}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Low Bitrate";
+		button.onclick = function(){iframe.contentWindow.postMessage({"bitrate":30}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "High Bitrate";
+		button.onclick = function(){iframe.contentWindow.postMessage({"bitrate":5000}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Default Bitrate";
+		button.onclick = function(){iframe.contentWindow.postMessage({"bitrate":-1}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Reload";
+		button.onclick = function(){iframe.contentWindow.postMessage({"reload":true}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "50% Volume";
+		button.onclick = function(){iframe.contentWindow.postMessage({"volume":0.5}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "100% Volume";
+		button.onclick = function(){iframe.contentWindow.postMessage({"volume":1.0}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Request Stats";
+		button.onclick = function(){iframe.contentWindow.postMessage({"getStats":true}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Request Loudness Levels";
+		button.onclick = function(){iframe.contentWindow.postMessage({"getLoudness":true}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Stop Sending Loudness Levels";
+		button.onclick = function(){iframe.contentWindow.postMessage({"getLoudness":false}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "Say Hello";
+		button.onclick = function(){iframe.contentWindow.postMessage({"sendChat":"Hello!"}, '*');};
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "previewWebcam()";
+		button.onclick = function(){iframe.contentWindow.postMessage({"function":"previewWebcam"}, '*');};  
+		iframeContainer.appendChild(button);
+		
+		var button = document.createElement("button");
+		button.innerHTML = "CLOSE IFRAME";
+		button.onclick = function(){iframeContainer.parentNode.removeChild(iframeContainer);};
+		iframeContainer.appendChild(button);
+		
+As for listening events, where the parent listens for responses or events from the OBSN child frame:		
+		
+		////////////  LISTEN FOR EVENTS
+	
+		var eventMethod = window.addEventListener ? "addEventListener" : "attachEvent";
+		var eventer = window[eventMethod];
+		var messageEvent = eventMethod === "attachEvent" ? "onmessage" : "message";
+		
+		eventer(messageEvent, function (e) {
+			if (e.source != iframe.contentWindow){return} // reject messages send from other iframes
+			
+			if ("stats" in e.data){
+				var outputWindow = document.createElement("div");
+				
+				var out = "<br />total_inbound_connections:"+e.data.stats.total_inbound_connections;
+				out += "<br />total_outbound_connections:"+e.data.stats.total_outbound_connections;
+				
+				for (var streamID in e.data.stats.inbound_stats){
+					out += "<br /><br /><b>streamID:</b> "+streamID+"<br />";
+					out += printValues(e.data.stats.inbound_stats[streamID]);
+				}
+				
+				outputWindow.innerHTML = out;
+				iframeContainer.appendChild(outputWindow);
+			}
+			
+			if ("gotChat" in e.data){
+				var outputWindow = document.createElement("div");
+				outputWindow.innerHTML = e.data.gotChat.msg;
+				outputWindow.style.border="1px dotted black";
+				iframeContainer.appendChild(outputWindow);
+			}
+			
+			if ("action" in e.data){
+				var outputWindow = document.createElement("div");
+				outputWindow.innerHTML = "child-page-action: "+e.data.action+"<br />";
+				outputWindow.style.border="1px dotted black";
+				iframeContainer.appendChild(outputWindow);
+			}
+			
+			if ("loudness" in e.data){
+				console.log(e.data);
+				if (document.getElementById("loudness")){
+					outputWindow = document.getElementById("loudness");
+				} else {
+					var outputWindow = document.createElement("div");
+					outputWindow.style.border="1px dotted black";
+					iframeContainer.appendChild(outputWindow);
+					outputWindow.id = "loudness";
+				}
+				outputWindow.innerHTML = "child-page-action: loudness<br />";
+				for (var key in e.data.loudness) {
+                    outputWindow.innerHTML += key + " Loudness: " +  e.data.loudness[key] + "\n";          
+                }
+				outputWindow.style.border="1px black";
+				
+			}
+		});
+		
+This OBS.Ninja API is developed and expanded based on user feedback and requests. It is by no means complete.
+
+Regarding versioning, I currently host past versions of OBS.Ninja, so using those past versions can ensure some level of consistency and expectation. https://obs.ninja/v12/ for example is the version 12 hosted version. The active and main production version of OBSN of course undergoes constant updates, and while I try to maintain backwards compatibility with changes to the API, it is still early days and changes might happen.
+
+Please feel free to follow me in the OBS.Ninja Discord channel, where I post news about updates and listen to requests. The upcoming version of OBS.Ninja is also often hosted at https://obs.ninja/beta, where you can explore new features and help crush any unexpected bugs.
+
+
+-steve

LICENCE.md

@@ -1,7 +1,7 @@
 The OBS.Ninja source repository is governed by the GNU AFFERO GENERAL PUBLIC LICENSE. (AGPL-3.0)
 That AGPL-3.0 licence can be found here: https://raw.githubusercontent.com/steveseguin/obsninja/master/AGPLv3.md
 
-In essence, OBS.Ninja is open-source and free to use, both for commericial and non-commericial use.
+In essence, OBS.Ninja is open-source and free to use, both for commercial and non-commercial use.
 Modifications of AGPL-3.0 licenced code must be made publicly accessible. Please refer to that licence.
 
 Some individual source files may contain different licencing term and perhaps different copyright holders.

README.md

@@ -1,4 +1,5 @@
-![ILogo by brimace](images/obsNinja_logo_full.png)
+
+<img src="images/obsNinja_logo_full.png" alt="Logo by brimace" data-canonical-src="https://gyazo.com/eb5c5741b6a9a16c692170a41a49c858.png" height="150" />
 
 ## What is OBS NINJA
 OBS.Ninja uses peer-to-peer technology to bring remote cameras into OBS. In most cases, all video data is transferred directly from peer to peer, without needing to go through any video server. This results in high-quality video with super low latency. In a small number of cases, video data may go through an encrypted TURN server, which is used to facilitate peer connections when otherwise not possible.
@@ -8,12 +9,18 @@ OBS Ninja is not affiliated with OBS. OBS.Ninja is designed to allow content cre
 Please see the sub-reddit added info: https://reddit.com/r/obsninja  
 Also check out the FAQ for more info: https://github.com/steveseguin/obsninja/wiki
 
+<img src="https://user-images.githubusercontent.com/2575698/94018108-34b1de00-fd7e-11ea-8c7d-df001253b60d.png" data-canonical-src="https://gyazo.com/eb5c5741b6a9a16c692170a41a49c858.png" height="300" />
+
 ## How to use:
 I demo the basic usage of OBS.Ninja on YouTube: https://www.youtube.com/watch?v=6R_sQKxFAhg
 
+Here is a podcast series showing how to use different basic OBS.Ninja features, including macOS support: https://www.youtube.com/watch?v=XfSqufuoV74&list=PLWodc2tCfAH1l_LDvEyxEqFf42hOBKqQM
+
+And Here is another video series touching on some more advanced settings: https://www.youtube.com/watch?v=mQ1Jdhf5aYg&list=PL8VJWj2-XLFpFu3G35Hdm1nKZ2xn9_0_8
+
 Check the subreddit for added use cases, advanced features, and support. Advanced features includes high-quality audio modes, custom video resolutions, and more.
 
-MacOS users will face some challenges in using OBS currently, but there are workarounds. Please see the subreddit or the Wiki.
+MacOS users will face some challenges in using OBS 25/26, but there are workarounds. Please see the subreddit or the Wiki.
 
 ## What's in this repo?
 This repo contains software for OBS.Ninja, including the HTML landing page for its Electron Capture app offering. A sample config file and instructions for setting up a TURN server (video relay server), is also provided. You may also find the Wiki for the project in this repo, which contains added information on how to use the software.
@@ -21,7 +28,7 @@ This repo contains software for OBS.Ninja, including the HTML landing page for i
 ## How to Deploy this Repo:
 To use, just download and host the files on a HTTPS-enabled webserver. You may want to hide the .html extensions within your HTTP server as well, else the generated links will not work. See [here](https://github.com/steveseguin/obsninja/blob/master/install.md) for added details, although I don't really recommend it.
 
-Directions on how to deploy a TURN server are listed in the turnserver.md file. You may wish to do so, although not all use cases will not need one. About 10% of remote guests, those often connected via 4G LTE, will require a TURN server however. While OBS.Ninja does host some TURN servers, they are quite expensive to operate and not really for private deployment use. If you are deploying your own version of OBS.Ninja, I'd ask you use your own TURN servers instead.
+Directions on how to deploy a TURN server are listed in the turnserver.md file. You may wish to do so, although not all use cases will not need one. Only about 10% of remote guests, those often connected via 4G LTE, will require a TURN server. While OBS.Ninja does host some TURN servers, they are quite expensive to operate and not really for private deployment use. If you are deploying your own version of OBS.Ninja, I'd ask you use your own TURN servers instead. 
 
 ## Server side / API software?
 Since OBS.Ninja uses peer-2-peer technology, video connections are made directly between viewer and publisher in 90% of cases. Hosting a TURN server yourself may help improve performance, but less than 1% of users will see any benefit of this. Details on how to deploy a TURN server are provided. For those capable of hosting their own TURN server, that would be appreciated if possible, as TURN servers are the only real cost incurred by OBS.Ninja at present. (other than time, of course)
@@ -45,12 +52,15 @@ If urgent, join me on discord: https://discord.gg/EksyhGA or email me at steve@s
 A better way to perform "Window Capturing" on desktop if OBS Browser Sources fails you. A downloadable tool designed to enhance OBS.Ninja.
 https://github.com/steveseguin/electroncapture
 
+#### CAPTION.Ninja
+A free AI-based closed-captioning tool to add speech-to-text overlays to OBS Studio. It's browser-based with an easy OBS integration. Developed by Steve as well! https://caption.ninja
+
 #### Steves.app:
 A website designed to also work with OBS.Ninja as a Broadcasting tool. Share your webcam, window, desktop, or video file with friends and family. Peer-2-peer, so privacy can be maintained, but you can also list your broadcasts for others to watch.
 https://steves.app/
 
-#### StageTen.tv
-A browser-based studio solution and simplified alternative to OBS, with built-in OBS.Ninja functionality. It is a server-based approach to group interactions and live production. Steve Seguin is affiliated with StageTen, yet StageTen is not affiliated with OBS.Ninja.
+#### StageTEN.tv
+A browser-based studio solution and simplified alternative to OBS, with built-in OBS.Ninja functionality. It is a server-based approach to group interactions and live production. Steve Seguin is affiliated with StageTEn, yet StageTEN is not affiliated with OBS.Ninja.
 
 ## Privacy
 I try to avoid data collection whenever possible and video streams are generally designed to be private, but use at your own risk. It is best to not share links created with OBS.Ninja with those you do not trust. I've provided instructions on how to deploy a TURN server if IP-address privacy is an issue for you. See: turnserver.md 

index.html

@@ -698,7 +698,7 @@
 		// If you wish to change branding, blank offers a good clean start.
 		<script type="text/javascript" id="main-js" src="./main.js" data-translation="blank"></script>
 	-->
-		<script type="text/javascript" crossorigin="anonymous" id="main-js" src="./main.js?ver=40"></script>
+		<script type="text/javascript" crossorigin="anonymous" id="main-js" src="./main.js?ver=41"></script>
 		<script type="text/javascript" crossorigin="anonymous" src="./animations.js?ver=10"></script>
 	</body>
 </html>

main.css

@@ -620,9 +620,9 @@ body {
 	   /* Add shadows to create the "card" effect */
 	   box-shadow: 0 4px 8px 0 rgba(0,0,0,.1);
 	   background-color: #ddd;
-	   transition: box-shadow 0.1s ease-in-out;
-	   
+	   transition: box-shadow 0.1s ease-in-out;   
    }
+
    /* On mouse-over, add a deeper shadow */
    .column:hover {
 	   box-shadow: 0 8px 16px 0 rgba(0,0,0,.3);
@@ -631,6 +631,11 @@ body {
    .column:active{
 	    box-shadow: 0 8px 16px 0 rgba(0,0,0,.5);
    }
+
+    /* When the columns are inactive, make behave link-like */
+   .column:not(.in-animation) {
+	   cursor: pointer;
+   }
    
    .column > h2 {color:black;}
 

main.js

@@ -161,8 +161,6 @@ document.addEventListener("keydown", event => {
 		} else {
 			toggleMute(); // Windows
 		}
-	  } else if (event.keyCode == 77) {  // m
-		toggleMute();
 	 // } else if (event.keyCode == 69) { // e 
 	//	hangup();
 	  } else if (event.keyCode == 66) { // b
@@ -1814,7 +1812,7 @@ function joinRoom(roomname){
 			for (var i in response){
 				if ("UUID" in response[i]){
 					if ("streamID" in response[i]){
-						if (response[i].UUID in session.pcs){
+						if (response[i].UUID in session.rpcs){
 							log("RTC already connected"); /// lets just say instead of Stream, we have 
 						} else {
 							//var title = "";                            // TODO: Assign labels 
@@ -4363,4 +4361,4 @@ function EnterButtonChat(event){
 		// Trigger the button element with a click
 		sendChatMessage();
 	}
-}
+}

translations/pt.json

@@ -56,13 +56,12 @@
   "send-chat": "Enviar",
   "available-languages": "Línguas disponíveis:",
   "add-more-here": "Adicionar mais aqui!",
-  "invite-users-to-join": "Invites users to join the group and broadcast their feed to it. These users will see every feed in the room.",
-  "link-to-invite-camera": "Link to invite users to broadcast their feeds to the group. These users will not see or hear any feed from the group.",
-  "this-is-obs-browser-source-link": "This is an OBS Browser Source link that is empty by default. Videos in the room can be manually added to this scene.",
-  "this-is-obs-browser-souce-link-auto": "Also an OBS Browser Source link. All guest videos in this group chat room will automatically be added into this scene.",
-  "click-for-quick-room-overview": "❔ Click Here for a quick overview and help",
-  "push-to-talk-enable": "🔊 Enable Director's Push-to-Talk Mode",
-  "welcome-to-control-room": "Welcome. This is the control-room for the group-chat. There are different things you can use this room for:<br><br>\t<li>You can host a group chat with friends using a room. Share the blue link to invite guests who will join the chat automatically.</li>\t<li>A group room can handle around 4 to 30 guests, depending on numerous factors, including CPU and available bandwidth of all guests in the room.</li>\t<li>Solo-views of each video are offered under videos as they load. These can be used within an OBS Browser Source.</li>\t<li>You can use the auto-mixing Group Scene, the green link, to auto arrange multiple videos for you in OBS.</li>\t<li>You can use this control room to record isolated video or audio streams, but it is an experimental feature still.</li>\t<li>Videos in the Director's room will be of low quality on purpose; to save bandwidth/CPU</li>\t<li>Guest's in the room will see each other's videos at a very limited quality to conserve bandwidth/CPU.</li>\t<li>OBS will see a guest's video in high-quality; the default video bitrate is 2500kbps.</li>\t<br>\tAs guests join, their videos will appear below. You can bring their video streams into OBS as solo-scenes or you can add them to the Group Scene.\t<br>The Group Scene auto-mixes videos that have been added to the group scene. Please note that the Auto-Mixer requires guests be manually added to it for them to appear in it; they are not added automatically.<br><br>Apple mobile devices, such as iPhones and iPads, do not fully support Video Group Chat. This is a hardware constraint.<br><br>\tFor advanced options and parameters, <a href=\"https://github.com/steveseguin/obsninja/wiki/Guides-and-How-to's#urlparameters\">see the Wiki.</a>",
-  "guest-will-appaer-here-on-join": "(A video will appear here when a guest joins)",
-  "SOLO-LINK": "SOLO LINK for OBS:"
-}
+  "invite-users-to-join": "Convida os utilizadores a juntarem-se à sala e partilharem câmera ou ecrã com ele. Estes utilizadores vêm as transmissões do resto da sala.",
+  "link-to-invite-camera": "Convida os utilizadores a juntarem-se à sala e partilharem câmera ou ecrã com ele. Estes utilizadores não vêm nem ouvem as transmissões do resto da sala.",
+  "this-is-obs-browser-source-link": "Este é um link para Fonte Browser do OBS que por omissão está vazio. Vídeos da sala podem ser manualmente adicionados.",
+  "this-is-obs-browser-souce-link-auto": "Também é um link para Fonte Browser do OBS. Todos os vídeos desta sala serão automaticamente adicionados.",
+  "click-for-quick-room-overview": "❔ Clique aqui para uma pequena apresentação e ajuda",
+  "push-to-talk-enable": "🔊 Ativar Push-to-talk do diretor",
+"welcome-to-control-room": "Bem-vindo. Esta é a sala de controlo para o chat de grupo. Há diferentes coisas que pode fazer aqui:<br><br>\t<li>Pode hospedar um chat de grupo com amigos. Partilhe o link azul para os convidados se juntarem ao chat de forma automática.</li>\t<li>Uma sala de grupo pode hospedar entre 4 a 30 4 to 30 convidados, dependendo de inúmeros factores, incluindo CPU e largura de banda de todos os convidados na sala.</li>\t<li>Visualizações individuais de cada vídeo serão mostradas quando carregam. Estas podem ser usadas em Fontes do tipo Browser no OBS.</li>\t<li>Pode usar a cena de grupo automática, o link verde, para dispôr automaticamente os vídeos por si no OBS.</li>\t<li>Pode usar esta sala de controlo para gravar streams isolados de vídeo ou áudio, mas isto é ainda experimental.</li>\t<li>Vídeos na sala de controle são de baixa qualidade propositadamente; para poupar largura de banda/CPU</li>\t<li>Convidados na sala irão ver-se numa qualidade muito reduzida para conservar largura de banda/CPU.</li>\t<li>OBS tem acesso ao vídeo do convidado em alta qualidade; o bitrate de vídeo por omissão é 2500kbps.</li>\t<br>\tÀ medida que os convidados entram, os seus vídeos são mostrados abaixo. Pode levar os seus sinais para o OBS como cenas individuais ou pode adicioná-los à cena de grupo.\t<br>A Cena de grupo auto-mistura vídeos que lhe forem adicionados. Note que a auto-mistura requer que os convidados sejam manualmente adicionados; não são adicionados automaticamente.<br><br>Dispositivos móveis Apple, como iPhones e iPads, não suportam totalmente o Chat de Grupo. Este é um constrangimento de hardware.<br><br>\tPara opções avançadas e parâmetros, <a href=\"https://github.com/steveseguin/obsninja/wiki/Guides-and-How-to's#urlparameters\">veja o Wiki.</a>",  "guest-will-appaer-here-on-join": "(Aparece aqui o vídeo quando um convidado entrar)",
+  "SOLO-LINK": "Link individual para OBS:"
+}

translations/ru.json

@@ -2,7 +2,7 @@
   "GO": "ВОЙТИ",
   "add-group-chat": "Добавить групповой чат в OBS",
   "add-to-group": "Добавить в групповую сцену",
-  "add-your-camera": "Добавьте свою камеру в OBS",
+  "add-your-camera": "Добавить свою камеру в OBS",
   "added-notes": "\n\t\t\t\t<u><i>Добавленные заметки:</i></u>\n\t\t\t\t<li>Любой может войти в комнату, если знает имя, поэтому оставьте его уникальным</li>\n\t\t\t\t<li>Наличие более четырех (4) человек в комнате не рекомендуется по причинам производительности, но это зависит от вашего оборудования.</li>\n\t\t\t\t<li>Устройства iOS ограничены размерами группы не более двух (2) человек. Это аппаратное ограничение.</li>\n\t\t\t\t",
   "advanced-paramaters": "Расширенные параметры",
   "audio-sources": "Источники звука",
@@ -27,7 +27,7 @@
   "open-in-new-tab": "Открыть в новой вкладке",
   "record": "Запись",
   "remote-control-for-obs": "Пульт дистанционного управления для OBS",
-  "remote-screenshare-obs": "Удаленный просмотр экрана в OBS",
+  "remote-screenshare-obs": "Удаленная демонстрация экрана в OBS",
   "room-name": "Название комнаты",
   "rooms-allow-for": "В комнатах предусмотрены упрощенный групповой чат и расширенное управление несколькими потоками одновременно.",
   "select-audio-source": "Выберите источники звука",
@@ -39,30 +39,30 @@
   "video-source": "Источники видео",
   "volume": "Громкость",
   "you-are-in-the-control-center": "Вы находитесь в центре управления комнатой",
-  "password-input-field": "Password",
-  "waiting-for-camera": "Waiting for Camera to Load",
-  "select-output-source": " Audio Output Destination: \n\t\t\t\t\t",
-  "video-resolution": "Video Resolution: ",
-  "hide-screen-share": "Hide Screenshare Option",
+  "password-input-field": "Пароль",
+  "waiting-for-camera": "Ожидание загрузки камеры",
+  "select-output-source": " Назначение аудиовыхода: \n\t\t\t\t\t",
+  "video-resolution": "Разрешение видео: ",
+  "hide-screen-share": "Скрыть параметр демонстрации экрана",
   "allow-remote-control": "Remote Control Camera Zoom (android)",
-  "add-a-password-to-stream": " Add a password:",
-  "add-the-guest-to-a-room": " Add the guest to a room:",
-  "invite-group-chat-type": "This room guest can:",
-  "can-see-and-hear": "Can see and hear the group chat",
-  "can-hear-only": "Can only hear the group chat",
-  "cant-see-or-hear": "Cannot hear or see the group chat",
-  "welcome-to-obs-ninja-chat": "\n\t\t\t\t\tWelcome to OBS.Ninja! You can send text messages directly to connected peers from here.\n\t\t\t\t",
+  "add-a-password-to-stream": " Добавить пароль:",
+  "add-the-guest-to-a-room": " Добавить гостя в комнату:",
+  "invite-group-chat-type": "В этой комнате гость может:",
+  "can-see-and-hear": "Видеть и слышать групповой чат",
+  "can-hear-only": "Только слышать груповой чат",
+  "cant-see-or-hear": "Не слышать и не видеть групповой чат",
+  "welcome-to-obs-ninja-chat": "\n\t\t\t\t\tДобро пожаловать в OBS.Ninja! You can send text messages directly to connected peers from here.\n\t\t\t\t",
   "names-and-labels-coming-soon": "\n\t\t\t\t\tNames identifying connected peers will be a feature in an upcoming release.\n\t\t\t\t",
-  "send-chat": "Send",
-  "available-languages": "Available Languages:",
-  "add-more-here": "Add More Here!",
+  "send-chat": "Отправить",
+  "available-languages": "Доступные языки:",
+  "add-more-here": "Добавить больше!",
   "invite-users-to-join": "Invites users to join the group and broadcast their feed to it. These users will see every feed in the room.",
   "link-to-invite-camera": "Link to invite users to broadcast their feeds to the group. These users will not see or hear any feed from the group.",
   "this-is-obs-browser-source-link": "This is an OBS Browser Source link that is empty by default. Videos in the room can be manually added to this scene.",
   "this-is-obs-browser-souce-link-auto": "Also an OBS Browser Source link. All guest videos in this group chat room will automatically be added into this scene.",
-  "click-for-quick-room-overview": "❔ Click Here for a quick overview and help",
-  "push-to-talk-enable": "🔊 Enable Director's Push-to-Talk Mode",
+  "click-for-quick-room-overview": "❔ Нажмите здесь, чтобы ознакомиться с кратким обзором",
+  "push-to-talk-enable": "🔊 Включить режим «Нажми, чтобы говорить»‎",
   "welcome-to-control-room": "Welcome. This is the control-room for the group-chat. There are different things you can use this room for:<br><br>\t<li>You can host a group chat with friends using a room. Share the blue link to invite guests who will join the chat automatically.</li>\t<li>A group room can handle around 4 to 30 guests, depending on numerous factors, including CPU and available bandwidth of all guests in the room.</li>\t<li>Solo-views of each video are offered under videos as they load. These can be used within an OBS Browser Source.</li>\t<li>You can use the auto-mixing Group Scene, the green link, to auto arrange multiple videos for you in OBS.</li>\t<li>You can use this control room to record isolated video or audio streams, but it is an experimental feature still.</li>\t<li>Videos in the Director's room will be of low quality on purpose; to save bandwidth/CPU</li>\t<li>Guest's in the room will see each other's videos at a very limited quality to conserve bandwidth/CPU.</li>\t<li>OBS will see a guest's video in high-quality; the default video bitrate is 2500kbps.</li>\t<br>\tAs guests join, their videos will appear below. You can bring their video streams into OBS as solo-scenes or you can add them to the Group Scene.\t<br>The Group Scene auto-mixes videos that have been added to the group scene. Please note that the Auto-Mixer requires guests be manually added to it for them to appear in it; they are not added automatically.<br><br>Apple mobile devices, such as iPhones and iPads, do not fully support Video Group Chat. This is a hardware constraint.<br><br>\tFor advanced options and parameters, <a href=\"https://github.com/steveseguin/obsninja/wiki/Guides-and-How-to's#urlparameters\">see the Wiki.</a>",
-  "guest-will-appaer-here-on-join": "(A video will appear here when a guest joins)",
-  "SOLO-LINK": "SOLO LINK for OBS:"
-}
+  "guest-will-appaer-here-on-join": "(Видео появится здесь, когда гость присоединится)",
+  "SOLO-LINK": "ПЕРСОНАЛЬНАЯ ССЫЛКА для OBS:"
+}

turnserver.md

@@ -1,3 +1,7 @@
+## Install and setup gudie for a TURN Relay Server
+
+#### why? You may want to deploy one to ensure high compatiblity with remote guests. If you try to use the official OBS.Ninja TURN servers for a private deployment, you may find yourself getting kicked off.
+
 This install script and config file was used with a standard virtual machine server loaded with Ubuntu 20.  GCP/AWS servers might need slightly different settings.
 
 ```
@@ -24,7 +28,8 @@ see this issue with coturn: https://github.com/coturn/coturn/issues/268
 
 You might also want to consider buying a better certificiate, as not all Google-related projects properly support certbot certificates, including libwebrtc. see [this issue ticket](https://github.com/coturn/coturn/issues/240#issuecomment-648550885).  If you go this route, see [turnserver2.conf](https://github.com/steveseguin/obsninja/blob/master/turnserver2.conf) for an example config.
 
-Nexzt, we update the User and Group values in our service file to be "root". This seems to fix the issue with Lets Encrypt. ..  I welcome a better solution tho.
+Next, we may want to update the User and Group values in our service file to be "root". This seems to be a quick hacky fix for the issue with Lets Encrypt. ..  I welcome a better solution tho.  If you move the certs somewhere else, or buy proper certificates, then the default turnserver user/group will work.
+
 ```
 sudo vi /usr/lib/systemd/system/coturn.service
 sudo systemctl daemon-reload