home *** CD-ROM | disk | FTP | other *** search
/ ST-Computer Leser 1998 October / STC_CD_10_1998.iso / GRAFIK / MY_PLAY / COMMANDS.DOC next >
Text File  |  1998-09-26  |  7KB  |  198 lines
  1. M_PLAYER command line
  2. ╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣
  3.  
  4.     The player can be called from another program with every option
  5. into the command line. You can rename it as M_PLAYER.TTP or M_PLAYER.GTP
  6. or else, install an application.
  7.     If M_Player is an accessory, then you can call it via APPL_WRITE
  8. with the same options as if you were using a command line. See below for
  9. the AES Message format.
  10.  
  11.     The command line is:
  12.  
  13.     <options> path\file_name
  14.  
  15.     The options must appear before the file name! Options can be
  16. separated with spaces or not.
  17.  
  18.     Every option is:
  19.  
  20.     +LETTER to set this option
  21.     -LETTER to clear this option
  22.  
  23.     Available options:
  24.  
  25.     +d, -d
  26.     ╣╣╣╣╣╣
  27.         if set will display the dialogs, if cleared won't display
  28.         them.
  29.         Default value: +d
  30.  
  31.     +p, -p
  32.     ╣╣╣╣╣╣
  33.         if '-d' is specified, then if set will play the sound (if
  34.         available), if cleared won't play the sound
  35.         Default value: +p
  36.         Used only with AVI and MOV
  37.  
  38.     +s, -s
  39.     ╣╣╣╣╣╣
  40.         if '-d' is specified, then if set will synchronise the
  41.         images and sound, if cleared will display the images at
  42.         the max speed.
  43.         Default value: +s
  44.         Used with AVI, MOV and FLx
  45.  
  46.     +a, -a
  47.     ╣╣╣╣╣╣
  48.         if '-d' is specified, then if set will simulate the Alt
  49.         key (Alt Go! in the first dialog) to enter step by step
  50.         mode automatically or to create MOVs with a batch file.
  51.         Default value: -a
  52.  
  53.     +e, -e
  54.     ╣╣╣╣╣╣
  55.         if '-d' is specified, then if set will display every error
  56.         message (bad file, etc...), else if cleared, won't
  57.         display any error message.
  58.         Default value: -e
  59.  
  60.     +i, -i
  61.     ╣╣╣╣╣╣
  62.         if '-d' is specified, then if set will play in loop mode
  63.         (on the mask or single file passed through the command line)
  64.         until an event accurs (keyboard, mouse, joystick), else
  65.         will play normally.
  66.         Default value: -i
  67.         This is for being used with a screen saver for example.
  68.  
  69.     +xnnn, +ynnn
  70.     ╣╣╣╣╣╣╣╣╣╣╣╣
  71.         if '-d' is specified, then fixes the position where to
  72.         display the anim. If a resolution switch is necessary,
  73.         then this position will be ignored and the anim will be
  74.         centered as usual.
  75.         In this mode, the background is not cleared, so you can
  76.         display an anim into one of your windows.
  77.         There are no checking upon these coordinates, you must be
  78.         sure that the anim fits into the screen.
  79.         Note: when using a TT without graphic card, the TT Low
  80.         mode is often used, and some anims are doubled in height
  81.         to correct the proportions, make some tests!
  82.         Note2: +x100 or -x100 are equivalent, both x and y must be
  83.         specified, else the coordinate is ignored.
  84.         Note3: when using a TT without graphic card, the X value
  85.         is automatically aligned to a 16 pixels boundary.
  86.  
  87.  
  88.     Options p, s, a, i and e are only usefull when '-d' is specified,
  89. else, the player uses the returned values from the dialogs to set the
  90. options.
  91.  
  92.     +rnnnn
  93.     ╣╣╣╣╣╣
  94.         (+r and -r are equivalent)
  95.         specifies the address of a buffer where M_Player will
  96.         return the infos about a movie, in this mode the anim is
  97.         not played, you'll get no dialog, only the buffer filled
  98.         (72 bytes are needed):
  99.         WORD status    1=Ok
  100.                 0=File not found (nothing else filled)
  101.                 -1:unknown type (only file_name filled)
  102.         CHAR file_name (14 bytes: max 12 + nul + even address)
  103.         CHAR file_type (28 bytes: max 26 + nul + even address)
  104.              such as 'Video for Windows (AVI)'
  105.         WORD graph_status
  106.                 1: supported
  107.                 0: no graphics (infos filled with garbage)
  108.                 -1:unsupp (infos filled)
  109.         WORD width
  110.         WORD height
  111.         LONG number of frames
  112.         LONG compression (4 bytes such as 'cram', 'cvid'...)
  113.         WORD sound_status
  114.                 1: supported
  115.                 0: no sound (infos filled with garbage)
  116.                 -1: unsupp (infos filled)
  117.         WORD sound bits (more often 8 or 16)
  118.         WORD channels (1:mono, 2:stereo)
  119.         LONG frequency
  120.         LONG version    4 ASCII bytes representing the version of
  121.                 the player, for example '2.49'
  122.  
  123.     Examples:
  124.  
  125.     m_player -d *.AVI
  126.  
  127.     will display every AVI from the current folder without any dialog
  128. and using the default values (+p, +s, -a).
  129.  
  130.     m_player -d +a c:\batch\*.bat
  131.  
  132.     will create MOV files from every BAT file found into the c:\batch
  133. folder.
  134.  
  135.     m_player -d-p+s+i C:\anims\*.*
  136.  
  137.     will display every file found into the anims folder without sound
  138. but at their normal speed (synchro is on). Will also loop into this folder
  139. until an event occurs (keyboard, mouse, joystick), it means that when the
  140. end of the folder is reached, the research starts again.
  141.  
  142.     m_player +r81500 C:\anims\*.DL
  143.  
  144.     will fill the buffer with the infos corresponding to the first DL
  145. anim found into C:\ANIM. If no DL file is found, the first word will
  146. contain -1 and garbage for the other bytes.
  147.  
  148.  
  149.     Note: for options using a number as parameter (+x, +y, +r...), you
  150. can write:
  151.     +x200    -> decimal value
  152.     +x$C8    -> hexadecimal value (with $)
  153.     +xw??    -> w indicates that the two bytes ?? represent a WORD value
  154.         +xl????    -> l indicates that the 4 bytes ???? represent a LONG value
  155.  
  156.         The 'w' and 'l' facilities allow you to pass parameters without
  157. the Integer to string conversion, just 'poke' them into the command line.
  158.  
  159.  
  160. Programmers
  161. ╣╣╣╣╣╣╣╣╣╣╣
  162.  
  163.     If you want to incorporate M_PLAYER into one of your creations,
  164. you're allowed to distribute the shareware version (grey display) with its
  165. DOCs and RSC as long as you contact me before.
  166.     If you just tell your users that M_Player can be used and let them
  167. get it, you don't have to contact me.
  168.  
  169.     If you would like to distribute a color version of M_Player (you
  170. want to look 'pro'), you MUST contact me! Every color version must be
  171. paid! So we'll have to talk.
  172.  
  173. AES Message format
  174. ╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣
  175.     When M_Player is an accessory, it waits for two messages:
  176.  
  177.     1/ AC_OPEN (40) when called from the menu bar of the desktop
  178.     2/ M_PLAYER ('MP' or $4D50) when called by another application,
  179.     the AES buffer must be like this:
  180.         word(0) : $4D50
  181.         word(1)    : appl_id of the calling process
  182.         word(2)    : 0 (not more than 16 bytes)
  183.         word(3) and
  184.         word(4)    : LONG address of the command line
  185.         word(5)    : not used
  186.         word(6)    ; not used
  187.         word(7)    : not used
  188.  
  189.         if the LONG address is 0, then no command line is used and
  190.     you'll get the normal dialogs and fileselector. If an address is
  191.     specified, it should point to a nul-terminated string
  192.     corresponding to the command line as described above.
  193.  
  194.         for example: "-d+x100+y100 d:\anim\test.dl"
  195.     to display the anim TEST.DL at (100,100) without clearing the
  196.     background and without displaying the dialogs.
  197.  
  198.