sync~
Synchronize MSP with an external source
Description
sync~ outputs a 0-1 ramp, like phasor~. The frequency of the ramp can be specified in beats per minute (BPM), or by sending sync~ a tempo reference via tap tempo, MIDI beat clock, or an audio signal containing a 'click track.' Also, sync~ generates MIDI beat clock to synchronize external devices.
Arguments
None.
Attributes
rtport[symbol]: None
Optionally, the sync~ object can establish a direct connection to Max's MIDI system and receive MIDI Clock messages without patcher connections. This will ensure the best timing accuracy for MIDI Clock.
By default, this attribute is set to and is disabled. Choosing will route all MIDI Clock messages from any and all ports to the sync~ object -- useful if you have a simple single-source MIDI clocking environment. For more complex usage, choose a specific MIDI Clock source from the menu to avoid conflicting MIDI Clock messages.
Possible values:
'None'
(
MIDI RT Port disabled
)
Do not use a MIDI RT port for MIDI Clock
'All'
(
MIDI RT Port Omni Mode
)
Use any (and every) MIDI Clock message available to Max on any (and every) port
'(available MIDI ports)'
(
The active MIDI RT Port
)
Use a specific MIDI port for receipt of MIDI Clock messages
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
bang
A sequence of sync~ object receives three taps in a row with reasonably consistent timing, it changes the tempo to match them.
messages is used to set the tap tempo. A message is interpreted as one tap. If the
int
float
Sets the BPM for the clock.
- beats-per-minute
[float]
bpm
The word
, followed by a number, sets the rate of the current output ramp to a frequency corresponding to the specified beats/minute.- bpm-rate
[float]
midioffset
The word
, followed by a floating point number in the range 0.-1.0, adjusts the MIDI output "phase" of the current output ramp.- output-phase
[float]
offset
The word
, followed by a floating point number in the range 0.-1.0, adjusts the "phase" of the current output ramp.- ramp-phase
[float]
ppq
The word sync~ object can be scaled for output further by using the rate~ object.
(parts per quarter), followed by a number, specifies the number of ticks output for each quarter note. By default, MIDI beat clock specifies a PPQ of 24. The message is useful mainly for doubling or halving the tempo for an external device that is set to a different time signature. The ramp signal generated by the- number-of-ticks-per-quarter-note
[int]
signal
The sync~ object will set its tempo to match an audio click track input. The click track should contain amplitude peaks at quarter-note intervals of the desired tempo. Signal input will affect the tempo only if sync~ detects peak values greater than 0.1 and within the tempo range of approximately 30-240 BPM.
start
The word sync~ outputs the number 250 from the MIDI beat clock output so that any external devices will also start.
causes the current output ramp to halt, and resets the ramp to 0. The message has the same effect as receiving the MIDI beat clock start value (250). When the message is received,
stop
The word sync~ object sends the number 252 from its MIDI beat clock output. The sync~ object does not send MIDI beat clock ticks while it is stopped.
causes the current output ramp to halt, and to remain stationary until a message is received. It is equivalent to sending the MIDI beat clock stop value (252). When the message is received, theOutput
bpm
Out middle outlet: Whenever the tempo changes, sync~ outputs the message , followed by a float value that specifies the new tempo.
click
Out middle outlet: When the sync~ object receives an audio click, it sends a message out the middle outlet.
int
midi
Out middle outlet: When the sync~ object receives a MIDI beat clock tick, it sends a message out the middle outlet.
signal
tap
Out middle outlet: When the sync~ object receives a tap, it sends a message out the middle outlet.
See Also
Name | Description |
---|---|
midiout | Transmit raw MIDI data |
phasor~ | Generate sawtooth signals |
rate~ | Time-scale the output of a phasor~ |
rtin | Receive MIDI real time messages |
seq | Sequencer for recording and playing MIDI data |
transport | Control a clock |
wave~ | Variable size wavetable |