mediasfu-angular/dist/lib/consumers/update-participant-audio-decibels.service.d.ts

MediaSFU Prebuilt Angular SDK

import { AudioDecibels } from '../@types/types';
import * as i0 from "@angular/core";
export interface UpdateParticipantAudioDecibelsOptions {
    name: string;
    averageLoudness: number;
    audioDecibels: AudioDecibels[];
    updateAudioDecibels: (audioDecibels: AudioDecibels[]) => void;
}
export type UpdateParticipantAudioDecibelsType = (options: UpdateParticipantAudioDecibelsOptions) => void;
/**
 * Updates or adds a participant's audio decibel data in the array.
 *
 * This method checks if a participant's name exists in the audio decibels array.
 * If it does, it updates the participant's `averageLoudness`; otherwise, it adds a new entry.
 * After modification, it calls `updateAudioDecibels` to apply the changes to the array.
 *
 * @param {UpdateParticipantAudioDecibelsOptions} options - The options for updating participant audio decibels.
 * @param {string} options.name - The name of the participant.
 * @param {number} options.averageLoudness - The current average loudness of the participant.
 * @param {AudioDecibels[]} options.audioDecibels - The array of current audio decibel entries.
 * @param {Function} options.updateAudioDecibels - The function to update the audio decibels array.
 *
 * @returns {void} - This function does not return a value.
 *
 * @example
 * ```typescript
 * const audioDecibels = [
 *   { name: 'Alice', averageLoudness: -10 },
 *   { name: 'Bob', averageLoudness: -12 },
 * ];
 *
 * const updateAudioDecibels = (newDecibels) => {
 *   console.log('Updated audio decibels:', newDecibels);
 * };
 *
 * const updateService = new UpdateParticipantAudioDecibels();
 *
 * // Update existing participant
 * updateService.updateParticipantAudioDecibels({
 *   name: 'Alice',
 *   averageLoudness: -8,
 *   audioDecibels,
 *   updateAudioDecibels,
 * });
 *
 * // Add a new participant
 * updateService.updateParticipantAudioDecibels({
 *   name: 'Charlie',
 *   averageLoudness: -15,
 *   audioDecibels,
 *   updateAudioDecibels,
 * });
 * ```
 */
export declare class UpdateParticipantAudioDecibels {
    /**
     * Updates the audio decibels for a participant.
     *
     * @param {Object} options - The options for updating participant audio decibels.
     * @param {string} options.name - The name of the participant.
     * @param {number} options.averageLoudness - The average loudness of the participant.
     * @param {Array<{ name: string, averageLoudness: number }>} options.audioDecibels - The array of audio decibels entries.
     * @param {Function} options.updateAudioDecibels - The function to update the audio decibels array.
     *
     * @returns {void}
     */
    updateParticipantAudioDecibels({ name, averageLoudness, audioDecibels, updateAudioDecibels, }: UpdateParticipantAudioDecibelsOptions): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<UpdateParticipantAudioDecibels, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<UpdateParticipantAudioDecibels>;
}