Versions Compared

Key

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

Overview

ST gain manager

Discussion

The GAM module allows the user to digitally modify the volume of the input signal in the [-80;0] dB range, with a granularity of 0.5 dB.

...

The minimum input frame is 96 and the maximum input frame is 480 stereo samples.

Type Definition

Code Block
typedef struct _ModuleSTGainManager
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 nAPIResult;                             // Return status for last call into the ST API
    INT32 numChannels;                            // Number of channels
    FLOAT32* target_volume_dB;                    // Up to 8 channels of gain (-80 - 0) dB
    INT32* mute;                                  // mute
    void * pGlobals;                              // Points to the global variables structure
} ModuleSTGainManagerClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

nAPIResult

int

state

0

0

Unrestricted

numChannels

int

parameter

1

1

Unrestricted

target_volume_dB

float*

parameter

0

[1 x 1]

-80:0.5:0

dB

mute

int*

parameter

0

[1 x 1]

0:1:1

pGlobals

void *

const

1

Unrestricted

Pins

Input Pins

Name: in

Description: audio input

...

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: out

Description: audio output

Data type: fract32

MATLAB Usage

File Name: st_gain_manager_module.m

...