Lib.numbers.anim.time.AbletonLinkSync - tixl3d/tixl GitHub Wiki

AbletonLinkSync

in Lib.numbers.anim.time


An experimental implementation of the AbletonLink synchronization.

This operator uses the library provided by Ableton to identify available Ableton Link sources and automatically connects to them. All instances of this operator share the same connection. To align the timing information provided by Link with Tooll's time units, we also provide a various output timing formats.

This operator can by combined with [SetPlaybackTime] or [SetBpm].

Note: if the connection is cancelled by the host or client, it might be necessary to trigger reconnect.


Input Parameters

Name (Relevancy & Type) Description
OutputType (Int32) We attempt to map the incoming timing signals to Tooll's measure units.

- Measure: 1 unit per bar (e.g. per 4 beats)
- Phase: Phase returned by Link
- Beats: Beats returned by Link offset by start measure
- Time: Time returned by Link / 1000
- Quantum: In order to enable the desired bar and loop alignment, an application provides a quantum value to Link that specifies, in beats, the desired unit of phase synchronization. Link guarantees that session participants with the same quantum value will be phase aligned, meaning that if two participants have a 4 beat quantum, beat 3 on one participant’s timeline could correspond to beat 11 on another’s, but not beat 12 (see link documentation)
TriggerStartPlaying (Boolean) Sends a start signal
TriggerStopPlaying (Boolean) Sends a stop signal
TriggerReconnect (Boolean) Closes and restarts the connection. This my be necessary if the host cancelles the connection.
AutoConnect (Boolean) If there are no peers found, we try to reconnect every 3 seconds.
PauseIfDisconnected (Boolean) Normally Ableton link would keep playing even if connection gets lost. If this option is enabled the output will be paused if there are no other peers.

Outputs

Name Type
Result System.Single
Tempo System.Single
IsConnected System.Boolean

Please help use to improve this documentation. Feel free to improve the description.

⚠ Everything else is automatically generated and will be overwritten regularly.

⚠️ **GitHub.com Fallback** ⚠️