mozaic_include_migration_mananger

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revisionBoth sides next revision
mozaic_include_migration_mananger [2020/07/27 02:59] – [Samples using the Migration Manager] Chapter title unification _kimozaic_include_migration_mananger [2021/07/14 05:47] – Added more info regarding the mmScriptId _ki
Line 25: Line 25:
   * The [[https://patchstorage.com/migration-manager-include/|Migration Manager (Include) Demo]]   * The [[https://patchstorage.com/migration-manager-include/|Migration Manager (Include) Demo]]
   * The [[https://patchstorage.com/midi-multicast/|MIDI MultiCast]] script transfers its up to 7x16 routing scenes and config variables   * The [[https://patchstorage.com/midi-multicast/|MIDI MultiCast]] script transfers its up to 7x16 routing scenes and config variables
-  * The 'MutatoRscript transfers around 12KB of data in 13 migration steps+  * The[[https://patchstorage.com/mutator/|MutatoR]] script transfers around 12KB of data in 13 migration steps 
 +  * The[[https://patchstorage.com/ms6-sysex-performance-editor-and-spatial-processor/|MS6 Performance Editor and Spatial Processor]] script transfers its settings in 2 migrations steps
  
 \\  \\ 
Line 40: Line 41:
  
   * Your scipt also needs to define the 4 event functions @MigrateSend, @MigrateRead, @MigrateImportDone,@MigrateExportDone that will be called by the Migration Manager.    * Your scipt also needs to define the 4 event functions @MigrateSend, @MigrateRead, @MigrateImportDone,@MigrateExportDone that will be called by the Migration Manager. 
 +
 +  * Choose a unique **mmScriptId** for your script, see [[#Reserved mmScriptId‘s]]
  
 ==== @OnLoad ====  ==== @OnLoad ==== 
Line 62: Line 65:
      
  <code>  <code>
-  mmScriptId    = 0x4200 +  mmScriptId    = 0xDEAA0 // Please choose an new unique number up to 24bits ! 
-  mmScriptTimer = YES  // Remove the line if your script does define an OnTimer+  mmScriptTimer = YES     // Remove the line if your script does define an OnTimer
   Call @MigrationManagerOnLoad    Call @MigrationManagerOnLoad 
   if mmIsMigrating   if mmIsMigrating
Line 71: Line 74:
   endif   endif
 </code> </code>
 +
 +Each script needs to use an own unique mmScriptId. There could be several totally different scripts including the Migration Manager Snippet loaded in a single AUv3 host session. A scripts unique id is used to identify other instances of this specific script even if other scripts using the Migration Manager are present. The id can be understood as „sender/receiver name or address“ of a script. 
 +The maximum value for mmScriptId is 24bits or 6 hex chars (0x000100 to 0xFFFF80)
 +
 +\\ 
 +=== Reserved mmScriptId‘s ===
 +The following mmScriptId ranges are already in use by other scripts and should be avoided in new scripts using the Migration Manager Include Snippet:
 +^  ^ mmScriptId ^ end of range ^ script ^
 +|  | 0x4200 | 0x420F | MS6 SysEx Performance Editor and Spatial Processor | |
 +|  | 0xDEAA0 | 0xDEAAF | Migration Manager Demo | |
 +|  | 0x4D4D43 | 0x4D4D4F | Midi Multicast | |
 +|  | 0x50C001 | 0x50C01F | MutatoR | |
  
 ==== @OnTimer ====  ==== @OnTimer ==== 
  • mozaic_include_migration_mananger.txt
  • Last modified: 2021/07/16 22:20
  • by _ki