Package com.bitwig.extension.controller.api

Interface Subscribable

All Known Subinterfaces:
Arpeggiator, AudioHardwareIoInfo, Bank<ItemType>, BeatTimeValue, BitwigBrowsingSession, BooleanValue, Browser, BrowserColumn, BrowserFilterColumn, BrowserFilterColumnBank, BrowserFilterItem, BrowserFilterItemBank, BrowserItem, BrowserItemBank<ItemType>, BrowserResultsColumn, BrowserResultsItem, BrowserResultsItemBank, BrowsingSession, BrowsingSessionBank, ChainSelector, Channel, ChannelBank<ChannelType>, Clip, ClipBrowsingSession, ClipLauncherSlot, ClipLauncherSlotBank, ClipLauncherSlotOrScene, ClipLauncherSlotOrSceneBank<ItemType>, ColorValue, CueMarker, CueMarkerBank, CursorBrowserFilterColumn, CursorBrowserFilterItem, CursorBrowserItem, CursorBrowserResultItem, CursorBrowsingSession, CursorChannel, CursorClip, CursorDevice, CursorDeviceLayer, CursorDeviceSlot, CursorTrack, Device, DeviceBank, DeviceBrowsingSession, DeviceChain, DeviceLayer, DeviceLayerBank, DeviceSlot, DoubleValue, DrumPad, DrumPadBank, EnumValue, GenericBrowsingSession, IntegerValue, MasterTrack, MultiSampleBrowsingSession, MusicBrowsingSession, NoteLatch, ObjectArrayValue<ObjectType>, ObjectProxy, Parameter, PinnableCursorClip, PinnableCursorDevice, PlayingNoteArrayValue, PopupBrowser, PresetBrowsingSession, PrimaryDevice, Project, RangedValue, RemoteControl, SampleBrowsingSession, Scene, SceneBank, Send, SendBank, SettableBeatTimeValue, SettableBooleanValue, SettableColorValue, SettableDoubleValue, SettableEnumValue, SettableIntegerValue, SettableRangedValue, SettableStringArrayValue, SettableStringValue, SoloValue, SourceSelector, SpecificDevice, StringArrayValue, StringValue, TimeSignatureValue, Track, TrackBank, Transport, Value<ObserverType>
public interface Subscribable
Interface for an object that can be 'subscribed' or not. A subscribed object will notify any observers when changes occur to it. When it is unsubscribed the observers will no longer be notified. A driver can use this to say which objects it is interested in and which ones it is not (for example in one mode the driver may not be interested in track meters) at runtime. This allows the driver to improve efficiency by only getting notified about changes that are really relevant to it. By default a driver is subscribed to everything. Subscription is counter based.
Since:
API version 2

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isSubscribed()
    Determines if this object is currently 'subscribed'.
    void
    setIsSubscribed(boolean value)
    Deprecated.
    subscribe/unsubscribe is now counter based.
    void
    subscribe()
    Subscribes the driver to this object.
    void
    unsubscribe()
    Unsubscribes the driver from this object.

  • Method Details

    • isSubscribed

      boolean isSubscribed()
      Determines if this object is currently 'subscribed'. In the subscribed state it will notify any observers registered on it.

    • setIsSubscribed

      @Deprecated void setIsSubscribed(boolean value)
      Deprecated.
      subscribe/unsubscribe is now counter based.
      Sets whether the driver currently considers this object 'active' or not.

    • subscribe

      void subscribe()
      Subscribes the driver to this object.

    • unsubscribe

      void unsubscribe()
      Unsubscribes the driver from this object.