hostcontrol~ Reference

Control a ReWire host's transport

hostcontrol~

Description

When you choose the ad_rewire driver in the Audio Status window, the hostcontrol~ object lets you send commands to the ReWire host to start and stop the transport, set the transport position, change the tempo, change the time signature, and set loop points.

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.

jspainterfile [symbol]

JS Painter File

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

int

Arguments

playback-flag (1 or 0) [int]
1 starts playing from the beginning. 0 stops playing and resets the position to the beginning.

bpm

Arguments

host-tempo [float]
The word bpm, followed by a number (in beats per minute), changes the host's tempo.

loop

Arguments

state (0 or nonzero), start (1-PPQ-ticks), and end (1-PPQ-ticks) [list]
The word loop, followed by one or three numbers, controls the host's loop state. If the first number is non-zero, looping will be enabled; otherwise, it will be turned off. An optional second and third number may be used to specify the loop start and end points, expressed in 1 PPQ ticks. If the second and third numbers are not present, the loop points are not changed.

pause

The word pause stops playback without changing the current position.

resume

The word resume starts playback from the current position.

seek

Arguments

transport-position (1-PPQ-ticks) [float]
The word seek, followed by a number specifying ticks (in 1 PPQ), sets the current transport position. For example, to seek to the start of the fifth measure if the time signature is 4/4 the send the message "seek 16".

tempo

Arguments

host-tempo [float]
The word tempo, followed by a number (in samples per beat), changes the host's tempo.

timesig

Arguments

host-time-signature (numerator) [int]
host-time-signature (denominator) [int]
The word timesig, followed by two numbers that specify numerator and denominator values, changes the host's time signature. For example, to set the time signature to 3/4 send the message timesig 3 4.

Output

Rewire

Controls a Rewire host.

See Also

Name Description
hostphasor~ ReWire host synchronization source
hostsync~ Get transport control info from a ReWire host