Module org.praxislive.code
Package org.praxislive.code.userapi

Class Property.Sync

java.lang.Object
org.praxislive.code.userapi.Property.Sync
Enclosing class:
Property
public static final class Property.Sync extends Object
The Sync instance of a Property allows for synchronizing the value of a property to a control on another component. Synchronization is bi-directional. The Sync instance can be obtained using Property.sync().

  • Method Details

    • bindTo

      public Property.Sync bindTo(ControlAddress address)
      Bind to the specified control. A Sync can only be bound to one control at a time.
      Parameters:
      address - binding address to synchronize to
      Returns:
      this

    • unbind

      public Property.Sync unbind()
      Unbind and stop synchronization.
      Returns:
      this

    • info

      public Optional<ControlInfo> info()
      Obtain the ControlInfo for the bound control, if and when synchronized.
      Returns:
      bound control info