time module reference

index

• *clock* (clock):  – Default clock source (60fps).
• clock (opdef):  – Create a clock source.
• every (opdef):  – Emit events regularly.
• lfo (opdef):  – Low-frequency oscillator.
• ramp (opdef):  – Sawtooth LFO.
• scale-time (opdef):  – Scale clock time.
• sequence (opdef):  – Emit a sequence of values as events over time.
• tick (opdef):  – Count ticks.

details

• *clock* (clock):  – Default clock source (60fps).
• clock (opdef):  – Create a clock source.

  (clock) (clock fps)

  Creates a new clock event stream.

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

  • fps has to be an eval-time constant and defaults to 60 if omitted.
• every (opdef):  – Emit events regularly.

  (every [clock] period [evt])

  Emits evt as an event once every period seconds.

  • clock should be a time/clock event stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num-value.
  • 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] freq [wave])

  Oscillates betwen 0 and 1 at the frequency freq.

  • clock should be a time/clock event stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • freq should be a num-value.
  • wave selects the wave shape from one of the following:
    • 'sin' (the default)
    • 'saw'
    • 'tri'
• ramp (opdef):  – Sawtooth LFO.

  (ramp [clock] period [max])

  Ramps from 0 to max once every period seconds.

  • clock should be a time/clock event stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num-value.
  • max should be a num-value and defaults to period if omitted.
• scale-time (opdef):  – Scale clock time.

  (scale-time [clock] scale)

  Creates a new clock event stream scaled by scale.

  • clock should be a time/clock event stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • scale should be a num-value.
• sequence (opdef):  – Emit a sequence of values as events over time.

  (sequence [clock] delay0 evt1 delay1 evt2 delay2…)

  Emits evt1, evt2, … as events with delays delay0, delay1, … in between.

  • clock should be a time/clock event stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • delay0, delay1, … must be num-values.
  • evt1, evt2, … must be values of the same type.
  • the return type will be an event stream with the same type as the evts.
• tick (opdef):  – Count ticks.

  (tick [clock] period)

  Counts upwards by one every period seconds.

  • clock should be a time/clock event stream. This argument can be omitted and the stream be passed as a dynamic definition in *clock* instead.
  • period should be a num-value.
  • returns a num value that increases by 1 every period.