Skip to main content

DPF Framework 2026 R1

sound:apply gain to a signal

Last update: 31.07.2026

Version: 0.0.0

Description

Apply gain on each channel of a signal (fields_container). Note: The gain is applied to every channel of the signal.

Inputs

Input Name Expected type(s) Description
Pin 0
Required
input_signal fields_container, field The input signal.
Pin 1
Required
gain double Gain value in decibels (dB) or linear unit. By default, gain is specified in decibels. If gain is given in a linear unit, set is_gain_dB to false.
Pin 2
Required
is_gain_dB bool If value is true, the gain is specified in dB. If value is false, the gain is in a linear unit.

Outputs

Output Name Expected type(s) Description
Pin 0 output_signal fields_container, field Signal(s) with the gain applied. The type of the output will be the same as the input on pin 0. For example, a Field as an input will result in a Field for the output.

Configurations

Name Expected type(s) Default value Description
mutex bool false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

Category: sound

Plugin: sound

Scripting name: None

Full name: None

Internal name: apply_gain

License: avrxp_snd_level1

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys