<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="freqshift~" module="msp" category="MSP Modifiers">
	<digest>
		Time-domain frequency shifter
	</digest>
	<description>
		<o>freqshift~</o> is a time-domain frequency shifter (also known as a single-sideband ring modulator).
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP Modifiers
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Audio Signal to be Shifted
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal/float">
			<digest>
				(signal/float) Amount of Frequency Shift (Hz)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				(signal) Frequency-shifted Signal (Positive Sideband)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="signal">
			<digest>
				(signal) Frequency-shifted Signal (Negative Sideband)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="frequency-shift" optional="1" units="hz" type="float">
			<digest>
				Frequency shift
			</digest>
			<description>
				A numerical argument will be used as the frequency shift in Hertz. The default is zero.
			</description>
		</objarg>
		<objarg name="frequency-shift" optional="0" units="hz" type="int">
			<digest>
				Frequency shift
			</digest>
			<description>
				A numerical argument will be used as the frequency shift in Hertz. The default is zero. <m>.</m> 
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="int">
			<arglist>
				<arg name="frequency-shift" optional="0" units="hz" type="int" />
			</arglist>
			<digest>
				Set the frequency shift amount
			</digest>
			<description>
				In right inlet: Converted to <m>float</m>. 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.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="frequency-shift" optional="0" units="hz" type="float" />
			</arglist>
			<digest>
				Set the frequency shift amount
			</digest>
			<description>
				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.
			</description>
		</method>
		<method name="clear">
			<arglist />
			<digest>
				Clear the sample memory
			</digest>
			<description>
				Clears sample memory (in case the filter is blown up).
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In left inlet: The signal present at the left inlet is frequency-shifted by the argument or value given in the right inlet.
				<br />
				<br />
				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.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="freqshift~.png" caption="freqshift~ shifts the frequencies of an incoming sound more efficiently than if you build it yourself from scratch" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="fbinshift~" />
		<seealso name="gizmo~" />
		<seealso name="hilbert~" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				The output is the frequency shifted signal.
			</description>
		</entry>
	</misc>
</c74object>
