Package com.vivoka.vsdk.speechenhancement

Class SpeechEnhancer

java.lang.Object
com.vivoka.vsdk.speechenhancement.SpeechEnhancer
All Implemented Interfaces:
IModifierModule
public abstract class SpeechEnhancer extends Object implements IModifierModule
Abstract class representing a speech enhancement module.

  • Field Details

    • _name

      protected final String _name

  • Constructor Details

    • SpeechEnhancer

      protected SpeechEnhancer(String name)

  • Method Details

    • release

      protected abstract void release() throws Exception
      Throws:
      Exception

    • getName

      public String getName()
      Returns:
      The name of the speech enhancer.

    • getInputChannelCount

      public abstract int getInputChannelCount() throws Exception
      Returns:
      The number of expected audio channels to process
      Throws:
      Exception - if the channel count cannot be retrieved

    • getOutputChannelCount

      public abstract int getOutputChannelCount() throws Exception
      Returns:
      The number of audio channels to expect once processing is done
      Throws:
      Exception - if the channel count cannot be retrieved

    • referenceConsumer

      public abstract IConsumerModule referenceConsumer() throws Exception
      Returns the consumer module for reference audio. This consumer can be connected to a producer in the audio pipeline to provide reference audio, which may be used to remove unwanted sounds from the main audio if echo canceling is enabled.
      Returns:
      IConsumerModule for reference audio.
      Throws:
      Exception - if the consumer module cannot be retrieved.

    • clearReferenceBuffer

      public abstract void clearReferenceBuffer() throws Exception
      Clears the internal reference buffer used by the speech enhancer.
      Throws:
      Exception - if the reference buffer cannot be cleared.