<embed src="jfk8.vox" name=ToolVoxPlugIn playmode=user visualmode=background 
height=2 width=2>

play and stop

The play and stop methods are used to begin and stop playback of a VOX file. No parameters are needed for these methods, and they do not return a value.

Example 1:

Here's a simple form with two buttons to stop and play a VOX file. Click on them to try them out!

playAt

The playAt method is used to begin playback of a VOX file at a certain time. This method accepts a single floating point value as an input parameter, which is the time (in seconds) to skip from the beginning of the VOX file. The playAt method does not return a value.

Example 2:

The following is an example of a button which will start playback of our VOX file at 33 seconds.

Here's the code that was used to create Example 2:

<form>
<input type=button value="Play at 33 Seconds" 
onClick='document.ToolVoxPlugIn.playAt(33.0)'>
<input type=button value="Stop" onClick='document.ToolVoxPlugIn.stop()'>
</form>

rewind

The rewind method is used set the playback starting point to the beginning of the VOX file. No input parameters are used with this method, and it does not return a value.

Example 3:

Building on our previous examples, the following starts playback of the VOX file at 33 seconds when you click on the "Play at 33 Seconds" button, then the "Rewind" will rewind the file and "Play" button will start playback at the beginning of the file. To test this example, click on the four buttons from left to right.

setWarp and getWarp

The setWarp and getWarp methods are used to specify or retrieve a value for the warp parameter, which speeds up or slows down playback. The setWarp method will take a floating point value as input and doesn't return any values. Input values can range from 0.4 to 4.0.

If the input value to setWarp is less than 1, the playback will speed up; if the value is greater than 1, the playback will slow down. HINT: Think of the warp value as a multiplier of the total duration of a file. If a file is 100 seconds long, setting a warp value of .5 will make it 50 seconds long.

The getWarp method does not have any inputs and it will return a floating point value.

In this example, enter a number between 0.4 and 4.0 in the text field, then click on the "Play" button to hear the results. The warp value is set using the setWarp method.

Then click the "Get Warp" button to display the warp value that you entered in a confirmation dialog box. The warp value is retrieved using the getWarp method.

This is the first example that uses JavaScript to validate the input and call the ToolVox Player methods.

Here's the code that was used to create Example 4:

<script language="JavaScript">
// The VerifyInputAndSetWarp function checks if the warp   
// value entered by the user is within the valid range     
// (0.4-4.0), and if it is, the function will set the warp 
// value using the setWarp method.                         
function VerifyInputAndSetWarp(ValueEnteredByUser)
   {
// Call reset to clear other parameters that may have been 
// set by a previous example. (Example of the reset method 
// to follow.)                                             
   document.ToolVoxPlugIn.reset()
   if (ValueEnteredByUser < 0.4 | ValueEnteredByUser > 4) 
      {
      alert("Please enter a warp value between 0.4 and 4.0.")
      }
   else
      {
      var Value = parseFloat(ValueEnteredByUser)
      document.ToolVoxPlugIn.setWarp(Value)
      }
   }
// The GetWarpValueAndDisplayIt function will retrieve the 
// current warp value and display it in a confirmation     
// dialog box.                                             
function GetWarpValueAndDisplayIt()
   {
   WarpValue = document.ToolVoxPlugIn.getWarp()
   confirm("The warp value you entered was " + WarpValue + ".")
   }
</script>

<form>
Enter a warp value: 
<input type=text name=warp size=5 
onChange="VerifyInputAndSetWarp(form.warp.value)"><br>
<input type=button value="Play" onClick='document.ToolVoxPlugIn.play()'>
<input type=button value="Stop" onClick='document.ToolVoxPlugIn.stop()'>
<br><br>
<input type=button value="Get Warp" onClick='GetWarpValueAndDisplayIt()'>
</form>

setTransposition and getTransposition

The getTransposition method does not have any inputs and it returns a floating point value.

Example 5:

reset

Example 6:

Click on the "Play" button to hear the VOX file start to play at the 99 second mark with warp set to 0.5. Then click on the "Reset and Play Again" button to reset the "play at" value and warp, and play the VOX file again.

Here's the code that was used to create Example 6:

<script language="JavaScript">
// The SetParametersOrResetThenPlay function will set the  
// play at value to 99 seconds and warp to 0.5, then play 
// OR                                                     
// reset and playback file from beginning                 
function SetParametersOrResetThenPlay(reset)
   {
// Call reset to clear other parameters that may have been 
// set by a previous example.                              
   document.ToolVoxPlugIn.reset()
   if (!reset)
      {
      document.ToolVoxPlugIn.stop()     
      document.ToolVoxPlugIn.playAt(99)
      document.ToolVoxPlugIn.setWarp(0.5)
      }
   else
      {
      document.ToolVoxPlugIn.stop()     
      document.ToolVoxPlugIn.reset()      
      }
   document.ToolVoxPlugIn.play()
   }
</script>

<form>
<input type=button value="Play" onClick='SetParametersOrResetThenPlay(0)'>
<input type=button value="Reset and Play Again" 
onClick='SetParametersOrResetThenPlay(1)'>
<input type=button value="Stop" onClick='document.ToolVoxPlugIn.stop()'>
</form>

getDuration

Example 7:

Click on the "Get Duration" button to display a confirmation dialog with the total playback time of the VOX file.

Here's the code that was used to create Example 7:

<script language="JavaScript">
// The GetDurationOfFile function uses the getDuration 
// method to retrieve the total playback time and       
// display it in a confirmation dialog.                 
function GetDurationOfFile()
   {
   Duration = document.ToolVoxPlugIn.getDuration()
   confirm("The total playback time of the file is: " + Duration + " seconds.")
   }
</script>

<form>
<input type=button value="Get Duration" onClick=GetDurationOfFile()>
</form>

isPlaying

Example 8:

In this example, click on the "Play" or "Stop" button, then click on the "Check if File's Playing" button. A confirmation box will be displayed with the current status.

Here's the code that was used to create Example 8:

<script language="JavaScript">
// The IsFilePlaying function uses the isPlaying method  
// to determine if the VOX file is playing. The file's   
// playback status will be displayed in a confirmation  
// dialog.                                              
function IsFilePlaying()
   {
   Result = document.ToolVoxPlugIn.isPlaying()
   if (Result)
      confirm("The file is playing.")
   else
      confirm("The file is NOT playing.")
   }
</script>

<form>
<input type=button value="Play" onClick='document.ToolVoxPlugIn.play()'>
<input type=button value="Stop" onClick='document.ToolVoxPlugIn.stop()'>
<input type=button value="Check if File's Playing" onClick=IsFilePlaying()>
</form>

getCurrentTime

Example 9:

In this example, click on the "Play" button to start the VOX file, then click on "Get Time". The current time in seconds of the playing VOX file will be displayed in the text field. You can click on the "Get Time" button many times and see the value in the text field increase. Try it!

Here's the code that was used to create Example 9:

<script language="JavaScript">
function Play()
   {
   document.ToolVoxPlugIn.play()
   }
// The SetTimeInTextField function uses the getCurrentTime 
// method to return the time of the VOX file that is playing (in
// seconds) and places the value in the text field named textform.  
function SetTimeInTextField(form)
   {
   Value = document.ToolVoxPlugIn.getCurrentTime()
   Value = parseFloat(Value)
   form.textform.value = Value
   }
</script>

<form>
<input type=button value="Play" onClick=Play()>
<input type=button value="Get Time" onClick=SetTimeInTextField(form)>
<input type=text name=textform value="">
<input type=button value="Stop" onClick="document.ToolVoxPlugIn.stop()">
</form>