openvidu-toggle-hand

Source code

The openvidu-toggle-hand tutorial demonstrates how to add a toggle hand feature to the OpenVidu Components Angular library.

The toggle hand feature allows participants to raise and lower their hand during a videoconference. This feature is useful for participants to signal that they want to speak or ask a question.

This tutorial combines the use of the ToolbarAdditionalButtonsDirective, the StreamDirective and the ParticipantsPanelItemElementsDirective to create a custom toolbar button, a custom stream component element and a custom participant panel item element. Check the openvidu-toolbar-buttons and the openvidu-custom-stream tutorials documentation for learning more about these directives.

OpenVidu Components - Toggle Hand

Running this tutorial

1. Run OpenVidu Server

Run OpenVidu locallyDeploy OpenVidu

1. Download OpenVidu

   git clone https://github.com/OpenVidu/openvidu-local-deployment -b 3.0.0
   

2. Configure the local deployment

   Windows macOS Linux

   cd openvidu-local-deployment/community
   .\configure_lan_private_ip_windows.bat
   

   cd openvidu-local-deployment/community
   ./configure_lan_private_ip_macos.sh
   

   cd openvidu-local-deployment/community
   ./configure_lan_private_ip_linux.sh
   

3. Run OpenVidu

   docker compose up
   

To use a production-ready OpenVidu deployment, visit the official deployment guide.

Configure Webhooks

All application servers have an endpoint to receive webhooks from OpenVidu. For this reason, when using a production deployment you need to configure webhooks to point to your local application server in order to make it work. Check the Send Webhooks to a Local Application Server section for more information.

2. Download the tutorial code

git clone https://github.com/OpenVidu/openvidu-livekit-tutorials.git -b 3.0.0
git clone https://github.com/OpenVidu/openvidu-tutorials.git -b 3.0.0

3. Run a server application

Node Go Ruby Java Python Rust PHP .NET

To run this server application, you need Node installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/node
   

2. Install dependencies

   npm install
   

3. Run the application

   npm start
   

For more information, check the Node.js tutorial.

To run this server application, you need Go installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/go
   

2. Run the application

   go run main.go
   

For more information, check the Go tutorial.

To run this server application, you need Ruby installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/ruby
   

2. Install dependencies

   bundle install
   

3. Run the application

   ruby app.rb
   

For more information, check the Ruby tutorial.

To run this server application, you need Java and Maven installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/java
   

2. Run the application

   mvn spring-boot:run
   

For more information, check the Java tutorial.

To run this server application, you need Python 3 installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/python
   

2. Create a python virtual environment

   python -m venv venv
   

3. Activate the virtual environment

   Windows macOS Linux

   .\venv\Scripts\activate
   

   . ./venv/bin/activate
   

   . ./venv/bin/activate
   

4. Install dependencies

   pip install -r requirements.txt
   

5. Run the application

   python app.py
   

For more information, check the Python tutorial.

To run this server application, you need Rust installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/rust
   

2. Run the application

   cargo run
   

For more information, check the Rust tutorial.

To run this server application, you need PHP and Composer installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/php
   

2. Install dependencies

   composer install
   

3. Run the application

   composer start
   

Warning

LiveKit PHP SDK requires library BCMath. This is available out-of-the-box in PHP for Windows, but a manual installation might be necessary in other OS. Run sudo apt install php-bcmath or sudo yum install php-bcmath

For more information, check the PHP tutorial.

To run this server application, you need .NET installed on your device.

1. Navigate into the server directory

   cd openvidu-livekit-tutorials/application-server/dotnet
   

2. Run the application

   dotnet run
   

Warning

This .NET server application needs the LIVEKIT_API_SECRET env variable to be at least 32 characters long. Make sure to update it here and in your OpenVidu Server.

For more information, check the .NET tutorial.

4. Run the openvidu-toggle-hand tutorial

To run the client application tutorial, you need Node installed on your development computer.

1. Navigate into the application client directory:

     cd openvidu-tutorials/openvidu-components/openvidu-toggle-hand
   

2. Install the required dependencies:

     npm install
   

3. Serve the application:

     npm start
   

Once the server is up and running, you can test the application by visiting http://localhost:5080.

