The openvidu-custom-activities-panel tutorial shows how to replace the default activities panel with a custom one.
This customization is possible thanks to the ActivitiesPanelDirective, which provides us a simple way to customize the ActivitiesPanelComponent.
Running this tutorial 🔗
To run the tutorial you need the three components stated in OpenVidu application architecture: an OpenVidu deployment, your server application and your client application. In this order:
1. Run OpenVidu deployment 🔗
Using Docker Engine:
# WARNING: this container is not suitable for production deployments of OpenVidu # Visit https://docs.openvidu.io/en/stable/deployment docker run -p 4443:4443 --rm -e OPENVIDU_SECRET=MY_SECRET openvidu/openvidu-dev:2.26.0
2. Run your preferred server application sample 🔗
For more information visit Application server.
3. Run the client application tutorial 🔗
You need NPM and Angular CLI to serve the application. Check them with the following command:
npm -v ng v
To serve the tutorial:
# Using the same repository openvidu-tutorials from step 2 cd openvidu-tutorials/openvidu-components/openvidu-custom-activities-panel npm install ng serve
http://localhost:4200 to test the app once the server is running.
To test the application with other devices in your network, visit this FAQ
Understanding the code 🔗
This is an Angular project generated with angular-cli tool, and therefore you will see lots of configuration files and other stuff that doesn't really matter to us. We will focus on the following files under
app.module.ts: defines the AppComponent module where we import and configure the openvidu-angular library.
app.component.ts: defines AppComponent, main component of the app. It handles the request of OpenVidu tokens to pass them to the videoconference component, so it is able to connect to the OpenVidu session.
First, we need to install the openvidu-angular library. You can check how to do that here.
The VideoconferenceComponent needs the OpenVidu tokens to connect to the session. We request them on
ngOnInit method. The VideoconferenceComponent will automatically use them to connect to the session when available.
<ov-videoconference [tokens]="tokens" [toolbarDisplaySessionName]="false"> <div *ovToolbarAdditionalPanelButtons style="text-align: center;"> <button mat-icon-button (click)="toggleMyPanel('my-panel')"> <mat-icon>360</mat-icon> </button> <button mat-icon-button (click)="toggleMyPanel('my-panel2')"> <mat-icon>star</mat-icon> </button> </div> <div *ovAdditionalPanels id="my-panels"> <div id="my-panel1" *ngIf="showExternalPanel"> <h2>NEW PANEL</h2> <p>This is my new additional panel</p> </div> <div id="my-panel2" *ngIf="showExternalPanel2"> <h2>NEW PANEL 2</h2> <p>This is other new panel</p> </div> </div> </ov-videoconference>
Inside of the
ov-videoconference component we add the custom template tagged with the
*ovActivitiesPanel directive. You can see how the
ActivitiesPanelDirective works here.
Deploying openvidu-custom-activities-panel 🔗
1) Build the docker image 🔗
Under the root project folder, you can see the
openvidu-components/docker/ directory. Here it is included all the required files yo make it possible the deployment with OpenVidu.
First of all, you will need to create the openvidu-custom-activities-panel docker image. Under
openvidu-components/docker/ directory you will find the
create_image.sh script. This script will create the docker image with the openvidu-basic-node as application server and the static files.
./create_image.sh openvidu/openvidu-custom-activities-panel-demo:X.Y.Z openvidu-custom-activities-panel
The script needs two parameters:
- The name of the docker image to create.
- The name of the tutorial folder.
This script will create an image named
openvidu/openvidu-custom-activities-panel-demo:X.Y.Z. This name will be used in the next step.
2) Deploy the docker image 🔗
Time to deploy the docker image. You can follow the Deploy OpenVidu based application with Docker guide for doing this.