home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / cset21v6.zip / MMPM2TK / TK / CAPSAMP / CAPSAMP.IPF < prev    next >
Text File  |  1992-12-04  |  5KB  |  124 lines
  1. :userdoc.
  2. .***********************************************************************
  3. .*General help for the Caption Sample Application Program
  4. .***********************************************************************
  5. :h1 res=001.Help for Caption Sample Application
  6. .*
  7. :p.
  8. Welcome to MMPM/2's sample captioning system.  We call it our sample
  9. captioning system because we've provided it, source code and all, as an
  10. example of one way to implement captioning with MMPM/2.  The system can be
  11. used as it's provided, or it can be modified to suit your specific needs.
  12. :p.
  13. This sample captioning system is made up of three parts.  The first part of
  14. the system is the Caption Creation Utility.  This allows you to synchronize
  15. an audio file with a text file.  The second part of the system is the Caption
  16. DLL.  This DLL provides three api's that allow an application to display,
  17. manage, and hide a caption window.  The third part of the system is this
  18. application, the Caption Sample Application.  It shows programmers how to
  19. use the three api's provided by the Caption DLL in order to display a caption
  20. window in an application.
  21. .*
  22. :p.
  23. Select the :hp2.Play:ehp2. push button to start playing the audio file.
  24. If MMPM/2's caption flag is selected (in the Setup applet) then a caption
  25. window will be displayed
  26. in the application's window as the audio file plays.
  27. While the audio file plays,
  28. the text in the caption window will scroll in syncronization
  29. with the audio file.
  30. :p.
  31. Select the :hp2.Stop:ehp2. push button to stop playing an audio file.
  32. If the caption window was displayed while the audio file was playing, then
  33. it will be hidden when the audio file stops.
  34. .*
  35. :p.
  36. Select the :hp2.Pause:ehp2. push button to pause the playing of an audio file.
  37. To resume playing the audio file,
  38. select the :hp2.Pause:ehp2. or :hp2.Play:ehp2. push button.
  39. .*
  40. :p.
  41. Select the :hp2.Rewind:ehp2. push button to stop the audio file and
  42. seek to it's beginning.
  43. .*
  44. :p.
  45. The :hp2.Audio position:ehp2. control provides a graphic display of the
  46. current position of the audio file.  To change position in the audio file,
  47. drag the
  48. slider bar or select the buttons at the left end of the slider.
  49. .*
  50. :p.Adjust the audio volume of the currently loaded audio file by using
  51. the :hp2.Volume:ehp2. control.
  52. .*
  53. :p.
  54. The caption window may be dragged around the application's window.
  55. To accomplish this,
  56. click button one while the mouse is over the caption window, drag the window to
  57. the desired location and release the mouse button.
  58. .*
  59. :p.
  60. Select the :hp2.Options:ehp2. menu to configure the captioning system.
  61. .*
  62. :p.
  63. Select the :hp2.Help:ehp2. menu to access various help functions.
  64. .*
  65. .*************************************************************************
  66. .* Help for the Settings dialog box
  67. .*************************************************************************
  68. :h1 res=002.Help for Settings Dialog Box
  69. .*
  70. :p.
  71. Select the :hp2.Text columns:ehp2. spin button to change the number of
  72. characters in each line of text in the caption window (ie. the horizontal size
  73. of the caption window).
  74. .*
  75. :p.
  76. Select the :hp2.Text rows:ehp2. spin button to change the number of text rows
  77. displayed in the caption window (ie. the height of the caption window).
  78. .*
  79. :p.
  80. Select the :hp2.Background color:ehp2. spin button to change the
  81. background color of the caption window.
  82. .*
  83. :p.
  84. Select the :hp2.Text color:ehp2. spin button to change the text color in the
  85. caption window.
  86. .*
  87. :p.
  88. Select the :hp2.Window position:ehp2. spin button to change the caption's
  89. window position inside of the application.
  90. .*
  91. :p.
  92. Select the :hp2.OK:ehp2. pushbutton to save the current state of the spin buttons
  93. and to remove this pop-up window.
  94. .*
  95. :p.
  96. Select the :hp2.Cancel:ehp2. pushbutton to to remove this pop-up window without
  97. saving the changes made to the spin buttons.
  98. .*
  99. :p.
  100. Select :hp2.Help:ehp2. pushbutton to display this help panel.
  101. .*
  102. .***********************************************************************
  103. .*Keys help for the Caption Sample Application Program
  104. .***********************************************************************
  105. :h1 res=003.Help for Caption Sample Application Keys
  106. .*:i1.keys help
  107. :p.The following keys can be used to control the Caption Sample Application
  108. program&colon.
  109. :dl tsize=5 break=all.
  110. :dt.:hp2.Tab:ehp2.
  111. :dd.Move among choices.
  112. :dt.:hp2.Alt:ehp2.
  113. :dd.Switch to or from the menu of an application window.
  114. :dt.:hp2.Up:ehp2. and :hp2.Down:ehp2. arrow keys
  115. :dd.Move among the push buttons, when focus is on the push button.
  116. :dt.:hp2.Left:ehp2. and :hp2.Right:ehp2. arrow keys
  117. :dd.Move among the push buttons, when focus is on the push button.
  118. When focus is on the volume control use left arrow key to decrease,
  119. right arrow key to increase the volume level.
  120. :dt.:hp2.F1:ehp2.
  121. :dd.Obtain help for the Caption Sample Application program.
  122. :edl.
  123. :euserdoc.
  124.