Accessing your application client from other devices in your local network

One advantage of running OpenVidu locally is that you can test your application client with other devices in your local network very easily without worrying about SSL certificates.

Access your application client through https://xxx-yyy-zzz-www.openvidu-local.dev:5443, where xxx-yyy-zzz-www part of the domain is your LAN private IP address with dashes (-) instead of dots (.). For more information, see section Accessing your local deployment from other devices on your network.

Understanding the code

This tutorial is an Angular project generated with Angular CLI tool. Therefore, you will see many configuration files and other components that are not the primary focus of this tutorial. We will concentrate on the following files in the src directory:

• main.ts: This file defines the root application component. It imports the OpenViduComponentsModule, where we configure the OpenVidu Components Angular library.
• app/app.component.ts: This file defines the AppComponent, the primary and sole component of the application. It is responsible for requesting the OpenVidu token and passing it to the videoconference component, facilitating the connection to the OpenVidu Room.

• styles.scss: This file defines the global styles of the application. Here, you can customize the UI of the OpenVidu Components Angular library.

• app/models/participant-app.model.ts: Contains the ParticipantAppModel class that extends the ParticipantModel class to add the ability to raise and lower the hand.

---

To use OpenVidu Components Angular in your application, you need to install the library and import the OpenViduComponentsModule in your Angular module. Let's see how to do this:

1. Create an Angular Project (version 17 or higher)

   To begin, you will need to create a new Angular project if you haven't already. Ensure you have Node.js and the Angular CLI installed. Then, run the following command to create a new Angular project:

   ng new your-project-name
   

   Replace your-project-name with the desired name for your project.

2. Add Angular Material to your project

   OpenVidu Components Angular needs Angular Material, which provides a range of UI components. To add Angular Material to your project, navigate to your project directory and run:

   ng add @angular/material
   

3. Install OpenVidu Components Angular

   With your Angular project set up, it's time to add videoconferencing capabilities with OpenVidu Components Angular. Install the library using npm:

   npm install openvidu-components-angular
   

4. Import and use OpenVidu Components Angular

   To use OpenVidu Components Angular in your application, you need to:

   1. Import the OpenViduComponentsModule in your Angular application.
   2. Configure the module with the OpenViduComponentsConfig object.
   3. Add the component to your template file.
   4. Assign the OpenVidu token and LiveKit URL to the component.
   5. Customize the appearance of the components using CSS variables.

main.tsapp.component.tsmodels/participant-app.model.tsstyles.scss

In your main.ts application file, import the it and configure it as follows:

// Other imports ...

import { OpenViduComponentsModule, OpenViduComponentsConfig } from 'openvidu-components-angular';

const config: OpenViduComponentsConfig = {
    production: true,
};

bootstrapApplication(AppComponent, {
    providers: [
        importProvidersFrom(
            OpenViduComponentsModule.forRoot(config)
            // Other imports ...
        ),
        provideAnimations(),
    ],
}).catch((err) => console.error(err));

Use the ov-videoconference component to create a videoconference. This component requires a token to connect to the OpenVidu Room. The AppComponent class is responsible for requesting the token and passing it to the ov-videoconference component.

import {
  ParticipantModel,
  ParticipantService,
  OpenViduComponentsModule
} from 'openvidu-components-angular';

enum DataTopicApp {
  HAND_TOGGLE = 'handToggle'
}

@Component({
  selector: 'app-root',
  template:`
    <!-- OpenVidu Video Conference Component -->
    <ov-videoconference
      [prejoin]="true"
      [token]="token"
      [livekitUrl]="LIVEKIT_URL"
      (onTokenRequested)="onTokenRequested($event)"
      (onRoomCreated)="handleRemoteHand($event)"
    >
      <div *ovToolbarAdditionalButtons>
        <button toolbar-btn mat-icon-button (click)="handleLocalHand()" [class.active-btn]="hasHandRaised">
          <mat-icon matTooltip="Toggle hand">front_hand</mat-icon>
        </button>
      </div>

      <div *ovStream="let track" style="height: 100%">
        <ov-stream [track]="track"></ov-stream>
        @if (track.participant.hasHandRaised) {
        <mat-icon @inOutHandAnimation id="hand-notification">front_hand</mat-icon>
        }
      </div>

      <div *ovParticipantPanelItemElements="let participant">
        @if (participant.hasHandRaised) {
        <mat-icon>front_hand</mat-icon>
        }
      </div>
    </ov-videoconference>
  `,
  styles: [''],
  standalone: true,
  imports: [OpenViduComponentsModule, MatIconButton, MatIcon]
})
export class AppComponent {
  // For local development, leave these variables empty
  // For production, configure them with correct URLs depending on your deployment

