pitchshift~
Description
Use the pitchshift~ object to load a perform pitch-shifting on an input signal.
Arguments
channels [int]
An optional argument can be used to specify the number of channels of the signal to be processed (default = 1).
Attributes
constantlatency [int]
Constant Latency
enabled [int]
Enable or disable pitchshifting.
pitchshift [float] (default: 1.)
Set the pitchshifting as a factor of the original pitch (i.e. 2.0 = doubling of pitch, .5 = halving of the original pitch, etc.).
pitchshiftcent [int] (default: 0)
Set the amount of pitchshift as positive or negative cent values (i.e. 100 = semitone up, -1200 = octave down). Cents may be specified as ints or floats.
quality [int]
Pitch shifting output quality.
When building a standalone with pitchshift, quality will always default to 'basic'.
Possible values:
'basic'
(
Basic quality (the default)
)
'good'
(
Good quality
)
'better'
(
Better quality
)
'best'
(
Highest quality
)
reportlatency [int]
Enable/disable reporting latency, in samples, introduced by the pitchshift~ object's calculations. Latency is output from the object's right-hand outlet in the form of a message in the form latency [number-of-samples].
usecents [int]
Enable/disable the use of cent values in the second inlet of the pitchshift~ object to specify pitch change.
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]
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]
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]
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
getlatency
signal
See Also
| Name | Description |
|---|---|
| retune~ | Ztx-based pitch detection and pitchshift |