P A R A M E T E R    C H E A T    S H E E T
=========================================================================
CodeBrainVoice.class



GENERAL NOTES
-------------------------------------------------------------------------

// CodeBrainVoice's code is written protectively -- to make it easy
// to set up and get running.  Demos and associated graphics and sound
// files are included, to get you rolling quickly.
//
// Other than the "Notice" parameter and a sound file, you can leave out
// any parameter and the applet will run.  That is, "If in doubt, leave
// it out!"  
//
// You can make the applet as simple as you wish, without the
// clutter and confusion of a multitude of parameters -- and then
// gradually build upward into more complex uses.
//
// Parameter names are as descriptive as we can make them without
// having them a mile long, and they ARE case sensitive, so take care.
//
// Note that a keyfile is required (see below) to run the applet on
// your website -- but the applet will run fine for testing off your
// hard drive without the keyfile.
//
// Keep image and sound files to the smallest sizes possible to meet
// the needs for your application.  Remember, a large sound or image
// file used with the applet will take longer to load -- even though
// the CodeBrainVoice.class file is itself very small.
//
// To get started, place the CodeBrainVoice.class file and ALL files
// used by the applet in the SAME directory.
//
// For those interested in using the applet with JavaScript calls,
// note the .html demo files ending in MS and NS.  JavaScript calls
// only work in NS4 and MS4 (and later), of course, since earlier
// browsers don't have the necessary tooling in their JVM's to com-
// municate with an applet this way.  Also, note that the implementa-
// tion of the JavaScript calls to the applet are the same in both
// NS and MS -- it's the way you have to handle the image rollovers
// that differs.
//
// Check out the demos included, and gradually add and change the
// parameters to get a feel for how the applet works.
//
// We know you'll find a number of interesting ways to put the
// CodeBrainVoice applet to work on your site.  For a very small,
// simple utility, it's got quite a bit of flexibility.
//
// Best regards,
//
//
// CodeBrain  
//
// IMPORTANT:  CodeBrainVoice.class will function properly off your
// disk drive, as is.  To use it on your website, you MUST MUST MUST
// get a KEYFILE from www.CodeBrain.com -- or the applet won't run.
// The KEYFILE, CodeBrainSlider.key, must be in the SAME DIRECTORY
// as the CodeBrainSlider.class file.





P A R A M E T E R S
=========================================================================



<param name="Notice"                 value="Applet by www.CodeBrain.com">
-------------------------------------------------------------------------
// Must be present, EXACTLY, or the applet will not run.  (See note
// above, you also need a keyfile to use the applet on your site.)


<param name="Sound"                                 value="soundfile.au">
-------------------------------------------------------------------------
// This is the sound file that the applet will play, and is, of course,
// required.  Any standard .au file in usual JAVA format is acceptable.





[       *** All parameters from this point down are optional. ***       ]
=========================================================================


<param name="BackgroundColor"                        value="rrr,ggg,bbb">
-------------------------------------------------------------------------
// This sets the applet background color.  The default is black.
// Usual RGB format, values 0-255.
// Example: value = "255,0,0" would make the applet background red.


<param name="BackgroundImage"                      value="imagefile.ext">
-------------------------------------------------------------------------
// This is the (optional) image to be used for the applet background.
//   This can be any standard .jpg or .gif or .gif 89a animation.
// Note:  If you wish to use Play, Loop, and/or Stop buttons, there
//   are no separate image files for these.  You build in the button
//   artwork in the background image.


<param name="BoxColor"                               value="rrr,ggg,bbb">
-------------------------------------------------------------------------
// This sets the color of the box that surrounds each of the three
//    possible controls (Play, Loop, and Stop) when the mouse is clicked
//    over them. (They also appear when JavaScript calls are used.)
// Usual RGB format, values 0-255.
// Example: value = "0,0,255" would make the boxes blue.