  APPLICATION_SERVER_URL = '';  // (1)!
  LIVEKIT_URL = ''; // (2)!

  // The name of the room to join.
  roomName = 'openvidu-toggle-hand';  // (3)!

  // The token used to join the room.
  token!: string; // (4)!

  // Whether the local participant has raised their hand.
  hasHandRaised: boolean = false; // (5)!

  constructor(private httpClient: HttpClient, private participantService: ParticipantService) {
    this.configureUrls();
  }

  private configureUrls() {
    // If APPLICATION_SERVER_URL is not configured, use default value from local development
    if (!this.APPLICATION_SERVER_URL) {
      if (window.location.hostname === 'localhost') {
        this.APPLICATION_SERVER_URL = 'http://localhost:6080/';
      } else {
        this.APPLICATION_SERVER_URL =
          'https://' + window.location.hostname + ':6443/';
      }
    }

    // If LIVEKIT_URL is not configured, use default value from local development
    if (!this.LIVEKIT_URL) {
      if (window.location.hostname === 'localhost') {
        this.LIVEKIT_URL = 'ws://localhost:7880/';
      } else {
        this.LIVEKIT_URL = 'wss://' + window.location.hostname + ':7443/';
      }
    }
  }

  // Requests a token to join the room with the given participant name.
  async onTokenRequested(participantName: string) { // (6)!
    const { token } = await this.getToken(this.roomName, participantName);
    this.token = token;
  }

  // Handles the reception of a remote hand-raising event.
  handleRemoteHand(room: Room) { // (7)!
    // Subscribe to hand toggling events from other participants
    room.on(RoomEvent.DataReceived, (payload: Uint8Array, participant?: RemoteParticipant, _?: DataPacket_Kind, topic?: string) => { // (8)!
      if (topic === DataTopicApp.HAND_TOGGLE) {
        const p = this.participantService.getRemoteParticipantBySid(participant.sid); // (9)!
        if (p) {
          (<ParticipantAppModel>p).toggleHandRaised(); // (10)!
        }
        this.participantService.updateRemoteParticipants(); // (11)!
      }
    });
  }

  // Handles the local hand-raising event.
  async handleLocalHand() {  // (12)!
    // Get local participant with ParticipantService
    const participant = <ParticipantAppModel>this.participantService.getLocalParticipant(); // (13)!

    // Toggle the participant hand with the method we wil add in our ParticipantAppModel
    participant.toggleHandRaised(); // (14)!

    // Refresh the local participant object for others component and services
    this.participantService.updateLocalParticipant(); // (15)!

    // Send a signal with the new value to others participant using the openvidu-browser signal
    const strData = JSON.stringify({});
    const data: Uint8Array = new TextEncoder().encode(strData);
    const options: DataPublishOptions = { topic: DataTopicApp.HAND_TOGGLE };

    await this.participantService.publishData(data, options); // (16)!
  }

  // Retrieves a token to join the room with the given name and participant name.
  getToken(roomName: string, participantName: string): Promise<any> { // (17)!
    // Requesting token to the server application
  }
}

