Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When developing a layout, modules may have arguments created using system wide data such as HW input sample rate or HW input block size. Data such as this may be entered explicitly for module arguments (i.e. 48000 for sample rate), or a symbol can be defined and used instead. For example, system input parameters such as TOP_SAMPLERATE are automatically defined in Layout Variables, so rather than entering 48000 as a module argument, you can use $TOP_SAMPLERATE (the ‘$’ tells Designer to treat this as a symbol). When this data value changes, it changes everywhere else that it is used. For example, if  $TOP_SAMPLERATE is used across the layout (rather than explicitly defining 48000), it only needs to be changed in one place.

Info

Note: Despite the name, Layout Variables are designed to work with Module Arguments, not Module Variables.

Defining Layout Variables

...

User variables previously saved to a file may be loaded from that file. To load user variables click on the “Load from File” button and select the file.

Info

Loading user variables from a file will overwrite any existing user variables.

Using Layout Variables

To use a layout variable precede the symbol with a ‘$’.

...