mediasfu-reactjs
Version:
MediaSFU Prebuilt ReactJS SDK - Compatible with React 18 & 19, TypeScript & JavaScript
31 lines • 1.39 kB
TypeScript
import { AudioDecibels } from "../@types/types";
export interface UpdateParticipantAudioDecibelsOptions {
name: string;
averageLoudness: number;
audioDecibels: AudioDecibels[];
updateAudioDecibels: (audioDecibels: AudioDecibels[]) => void;
}
export type UpdateParticipantAudioDecibelsType = (options: UpdateParticipantAudioDecibelsOptions) => void;
/**
* Updates the audio decibels for a participant.
*
* @param {UpdateParticipantAudioDecibelsOptions} 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<AudioDecibels>} options.audioDecibels - The array of audio decibels entries.
* @param {Function} options.updateAudioDecibels - The function to update the audio decibels array.
*
* @returns {void}
*
* @example
* const options = {
* name: 'participant1',
* averageLoudness: 50,
* audioDecibels: [{ name: 'participant1', averageLoudness: 50 }],
* updateAudioDecibels: updateAudioDecibelsFunction,
* };
*
* updateParticipantAudioDecibels(options);
*/
export declare function updateParticipantAudioDecibels({ name, averageLoudness, audioDecibels, updateAudioDecibels, }: UpdateParticipantAudioDecibelsOptions): void;
//# sourceMappingURL=updateParticipantAudioDecibels.d.ts.map