Ninja Docs
Search…
&screensharetype
Defines how webcam and screenshare of a guest in a room interacts which each other
Sender-Side Option! (&push)

Aliases

  • &sstype

Options

Value
Description
1
Replaces the webcam screen with the screen share
2
Creates a totally new connection for the screen share
3
Reuses the existing connection, adding a second video track

Details

This parameter can be used to specify which type of screen sharing logic is used.
  • screensharetype=1 replaces the webcam screen with the screen share
  • screensharetype=2 creates a totally new connection for the screen share
  • screensharetype=3 reuses the existing connection, adding a second video track; also doesn't show the local screen share window
I hope to have screensharetype=3 become the standard for sharing screens eventually, but for now it will remain optional, until the issues are all worked out.
As a viewer or scene link, to specify only loading the &screensharetype=3 screen share, you can now use &view=xxxx:s, where :s is appended to the end of the stream ID. This tells the system to ignore the webcam/mic feed, and just send over the screen share. You can do &view=xxxx,xxxx:s to target both webcam and screen share though. I may change this syntax over time, but for now it works. The solo-links in the director's room has this :s applied already where needed.
If using &screensharetype=3 the parameter &screenshareid doesn't do anything.
The type-3 screen share is still not fully cooked for use in scenes, etc, and it won't yet work with &meshcast, &novideo or &noaudio.

Copy link
On this page
Aliases
Options
Details
Related