APPENDIX E: OctaMED's ARexx Commands (version 2)

Version 2 commands are compatible with OctaMED Soundstudio only.

E.1 New option names

CutAllPages_Block      CutAllPages_Range        CutAllPages_Track
DefChannelMode         FastMemPlay              FastMemPlay_BufferSize
GadgetShortCutQual     ImmediateMIDIPresetChg   KEYMAPACTIVE
MIDISLAVE              Mix_BufferSize           Mix_Frequency
Mix_OutputDev          MixSwapAmigaChannels     Notat_Dispmode
Notat_DefaultWidth     NOTAT_STAFFNAMES         PrintResolution
ShowAnnoAfterLoading   ShowChangedSettings      SListFileFormat_8
SListFileFormat_16     UsingMixing_MMD          UseMixing_Tracker
TransposeOutOfRange

E.2 New window names

AREXXTRIGGERSETUP      FASTMEMPLAY              MIDICMD3CXXSETTINGS
MISCOPT_DIRS           MIXEFFECTS               MIXPAN
MIXPARAMETERS          NOTATION                 NOT_ASSIGNTRACKS
NOT_DISPLAYSETUP       NOT_PRINT                NOT_SIGNATURES
NOT_STAFFSETUP         NOT_TOOL                 REPLACENOTES
SELECTINSTRUMENT

E.3 New commands

E.3.1 WI, IN, SG and ED commands

 WI_WBENCHTOFRONT: Brings the Workbench screen to the front.
*IN_GETDISABLE: Returns current instrument's Disable state.
*IN_GETLOOPPINGPONG: Returns current instrument's loop ping-pong state.
 IN_MOVESAMPLESTOCHIP: Moves all samples to Chip memory.
 IN_MOVESAMPLESTOFAST: Moves all samples to Fast memory.
 IN_SETDISABLE ON/S,OFF/S,TOGGLE/S: Sets/clears/toggles Disable.
 IN_SETLOOPPINGPONG ON/S,OFF/S,TOGGLE/S: Sets/clears/toggles Loop Ping-Pong.
*SG_GETTRACKPAN TRACK/N/A: Returns the panning of TRACK (0 to 63).
 SG_MIXECHO OFF/S,ECHO/S,CROSSECHO/S,RATE/K/N,DEPTH/K/N: Changes Mix mode
    Echo settings. OFF/ECHO/CROSSECHO is the mode. RATE is the rate in
    milliseconds. DEPTH is value 1 to 6, where 1 is very deep (50.0%), 6 is
    very shallow (1.44%).
 SG_MIXPARAMS MONO/S,STEREO/S,MAXCH/K/N,VOLADJ/K/N,FREEPAN/S,NOFREEPAN/S:
    Sets the song's mixing settings. All are in the Mixing Settings window,
    apart from FREEPAN and NOFREEPAN, in the Mix - Track Panning window.
 SG_MIXSTEREOSEP SEP/N: Sets the stereo separation (between -4 and 4).
 SG_SETTRACKPAN TRACK/N/A,PAN/N/A: Sets the panning of TRACK (0 - 63). PAN
    can be between -16 and 16.
 ED_NOTETONUMBER NOTE/A: Converts a string like "D#5" to a note number.
 ED_SETMIDIINPUTCHANNEL CH=CHANNEL/N/A: Sets the MIDI input channel (0 -
    16).

E.3.2 RN and MM commands

*RN_BUFFEREXISTS BUFF/N/A: If the buffer exists, returns 1, otherwise 0.
    Valid buffer numbers are 0 (block), 1 (track) or 2 (edit).
*RN_FINDREPLACESOURCE NEXT/S,PREV/S: Searches for the next/previous
    occurrence of the Source full note (Replace Notes window). Returns 1 if
    found, 0 otherwise. If both NEXT and PREV omitted, compares the note
    under the cursor with the source note.
