link-time module reference

link-time module reference

Musical time with Ableton Link.

index

• ad (opdef):  – Attack-Decay enveloper from bang!.
• clock (opdef):  – Create a clock source.
• decay (opdef):  – Decay envelope from bang!.
• every (opdef):  – Emit events regularly.
• lfo (opdef):  – Low-frequency oscillator.
• phase (opdef):  – Get phase.
• ramp (opdef):  – Get normalized phase.
• spring (opdef):  – Integrate impulses using easing
• tick (opdef):  – Count ticks.

details

• ad (opdef):  – Attack-Decay enveloper from bang!.

  (ad [clock] attack decay trigger)

  Ramp from 0 to 1 and back on trigger.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • attack and decay should be num~ streams.
  • trigger should be a bang! stream.
• clock (opdef):  – Create a clock source.

  (clock [synced] [bpm] [fps])

  Creates a new link/clock~ stream.

  The clock event stream is an IO that triggers other operators at a fixed frame rate.

  • synced has to be a bool~ constant and defaults to false.
  • bpm should be a num~ stream and defaults to 120.
  • fps has to be a num= constant and defaults to 60 if omitted.
• decay (opdef):  – Decay envelope from bang!.

  (decay [clock] dur trigger)

  Ramp from 1 to 0 in dur beats on trigger.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • dur should be a num~ stream.
  • trigger should be a bang! stream.
• every (opdef):  – Emit events regularly.

  (every [clock] period [phase] [evt])

  Emits evt as an event once every period beats.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num~ stream.
  • phase should be a num~ stream and defaults to 0.
  • evt can be a value of any type. It defaults to bang.
  • the return type will be an event stream with the same type as evt.
• lfo (opdef):  – Low-frequency oscillator.

  (lfo [clock] period [phase] [wave])

  Oscillates betwen 0 and 1 once every period beats.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • freq should be a num~ stream.
  • phase should be a num~ stream and defaults to 0.
  • wave selects the wave shape from one of the following:
    • 'sin' (the default)
    • 'saw'
    • 'tri'
• phase (opdef):  – Get phase.

  (tick [clock] period [phase])

  Ramps from 0 to period once every period beats.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num~ stream.
  • phase should be a num~ stream and defaults to 0.
• ramp (opdef):  – Get normalized phase.

  (ramp [clock] period [phase])

  Ramps from 0 to 1 once every period beats.

  • clock should be a time/clock! stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num~ stream.
  • phase should be a num~ stream and defaults to 0.
• spring (opdef):  – Integrate impulses using easing

  (spring [clock] evt0 [evt1…])

  Every arriving evt triggers an impulse that is integrated as clock ticks. Returns a num~ stream that starts at 0.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • evt! are !-streams of structs. The following struct keys can be specified:
    • amp: amplitude of the impulse
    • dur: duration of the impulse (beats)
• tick (opdef):  – Count ticks.

  (tick [clock] period [phase])

  Counts upwards by one every period beats.

  • clock should be a link/clock~ stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num~ stream and defaults to 1.
  • phase should be a num~ stream and defaults to 0.
  • returns a num~ stream that increases by 1 every period.