Ninja Docs
Search…
Screen-share Parameters
Labels, audio filters, type, bitrate, quality etc.
Screen-share Parameters are separated in general options, source side (push) options and viewer side (view) options.

General options

You can add them to both, source (&push) and viewer (&view or &scene) sides.
Parameter
Explanation
Sets the audio mode for screen-shares to stereo and changes default audio settings to improve audio quality

Source side options

You can add them to both, source (&push) and viewer (&view or &scene) sides.
Parameter
Explanation
Disables camera-sharing as an option
Will show the "Share your Screen" button before asking the user to select screenshare options
Turns automatic echo-cancellation filter for screen-shares ON or OFF
Turns audio auto-normalization filter for screen-shares ON or OFF
Attempts to show the mouse cursor on screen shares
Turns audio noise reduction filter for screen-shares ON or OFF
Set a target FPS for your screenshare (secondary stream)
Hides the local screen-share sub-window that appears when screen sharing in a room
Pre-sets the screenshare stream id for a screen share if its a secondary stream
The screen-share of the guest will have the same label as the guest
Set a custom screenshare quality
Sets the audio mode for screen-shares to stereo and changes default audio settings to improve audio quality
Defines how webcam and screenshare of a guest in a room interacts which each other
Lets you disable the option to select audio when screen sharing
&ssb
Forces the screen-share button to appear for guests

Viewer side options

You have to add them to the viewer side (&view or &scene).
Parameter
Explanation
Lets you manually set the video bitrate for screen-shares
&sspaused
Starts any screen-share paused