home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / audio / EdPlyr21.lha / EdPlayer.DOCs / EdP2.1.Commands.DOC < prev    next >
Text File  |  1992-09-18  |  39KB  |  780 lines

  1. ============================================================================
  2.  
  3.                     A R E X X / T E L L E D   S E C T I O N
  4.  
  5. ============================================================================
  6.  
  7. This section describes EdPlayer commands which can be issued from ARexx,
  8. or from programs like telled/cteled.  I'll try to explain it so that even
  9. people who are not familiar with ARexx can use the commands.
  10.  
  11. EdPlayer has a special message port.  This port is more than an ARexx port,
  12. because it can accept both ARexx messages and special "EdPlayer" messages
  13. in the same port.  The reason for this is that some unfortunate people
  14. using OS1.3 still don't have ARexx!  What are you guys waiting for??
  15.  
  16. Anyway, included in this archive are two programs and their respective
  17. source codes, called "Telled" (Telled.asm) and "cteled" (cteled.c).  The
  18. two are almost identical:  Telled was written in Assembly, being as SMALL
  19. as possible, for easy use in script files.  Cteled was written in Aztec C,
  20. and is somewhat larger because it actually returns error messages on the
  21. screen.  Both of these programs transmit the special "EdPlayer" messages so
  22. that ARexx is not required.  Their source codes are provided in case you
  23. want to write your own programs that transmit these messages.  However, it
  24. is strongly recommended that you look up in your ARexx manual the proper
  25. way of sending true ARexx messages, so that you know how to send messages to
  26. other ARexx applications, not just EdPlayer.
  27.  
  28. In EdPlayer 2.0, two new programs appear in the archive:  "AskEd.rexx" and
  29. "wport" (wport.c).  AskEd.rexx is an ARexx script that should be used to
  30. send the ARexx queries.  EdPlayer cannot return a result (other than an
  31. error) to telled and cteled, so you must use "rx AskEd <query>" to get
  32. responses from EdPlayer.  Wport is a little program I wrote that waits
  33. for the EDPLAYER message port to appear.  This is very useful for scripts
  34. that launch EdPlayer and immediately try to send it commands; these scripts
  35. should wait (with wport) for EdPlayer to set up its message port first. 
  36. See wport.c (it's commented) for info on how to use wport.
  37.  
  38. For those of you making script files:  If you have ARexx, you'll almost
  39. certainly want to make ARexx scripts instead of CLI scripts.  For that, use
  40. an "address 'EDPLAYER'" type command.  Again, see your ARexx manual for
  41. more details.  NOTE:  rexx:Startup.EdP (the startup script)
  42. should ** NOT ** contain an "address 'EDPLAYER'" command!  It automatically
  43. addresses a special startup message port, so that programs waiting with
  44. wport or whatever don't mix their messages in before the startup script
  45. completes.  ANYWAY, for you people without ARexx, you're stuck making CLI
  46. scripts!  For this, use "telled" or "cteled" as described here:  NOTE!: the
  47. parameters are different.  Telled does NOT use quotes, while cteled DOES:
  48.  
  49. CORRECT:
  50.      >>>>   telled PLAY mod.cream of the earth
  51. ;Note that telled NEVER needs any quotes no matter how many spaces are
  52. ;in the line.
  53.  
  54.      >>>>   cteled "PLAY mod.cream of the earth"
  55. ;Note that cteled NEEDS quotes, and all parameters go in the SAME
  56. ;set of quotes, because EdPlayer will parse it, NOT cteled.
  57.  
  58.      >>>>   telled play mod.cream of the earth
  59. ;NEW for EdP v1.1: Commands are no longer case-sensitive,
  60. ;EXCEPT the "MIDL" command's parameter which needs to be
  61. ;case-sensitive for looking up a midi_destination.
  62.  
  63. INCORRECT:
  64.             telled "PLAY mod.test module"   ;telled NEVER needs quotes
  65.                    X                    X
  66.  
  67.             cteled "PLAY" "mod.test module" ;put ALL in one set of quotes
  68.                         X X
  69.  
  70. Well, I hope you can get the hang of that.  There should be some example
  71. scripts in the archive, for more examples of sending commands.
  72.  
  73. ----------------------------------------------------------------------------
  74.  
  75. Now it's time for a complete list of commands.  Note that you may give ANY
  76. of these commands to EdPlayer by (1) using the CLI/Shell to issue "telled"
  77. or "cteled" as shown above, or (2) send the commands via ARexx to the ARexx
  78. port "EDPLAYER" (port name is all caps).
  79.  
  80. I'll list the commands in the order they were created.
  81.  
  82. *** New for 2.0: Some commands are no longer 4 letters.  However, only the
  83.     first 4 letters of ANY command are needed.  Users complained that they
  84.     wanted to type "pause" instead of "paus", "eject" instead of "ejec",
  85.     etc.  You can now do this (a) for commands that need no parameters
  86.     (this was actulally an undocumented feature in previous versions),
  87.     and (b) for commands that accept numbers as parameters.  You may
  88.     NOT do it for commands that accept text as a parameter, such
  89.     as LOAD, PLAY, JUKE, and MIDL.  These commands still need to be
  90.     only 4 letters long, with ONE SPACE between them and their parameter.
  91.     (The exception is the MESS command, which can be extended to MESSAGE).
  92.  
  93. Commands are presented with the first four letters capitalized.  These
  94. letters are the only ones used by EdPlayer to identify the command.
  95. Any letters after them are optional, they are there just to make
  96. script files more readable.  For example, the command presented as "MESSage"
  97. may be sent to EdPlayer as "mess", as "message", or even as
  98. "messInTheHall".  EdPlayer only looks at the first 4 letters.
  99.  
  100. Parameters in [<brackets>] are optional.
  101.  
  102. Parameters in <these things> are required!
  103.  
  104. LOAD <filename>
  105.        This command is used to load a module into EdPlayer.  EdPlayer
  106.        automatically figures out what module type it is, but does not yet
  107.        start to play it.  This command can NOT be used with programs!  It
  108.        erases the current program.  If you want to use programs, see JUKE
  109.        below.  Anyway, LOAD will wait until the module finishes loading
  110.        before it returns, so it can report if there was an error or not.
  111.        Note:  ALWAYS use a FULL PATH with LOAD, because the current
  112.        directory of EdPlayer may not match the current directory of the
  113.        program sending the command.
  114.        NEW for EdP v1.1:  If you want to load a PP encrypted module, you
  115.        can do this:   LOAD volume:path/modulename|password
  116.        (Please note the LACK of spaces around the "|").
  117.        If you don't give a password when needed, a password requester opens.
  118.        query: see ANAM.
  119.  
  120. PLAY [<filename>]
  121.        This command can be used with or without the parameter.  If it is
  122.        given with no parameter, it will attempt to play the current song. 
  123.        If there is a parameter, it will call LOAD first, and then PLAY.  
  124.        This command will wait for the module to load, so it can report
  125.        errors like LOAD does, but it will return once the song begins to
  126.        play.  Note:  This is NOT the same as the PLAY button on the CD,
  127.        because there is no PAUSE feature here.
  128. ***    NEW for EdP v2.0:  If there is no current song, and no parameter,
  129.        but there IS a current program, PLAY will grab a name from the
  130.        program and use it.  To launch a program, I recommend PJUM, not PLAY.
  131.        see PAUS, CONT, PJUM, and NEXT.  query: see ANAM.
  132.  
  133. STOP
  134.        Stops the music immediately, just like the STOP button.
  135.  
  136. EJECt
  137.        Ejects the current song, un-loading it from your CHIP mem.
  138.        (Just like the EJECT button!)  Does nothing to your program.
  139.        see ERAS
  140.  
  141. VOLUme <volume>
  142.        Sets the music's volume, and affects the volume slide on the CD
  143.        player panel.  <volume> can be an integer from 0 to 64.
  144.        The default is 64, the loudest.
  145.        see FADE.  query: see AVOL.
  146.  
  147. PAUSe [<rate>]
  148.        This will pause the music.  If there is no parameter, the music will
  149.        pause immediately.  If there is a <rate>, then the music will fade
  150.        to a pause.  Common <rate>s are:  1 = Very slow, 2 = slow,
  151.        4 = initial default fade rate from CD panel, 8 = medium fast, 16 =
  152.        fast. Integers from 1 to 32 usually work OK.  NOTE: Entering a new
  153.        PAUSE rate may not affect the end-of-song fade-out rate, BUT, it
  154.        WILL set a new default for the panel's rate for everything.  So next
  155.        time someone uses the panel to fade something, it will happen in the
  156.        last-used <rate>.  This side-effect on the panel goes for ALL
  157.        EdPlayer commands that use <rate>, such as CONT, AUTO, FADE, etc.
  158.        see CONT.
  159.  
  160. CONTinue [<rate>]
  161.        This will make the music continue, if it has been PAUSed.  If no
  162.        <rate> is given, the rate from the last PAUS will be used.  For a
  163.        description of <rate>s, see PAUS.
  164.  
  165. FADEout [<rate>]
  166.        This is for fading the song to a STOP.  You cannot continue after
  167.        this!!  The <rate> works like in PAUS, except that if it is not
  168.        specified, it defaults to 4, taking the panel's rate to 4 along
  169.        with it, probably.  (Yet another feature that needs testing!)
  170.        NOTE: In program mode, at the end of a FADE, the next song is
  171.        loaded and played.  I often send this command when I'm bored
  172.        with one song and want to move to the next in a non-abrupt way.
  173.  
  174. AUTOfadeout [<rate>]
  175.        This command is for automatically getting a song (or program) to
  176.        stop at the end (this is the default when EdPlayer starts).  If no
  177.        <rate> is specified, the song will stop immediately when it reaches
  178.        the end, otherwise, the song will loop and start to fade to a stop
  179.        at the specified <rate>.  During programs, it will set the fade-out
  180.        rate at the end of each song, as well as telling the program not
  181.        to loop.  If you set this rate but still want your program to loop,
  182.        just issue a LOOP command afterwards.  For a descripton of <rate>s,
  183.        see PAUS.  query: see AFAD.
  184.  
  185. LOOP
  186.        The current song or program will loop and keep playing, instead of
  187.        stopping, when it reaches the end.  This is the opposite of AUTO.
  188.        query: see ALOP.
  189.  
  190. KILL
  191.        This has the same effect as pressing the "Power" button:  The
  192.        current song STOPs, gets EJECted, the program is erased, and then
  193.        EdPlayer exits the system, all very quickly.  It's a good idea to
  194.        ask the user if he/she wants this before you send a KILL command.
  195.  
  196. JUMP <position>
  197.        This is an interesting command.  It tells EdPlayer that on the next
  198.        position change (a position currently shows up as "POS" on the
  199.        CD panel), the music should jump to the specified position rather
  200.        than just proceeding to the next one.  My brother created a perfect
  201.        example of what this can be used for:  He wrote a module (in MED)
  202.        that had several sections, each section ending in a $B command for
  203.        looping.  Then he turned EdPlayer's LOOP on, and in a DeluxeVideoIII
  204.        presentation, had EdPlayer start playing this song.  Of course, it
  205.        got caught in the first looping section.  But then, as the
  206.        presentation continued (it was more like a game actually), he sent
  207.        JUMP commands to EdPlayer to play the different sections.  As the
  208.        user moved from one part to the next, the music changed to match the
  209.        current place in the game.  It was a really neat effect.  Anyway, if
  210.        this DVideo game ever becomes playable, I'm sure he'll distribute
  211.        it....
  212. *2.0*> ...NOT!!
  213.        My brother lost interest in DVideo after a few months and moved on...
  214.        see SJUM.  query: see APOS, ATOT.
  215.  
  216. SELFdestruct [<rate>]
  217.        This command works exactly like AUTO, except that at the end of the
  218.        song's fade-out, EdPlayer KILLs itself (exits the system).  I don't
  219.        think I ever updated this command for use with programs, because
  220.        quite frankly I never found a use for it myself.  If you use it, and
  221.        want it updated, tell me!
  222.        (Updating would mean having it wait for the end of a program, rather
  223.        than the end of a song, before the self-destruct.)
  224.        query: see ASEL.
  225.  
  226. NORMalmode
  227.        This command is kind of left over from previous versions.  If you
  228.        have an NTSC machine, this runs the NTSC command, and if you have
  229.        a PAL machine, this runs the PALM command.
  230.        see NTSC, PALM.  query: see ATEM.
  231.  
  232. NTSCmode
  233.        This command is here for those old NoiseTracker mods that sound
  234.        better when played at the NTSC tempo (sped up a bit).  Most mods
  235.        use PAL timing, and ALL ProTracker mods use PAL.  MED mods are not
  236.        affected by PALM and NTSC.
  237.        see NORM, PALM.  query: see ATEM.
  238.  
  239. PALMode
  240.        This command sets the tempo to PAL timing, which is now the
  241.        default for EdPlayer.
  242.        see NORM, NTSC.  query: see ATEM.
  243.  
  244. MENU
  245.        This command will bring up EdPlayer's CD-like control panel if it's
  246.        not visible, and redraw it if it is.  The EdPlayer version
  247.        information will be re-displayed.  Whether or not EdSynth appears
  248.        at the same time depends on the most recent SYNTh command.
  249.        see ICON, HIDE, SYNT.  query: see AMOD, ASYN.
  250. *2.1*> For EdPlayer Junior, this command returns error #3.  There is no
  251.        panel in EdPlayerJr.
  252.  
  253. ICONify
  254.        This command will close the CD display and create the iconified WB
  255.        window that also appears when someone presses the "ICONIFY" button
  256.        or starts EdPlayer with the -i option.  Selecting this WB window
  257.        and pressing the right mouse button will bring back the CD panel.
  258.        see MENU, HIDE.  query: see AMOD.
  259.  
  260. HIDE
  261.        This command will remove EdPlayer's user interface altogether, as if
  262.        you had started EdPlayer with the -h option.  This allows WB to be
  263.        closed if necessary, but is not really recommended because the user
  264.        has no way to undo this using the mouse alone.  It can only be
  265.        undone with the MENU or ICON commands, above.
  266.        see MENU, ICON.  query: see AMOD.
  267.  
  268. MIDI
  269.        This is for direct MIDI on MED modules.  If any midi.library
  270.        resources have been allocated, they are deallocated and the library
  271.        is closed.  Then, EdPlayer tries to allocate the serial port for
  272.        direct MIDI output, using the default MED MIDI routines.  This is
  273.        the mode that the MIDI button on the panel uses.  Safe to call even
  274.        when a module is playing, because a playing MED module will be
  275.        paused VERY briefly during the allocation & init of the MIDI stuff.
  276.        see NOMI, MIDL.  query: see AMID.
  277.  
  278. NOMIdi
  279.        NO MIdi.  Deallocates any and all MIDI-related resources, such as
  280.        the midi.library or serial port.  Safe to call even when a module
  281.        is playing.
  282.        see MIDI, MIDL.  query: see AMID.
  283.  
  284. MIDL [<midi_destination>]
  285.        (Don't put extra characters on the end of the MIDL command).
  286.        MIDi.Library.  If you own the midi.library by Bill Barton, you can
  287.        use this command to take over MED's MIDI output:  Instead of
  288.        allocating and directly controlling the serial port, EdPlayer will
  289.        attempt to open the midi.library and create a "midi source" called
  290.        EDPLAYER.  Then, if there is a parameter, EdPlayer will try to make
  291.        a "Midi Route" from its source to a destination of the name
  292.        specified in the parameter.  This means that if you do NOT give a
  293.        parameter, you must create your own route with a Patch Bay before
  294.        anything can happen.  The "standard" use of this command would be
  295.        "MIDL MidiOut" because MidiOut is the standard midi.library output
  296.        to the serial port.  However, there are more useful options if you
  297.        are multitasking with other applications that use midi.library, and
  298.        want to recieve MIDI data from EdPlayer.  For instance, if you had a
  299.        MIDI monitor called "MidiMon", you could send Edplayer a
  300.        "MIDL MidiMon" to monitor EdPlayer's MIDI output.  Like the other
  301.        MIDI commands, it is safe to call MIDL even when a module is
  302.        playing, and MIDL works differently based on what resources are
  303.        already allocated.  For instance, if the serial port is allocated
  304.        when you call MIDL, it will be dumped so that midi.library can open.
  305.        Also, if midi.library was ALREADY open, MIDL won't close or re-open
  306.        it or the EDPLAYER midi_source.  It will, however, erase the old
  307.        midi route and make a new one, because routes can become useless if
  308.        their destination disappears.
  309.        NOTE that MIDL's parameter is CASE-SENSITIVE!
  310.             Use MidiOut, not MIDIout etc.  This is because midi.library
  311.             itself uses case-sensitive midi_destinations.
  312.        see MIDI, NOMI.  query: see AMID.
  313.  
  314. PREVious
  315.        EJECts current song, moves to previous song in program, and tries to
  316.        load AND PLAY it.  PREV waits for the load to complete before
  317.        returning, so it can result in all the usual load errors (file not
  318.        found, out of mem, etc.) as well as the "no program" error.  Note
  319.        that the PREV "|<" button on the panel does not work exactly like
  320.        this, because it does not automatically try to load and play.
  321.        see NEXT, JUKE, PJUM.  query: see APRG.
  322.  
  323. NEXT
  324.        Like PREV, but moves to NEXT program selection instead of
  325.        previous one.  NOTE: If RANDOM mode is ON, then this command will
  326.        send you to a random song!
  327.        NOTE:  This command used to be used for starting programs.  I now
  328.        recommend using PJUM with no parameters to start programs.  See
  329.        PJUM for the reasons.
  330.        see PREV, JUKE, PJUM, RAND.  query: see APRG.
  331.  
  332. JUKE <filename>
  333.        (Don't put extra characters on the end of the JUKE command.
  334.         For instance, "Jukebox" is NOT a command).
  335.        This is the way to make EdPlayer programs from an ARexx or CLI
  336.        (telled) script.  Each call to JUKE adds the one <filename>
  337.        parameter to the end of the current program.  It's a good idea to
  338.        include the full path in this filename, because EdPlayer's current
  339.        directory may not be the same one that the script file with the
  340.        JUKEs is executing from.  Once a program is created (by a series of
  341.        "JUKE"s), the program can be started by a call to "PJUM".
  342.        NEW for EdP v1.1:  If you want to load a PP encrypted module, you
  343.        can do this:   JUKE volume:path/modulename|password
  344.        (Please note the LACK of spaces around the "|").
  345.        If you don't give a password for a mod that needs it, a password
  346.        requester opens each time the mod is loaded.  If you give a wrong
  347.        password, you will get error #5, and no requester opens.
  348.        see PREV, NEXT
  349.  
  350. * NEW COMMANDS in EdP v1.1: *
  351.  
  352. DCOLor <decrunch color>
  353.        If you have powerpacked modules, and if you're *NOT* using
  354.        PowerPatch or some such stuff, then you can control the effect
  355.        displayed by powerpacker.library when decrunching your files.
  356.        Possible <decrunch color>s are the same as PP.lib uses:
  357.          0 = flash palette 0 on all screens
  358.          1 = flash palette 1 on all screens (EdPlayer's default)
  359.          2 = flash the mouse pointer
  360.          3 = do WEIRD FUNNY THINGS with the screen (I don't like this one)
  361.          4 = NO decrunch effect.  It just sits there, quietly decrunching.
  362.        query: see ACOL.
  363.  
  364. ERASe
  365.        Nobody asked for this command, but I thought it would be more than
  366.        useful...    It erases the current program.  POOF.  Gone.
  367.        It does nothing to the current song however, so I suggest calling
  368.        both ERAS and EJEC if you want a clean sweep!
  369.        query: see APTO.
  370.  
  371. *** NEW COMMANDS in EdP v2.0: ***
  372.  
  373. * The PLAY command changed a bit.  Now, if PLAY is issued with no
  374.   parameters, and there is no current song, PLAY will look in the current
  375.   program before giving up.  However, to start program scripts, I recommend
  376.   PJUM over play.
  377.  
  378. FREQuester <frq number>
  379.        File Requester preference.  If you have more than one recognised
  380.        file requester in your LIBS: directory, this command lets you
  381.        pick which one you want to use.  To get <frq number>, pick a
  382.        LIBRARY NUMBER from below, and add to that number any
  383.        LIBRARY FLAGS you want.
  384.  
  385.             LIBRARY NUMBERS:  (choose one of these numbers)
  386.               0 = kd_freq.library
  387.              16 = req.library
  388.              32 = asl.library
  389.              [others may appear in future versions]
  390.  
  391.             LIBRARY FLAGS:  (add none/some/all of these to above chosen #).
  392.               1 = No shadows under text.  (affects: kd_freq.library)
  393.               2 = Use default size, not big size (affects: kd_freq, asl)
  394.               [more flags may appear in future versions]
  395.  
  396.        For example, to use kd_freq.library with no shadowtext and a big
  397.        window, use (library #0) + (flags #1) =  'FREQ 1'.
  398.        To use a small asl requester, use (library #32) + (flags #2)
  399.        = 'FREQ 34'.
  400.        query: see AFRQ.
  401.  
  402. SAVC <filename>
  403.        Save current program as a CLI script.
  404.        Don't put extra characters on the end of the SAVC command.
  405.        This takes the current EdPlayer program, and saves it to disk as
  406.        <filename>.  WARNING:  There are no requesters or such if saving
  407.        the program with this name would overwrite an existing file.
  408.        Please be careful.  To load a program saved with SAVC, make sure
  409.        that the program "telled" is in your path, and from CLI type:
  410.            execute <filename of program to load>
  411.        Note that these programs do not load as fast as programs
  412.        saved with SAVA.
  413.        Also note that the status of the LOOP and RANDOM LEDs are saved
  414.        with the program.
  415.        see SAVA.
  416.  
  417. SAVA <filename>
  418.        Save current program as an ARexx script.
  419.        Don't put extra characters on the end of the SAVA command.
  420.        This does almost the same thing that SAVC does (and hence the same
  421.        WARNING applies), but to load the saved program requires ARexx,
  422.        and is done like this:
  423.            rx <filename of program to load>
  424.        Also, if you want to load a program and start playing from
  425.        song number 16 (for example), you can say:
  426.            rx <filename> 16
  427.        Generally, these programs should be saved to the REXX: directory
  428.        with names ending in .rexx, like this: "SAVA REXX:myprogram.rexx"
  429.        For programs with 40 songs or more, the speed increase of loading
  430.        SAVA programs over loading SAVC programs becomes quite noticable.
  431.        Also note that the status of the LOOP and RANDOM LEDs are saved
  432.        with the program.
  433.        see SAVC.
  434.  
  435. PJUMp [<song number>]
  436.        This command has two functions.  One is jumping to arbitrary songs
  437.        in a program.  When the <song number> is provided, the current song
  438.        stops immediately, and EdPlayer goes to the specified song in the
  439.        program and plays from there.  Note that if the <song number> is 0,
  440.        EdPlayer will stop the program and set the current song to "--",
  441.        where it waits for more input.
  442.          The other function this command does, is when no <song number>
  443.        is provided, EdPlayer just tries to get some music from a program
  444.        up and playing.  I'm sorry this is such an obvious kludge to make
  445.        a nice command to put at the end of program scripts, but it was
  446.        needed.  The main difference between this and the new PLAY command,
  447.        is that this command is satisfied as soon as music is playing.
  448.        So, if a song is already playing when you issue PJUM, then PJUM
  449.        has no effect, whereas PLAY would reset the song to the beginning.
  450.        Also, if a song played and stoped, and THEN a program was loaded,
  451.        a PJUM at the end of the program script would eject the stopped
  452.        song and move into the program, whereas a PLAY in that place would
  453.        have played the current song a second time.  As you can see, it
  454.        is much better to have a PJUM at the end of your program scripts
  455.        than a PLAY.  PJUM is used by SAVC and SAVA in saved program files.
  456.        see PLAY, SAVC, SAVA.  query: see APRG, APTO.
  457.  
  458. SJUMp <position>
  459.        SuperJUMP.  This command is like JUMP, but its effect is immedeate,
  460.        rather than delayed until the next position change.  With this
  461.        command, you can instantly jump to any position in the song.
  462.        (Actually, its effect is delayed until the next line change, but
  463.        lines usually go by so fast no one should notice this).
  464.        This command also has the ability to jump right into the middle
  465.        of a song.  For example, suppose you LOAD a song and then want
  466.        to start from position 8 rather than from the beginning.  A quick
  467.        'SJUM 8' will get you there.
  468.        see JUMP.  query: see APOS, ATOT.
  469.  
  470. FILTer <filter>
  471.        This controls the audio filter and whether or not EdPlayer will
  472.        override the song's control of it.  For <filter>, use one of these:
  473.            0 = Override turned ON, filter turned OFF.
  474.            1 = Override turned ON, filter turned ON.
  475.            2 = Override turned OFF, filter turned OFF.
  476.            3 = Override turned OFF, filter turned ON.
  477.            4 = Override turned OFF.  (no effect on filter).
  478.        query: see AFIL.
  479.  
  480. DISPlaymode <displaymode>
  481.        This controls the display mode.  Select a number from each:
  482.                 TABLE 1:
  483.                   0 = Prg#, Pos, Total display
  484.                   1 = Line, Pos, Patt display
  485.                   2 = Time (with AM/PM) display
  486.                   3 = Date (month/day/year) display
  487.                 TABLE 2:
  488.                   0 = VU meters 0,1,2,3 (Left, Right, Right, Left)
  489.                   4 = VU meters 0,3,2,1 (Left, Left, Right, Right)
  490.                   8 = Spectrum Analyzer
  491.        Pick one choice from Table 1, and one choice from Table 2.
  492.        Then, ADD their numbers together!  That gives you the
  493.        number to put next to the DISP command.  For example, if
  494.        you wanted a Spectrum Analyzer with Line/Pos/Patt display,
  495.        you would add 8 and 1 to get 'DISP 9'.
  496.        query: see ADIS.
  497.  
  498. MCOLor <0 or 1>
  499.        This tells EdPlayer whether or not to try to extract
  500.        RGB color info from MED mods and apply it to the CD panel.
  501.        This will not work on mods older then MED 3.20.
  502.            0 = normal colors, 1 = extract MED mod colors.
  503.        NOTE: Obviously, some remapping of the colors is done, so
  504.        that colors that look good in MED will usually look ok on
  505.        EdPlayer as well.
  506.        This command has no effect on NT/PT mods or MED mods without RGB.
  507.        query: see MCOL.
  508.  
  509. RANDom <0 or 1>
  510.        This turns random mode on (1) and off (0) for the current program.
  511.        This setting is saved with a program when you use SAVC or SAVA.
  512.        When random mode is on, songs play in random order, and the NEXT
  513.        command goes random places, as does the ">|" gadget on the panel.
  514.        If the current program is larger than 5 songs, EdPlayer keeps
  515.        track of the last 4 songs selected by the random fuction,
  516.        and makes sure it does not play the same song twice in a row.
  517.        see NEXT.  query: see ARND.
  518.  
  519. MESSage [<message>]
  520.        This is a very simple command, that I added mostly because it only
  521.        took about 20 bytes to program it :-).  It takes whatever <message>
  522.        you give it, and displays it in the scroll bar under the CD panel.
  523.        If the panel is not open, this command does nothing.  If no
  524.        <message> is provided, it displays the song name & author info.
  525.        NOTE that you can add colors and things to your message with the
  526.        "special effects" characters listed in the BUTTONS section under
  527.        Info Bar.
  528.        query: see ANAM.
  529.  
  530. LPRIority <pri>
  531.        This controls what EdPlayer's task priority will be while
  532.        loading or decrunching a song.  It only accepts 0 or
  533.        negative numbers as input.  The default is 0, but you
  534.        could change this to -5 or such if you wanted EdPlayer
  535.        not to strangle the CPU during a mod decrunch.  BEWARE,
  536.        if you multitask EdPlayer with a Ray Tracer, Fractal
  537.        Generator, or some other CPU-intensive task while this
  538.        priority is negative, EdPlayer may not be able to get
  539.        any CPU time to load the next module with!!  EdPlayer
  540.        would then freeze until the ray trace was done.  So, new
  541.        users are advised to keep their hands off this one.
  542.        If you already know about Amiga task priorities, then
  543.        you can change this, but please be careful.
  544.        query: see APRI.
  545.  
  546. SWAIt [<pos>]
  547.        Song wait.
  548.        This is a VERY cpu-friendly way to wait for a song to finish or
  549.        reach a certain point.  Any script that sends an SWAI will then
  550.        wait until EdPlayer returns the SWAI (careful, there is no
  551.        Ctrl-C or anything to get out of this, but pressing STOP on
  552.        EdPlayer will do the trick).  EdPlayer returns an SWAI when
  553.        EdPlayer's position in the current song reaches or passes the
  554.        <pos> given by the SWAI.  If the <pos> is higher than the highest
  555.        position in the song, or if no <pos> was given, EdPlayer hangs
  556.        on to the SWAI until the song ends.  If the current song ends,
  557.        for _ANY_ reason, _ALL_ remaining SWAI messages are returned.
  558.        You may have any number of SWAI and PWAI messages queued up in
  559.        EdPlayer at the same time; normal ARexx/telled message processing
  560.        will continue for other scripts.
  561.        see: PWAI.  query: see APOS, ATOT.
  562.  
  563. PWAIt [<song>]
  564.        Program Wait.
  565.        This is a VERY cpu-friendly way to wait for a program to finish or
  566.        reach a certain song.  Any script that sends a PWAI will have
  567.        to wait until EdPlayer returns the PWAI (careful, there is no
  568.        Ctrl-C or anything to get out of this, but erasing the program on
  569.        EdPlayer will do the trick).  EdPlayer returns a PWAI when
  570.        the current program reaches or passes the given <song> number.
  571.        (NOTE: For random programs, PWAI is almost useless).  If the
  572.        <song> number is higher than the highest song in the program,
  573.        or if no <song> was given, EdPlayer hangs on to the PWAI until
  574.        the program ends.  If the current program ends or gets erased,
  575.        _ALL_ remaining PWAI messages are returned.
  576.        You may have any number of SWAI and PWAI messages queued up in
  577.        EdPlayer at the same time; normal ARexx/telled message processing
  578.        will continue for other scripts.
  579.        see: SWAI.  query: see APRG, APTO.
  580.  
  581. SYNTh <0 or 1>
  582.        Controls the appearence of EdSynth.
  583.        0 = hidden, 1 = displayed in lo-res, 2 = displayed in HIRES/Interlace
  584.        This command takes effect instantly if EdPlayer's CD panel is
  585.        already open.  However, if the panel is NOT open, this command
  586.        merely records what display mode EdSynth will be in the next time the
  587.        panel is opened.  A description of EdSynth is in the BUTTONS section.
  588.        see: MENU  query: see ASYN.
  589.  
  590. *** NEW commands for EdP 2.1:
  591.  
  592. DMAWait <value>
  593.        This command allows you to adjust the audio timing used in the
  594.        ProTracker replay routines.  The PT replay routines in EdPlayer
  595.        don't use a CPU busy-loop, instead, they call the _wait1line
  596.        subroutine from the MED replay routines.  In EdPlayer 2.0, they
  597.        would always call this routine with a value of 120.  However, for
  598.        some systems, this value was not high enough and EdP would skip
  599.        notes in ST/NT/PT mods.  So, this command lets you change the
  600.        value.  If EdPlayer seems to be skipping notes, you might want
  601.        to call DMAWait with a higher <value> like 160 or 180.  The higher
  602.        value you use, the less chance there is of note loss.  BUT, if you
  603.        go too high, the system will suffer:  the decrease in CPU time may
  604.        start to become noticable, and modem usage may get errors or
  605.        cause EdPlayer to drag the tempo down.  Any <value> 10 or higher
  606.        will be accepted by this command, so if you're really trying to
  607.        crash your computer, you can enter something in the millions.
  608.        NOTE: This command only affects playback of ST/NT/PT mods.
  609.              It has no effect on MED mods.
  610.        query:  see ADMAwait.
  611.  
  612. ============================= ARexx queries: ===============================
  613.  
  614. This is the ARexx query part of the AREXX/TELLED section.  To use queries,
  615. you MUST have ARexx running, because all queries return RexxArg strings.
  616. To send a query from an ARexx script, use OPTIONS RESULTS and read
  617. the variable RESULT after the query returns.  To send a query from the
  618. CLI while ARexx is running, use the provided AskEd.rexx script.  Ex:
  619.      rx AskEd <query>
  620. That will print the result in your CLI window.  AskEd.rexx is also a good
  621. example of how to put queries in your own scripts.
  622.  
  623. NOTE: ARexx queries do NOT work through telled or cteled, because those
  624.       programs do not make use of ARexx.
  625.  
  626. ANAMe
  627.        Ask Name.  This returns the name and author info of the current
  628.        song.  NOTE:  This is NOT to be used as a filename!  It may have
  629.        author info in it.
  630.  
  631. AVOLume
  632.        Ask Volume.  Returns the current volume.
  633.        see VOLU.
  634.  
  635. AFADe
  636.        Ask Faderate.  Returns the current fade rate, or 0 for no fade.
  637.        the result from this may be used in a later AUTO command.
  638.        see AUTO.  Other queries: see ALOP.
  639.  
  640. ALOP
  641.        Ask LOOP.  Returns 1 if LOOP is on, or 0 if LOOP is off.
  642.        see LOOP, AUTO.  Other queries: see AFAD.
  643.  
  644. ASELfdestruct
  645.        Ask Self-Destruct.  Returns 1 if EdPlayer plans to kill itself after
  646.        the current song finishes, or 0 otherwise.
  647.        see SELF.
  648.  
  649. ATEMpo
  650.        Ask Tempo.  Returns a string: NTSC or PALM.  This string may later
  651.        be passed as a command to restore the tempo to what it was when ATEM
  652.        was issued.
  653.        see NTSC, PALM, NORM.
  654.  
  655. AMODe
  656.        Ask Mode.  Returns a string: MENU, ICON, or HIDE.  This string may
  657.        later be passed as a command to restore the user interface to what
  658.        it was when AMOD was issued.
  659.        see MENU, ICON, HIDE.  Other queries: see ASYN.
  660.  
  661. AMIDi
  662.        Ask MIDI.  Returns 0, 1, or 2.  0 = No MIDI is active, 1 = MIDI is
  663.        going direct to the serial port, and 2 = MIDI is going into the
  664.        midi.library (via MIDL).
  665.        see NOMI, MIDI, MIDL.
  666.  
  667. ACOLor
  668.        Ask color.  Returns the decrunch color to be used by powerpacker.
  669.        This number may later be used in DCOL to restore the color.
  670.        see DCOL (for meanings of color numbers).
  671.  
  672. AFRQ
  673.        Ask file requester.  Returns the last number sent to FREQ (0 is
  674.        the default).
  675.        see FREQ.
  676.  
  677. AFILter
  678.        Ask filter.  Returns a number from 0 to 3, showing the status
  679.        of the filter and the filter override.  This number may later be
  680.        used in FILT to restore the filter and its override.
  681.        see FILT (for the meanings of the numbers 0 to 3 here).
  682.  
  683. ADISplay
  684.        Ask Displaymode.  Returns a number showing the status of the LED
  685.        display (both digits and bars).  This number may later be used
  686.        in DISP to restore the display mode.
  687.        see DISP.
  688.  
  689. AMCOlors
  690.        Ask MED colors.  Returns 1 if EdPlayer is trying to use RGB color
  691.        tables found in MED mods, or 0 if EdPlayer is just keeping a normal
  692.        palette.  NOTE:  This always returns 1 if the last MCOL command
  693.        was a 1, regardless of whether or not EdPlayer has actually found
  694.        any nonstandard colors to use.
  695.        see MCOL.
  696.  
  697. ARND
  698.        Ask Random mode.  Returns 1 if EdPlayer is playing songs in random
  699.        order, or 0 if EdPlayer is playing songs sequentially.
  700.        see RAND.
  701.  
  702. APRIority
  703.        Ask Load priority.  Returns the task priority that EdPlayer uses
  704.        when loading and decrunching modules.
  705.        see LPRI.
  706.  
  707. APOSition
  708.        Ask POS.  Returns the position in the song, like the "POS" display
  709.        on the panel.  NOTE: DO NOT wait for a position in a song by
  710.        calling APOS until it returns a given number.  This will EAT UP
  711.        ALL OF YOUR CPU TIME!  To wait for a position, use SWAI!
  712.        see SWAI, JUMP, SJUM.  Other queries: see ATOT.
  713.  
  714. ATOTalpositions
  715.        Ask total positions.  Actually, this returns the number of the
  716.        highest position in the song, which technically is one less than
  717.        the total positions in the song.  However, it IS the same number
  718.        that appears above "TOTAL" on the panel during a song.  It is
  719.        also the greatest number you can legally send to JUMP or SJUM.
  720.        see JUMP, SJUM.  Other queries: see APOS.
  721.  
  722. APRGnum
  723.        Ask program number.  Returns the number of the current song in the
  724.        program.  NOTE: DO NOT wait for a song in a program by calling
  725.        APRG until your song is playing.  This will EAT UP ALL OF YOUR
  726.        CPU TIME!!  To wait for a given song, use PWAI.
  727.        see PWAI, PJUM.  Other queries: see APTO.
  728.  
  729. APTOtal
  730.        Ask program total.  Returns the total number of songs in the
  731.        current program.  This also happens to be the number of the highest
  732.        song you can PJUM to.
  733.        see PJUM.  Other queries: see APRG.
  734.  
  735. *** NEW Queries for EdPlayer 2.1: ***
  736.  
  737. AVERsion
  738.        Ask current version of EdPlayer.  This query was mostly added for
  739.        the benefit of EdPlayer Junior, which doesn't have a main panel
  740.        to display the version number on.  It returns a string like this:
  741.               EdPlayer version x.x by Ed Mackey
  742.        or
  743.               EdPlayerJunior version x.x by Ed Mackey
  744.        Note that for any given release, EdPlayer and EdPlayer Junior
  745.        will have the same version number.  This is so you can keep them
  746.        together.  Note also that there is no space in EdPlayerJunior,
  747.        so you can use the ARexx function WORD(version,3) to get
  748.        just the bare version number if you like.
  749.  
  750. AERRor <number>
  751.        Ask for a short description of a certain error <number>.  This
  752.        returns the same string that would be printed to the panel
  753.        if this error had occoured.  The DOCs have much better
  754.        descriptions, but I thought this would be useful for something.
  755.  
  756. APLAying
  757.        This is a feature I forgot to put in EdPlayer 2.0.  It returns
  758.        a number like this:
  759.             0 = no song loaded
  760.  
  761.             4 = PT-MOD loaded but STOPped.
  762.             5 = PT-MOD loaded and playing.
  763.             6 = PT-MOD loaded and paused.
  764.  
  765.             8 = MED mod loaded but STOPped.
  766.             9 = MED mod loaded and playing.
  767.            10 = MED mod loaded and paused.
  768.        The numbers were chosen for easy parsing of bitfilds, for you
  769.        binary-heads.  Note that if EdPlayer recieves a PAUSe command,
  770.        and is in the process of fading the music to a pause, this
  771.        query may still report "playing" (5 or 9) and won't report
  772.        "paused" (6 or 10) until after the music has faded all the
  773.        way out and is truly paused.
  774.  
  775. ADMAwait
  776.        Returns the most recent value sent to DMAWait.
  777.        see DMAW.
  778.  
  779. *End of ARexx commands and queries.
  780.