vdo.ninja/README.md
Steve Seguin 43ee28b9d4 Syncing codebase /w Production's v4 Release
Some of the notable changes revolve around fixing issues with the Group Chat, refining the UX/UI, adding stream iso-recording, enabling camera zooming on Android, and allowing users to select multiple audio sources, disable audio, or disable the video.

Change list

    Audio can be disabled and/or mixed with more than one audio input device

    video can be disabled, allowing for audio-only publishing

    avatar silhouette takes the place of a stream without a video

    Some Android cameras can now zoom-in with a swipe up action.

    The Create Invite Link option lets you select some advanced parameters, like bitrate and stereo, in a very easy way.

    reduced the size of the preview window ; for camera and screens hare

    made all OBS/invite links easier to copy, dragged into OBS v25, and seleced.

    Most OBS/invite links can be right clicked to access custom menu

    copy to clipboard links that are clicked

    Viewers in Group Chat can magnify and increase the bitrate of one video at a time.

    Pseudo-Fullscreen works in group chat now

    Room names can be accessed via https://obs.ninja/myroomnamehere

    You can record videos via the group control room; selectable bitrates. webm Format

    filename of recorded files is the timestamp of the ended recording time; milliseconds

    new iOS error messages

    firefox shows camera labels now

    Add a "secure" mode that increases verbosity and prevents a stream being accessed more than once

    electron app interface works with the production code

    It is harder to hit 'ready to go', before the camera is actually ready

    expanded help information in a less annoying way

    if you deny Screen-share permissions, it will let you try again without a page refresh

    Custom generated invite links, if dragged into OBS v25, will be named according to the given label

    Got rid of the cartoon cat; too much visual complexity

    Numerous UX changes to the Control Room page

    Codec remains set at VP8, but progress in OBS has made on its issues.

    Added a new TURN video relay server to US West (LA). I've also increased the capacity of the existing US-Central server. 16x more capacity over all.

    Video Control bar hidden in more cases; or delayed in showing

    Increased readability of some fonts

    Improved mobile layout and accessibility

    Mute/Unmute button has been made more secure

    No need to toggle mute in group chat to get the audio to work

    pressing enter on input fields auto submits; no clicking needed

    Dynamic bitrates improved

    Group automixer improved a bit

    no-cursor option works with Electron app now

    cleaned up the Error page in OBS if it fails to load a video; no more 'leaked' streamIDs

    renamed streamid, permaid, and roomid. They are now room, push, and view. backwards compatible tho still.

    Invite to Room page is more mobile friendly and clean; less noise

    iPad Pro treated like an iOS device; limits resolution to 720p

    rounded corners of the big buttons because "looks more modern". ;/

    Updated Licence and added a CLA

    Added translations / languages via a template system

    electron-app improvements, such as the ability to select OUTPUT AUDIO Destination

    Fixed a few bugs reported over the last few days, since production release

    and many others that I likely forgot about
2020-05-10 03:43:55 -04:00

4.5 KiB

ILogo by brimace

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.

OBS Ninja is not affiliated with OBS, but OBS Ninja is dependent on OBS to function. OBS.Ninja is designed to allow content creators to produce real-time live shows with OBS Studio and to allow smartphones to be used as webcams on a Windows PC.

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

How to use:

I demo the basic usage of OBS.Ninja on YouTube: https://www.youtube.com/watch?v=6R_sQKxFAhg

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 Reddit or the Wiki.

What's in this repo?

This repo contains the software for OBS.ninja and its TURN server deployment settings. Feel free to use it as you will; code contributions very welcomed. You may be best suited at getting ahold of me at steve@seguin.email instead of via Github if urgent though.

How to Deploy this Repo:

To use, just download and host 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. Customize the code as desired.

Directions on how to deploy a TURN server are listed in the turnserver.conf file. You may wish to do so if you are having problems with my existing TURN server, although most users will not need one. About 10% of users, those often connected via 4G LTE, will require a TURN server. My TURN server does cost me money to host, which I do for free, so please do not abuse it.

Why deploy OBS.Ninja? You may want to customize the UI for your brand/business, or control security/privacy beyond what I do already. I personally feel it is best to CONTRIBUTE desired changes to this repo instead, as technology moves fast and older forked versions will become obsolete.

Server side / API software?

Other than the hosted TURN server, OBS.Ninja uses public STUN servers and a hosted handshake server. These are used to facilitate the initial setup of peer connections and are not required after a peer connection is established. Development builds of OBS.Ninja may include debugging software, but in-production releases have this removed.

A design goal of OBS.Ninja is to be serverless and we are 99% of the way there. This design objective ensures OBS.Ninja can be offered for free, along with providing increased levels of security and privacy.

Issues? problems? Not working?

Please see the sub-reddit for more support: https://reddit.com/r/obsninja

Also check out the FAQ for common answers: https://github.com/steveseguin/obsninja/wiki

If urgent, join me on discord: https://discord.gg/EksyhGA or email me at steve@seguin.email

OBS.Ninja's Electron Capture:

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

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/

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.conf

Additional security features are being added weekly on request. Please ask about these options if added security and privacy are requirements for you.

Feedback

Idea, feed back, bugs, etc -- all welcomed. I'm dumping many of my ideas as issues into Github. Feedback is typcially most welcomed via Email or Discord.

Licence

OBS.Ninja is available as open-source; please see the LICENCE.md file for details.