Package com.bitwig.extension.controller.api

Interface ModulationSource

public interface ModulationSource
This interface represents a modulation source in Bitwig Studio.
Since:
API version 1

  • Method Details

    • isMapping

      BooleanValue isMapping()
      Value which reports when the modulation source is in mapping mode.
      Since:
      API version 2

    • addIsMappingObserver

      @Deprecated void addIsMappingObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isMapping() instead.
      Registers an observer which reports when the modulation source is in mapping mode.
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1

    • toggleIsMapping

      void toggleIsMapping()
      Toggles the modulation source between mapping mode and normal control functionality.
      Since:
      API version 1

    • name

      StringValue name()
      Value the reports the name of the modulation source.
      Since:
      API version 2

    • addNameObserver

      @Deprecated void addNameObserver(int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
      Deprecated.
      Use name() instead.
      Registers an observer the reports the name of the modulation source.
      Parameters:
      numChars - the maximum number of character the reported name should be long
      textWhenUnassigned - the default text that gets reported if the modulation source is not connected to to a modulation source in Bitwig Studio yet
      callback - a callback function that receives a single string parameter
      Since:
      API version 1

    • isMapped

      BooleanValue isMapped()
      Value which reports if the modulation source is mapped to any destination(s).
      Since:
      API version 2

    • addIsMappedObserver

      @Deprecated void addIsMappedObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isMapped() instead.
      Registers an observer which reports if the modulation source is mapped to any destination(s).
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1