Overview

Copies the data at the input pin and stores it in an internal buffer

Discussion

This module copies the integer data at the input pin to an internal buffer (value). The copy operation occurs at each block process and thus the data continuously updates. This module is used to store the value of a wire and make it available to the control code, or a host processor.

To temporarily pause the copying, place the module into the INACTIVE state.

Additionally, this module makes the wire information available as internal variables. Block size, channel number, sample rate and signal complexity can be accessed in MATLAB code, source code, or in a layout using the ParamGet module.

Type Definition

typedef struct _ModuleSinkIntProperties
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 BlockSize;                              // Block Size
    INT32 NumChannels;                            // Number of Channels
    FLOAT32 SampleRate;                           // Sample Rate
    INT32 IsComplex;                              // Is Complex
    INT32* value;                                 // Captured values
} ModuleSinkIntPropertiesClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
BlockSize	int	const	0	32	Unrestricted
NumChannels	int	const	0	1	Unrestricted
SampleRate	float	const	0	48000	Unrestricted
IsComplex	int	const	0	0	Unrestricted
value	int*	state	0	[32 x 1]	Unrestricted

Pins

Input Pins

Name: in

Description: audio input

Data type: int

Channel range: Unrestricted

Block size range: Unrestricted

Sample rate range: Unrestricted

Complex support: Real and Complex

MATLAB Usage

File Name: sink_int_properties_module.m

 M=sink_int_properties_module(NAME)
 Creates a sink (capture) module for use with the Audio Weaver
 environment.  The module captures a block of integer input data and
 stores it into an internal buffer.  Arguments:
    NAME - name of the module.

Documentation Hub [PUBLIC]

(8.D.1.2) SinkIntProperties