📖 Mercury Function Reference

Disclaimer: This documentation is not entirely finished and will subject to changes. If you like to contribute or find errors, please report them in the issues or correct them yourself and send a pull request

Disclaimer: There are differences between the Mercury Browser version and the Mercury for Max8 version. Please be aware that this may be the reason some functions are not working

Code Documentation

• Actions
  • new
  • list
  • set
  • print
  • silence
  • audio (Mercury4Max only)
• set (global)
  • tempo
  • scale
  • scalar (Mercury4Max only)
  • randomSeed
  • volume
  • highPass
  • lowPass
  • osc (Mercury4Max only)
  • midi (Mercury4Max only)
  • click (Mercury4Max only)
  • crossFade (Mercury Playground only)
  • samples (Mercury Playground only)
• new (instruments)
  • All instruments (except midi)
    • name
    • group (MercuryPlayground only)
    • time
    • play
    • shape
    • gain
    • pan
    • fx
  • synth
    • note
    • sub (Mercury4Max only)
    • super
    • noise (Mercury4Max only)
  • sample / loop
    • speed
    • offset
    • stretch
    • note
    • tune
  • polySynth
    • steal
    • voices
    • spread (Mercury4Max only)
  • polySample (MercuryPlayground only)
    • steal
    • voices
  • midi
    • note
    • length
    • out
    • chord
    • program (MercuryPlayground only)
    • sync (Mercury4Max only)
  • input
  • modulator (Mercury4Max only)
    • name
    • time
    • range
  • emitter (osc) (Mercury4Max only)
    • osc
    • name
    • address
• fx (Sound Effects)
  • freeze (Mercury4Max only)
  • shift
  • triggerFilter
  • kink (Mercury4Max only)
  • drive / distort
  • filter
    • filterModulation (Mercury4Max only)
  • degrade / chip
  • comb *
  • squash
  • double / chorus
  • hall / reverb
  • lfo
  • echo / delay
• list (list functions)
  • Generative Methods
    • spread / spreadFloat
    • spreadInclusive / spreadInclusiveFloat
    • fill
    • sine / cosine
    • sineFloat / cosineFloat
    • saw / sawFloat
    • square / squareFloat
  • Algorithmic Methods
    • euclidean
    • hexBeat
    • fibonacci
    • pisano
    • pell
    • lucas
    • threeFibonacci
  • Stochastic Methods
    • randomSeed
    • random
    • randomFloat
    • drunk
    • drunkFloat
    • urn
    • coin
    • dice
    • clave
    • twelveTone
    • choose
    • pick
    • shuffle
    • expand
  • Transformative Methods
    • clone
    • join
    • copy
    • pad
    • every
    • flat
    • invert
    • lace
    • lookup
    • merge
    • palindrome
    • repeat
    • reverse
    • rotate
    • slice
    • split
    • cut
    • spray
    • stretch
    • unique
  • Translate Methods
    • midiToNote
    • midiToFreq
    • noteToMidi
    • noteToFreq
    • freqToMidi
    • freqToMidi
    • freqToNote
    • relativeToMidi
    • relativeToFreq
    • chromaToRelative
    • ratioToCent
    • chordsFromNumerals
    • chordsFromNames
    • divisionToMs
    • divisionToRatio
    • ratioToMs
    • scaleNames
    • toScale
  • Utility Methods
    • wrap
    • clip
    • fold
    • map
    • mod
    • add
    • subtract
    • multiply
    • divide
    • normalize
    • equals
    • notEquals
    • greater
    • greaterEquals
    • less
    • lessEquals

Param Glossary

When describing input arguments for functions in some cases it is necessary to know if the values can be a number (positive and/or negative), a decimal number (float) or a name (string).

Values

• Value -> Any Number or Name
  • Number -> Int+, Int or Float
    • Bool -> 0 or 1 (true or false)
    • Int+ -> A positive whole number, bigger than 0
    • Int -> A whole number, negative or positive, including 0
    • Float -> A floating-point number, negative or positive, including 0
  • Name -> A combination of letter-characters, may include capital letter, underscores and digits

Lists

• List -> A list with Value’s
  • NumberList -> A list with Number’s
    • IntList+ -> A list with Int+’s
    • IntList -> A list with Int’s
    • FloatList -> A list with Float’s
  • NameList -> A list with Name’s