Skip to content

virtual-background

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

virtual-background

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
public
public
 
 
.env
.env
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
index.js
index.js
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

README.md

openvidu-virtual-background

An OpenVidu v2compatibility example that demonstrates virtual background effects (blur and image replacement) in video calls.

It uses openvidu-node-client-v2compatibility on the backend and openvidu-browser-v2compatibility on the frontend.

Prerequisites

Quick start (demos deployment)

The application is configured by default to use the public OpenVidu demos deployment at meet-demo.openvidu.io, so no OpenVidu setup is needed.

git clone https://github.com/OpenVidu/openvidu-v2compatibility-examples.git
cd openvidu-v2compatibility-examples/examples/virtual-background
npm install
node index.js

Open http://localhost:5000 in your browser.

Using your own OpenVidu deployment

The v2compatibility layer requires OpenVidu PRO. You can either:

  • Self-host an OpenVidu PRO deployment. A license key is required. See deployment types.
  • Run locally with the OpenVidu PRO local development deployment. See local deployment. It runs in evaluation mode for free (no license needed), with some limits: maximum 8 participants across all rooms and 5 minutes duration per room.

Once your deployment is running, update the .env file with its URL and secret. For example, for a local deployment:

OPENVIDU_URL=http://localhost:7880
OPENVIDU_SECRET=secret

Then run the application as usual:

npm install
node index.js