diff --git a/README.md b/README.md index a04c7cb..68115fd 100755 --- a/README.md +++ b/README.md @@ -11,12 +11,12 @@ With uClock, you gain the ability to create professional-grade sequencers, sync ## Interface The uClock library API operates through attached callback functions mechanism: -1. **onPPQNCallback(uint32_t tick)** calls on each new pulse based on selected PPQN resolution(if no PPQN set, the default is 96PPQN) -2. **onStepCallback(uint32_t step)** good way to code old style step sequencer based on 16th note schema(not dependent on PPQN resolution) -3. **onSync24Callback(uint32_t tick)** good way to code a clock machine, or keep your gears synced with your device -4. **onSync48Callback(uint32_t tick)** there are some 48ppqn based sync devices out there -5. **onClockStartCallback()** on uClock Start event -6. **onClockStopCallback()** on uClock Stop event +1. **setOnPPQN(onPPQNCallback) > onPPQNCallback(uint32_t tick)** calls on each new pulse based on selected PPQN resolution(if no PPQN set, the default is 96PPQN) +2. **setOnStep(onStepCallback) > onStepCallback(uint32_t step)** good way to code old style step sequencer based on 16th note schema(not dependent on PPQN resolution) +3. **setOnSync24(onSync24Callback) > onSync24Callback(uint32_t tick)** good way to code a clock machine, or keep your gears synced with your device +4. **setOnSync48(onSync48Callback) > onSync48Callback(uint32_t tick)** there are some 48ppqn based sync devices out there +5. **setOnClockStart(onClockStartCallback) > onClockStartCallback()** on uClock Start event +6. **setOnClockStop(onClockStopCallback) > onClockStopCallback()** on uClock Stop event ## uClock v2.0 Breakchanges @@ -24,10 +24,10 @@ If you are comming from uClock version < 2.0 versions keep attention to the brea #### setCallback functions name changing: **setClock96PPQNOutput(onClock96PPQNOutputCallback)** is now setOnPPQN(onPPQNCallback) and his clock depends on the PPQN setup using setPPQN (clockPPQNResolution). For clock setup you now use a separeted callback via setOnSync24(onSync48Callback) or setOnSync24(onSync48Callback) +**setClock16PPQNOutput(ClockOut16PPQN)** is now setOnStep(onStepCall) and its not dependent on clock PPQN resolution **setOnClockStartOutput(onClockStartCallback)** is now setOnClockStart(onClockStartCallback) **setOnClockStopOutput(onClockStopCallback)** is now setOnClockStop(onClockStopCallback) **setOnClockStartOutput(onClockStartCallback)** is now setOnClockStart(onClockStartCallback) -**setClock16PPQNOutput(ClockOut16PPQN)** is now setOnStep(onStepCall) and its not dependent on clock PPQN resolution #### Tick resolution and sequencers