Skip to main content

sound:apply gain to a signal

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

InputNameExpected type(s)Description
Pin 0
Required
input_signalfields_container, fieldThe input signal.
Pin 1
Required
gaindoubleGain 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_dBboolIf value is true, the gain is specified in dB. If value is false, the gain is in a linear unit.

Outputs

OutputNameExpected type(s)Description
Pin 0output_signalfields_container, fieldSignal(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

NameExpected type(s)Default valueDescription
mutexboolfalseIf 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.