Interface ActiveSpeakerPolicy

[[ActiveSpeakerPolicy]] calculates a normalized score of how active a speaker is. Implementations of [[ActiveSpeakerPolicy]] provide custom algorithms for calculating the score.

interface ActiveSpeakerPolicy {
    calculateScore(
        attendeeId: string,
        volume: number,
        muted: boolean,
    ): number;
    prioritizeVideoSendBandwidthForActiveSpeaker(): boolean;
}

Implemented by

DefaultActiveSpeakerPolicy

Index

Methods

calculateScore prioritizeVideoSendBandwidthForActiveSpeaker

Methods

calculateScore

calculateScore(attendeeId: string, volume: number, muted: boolean): number
Parameters
- attendeeId: string
- volume: number
- muted: boolean
Returns number
- Defined in src/activespeakerpolicy/ActiveSpeakerPolicy.ts:12

prioritizeVideoSendBandwidthForActiveSpeaker

prioritizeVideoSendBandwidthForActiveSpeaker(): boolean
Returns boolean
- Defined in src/activespeakerpolicy/ActiveSpeakerPolicy.ts:19