hostsync~
MSP Reference
Open Help

hostsync~

Get transport control info from a ReWire host

Description

The hostsync~ object provides information about the current state of the ReWire host.

Examples

Discussion

Sample count information is available in any host; even Max. The validity of the other information output by the object is dependent upon what synchronization capabilities the ReWire host implements; the value from the flags (10th) outlet tells you what information is valid. Output from hostsync~ is continuous when the scheduler is running. Alternatively, you can bang its inlet to report the current values.

Arguments

None.

Attributes

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] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 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'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

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] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

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] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 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]

g/s(set)

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]

g/s(set)

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 [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

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

bang will cause the hostsync~ object to report its transport state.

Output

float

Out 4nd outlet: The current beat fraction, from 0 to 1.0. If the ReWire host does not support synchronization, there is no output from this outlet.

float

Out 6th outlet: The current tempo in samples per beat. This number can be converted to beats per minute using the following formula: (sampling-rate / samples-per-beat) * 60. If the ReWire host does not support synchronization, there is no output from this outlet.

float

Out 7th outlet: The current number of beats, expressed in 1 PPQ. This number will contain a fractional part between beats. If the ReWire host does not support synchronization, there is no output from this outlet.

int

Out left outlet: 1 if the ReWire host's transport is currently running; 0 if it is stopped or paused.

int

Out 2nd outlet: The current bar count in the ReWire host sequence, starting at 1 for the first bar. If the ReWire host does not support synchronization, there is no output from this outlet.

int

Out 3rd outlet: The current beat count in the ReWire host sequence, starting at 1 for the first beat. If the ReWire host does not support synchronization, there is no output from this outlet.

int

Out 8th outlet: The current sample count, as defined by the ReWire host.

int

Out 10th outlet: A number representing the validity of the other information coming from hostsync~. Mask with the following values to determine if the information from hostsync~ will be valid.

Sample Count Valid 1 (always true)

Beats Valid 2 (2nd, 3rd, 4th, and 7th outlets valid)

Time Signature Valid 4 (5th outlet valid)

Tempo Valid 8 (6th outlet valid)

Transport Valid 16 (left outlet valid)

Loop Info Valid 64 (9th outlet valid)

list

Out 5th outlet: The current time signature as a list containing numerator followed by denominator. For instance, 3/4 time would be output as the list 3 4 . If the ReWire host does not support time signature information, there is no output from this outlet.

list

Out 9th outlet: The loop info output as a list of three numbers containing loop on/off state (0,1), the loop start point (in 1PPQ ticks), and the loop stop point (in 1PPQ ticks). For example, if the time signature was 4/4 and looping was on from the start of the fifth measure for four bars the list would be 1 16 32.

See Also

Name Description
hostcontrol~ Control a ReWire host's transport
hostphasor~ ReWire host synchronization source