dot-addAM: Add AM to a sound
In soundgen: Sound Synthesis and Acoustic Analysis

.addAM

R Documentation

Add AM to a sound

Description

Internal soundgen function, see addAM.

Usage

.addAM(
  audio,
  amDep = 25,
  amFreq = 30,
  amType = c("logistic", "sine")[1],
  amShape = 0,
  invalidArgAction = c("adjust", "abort", "ignore")[1],
  plot = FALSE,
  play = FALSE
)

Arguments

`audio`	a list returned by `readAudio`
`amDep`	amplitude modulation (AM) depth, %. 0: no change; 100: AM with amplitude range equal to the dynamic range of the sound (anchor format)
`amFreq`	AM frequency, Hz (anchor format)
`amType`	"sine" = sinusoidal, "logistic" = logistic (default)
`amShape`	ignore if amType = "sine", otherwise determines the shape of non-sinusoidal AM: 0 = ~sine, -1 = notches, +1 = clicks (anchor format)
`invalidArgAction`	what to do if an argument is invalid or outside the range in `permittedValues`: 'adjust' = reset to default value, 'abort' = stop execution, 'ignore' = throw a warning and continue (may crash)
`plot`	if TRUE, plots the amplitude modulation
`play`	if TRUE, plays the processed audio