Std.Audio.gain

fn

This is a callable function.

What it does

Audio scaled by a Q15 gain, where 32,768 is unity.

Each product is rounded half away from zero and saturated to 16 bits, so

gain is symmetric for positive and negative samples and never wraps. Unity

and zero gain touch no samples.

Read the signature

• The text after the name is the type checked by Pudu.
• Read arrows from left to right: inputs come first, and the final type is returned.
• & borrows a value for this call instead of moving or copying it.
• Names inside [ ] are type arguments, such as the item type held by a collection.
• Result makes success and recoverable failure part of the function's type.