Bitwig Studio Control Surface API  5.0.11
Subscribable Interface Reference
+ Inheritance diagram for Subscribable:

Public Member Functions

boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 

Detailed Description

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

Member Function Documentation

◆ isSubscribed()

boolean isSubscribed ( )

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

◆ setIsSubscribed()

void setIsSubscribed ( boolean  value)

Sets whether the driver currently considers this object 'active' or not.

Deprecated:
subscribe/unsubscribe is now counter based.

◆ subscribe()

void subscribe ( )

Subscribes the driver to this object.

◆ unsubscribe()

void unsubscribe ( )

Unsubscribes the driver from this object.


The documentation for this interface was generated from the following file: