Interface ActiveSpeakerDetector

  • All Implemented Interfaces:

    
    public interface ActiveSpeakerDetector<T>
    
                        

    Represents an algorithm for the detection/identification of the active/dominant speaker/participant/endpoint/stream in a multipoint conference.

    Implementations of ActiveSpeakerDetector get notified about the (current) audio levels of multiple audio streams (identified by their synchronization source identifiers/SSRCs) via calls to levelChanged and determine/identify which stream is dominant/active (in terms of speech). When the active stream changes, listeners registered via addActiveSpeakerChangedListener are notified.

    Author:

    Boris Grozev

    Lyubomir Marinov

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract void addActiveSpeakerChangedListener(ActiveSpeakerChangedListener<T> listener) Adds a listener to be notified by this active speaker detector when the active stream changes.
      abstract SpeakerRanking levelChanged(T id, int level) Notifies this ActiveSpeakerDetector about the latest/current audio level of a stream/speaker identified by a specific synchronization source identifier/SSRC.
      abstract void removeActiveSpeakerChangedListener(ActiveSpeakerChangedListener<T> listener) Removes a listener to no longer be notified by this active speaker detector when the active stream changes.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • addActiveSpeakerChangedListener

         abstract void addActiveSpeakerChangedListener(ActiveSpeakerChangedListener<T> listener)

        Adds a listener to be notified by this active speaker detector when the active stream changes.

        Parameters:
        listener - the listener to register with this instance for notifications about changes of the active speaker
      • levelChanged

         abstract SpeakerRanking levelChanged(T id, int level)

        Notifies this ActiveSpeakerDetector about the latest/current audio level of a stream/speaker identified by a specific synchronization source identifier/SSRC.

        Parameters:
        level - the latest/current audio level of the stream/speaker with the specified ssrc
        Returns:

        The current energy rank and related data.

      • removeActiveSpeakerChangedListener

         abstract void removeActiveSpeakerChangedListener(ActiveSpeakerChangedListener<T> listener)

        Removes a listener to no longer be notified by this active speaker detector when the active stream changes.

        Parameters:
        listener - the listener to unregister with this instance for notifications about changes of the active speaker