| Both sides previous revision Previous revision Next revision | Previous revision |
| howto:obs_ninja [2020/12/17 16:20] – [OBS Ninja] eric | howto:obs_ninja [2021/12/12 14:21] (current) – andi |
|---|
| ====== OBS Ninja ====== | ====== VDO Ninja ====== |
| |
| OBS Ninja allows speakers to share their webcam or desktop over the internet using peer to peer web-rtc video streams, so the mixer can embed those streams using a browser source in [[OBS]] | <bootnote>At the current state we can not recommend to use ninja. have a look at [[projects:kevin]] for an alternative</bootnote> |
| |
| Voc-Hosted Service: <del>[[https://ninja.c3voc.de/ | Ninja Winkekatze]]</del> Currently offline, see [[https://github.com/steveseguin/obsninja/issues/613 | Issue in Github]] | VDO Ninja (previously named "OBS Ninja") allows speakers to share their webcam or desktop over the internet using peer to peer web-rtc video streams, so the mixer can embed those streams using a browser source in [[OBS]] |
| |
| Currently Installed Version: 13.4 | Voc-Hosted Service: [[https://ninja.c3voc.de/ | Ninja Winkekatze]] |
| | |
| | Currently Installed Version: 6 |
| |
| Source Code: [[https://github.com/steveseguin/obsninja | Github]] | Source Code: [[https://github.com/steveseguin/obsninja | Github]] |
| | * <color #ed1c24>OBS Ninja is not totally open source, for details see [[https://github.com/steveseguin/obsninja/issues/613 | Issue in Github]]</color>. We are currently working on a fully free version. |
| |
| Official Documentation: [[https://github.com/steveseguin/obsninja/wiki | Github Wiki]] | Official Documentation: [[https://github.com/steveseguin/obsninja/wiki | Github Wiki]] |
| | |
| | |
| ===== Features ===== | ===== Features ===== |
| |
| |
| **TODO: Determine if sources in MultiView count as Visible.** | **TODO: Determine if sources in MultiView count as Visible.** |
| | |
| | |
| === Stats === | === Stats === |
| The Stats window can be enabled either by pressing right CTRL while clicking on the video or appending the ''stats'' parameter to the URL. On Mobile devices, you can open the stats video by rapidly pressing on the screen multiple times. | The Stats window can be enabled either by pressing right CTRL while clicking on the video or appending the ''stats'' parameter to the URL. On Mobile devices, you can open the stats video by rapidly pressing on the screen multiple times. |
| According to the documentation, it should be possible to share Files (Video / Audio) via OBS Ninja. <color #ed1c24>**As of 16.12.2020, this was not tested successfully.**</color> | According to the documentation, it should be possible to share Files (Video / Audio) via OBS Ninja. <color #ed1c24>**As of 16.12.2020, this was not tested successfully.**</color> |
| |
| ===== URL Parameters ===== | ===== URL Parameters (V13.4) ===== |
| [based on [[https://github.com/steveseguin/obsninja/wiki/Advanced-Settings | OBS Ninja / Advanced Settings]]] | [based on [[https://github.com/steveseguin/obsninja/wiki/Advanced-Settings | OBS Ninja / Advanced Settings]]] |
| ==== General Parameters ==== | ==== General Parameters ==== |
| |
| ^ Parameter ^ Alias ^ Value Type ^ Possible Values ^ Default ^ Description ^ | ^ Parameter ^ Alias ^ Value Type ^ Possible Values ^ Default ^ Description ^ |
| | ''chroma'' | | HEX-String (RGB) | 3-Digit or 6 Digit Hex | | Sets the Background of the website to the given color | | | ''chroma'' | | HEX-String (RGB) | 3-Digit or 6 Digit Hex | | Sets the Background of the website to the given color | |
| | ''cleanoutput'' | ''clean'' | None | Null | Null | Hides many UI elements and Popups | | | ''cleanoutput'' | ''clean'' | None | Null | Null | Hides many UI elements and Popups | |
| | ''director'' | | String | Valid Room ID | | Opens the Director View of the Room with the given ID | | | ''director'' | | String | Valid Room ID | | Opens the Director View of the Room with the given ID | |
| | ''flip'' | | None | Null | Null | Mirrors the Video at the x axis. For mirroring along the y axis, see ''mirror'' | | | ''flip'' | | None | Null | Null | Mirrors the Video at the x axis. For mirroring along the y axis, see ''mirror'' | |
| | ''hash'' | | String | Password Hashes | | acts as if ''password'' was added | | | ''hash'' | | String | Password Hashes | | acts as if ''password'' was added | |
| | ''hideheader'' | ''noheadder'' | None | Null | Null | Hides just the top headder bar. | | | ''hideheader'' | ''noheadder'' | None | Null | Null | Hides just the top headder bar. | |
| | ''icefilter'' | | String | tcp, udp, host | | Filters out ICE candidates that do not include the specified word in the candidate string. | | | ''icefilter'' | | String | tcp, udp, host | | Filters out ICE candidates that do not include the specified word in the candidate string. | |
| | ''label'' | | String | | blank | Used when dragging the link into OBS Studio, changes the title of the browser tab and shows up in the connection debug stats window. If blank, prompts user for a display name on load | | | ''label'' | | String | | blank | Used when dragging the link into OBS Studio, changes the title of the browser tab and shows up in the connection debug stats window. If blank, prompts user for a display name on load | |
| | ''ln'' | | Enum | en, ru, fr, pt, it, blank | en | Sets the UI Language. blank means Less verbose | | | ''ln'' | | Enum | en, ru, fr, pt, it, blank | en | Sets the UI Language. blank means Less verbose | |
| | ''mirror'' | | Enum | 0, 1, 2, 3, Null | Null | Mirrors the video along the x axis. For y axis mirroring, see ''flip''. See [[https://github.com/steveseguin/obsninja/wiki/Advanced-Settings#-mirror0123| Official Documentation]] for details | | | ''mirror'' | | Enum | 0, 1, 2, 3, Null | Null | Mirrors the video along the x axis. For y axis mirroring, see ''flip''. See [[https://github.com/steveseguin/obsninja/wiki/Advanced-Settings#-mirror0123| Official Documentation]] for details | |
| | ''nocursor'' | | None | Null | Null | Hides the mouse cursor with CSS, Useful for Window Captures | | | ''nocursor'' | | None | Null | Null | Hides the mouse cursor with CSS, Useful for Window Captures | |
| | ''obsoff'' | ''oo'' | None | Null | Null | Disable the tally light effects; can be applied to both viewer or pubilsher. | | | ''obsoff'' | ''oo'' | None | Null | Null | Disable the tally light effects; can be applied to both viewer or pubilsher. | |
| | ''password'' | | String | Alpha-Numeric, Case Sensitive | | Sets a Password to view a stream or join a room (If trying to access a password protected Stream / Room with out this parameter, a password prompt will appear). <color #ed1c24>If the password is wrong, no Error is shown. It just wont work.</color> | | | ''password'' | | String | Alpha-Numeric, Case Sensitive | | Sets a Password to view a stream or join a room (If trying to access a password protected Stream / Room with out this parameter, a password prompt will appear). <color #ed1c24>If the password is wrong, no Error is shown. It just wont work.</color> | |
| | ''relay'' | ''private'', ''privacy'' | None | Null | Null | Forces TURN relay into use | | | ''relay'' | ''private'', ''privacy'' | None | Null | Null | Forces TURN relay into use | |
| | ''remote'' | ''rem'' | String | Alpha-Numeric, Case Sensitive | | Allows remote operation of the zoom feature on Android devices. | | | ''remote'' | ''rem'' | String | Alpha-Numeric, Case Sensitive | | Allows remote operation of the zoom feature on Android devices. | |
| | ''room'' | ''roomid'', ''r'' | String | * | | Sets a room ID | | | ''room'' | ''roomid'', ''r'' | String | * | | Sets a room ID | |
| | ''roombitrate'' | | Integer | N (in kbps) | | Sets Bitrate of Speaker Viewers in Room. Should not affect OBS. If set to 0, can increase maximum number of possible Guests in a Room | | | ''roombitrate'' | | Integer | N (in kbps) | | Sets Bitrate of Speaker Viewers in Room. Should not affect OBS. If set to 0, can increase maximum number of possible Guests in a Room | |
| | ''showonly'' | | String | ? | | ?, Can increase maximum number of possible Guests in a Room | | | ''showonly'' | | String | ? | | ?, Can increase maximum number of possible Guests in a Room | |
| | ''stats'' | | None | Null | Null | Shows the Connection / Media Stats window by default | | | ''stats'' | | None | Null | Null | Shows the Connection / Media Stats window by default | |
| | ''stereo'' | ''s'', ''proaudio'' | Enum | 0, 1, 2, 3, 4 | 0 | see [[https://github.com/steveseguin/obsninja/wiki/Advanced-Settings#-stereo01234| Official Documentation]] | | | ''stereo'' | ''s'', ''proaudio'' | Enum | 0, 1, 2, 3, 4 | 0 | see [[https://github.com/steveseguin/obsninja/wiki/Advanced-Settings#-stereo01234| Official Documentation]] | |
| | ''sticky'' | | None | Null | Null | Allows saving and restoring of sessions using cookies. | | | ''sticky'' | | None | Null | Null | Allows saving and restoring of sessions using cookies. | |
| | ''style'' | | Enum | 0, 1, 2 | ? | Selects how Audio-Only Media is displayed. 1 hides audio-only elements, 2 shows a visual waveform for the audio element. Experimental, might change. | | | ''style'' | | Enum | 0, 1, 2 | ? | Selects how Audio-Only Media is displayed. 1 hides audio-only elements, 2 shows a visual waveform for the audio element. Experimental, might change. | |
| | ''transparent'' | | None | Null | Null | Makes the website background transparent using CSS, (not needed with OBS Default CSS, only useful when embedding OBS Ninja as IFrame) | | | ''transparent'' | | None | Null | Null | Makes the website background transparent using CSS, (not needed with OBS Default CSS, only useful when embedding OBS Ninja as IFrame) | |
| | | ''wss'' | | URL | [subdomain].domain.tld | wss13.0bs.ninja | Sets a custom URL for the websocket server | |
| |
| ==== Source Parameters ==== | ==== Source Parameters ==== |
| |
| |
| ===== Tested Platforms / Browsers ===== | ===== Tested Platforms / Browsers (V 13.4)===== |
| |
| ==== For Speakers ==== | ==== For Speakers ==== |