Difference between revisions of "Component: Delay (DSP)"
(XML import of component documentation) |
(XML import of components for release) |
||
| Line 16: | Line 16: | ||
==[[File:Component Icon e0ddc704_6bab_4d08_8f10_19a14c6683ef.png|Image]] Delay component== | ==[[File:Component Icon e0ddc704_6bab_4d08_8f10_19a14c6683ef.png|Image]] Delay component== | ||
| − | + | Allows a delay to be inserted into the DSP system | |
==Examples== | ==Examples== | ||
| Line 25: | Line 25: | ||
===<span style="font-weight: normal;"><u><tt>DelayTick</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>DelayTick</tt></u></span>=== | ||
| − | + | Passes a single value from a buffer into the delay buffer and spits out a delayed value at the other end | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 40: | Line 38: | ||
===<span style="font-weight: normal;"><u><tt>Delay</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>Delay</tt></u></span>=== | ||
| − | + | Passes an entire buffer into the delay buffer and spits out a delayed version of the buffer at the other end | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 55: | Line 51: | ||
===<span style="font-weight: normal;"><u><tt>SetDelaySize</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>SetDelaySize</tt></u></span>=== | ||
| − | + | Specifies the number of values in the delay buffer to allow the length of the delay to be adjustable during runtime. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 80: | Line 74: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_delay''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''max_delay''. | ||
| − | + | The maximum number of values to delay the incoming signal by | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Initial Delay Count</u></span> | <span style="font-weight: normal;"><u>Initial Delay Count</u></span> | ||
| Line 88: | Line 80: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''initial_delay''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''initial_delay''. | ||
| − | + | The initial delay that will be used at startup | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Buffer Manager</u></span> | <span style="font-weight: normal;"><u>Buffer Manager</u></span> | ||
| Line 96: | Line 86: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''. | ||
| − | + | Specifies the DSP system buffer manager | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Input</u></span> | <span style="font-weight: normal;"><u>Input</u></span> | ||
| Line 104: | Line 92: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | ||
| − | + | Specifies the buffer which is used as the input to the delay | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Output</u></span> | <span style="font-weight: normal;"><u>Output</u></span> | ||
| Line 112: | Line 98: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''output_c''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''output_c''. | ||
| − | + | Specifies the buffer which is used as the output to the delay | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Sample Rate (Hz)</u></span> | <span style="font-weight: normal;"><u>Sample Rate (Hz)</u></span> | ||
| Line 120: | Line 104: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''sample_rate''. | This property is of type ''Floating point'' and can be referenced with the variable name ''sample_rate''. | ||
| − | + | Sample rate used to generate some useful calculations | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Max Delay (s)</u></span> | <span style="font-weight: normal;"><u>Max Delay (s)</u></span> | ||
| Line 128: | Line 110: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''del_max''. | This property is of type ''Floating point'' and can be referenced with the variable name ''del_max''. | ||
| − | + | Maximum possible delay in seconds at the specified sample rate | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Initial Delay (s)</u></span> | <span style="font-weight: normal;"><u>Initial Delay (s)</u></span> | ||
| Line 136: | Line 116: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''del_initial''. | This property is of type ''Floating point'' and can be referenced with the variable name ''del_initial''. | ||
| − | + | Initial delay in seconds at the specified sample rate | |
Revision as of 13:34, 2 September 2013
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | DSP |
Contents
Delay component
Allows a delay to be inserted into the DSP system
Examples
No additional examples
Downloadable macro reference
DelayTick
Passes a single value from a buffer into the delay buffer and spits out a delayed value at the other end
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Delay
Passes an entire buffer into the delay buffer and spits out a delayed version of the buffer at the other end
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SetDelaySize
Specifies the number of values in the delay buffer to allow the length of the delay to be adjustable during runtime.
Parameters
- UINT Delay_Count
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Max Delay Count
This property is of type Signed integer and can be referenced with the variable name max_delay.
The maximum number of values to delay the incoming signal by
Initial Delay Count
This property is of type Signed integer and can be referenced with the variable name initial_delay.
The initial delay that will be used at startup
Buffer Manager
This property is of type Fixed list of ints and can be referenced with the variable name buffer_manager.
Specifies the DSP system buffer manager
Input
This property is of type Fixed list of ints and can be referenced with the variable name input_a.
Specifies the buffer which is used as the input to the delay
Output
This property is of type Fixed list of ints and can be referenced with the variable name output_c.
Specifies the buffer which is used as the output to the delay
Sample Rate (Hz)
This property is of type Floating point and can be referenced with the variable name sample_rate.
Sample rate used to generate some useful calculations
Max Delay (s)
This property is of type Floating point and can be referenced with the variable name del_max.
Maximum possible delay in seconds at the specified sample rate
Initial Delay (s)
This property is of type Floating point and can be referenced with the variable name del_initial.
Initial delay in seconds at the specified sample rate
