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:

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

Hierarchy

ActiveSpeakerDetectorFacade
- AudioVideoFacade

Index

Methods

Methods

subscribeToActiveSpeakerDetector

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

- Defined in src/activespeakerdetector/ActiveSpeakerDetectorFacade.ts:20
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

- Defined in src/activespeakerdetector/ActiveSpeakerDetectorFacade.ts:31
Parameters
- callback: (activeSpeakers: string[]) => void
  - - (activeSpeakers: string[]): void
    - Parameters
      - activeSpeakers: string[]
      Returns void
Returns void

Generated using TypeDoc