How do I enable or disable Scalable Video for my video project or application?

Objective

Enabling or disabling Scalable Video for your Vonage Video API projects or application.

Applies To

• Vonage Video API
• Projects
• Scalable Video

Contents

• Procedure for Vonage Video API Opentok Environment
• Procedure for Vonage Video API Unified Environment
• Additional Information

How to recognize if I’m using Vonage Video API Unified Environment or Vonage Video API OpenTok environment?

Procedure for Vonage Video API Opentok Environment

You can customize the scalable video setting for a specific project API key in the account portal.

1. Log in to your Vonage Video API Account.
2. From the left menu, select a Project.
3. Scroll down to Project Settings.
4. Under General Settings, click Edit.
5. Select the desired setting for the Scalable Video

On — Scalable video is always enabled (in supported clients) for all sessions in the project.

Off — Scalable video is not enabled for any sessions in the project.

Auto (default) — Scalable video is enabled for a session in the project when the OpenTok Media Router determines that it should be used (when there are more than two clients in the session).

Unless there is a specific reason for scalable video to be always on or off, you should leave the Auto option selected.

     6. Click the Save button.

Procedure for Vonage Video API Unified Environment

You can enable or disable scalable video settings on your applications at any time. 

1. Log in to your Vonage API account dashboard.
2. From the left menu, select Applications 
3. Select the application and click on Edit or click on Create a new application 
4. Scroll down to Capabilities
5. Goto video Capabilities and click Show advanced features
6. Select the desired setting for the Scalable Video
7. After you've made your selection, click on Save Changes to apply your changes.

Additional Information

By default, in sessions that support scalable video, scalable video is disabled for screen-sharing streams and enabled for all other streams (streams that have a camera or custom video source).

For sessions that support scalable video (that do not have scalable video turned off at the project level), you can override the default scalable video setting while publishing the stream (enabling it for a screen-sharing stream or disabling it for other streams). 

For more information on enabling and disabling scalable video, see our developer center page on scalable-video 

For additional details on scalable video, see our support article on Vonage-Scalable-Video-Simulcast