Ninja Docs
Search
K

Video Parameters

Resolution, FPS, effects, self preview, mute video, PTZ, codec, buffer, broadcast, scale
They are separated in three groups: general options (push and view), source side (push) options and viewer side (view) options.
If you want to change the bitrate: Video Bitrate Parameters

General options

You can add them to both, source (&push) and viewer (&view, &scene or &solo) sides.
Parameter
Explanation
&blind
Video playback is disabled

Source side options

You have to add them to the source side (&push).
Parameter
Explanation
&quality
Presets the quality setting for a guest
&width
Sets the maximum width of the video allowed in pixels
&height
Sets the maximum height of the video allowed in pixels
Changes the aspect ratio on the publisher side
=motion prioritizes resolution; =detail prioritizes frame rate
Adds the option to change the video and audio settings dynamically via the settings menu
&noscale
Disables the publishing resolution from being capped
&fps
Sets the maximum frame rate of the video in frames per second
Like &fps, except it will allow for lower frame rates if the specific frame rate requested failed
&effects
Applies effects to the video/audio feeds
Sets the amount of blur or effect applied
Can be used to pass a list of background images via the URL
&avatar
Adds the ability to select an image, instead of a video device
The preview video will be fullscreen
Forces the guest to have a self-preview
Mini self-preview at the top right corner
Used to position where the mini preview is located by default on screen
Disables the local self-preview
Has a guest join a room not visible to others
Auto mutes guest's video
&ptz
Enables pan/tilt control of the device, if compatible
&webp
Custom video codec for broadcasts
Quality setting for the &webp option
*NEW IN VERSION 23

Viewer side options

You have to add them to the viewer side (&room or &view, &sceneor &solo).
Parameter
Explanation
&scale
Scales the video resolution of the inbound video by the given percent
&dpi
Overrides the automatically selected Device Pixel Ratio
&sharper
Should 'up to' double the amount of playback video resolution
Does the same thing as &scale but you pass the width in pixels
Does the same thing as &scale but you pass the height in pixels
&codec
Sets the codec to encode the video
OpenH264 software encoding will be used
&buffer
Sets the video buffer
Same as &buffer, but instead includes the round-trip-time
&fadein
Has videos fade in smoothly
A useful flag to allow the director to present their own video to the group, often used in conjunction with a virtual webcam or Meshcast. It allows for larger groups rooms by reducing load on guests
A useful flag to allow the director to present their own video to the group, often used in conjunction with a virtual webcam or Meshcast. It allows for larger groups rooms by reducing load on guests
&showonly
Only shows any stream ID that is listed
&novideo
Disables all video playback on the local computer
Plays video back as a series of full-window images
*NEW IN VERSION 23
Last modified 4mo ago