Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActiveSpeakerDetectorFacade

ActiveSpeakerDetectorFacade listens to the volume indicator updates from the RealtimeController.

When you are done using an ActiveSpeakerDetectorFacade, you should perform some cleanup steps in order to avoid memory leaks:

  1. Unsubscribe from listeners; e.g., from active speaker callbacks via ActiveSpeakerDetectorFacade.unsubscribeFromActiveSpeakerDetector.
  2. Drop your reference to the facade to allow it to be garbage collected.

Hierarchy

Index

Methods

subscribeToActiveSpeakerDetector

  • subscribeToActiveSpeakerDetector(policy: ActiveSpeakerPolicy, callback: (activeSpeakers: string[]) => void, scoresCallback?: (scores: {}) => void, scoresCallbackIntervalMs?: number): void
  • Parameters

    • policy: ActiveSpeakerPolicy
    • callback: (activeSpeakers: string[]) => void
        • (activeSpeakers: string[]): void
        • Parameters

          • activeSpeakers: string[]

          Returns void

    • Optional scoresCallback: (scores: {}) => void
        • (scores: {}): void
        • Parameters

          • scores: {}
            • [attendeeId: string]: number

          Returns void

    • Optional scoresCallbackIntervalMs: number

    Returns void

unsubscribeFromActiveSpeakerDetector

  • unsubscribeFromActiveSpeakerDetector(callback: (activeSpeakers: string[]) => void): void

Generated using TypeDoc