home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / TUNEPL.ZIP / tuneplay.doc < prev    next >
Text File  |  1992-11-12  |  3KB  |  75 lines
  1. This utility will play 'tunes' on your PC speaker that have been created
  2. with the 'Tune Editor' mini-application in the OS/2 'Productivity Tools'
  3. folder.  It can run in the background or as part of a batch job.  Typing
  4. 'tuneplay' without parameters will display the following usage info:
  5.  
  6. -----------------------------------------------------------------
  7.  
  8. TunePlayer V1.0, Copyright (c) 1992, CoralSoft, Inc.
  9. Usage:
  10.  
  11.     tuneplay [tune file] [tune number]
  12.  
  13.     Where [tune file] = Data file created by 'Tune Editor'
  14.                         application (*.$$a)
  15.           [tune number] = Number of the tune (0-9A-Z)
  16. TunePlay allows background or batch playing of tunes
  17.  
  18. created with the OS/2 Tune Editor, found in the OS/2
  19. Productivity Folder.  When you save a tune file, it
  20. is given the extension '.$$a'.  By default, these files
  21. are stored on your boot drive in the \OS2\APPS directory
  22. By specifying '*' for the tune number, all tunes in the
  23. file will be played with a slight pause between each.
  24. -----------------------------------------------------------------
  25.  
  26. For example:
  27.  
  28. tuneplay c:\os2\apps\pmdiary.$$a z
  29.  
  30. This example will play tune 'Z' from the default PMDiary tune file.
  31. By default, it is 'The Yellow Rose of Texas'.
  32. In a batch file, you could start TunePlayer as a detached program:
  33.  
  34. detach tuneplay mytunes.$$a 0
  35.  
  36. ***********************************************************************
  37. This archive consists of the following files:
  38.  
  39.         TUNEPLYR.DOC    This file
  40.         TUNEPLAY.EXE    Executable TunePlayer app.
  41.         TUNEPLAY.C      C Source Code for TunePlayer app.
  42.         TUNEPLYR.C      C Source Code for TunePlayer module
  43.         TUNEPLYR.H      C Header File for TunePlayer module
  44. ***********************************************************************
  45.  
  46. If you only want to use the included application, you may delete the
  47. *.c and *.h files.
  48.  
  49.                 - - - D e v e l o p e r   N o t e s - - -
  50.  
  51. If you want to include this code into your own application, compile
  52. TUNEPLYR.C and link the object module into your executable.  You will
  53. also need to include "TUNEPLYR.H".
  54.  
  55. With IBM C Set/2:
  56.         icc /Ss /O /C tuneplyr.c
  57.         link386 /PM:VIO tuneplyr.obj+mayapp.obj,myapp.exe;
  58.  
  59. Look at TUNEPLAY.C for an example of calling the TunePlayer functions:
  60.  
  61. int createTune(PSZ tuneFile, BYTE tuneNo, PTUNENOTE *tuneBase, PBYTE tuneName);
  62. void playTune(PTUNENOTE base);
  63. void closeTune(PTUNENOTE base);
  64.  
  65. Note that 'createTune' will allocate memory (with malloc) and store the
  66. base of a linked list of notes in 'tuneBase'.  To properly free the memory
  67. associated with 'createTune', you must call the 'closeTune' function.
  68.  
  69. If 'createTune' fails, the 'tuneBase' parameter will be set to NULL.
  70.  
  71. Brought to you by...
  72.  
  73. Steve Horne / CoralSoft, Inc.
  74.  
  75.