File

projects/openvidu-components-angular/src/lib/directives/template/openvidu-components-angular.directive.ts

Description

The *ovParticipantPanelItemElements directive allows you to incorporate additional elements into the ParticipantPanelItemComponent. In the example below, we demonstrate how to add a simple button for disconnecting from the session.

With the *ovParticipantPanelItemElements directive, you can access the participant object within its context using the let keyword and referencing the participant variable as follows: *ovParticipantPanelItem="let participant". This enables you to access the ParticipantModel object and activate the button exclusively for the local participant.

Example :
import { HttpClient } from '@angular/common/http';
import { Component } from '@angular/core';
import { lastValueFrom } from 'rxjs';

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

@Component({
    selector: 'app-root',
    template: `
        <!-- OpenVidu Video Conference Component -->
        @if (connected) {
        <ov-videoconference
            [token]="token"
            [livekitUrl]="LIVEKIT_URL"
            [toolbarDisplayRoomName]="false"
            (onTokenRequested)="onTokenRequested($event)"
        >
            <!-- Participant Panel Item Elements -->
            <div *ovParticipantPanelItemElements="let participant">
                <!-- Leave Button for Local Participant -->
                @if (participant.isLocal) {
                <button (click)="leaveSession()">Leave</button>
                }
            </div>
        </ov-videoconference>
        }

        <!-- Session Disconnected Message -->
        @if (!connected) {
        <div style="text-align: center;">Session disconnected</div>
        }
    `,
    styles: [],
    standalone: true,
    imports: [OpenViduComponentsModule],
})
export class AppComponent {
    // For local development, leave these variables empty
    // For production, configure them with correct URLs depending on your deployment
    APPLICATION_SERVER_URL = '';
    LIVEKIT_URL = '';

    // Define the name of the room and initialize the token variable
    roomName = 'participant-panel-item-elements';
    token!: string;

    // Flag to indicate session connection status
    connected = true;

    constructor(
        private httpClient: HttpClient,
        private openviduService: OpenViduService
    ) {
        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/';
            }
        }
    }

    // Function to request a token when a participant joins the room
    async onTokenRequested(participantName: string) {
        const { token } = await this.getToken(this.roomName, participantName);
        this.token = token;
    }

    // Function to leave the session
    async leaveSession() {
        await this.openviduService.disconnectRoom();
        this.connected = false;
    }

    // Function to get a token from the server
    getToken(roomName: string, participantName: string): Promise<any> {
        try {
            // Send a POST request to the server to obtain a token
            return lastValueFrom(
                this.httpClient.post<any>(this.APPLICATION_SERVER_URL + 'token', {
                    roomName,
                    participantName,
                })
            );
        } catch (error: any) {
            // Handle errors, e.g., if the server is not reachable
            if (error.status === 404) {
                throw {
                    status: error.status,
                    message:
                        'Cannot connect with the backend. ' + error.url + ' not found',
                };
            }
            throw error;
        }
    }
}

For a comprehensive tutorial on adding elements to participant panel items, please visit this link.

Metadata

Index

Properties

Constructor

constructor(template: TemplateRef, viewContainer: ViewContainerRef)
Parameters :
Name Type Optional
template TemplateRef<any> No
viewContainer ViewContainerRef No

Properties

Public template
Type : TemplateRef<any>
Public viewContainer
Type : ViewContainerRef

results matching ""

    No results matching ""