<param name="PlayXYWH"                                   value="x,y,w,h">
-------------------------------------------------------------------------
// This sets the position and dimensions of the Play button box (see
//   also BoxColor above).  The following tag...
//
//          <param name="PlayXYWH" value="20,30,100,10">
//
//   would put the upper left corner of the button box at 20 pixels in
//   from the applet left edge , 30 pixels down from the applet top
//   edge; and it would make the button box 100 pixels wide and to high.
//
// When the mouse is clicked within that space, the applet would play
// the sound file specified in the Sound (above) parameter one time.
//
// Note that you must have MouseMode (below) set to YES for the buttons
// to function.
//
// If you don't want to have the Play button visible or functional in
// the applet space, simply position it outside the applet dimensions.
// Also, take care not to overlap buttons boxes!


<param name="LoopXYWH"                                   value="x,y,w,h">
-------------------------------------------------------------------------
// Same idea as PlayXYWH above, but it would cause the applet's sound
// file to loop continuously when the mouse is clicked in the Loop
// button box space.


<param name="StopXYWH"                                   value="x,y,w,h">
-------------------------------------------------------------------------
// Same general idea as PlayXYWH above, but clicking in this space
// would cause any currently playing sound file to stop.


<param name="MouseMode"                                      value="YES">
-------------------------------------------------------------------------
// If you want the applet to respond to clicks in the Play, Loop, or Stop
// button box spaces, you MUST set this parameter to YES.
//
// If you want to have the applet just start playing automatically when
// it loads -- just leave this parameter out entirely.  You must also
// leave out the JavaScriptMode parameter.  If either of the two is
// present and set to YES, the sound file will not begin play auto-
// matically upon loading.


<param name="Repeat"                                         value="YES">
-------------------------------------------------------------------------
// If you omit the MouseMode parameter, the applet begins playing the
// sound file as soon as it loads.  Normally, it will play the sound once
// only.  However, if you set Repeat to YES, the sound file will begin
// playing as soon as the applet loads, and then loop continuously.
// 
// Remember, for the applet to start automatically, you MUST leave out
// the MouseMode parameter AND the the JavaScriptMode parameters!


<param name="JavaScriptMode"                                 value="YES">
-------------------------------------------------------------------------
// This enables the applet for the acceptance of JavaScript calls.  Note
// that setting this parameter to YES will NOT allow the applet to begin
// play automatically on loading.  
//
// JavaScript calls only work in NS4 and MS4 (and later) browsers!
//
// The available JavaScript calls for CodeBrainVoice are:
//
//          cbvStop() -- which stops the sound if playing
//          cbvPlay() -- which will play the soundfile once
//          cbvLoop() -- which will play the soundfile continuously
//
// Using JavaScript calls with the applet is not difficult, but you MUST
// remember to give the applet a name!  If you're unfamiliar with this
// area of using applets, see the supplied demos to get a clearer picture
// of how to use JavaScript calls with an applet.  (Hint:  In the demos,
// the applet name is George.)  Thus, you'd just attach a JavaScript call
// that looks like this: onmouseup="George.cbvLoop();" to an <a href> or
// image tag, etc., to cause the applet to loop the sound file.  Note
// that no parameters are passed in the parenthesis -- none are needed.





W H E R E   T O   S T A R T
==========================================================================
//We suggest you start off with a minimum configuration like this, just to
//get the applet set up and running...
//
//    <applet code="CodeBrainVoice.class" width="4" height="4">
//      <param name="Notice" value="Applet by www.CodeBrain.com">
//      <param name="Sound" value="CodeBrainCurly.au">
//      <param name="BackgroundColor" value="0,0,0">
//    </applet>
//
// This would set the background color to black, at a small 4x4 pixels, so
// it wouldn't show up or occupy much space on a black-background .html
// page.  The applet would start the CodeBrainCurly.au sound file as soon
// as it loaded, and play it one time.




That's it, that's all there is!  Go to it!

Best regards,


CodeBrain


          







=========================================================================
The CodeBrainVoice.class applet is (c) 1999 by CodeBrain
All responsibility for use of the applet remains with the user.