*RN_GETBUFFDATA BUFF/N/A,L=LINE/K/N/A,T=TRACK/K/N/A,P=PAGE/K/N,NOTE/S,
    INUM/S,CMDNUM=CMDTYPE/S,QUAL=CMDLVL/S: Returns copy buffer data. The
    buffer number is given by BUFF (0, 1 or 2). See ED_GETDATA.
*RN_GETBUFFLINES BUFF/N/A: Returns the number of lines in the copy buffer.
*RN_GETBUFFPAGES BUFF/N/A: Returns the number of pages in the copy buffer.
*RN_GETBUFFTRACKS BUFF/N/A: Returns the number of tracks in the copy buffer.
 RN_REMARK: Brings back the most recently marked range, and moves to its
    start.
 RN_REPLACE SOURCE,DEST,SONG/S,BLOCK/S,TRACK/S,SELTRACKS/S,RANGE/S,
    CURRNOTE/S: The features of the Replace Notes window. SOURCE and DEST
    should be source and destination note strings (for example,
    "E-610xx34").
 RN_SETBUFFDATA BUFF/N/A,L=LINE/K/N/A,T=TRACK/K/N/A,P=PAGE/K/N,NOTE/K/N,
    INUM/K/N,CMDNUM=CMDTYPE/K/N,QUAL=CMDLVL/K/N: Changes a copy buffer's
    contenst. See RN_GETBUFFDATA and ED_SETDATA.
 RN_SWAPBUFFERS BUFF1/N/A,BUFF2/N/A: Swaps the contents of two copy buffers.
    Valid buffer numbers are 0 (block), 1 (track) or 2 (edit).
*MM_GETCURRMSGNUM: Returns the number of the currently selected MIDI
    message, or 0 if there are no messages in memory.
 MM_LOADMESSAGE NAME: Loads a MIDI message from disk. If NAME is omitted, a
    file requester appears.
 MM_SENDMESSAGE MSGNUM/N: Sends the given MIDI message number, or the
    current message if MSGNUM is omitted.
 MM_SETCURRMSGNUM MSG=MESSAGE/N/A: Selects a new message. This message is
    displayed in the MIDI Message Editor.

E.4 Changes to existing commands

 IN_SETVOLUME INCRBY/K/N,DECRBY/K/N,MAX/K/N,MIN/K/N: Use e.g. INCRBY 10 to
    increase the volume by 10. MAX is the maximum value reachable with
    INCREASE or INCRBY (for example, MAX 60 prevents volume increases beyond
    level 60). Similarly for MIN and DECREASE or DECRBY.
*SG_GETCHANNELMODE: Returns 9 for Mix mode.
 SG_SETCHANNELMODE MODE/N/A: Value 9 sets Mix mode.
 SG_SETMASTERVOL INCRBY/K/N,DECRBY/K/N,MAX/K/N,MIN/K/N: As above.
 SG_SETTRACKSTATE: If no TRACK value is given, the current track is changed.
 ED_ADVANCELINE NOWRAP/S: NOWRAP prevents "wrapping" at the top and bottom
    of the block. In other words, the line cannot be advanced beyond the
    top or bottom of the block.
 ED_CLEARNOTECMD SKIPSPACING/S: Space is now taken into account. If
    SKIPSPACING is not specified, the notes in the spacing range are
    cleared.
 ED_DELETENOTE NOTEONLY/S,CMDONLY/S: Remove only the note part or the player
    command if specified.
 ED_INSERTEMPTYNOTE NOTEONLY/S,CMDONLY/S: Similarly.
 ED_PICKPROGKEYNOTE CMDONLY/S: **New to V3!** Only picks the player
    command part of the full note. The note name, octave number and
    instrument number are made transparent.
 RN_DISCARDBUFFERS BUFF/N: If a buffer number is specified, only clears that
 buffer. Valid buffer numbers are 0 (block), 1 (track) or 2 (edit).
 RN_PASTE CMDONLY/S,NOTEONLY/S: Only pastes player commands or notes.