1. APPLICATION_SERVER_URL: URL to communicate the client application with the server application to request OpenVidu tokens.
2. LIVEKIT_URL: URL to communicate the client application with the LiveKit server.
3. roomName: OpenVidu Room identifier. This is the room where the VideoconferenceComponent will connect.
4. token: OpenVidu Token used to connect to the OpenVidu Room.
5. hasHandRaised: Boolean that indicates if the local participant has raised their hand.
6. onTokenRequested method that fires when the VideoconferenceComponent requests a token to connect to the OpenVidu Room.
7. handleRemoteHand method that handles the reception of a remote HAND_TOGGLE event.
8. on method that subscribes to the DataReceived event to handle the reception of a remote HAND_TOGGLE event.
9. getRemoteParticipantBySid method that retrieves a remote participant by its unique ID.
10. toggleHandRaised method that toggles the hand raising status of a remote participant.
11. updateRemoteParticipants method that updates the list of remote participants.
12. handleLocalHand method that handles the local HAND_TOGGLE event.
13. getLocalParticipant method that retrieves the local participant.
14. toggleHandRaised method that toggles the hand raising status of the local participant.
15. updateLocalParticipant method that updates the local participant.
16. publishData method that sends a signal to other participants.
17. getToken method that requests a token to the server application.

The app.component.ts file declares the following properties and methods:

• APPLICATION_SERVER_URL: URL to communicate the client application with the server application to request OpenVidu tokens.
• LIVEKIT_URL: URL to communicate the client application with the LiveKit server.
• roomName: OpenVidu Room identifier. This is the room where the VideoconferenceComponent will connect.
• token: OpenVidu Token used to connect to the OpenVidu Room.
• hasHandRaised: Boolean that indicates if the local participant has raised their hand.
• onTokenRequested method that fires when the VideoconferenceComponent requests a token to connect to the OpenVidu Room.
• handleRemoteHand method that handles the reception of a remote HAND_TOGGLE event.
• on method that subscribes to the DataReceived event to handle the reception of a remote HAND_TOGGLE event.
• getRemoteParticipantBySid method that retrieves a remote participant by its unique ID.
• toggleHandRaised method that toggles the hand raising status of a remote participant.
• updateRemoteParticipants method that updates the list of remote participants.
• handleLocalHand method that handles the local HAND_TOGGLE event.
• getLocalParticipant method that retrieves the local participant.
• toggleHandRaised method that toggles the hand raising status of the local participant.
• updateLocalParticipant method that updates the local participant.
• publishData method that sends a signal to other participants.
• getToken method that requests a token to the server application.

Configure the URLs

When running OpenVidu locally, leave APPLICATION_SERVER_URL and LIVEKIT_URL variables empty. The function configureUrls() will automatically configure them with default values. However, for other deployment type, you should configure these variables with the correct URLs depending on your deployment.

The ParticipantAppModel class extends the ParticipantModel class to add the ability to raise and lower the hand.

  import { ParticipantModel, ParticipantProperties } from 'openvidu-components-angular';

  // Represents a participant in the application, with the ability to raise their hand.
  export class ParticipantAppModel extends ParticipantModel {

    // Indicates whether the participant has raised their hand.
    hasHandRaised: boolean;

    //  Creates a new instance of ParticipantAppModel.
    constructor(props: ParticipantProperties) {
      super(props);
      this.hasHandRaised = false;
    }

    // Toggles the participant's hand raised status.
    toggleHandRaised() {
      this.hasHandRaised = !this.hasHandRaised;
    }
  }

The OpenVidu Components Angular library provides a set of CSS variables that you can use to customize the appearance of the components. You can define these variables in your application's global styles file (e.g. styles.scss).

:root {
    /* Basic colors */
    --ov-background-color: #303030; // Background color
    --ov-surface-color: #ffffff; // Surfaces colors (panels, dialogs)

    /* Text colors */
    --ov-text-primary-color: #ffffff; // Text color over primary background
    --ov-text-surface-color: #1d1d1d; // Text color over surface background

    /* Action colors */
    --ov-primary-action-color: #273235; // Primary color for buttons, etc.
    --ov-secondary-action-color: #f1f1f1; // Secondary color for buttons, etc.
    --ov-accent-action-color: #0089ab; // Color for highlighted elements

    /* Status colors */
    --ov-error-color: #eb5144; // Error color
    --ov-warn-color: #ffba53; // Warning color

    /* Radius */
    --ov-toolbar-buttons-radius: 50%; // Radius for toolbar buttons
    --ov-leave-button-radius: 10px; // Radius for leave button
    --ov-video-radius: 5px; // Radius for videos
    --ov-surface-radius: 5px; // Radius for surfaces
}