What do the parameters returned from the Dimension changed event from a session in Inspector tool mean?

Objective

To explain the parameters returned in the Dimension changed event from a session in the Inspector tool

Applies To

• Session Inspector tool
• Video API

Procedure

Below is an image of the parameters returned in a session from the Dimension changed event taken from the Inspector tool, followed by the parameter descriptions.

VideoHeight - the height of the video stream.

VideoWidth - the width of the video stream.

Height - the height of the video stream sent by the publisher.
 
VideoHeightInput - height of video frame being send by input device (camera, etc.). This may be different than the height of the actual video stream if, for example, a camera is sending frames at 640x480 but because of bandwidth they are downscaled to 320x240 on the subscriber side.
 
VideoSentEstimatedBandwidth - this is the bitrate the subscriber sees from the publisher. This is an indicator of video quality received from the publisher by the subscribers. If simulcast is not enabled, the subscriber with the lowest videoSentEstimatedBandwidth lowers the video quality sent to all subscribers.
 
VideoBandwidthLimitedResolution - this tells you whether the video resolution is limited due to low bandwidth for that session.
 
VideoFrameRateSent - the total number of frames sent up until that point.

VideoFrameRate - the frame rate.
 

Additional Information

By default the resolution of a Publisher is 640x480, but you can set it to 1920x1080, 1280x720 or 320x240 as well. It is best to try to match the resolution to the size that the video will be displayed. If you are only displaying the video at 320x240 pixels then there is no point in streaming at 1280x720 or 1920x1080. Reducing the resolution can save bandwidth and reduce congestion and connection drops.
 
By default the frame rate of the video is 30 frames per second, but you can set it to 15, 7, or 1 as well. Reducing the frame rate can reduce the bandwidth required. 
 
Smaller resolution videos can have a lower frame rate without as much of a perceived difference to the user. So if you are using a low resolution, you might also want to think about using a low frame rate.
 
Please see useful links below.
 
How to use setPreferredResolution() to manage bandwidth usage for subscribed streams
 
Vonage Scalable Video Simulcast
 
How to Retrieve Outgoing Bandwidth available Using RTC Stats
 
What is the minimum bandwidth requirement to use the Vonage Video API?