freqshift~
Time-domain frequency shifter
Description
freqshift~ is a time-domain frequency shifter (also known as a single-sideband ring modulator).
Arguments
frequency-shift[float]hz
optional
A numerical argument will be used as the frequency shift in Hertz. The default is zero.
frequency-shift[int]hz
optional
A numerical argument will be used as the frequency shift in Hertz. The default is zero. .
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]: 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'
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]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
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
int
In right inlet: Converted to float . A number value in the right inlet will be used as a frequency amount in Hertz by which the left input signal will be shifted.
- frequency-shift
[int]
float
In right inlet: a float in the right inlet will be used as a frequency amount in Hertz by which the left input signal will be shifted.
- frequency-shift
[float]
clear
Clears sample memory (in case the filter is blown up).
resetphase
Resets the phase of the two cycles that modulate the sidebands of the incoming signal.
signal
In left inlet: The signal present at the left inlet is frequency-shifted by the argument or value given in the right inlet.
In right inlet: a signal in the right inlet will be used as a frequency amount in Hertz by which the left input signal will be shifted.
Output
signal
The output is the frequency shifted signal.
See Also
| Name | Description |
|---|---|
| fbinshift~ | Frequency domain frequency shifter for pfft~ |
| gizmo~ | Frequency-domain pitch shifter for pfft~ |
| hilbert~ | Phase quadrature filter |