Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Documents: Update page title prefix

Overview

Sets parameters in other modules

Discussion

The ParamSet module takes a signal from an input wire and writes the value to an instance variable in another module. The module is useful for controlling the behavior of other modules in response to control signals or audio signals.

...

Please see the ParamSet example for specific use cases.

Type Definition

Code Block
typedef struct _ModuleParamSet
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 setBehavior;                            // Controls the behavior of the module
    void * modPtr;                                // Points to the module to set
    void * varPtr;                                // Points to the variable to set within the module instance structure
} ModuleParamSetClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

setBehavior

int

parameter

0

3

Unrestricted

modPtr

void *

parameter

1

Unrestricted

varPtr

void *

parameter

1

Unrestricted

Pins

Input Pins

Name: in

Description: parameter value

...

Sample rate range: Unrestricted

Complex support: Real

MATLAB Usage

File Name: param_set_module.m

...