home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / mcip100.zip / readme < prev   
Text File  |  1999-01-01  |  11KB  |  293 lines
  1.  
  2.                          MCI Processor V1.00 Readme
  3.                          ==========================
  4.  
  5. Contents
  6. ========
  7. 1. What is the MCIP package for ?
  8. 2. Install and usage of MCIP
  9. 3. Prerequisites/Restrictions/Limitations
  10. 4. Freeware license
  11. 5. Disclaimer
  12. 6. Check the archive integrity with
  13.    Pretty Good Privacy (PGP)
  14. 7. Author
  15.  
  16.  
  17.  
  18.  
  19. 1. What is the MCIP package for ?
  20. =================================
  21.  
  22. The MCI Processor (MCIP) provides a simple and easy to use way
  23. of writing batch files to control multimedia devices via the
  24. Media Control Interface (MCI).
  25.  
  26. Without this program, you would have either to write C program
  27. s or REXX scripts, in which you would send string commands  to
  28. the MCI. Instead, this package saves you from programming C or
  29. REXX for this task, but instead lets you deal with the MCI
  30. commands only.
  31.  
  32.  
  33.  
  34. 2. Install and configure MCI Processor
  35. ======================================
  36.  
  37. The package comes with the following files
  38.  
  39. readme               - you are reading this file
  40. file_id.diz          - package description file
  41. mci.cmd              - The MCI Processor
  42.                        -> place in a directory included in your
  43.                           PATH statement
  44. mcipm.cmd            - The "PM version" of MCI. It simply calls
  45.                        MCI.CMD from PM REXX. This is needed for
  46.                        playing video files.
  47.  
  48. samples\cd\*.cmd     - MCI sample files for playing audio CDs
  49.  
  50. samples\video\*.cmd  - MCI sample files for playing video files.
  51.                        In the current version PM REXX is used to
  52.                        display video files. This opens the PM
  53.                        REXX console window, which currently
  54.                        cannot be hidden. A forthcoming version
  55.                        will include a PM interface, that does
  56.                        not require to open an extra PM window,
  57.                        as PM REXX does.
  58.  
  59.  
  60. Copy MCI*.CMD to a directory within your PATH statement. Place
  61. the MCI sample CMD files to a directory of your choice. Then
  62. change to this directory (important !) and you can execute them.
  63.  
  64.   Note:
  65.   -----
  66.  
  67.    - MCI Command Documentation
  68.      -------------------------
  69.      The section "Command List" of the online book MCIREXX give
  70.      s a detailed list of the commands that you can use in MCI
  71.      command files.
  72.      All other programming topics (functions etc.) of this
  73.      online book are already covered by the MCI Processor
  74.      (MCI.CMD), so that you do not have to deal with them.
  75.  
  76.      Execute
  77.         start view MCIREXX "Command List"
  78.      to view this section. More, see the comments within the
  79.      sample MCI cmd files for explanations.
  80.  
  81.  
  82.    - special MCI processor commands
  83.      ------------------------------
  84.      Beside the MCI commands, MCI Processor implements the
  85.      following additional commands:
  86.  
  87.      ECHO           - works like in conventional batch
  88.                       programming except that a ^ character as
  89.                       the last character of a line lets MCI.CM
  90.                       D not append a CRLF, but a single space
  91.                       character (see getvol.cmd etc)
  92.      GOTO <label>   - works like in conventional batch
  93.                       programming
  94.      PAUSE          - works like PAUSE in conventional batch
  95.                       programming except that a different prompt
  96.                       can be specified:
  97.                       Syntax:
  98.                         prompt [message]
  99.  
  100.      PLAYTRACK      - plays a track.
  101.                       Syntax:
  102.                         playtrack <device> trackno [wait] [repeat]
  103.      TRACE          - lets MCI.CMD display all commands on
  104.                       execution
  105.  
  106.  
  107.    - environment variables support
  108.      -----------------------------
  109.      More, MCI Processor also supports environment variables.
  110.      Just enclose them with percent characters, like you do in
  111.      conventional batch programming. In addition to the existing
  112.      environment variables.
  113.  
  114.      MCI sets the following environment variables:
  115.  
  116.       %MCI_CALLDRIVE%  - drive of MCI source file
  117.       %MCI_CALLDIR%    - directory of MCI source file
  118.       %MCI_BOOTDRIVE%  - drive of OS/2 installation / bootdrive
  119.       %MCI_MMPMDRIVE%  - drive of MMPM installation
  120.       %MCI_MMPMDIR%    - directory of MMPM installation
  121.  
  122.  
  123.    - Hints on asynchronous play
  124.      --------------------------
  125.  
  126.      No access across session boundaries
  127.      - - - - - - - - - - - - - - - - - -
  128.      A multimedia device opened within one session (process)
  129.      cannot be accessed in a separate session. So you cannot
  130.      start play in one OS/2 window and try to stop it in anothe
  131.      r OS/2 window. The command file being executed to stop pla
  132.      y will report, that you are using an invalid alias, becaus
  133.      e it is known only to the session, that the play has been
  134.      started in.
  135.  
  136.      No asynchronous play in child processes
  137.      - - - - - - - - - - - - - - - - - - - -
  138.      Multimedia play requires the session to stay open, where
  139.      the play started. This is most important if you call MCI
  140.      command files from within WPS folders or file commander
  141.      programs. Here batch files, which start play
  142.      asynchronously, will do that, but after that the batch is
  143.      finished and the session will close - and so the play will
  144.      stop.
  145.  
  146.      If you want to start MCI command files from WPS icons or
  147.      file commander sort of programs, you have to code these
  148.      command files that way, that they play synchronously, that
  149.      is, that they wait for the end of the play. The only
  150.      drawback is, that you have no access from a program
  151.      outside e the session anymore, and that the program in that
  152.      session is blocked by the multimedia play. For CD play you
  153.      can play without "wait" option and use the special MCIP
  154.      command PAUSE, so that the session playing the CD is not
  155.      blocked by the play, but by the keyboard, then at least the
  156.      user can stop the play by pressing a key.
  157.  
  158.      Special Note: It seems not to be possible to play a video
  159.      file without the "wait" option. This means that you cannot
  160.      play video files asynchronously at all. Instead, you can
  161.      use the OS/2 command START to start the play in a separate
  162.      session. The only drawback is, that you cannot stop the
  163.      play anymore, because you don't have access to a multimedia
  164.      device opened within another session.
  165.  
  166.    - the first line of MCI cmd files must look like this
  167.        extproc mci
  168.      or
  169.        extproc mcipm
  170.      where the latter is required for playing video files.
  171.      This tells CMD.EXE not to execute the cmd file itself, but
  172.      instead to call an external batch processor named MCI or
  173.      MCIPM with the name of the MCD cmd file, so that MCI.CMD
  174.      can execute it.
  175.  
  176.    - if you do not want to use the extproc feature, you can also
  177.      execute an mci script file with the following command
  178.        mci <scriptfile>
  179.      or
  180.        mcipm <scriptfile>
  181.  
  182.      In this case you can use another filename extension than
  183.      .CMD, and for that the file extension .MCI is recommended.
  184.  
  185.    - Due to a bug in the extproc command, an MCI command file
  186.      executed as a .CMD file must reside in the current
  187.      directory.
  188.  
  189.      The problem is, that EXTPROC does not report the fully
  190.      quallified name of the .CMD file to an external batch
  191.      processor, but only the filename without drive and path
  192.      specification. This way MCI.CMD/MCIPM.CMD cannot find the
  193.      script file, if it is not located in the current directory.
  194.  
  195.  
  196.  
  197. 3. Prerequisites/Restrictions/Limitations
  198. =========================================
  199.  
  200. This package requires the Multimedia Presentation Manager
  201. (MMPM/2) and REXX being installed.
  202.  
  203. Note:
  204. -----
  205. - This package has not been tested with Object Rexx,
  206.   but only with classic REXX. If problems occur, please
  207.   send me a report.
  208. - MCI scripts must reside in the current directory (EXTPROC bug)
  209. - if you want to interrupt syncronous play, hit Ctrl-Break
  210.   twice. This is an implementation bug in REXX, that does not
  211.   handle Ctrl-Break properly, when an external routine (here:
  212.   mciRxSendString) is being called. Normally one Ctrl-Break should
  213.   be sufficient.
  214. - Video files are being played using PM REXX.
  215.   This opens the PM REXX console window, which currently cannot
  216.   be hidden. A forthcoming version will include a PM interface,
  217.   that does not require to open an extra PM window, as PM REXX
  218.   does.
  219.  
  220.  
  221.  
  222. 4. Freeware license
  223. ===================
  224.  
  225. This software package is freeware.
  226. It can be used wherever you use OS/2 WARP Version 3 or later.
  227.  
  228. You are allowed to freely use and distribute MCI Processor as
  229. long as
  230.  
  231.  -  MCI Processor is not sold as a part of another program
  232.     package;
  233.  -  no fee is charged for the program other than for cost of
  234.     media;
  235.  -  the complete package is distributed unmodified in the
  236.     original and unmodified zip file;
  237.  -  you send me some e-mail telling me how you liked it (or
  238.     didn't like it), and/or your suggestions for enhancements.
  239.  
  240.  
  241.  
  242. 5. Disclaimer
  243. =============
  244.  
  245. Since this program is free, it is supplied with no warranty,
  246. either expressed or implied.
  247.  
  248. I disclaim all warranties for any damages, including, but not
  249. limited to, incidental or consequential damage caused directly
  250. or indirectly by this software.
  251.  
  252. All software is supplied AS IS. You may use the MCI Processor
  253. package only at your own risk.
  254.  
  255. MCI Processor must not be used in states that do not allow the
  256. above limitation of liability.
  257.  
  258.  
  259.  
  260. 6. Check the archive integrity with
  261.    Pretty Good Privacy (PGP)
  262. ===================================
  263.  
  264. On my homepage I provide a detached signature certificate,
  265. with which you can verify, that you downloaded an unmodified
  266. version of this archive.
  267.  
  268. See my web pages also
  269. - for links to PGP sites, where you can obtain further
  270.   information on what PGP is and how you can install and use it
  271.   under OS/2
  272. - a manual for how to use PGP for the usage of such signature
  273.   certificates.
  274.  
  275. See section "Author" for the location of my homepage.
  276.  
  277.  
  278.  
  279. 7. Author
  280. =========
  281.  
  282. This program is written by Christian Langanke.
  283.  
  284. You can contact the author via internet e-mail.
  285.  
  286. Send your email to C.Langanke@TeamOS2.de
  287.  
  288. You can also visit my home page and download more free OS/2
  289. utilities at:
  290.  
  291.      http://www.online-club.de/m1/clanganke
  292.  
  293.