Out of sync docs? #137

Activity

1. walmik commented on Oct 18, 2020

   

   walmik

   on Oct 18, 2020

   Last edited by walmik

   Collaborator

   More actions

   Thank you for pointing this out @JestDotty ! I will update the docs once I get some time but to unblock you for now, I m sharing some details here.

   The instrument parameter is newly updated in Scribbletune and it will replace the synth parameters in the futures. Either ways, it uses a Tone.js instrument and can be use like this

   scribble
     .clip({
       instrument: 'Synth',  // string
       pattern: 'xx[xx]', 
       notes: 'C3 Cm-3'
     })
     .start();
   

   The following synths are provided thanks to Tone.js and you can define the instrument by seeing one of the following values as a string:

   • AMSynth
   • DuoSynth
   • FMSynth
   • MembraneSynth
   • MetalSynth
   • MonoSynth
   • NoiseSynth
   • PluckSynth
   • PolySynth
   • Sampler
   • Synth

   You could even define the instrument as a Tone.js object like this,

   const synth = new Tone.Synth();
   scribble
     .clip({
       instrument: synth, 
       pattern: 'xx[xx]', 
       notes: 'C3 Cm-3'
     })
     .start();
   

   and then augment it like this

   synth.set({oscillator: {type: "sawtooth"}});
   

   There is yet another way to define synths. You can initialize a Tone.js instrument with a JSON payload that defines the properties of the synth. This is a bit advanced way of doing it, but if you feel like giving it a shot, the play around with some of the "Instruments" here https://tonejs.github.io/examples/ and change their properties. Then click the <> button on the bottom and get hold of the JSON payload and use it here

   const synth = new Tone.Synth({<jsonPayload here>});
   

   

   Hope this helps for now!