Clipstream™ Audio 3 parameters you can add and what they do
This is a list of Clipstream™ Audio 3 parameters and how they control how the Clipstream™ Audio 3 applet plays audio. To learn how to add these parameters and edit them, see the Editing Clipstream™ Audio 3 options by editing the .js file page.

NOTE: Many of these parameters are available only to PRO users.
Parameter organization
You can paste parameters in any order within the applet but it is helpful to see how they are organized by function here. They are organized into Playback; Interface & Display; Licensing & Security; Events, Hyperlink, Javascript, Tracking;
PLAYBACK

 
NameDescriptionSyntax 
AudioStreamURLSpecify the URL of the encoded Clipstream Audio clip file.

<param name="AudioStreamURL" value="[Relative or Absolute URL location and filename]">

Note: It is only necessary to refer to one bit rate file name. If you have more than one bit rate file to offer, use the AutoBitRate parameter (set to True) so that the applet will choose another bit rate file if needed.

ex.
<param name="AudioStreamURL" value="32/64/96/128/256,clips/mymusic_32.csa">

 
AutoPlayToggle whether you want the applet to automatically play on page load.<param name="AutoPlay" value="[True or False]"> 
AutoLoopToggle whether you want the applet to play again from the beginning once it has finished playing once already.<param name="AutoLoop" value="[True or False]"> 
AutoBitRateToggle whether you want the applet to detect the user's connection speed. This is used if you want the applet to provide the user with an approrpiate high or low bit rate audio stream. If you only have one bit rate stream to offer, do not use this parameter.<param name="AutoBitRate" value="[True or False]"> 
UseCachesToggle whether you want the user's browser to cache the audio stream. <param name="UseCaches" value="[True or False]"> 
AudioStreamURLSizeSpecifies the number of clips that the applet will call in a playlist. Not needed if you are only streaming a single clip.

<param name="AudioStreamURLSize" value="[# of clips in playlist]">

<param name="AudioStreamURLSize" value="4">

 
AudioMessageModeToggles whether playback information such as clip length, progress is displayed below the player graphics, in the browser's status bar or on mouseover.

0=mouseover only
1=always on
2=status bar and mouseover
3=on and status bar

<param name="AudioMessageMode" value="[toggle mode #]">

<param name="AudioMessageMode" value="1">

 
LICENSING & SECURITY

 
NameDescriptionSyntax 
KeyLicenses the clip for playing.

<param name="Key" value="[The alphanumeric codekey string given to you by your Clipstream representative]">

Note: Not the same as KeyURL, use one or the other.

ex.
<param name="Key" value="ABEY53YH6UJFD455DFHG">

 
KeyURLIf you have multiple licensing models for your site(s), you can include all of your keys in a single text file. Use the KeyURL parameter to refer to that text file's location on your web server.

<param name="KeyURL" value="[URL of the text file containing all of your keys]">

ex.
<param name="KeyURL" value="/mykeys.txt">

 
AuthorizedDomainURLYou can specify other websites that you are allowing this clip to be played on by referring to a text file that has a list of these domains.

NOTE: This is used in conjunction with Clipstream security (SID).

<param name="AuthorizedDomainURL" value="[URL of the text file containing the list of allowed domains]">

ex.
<param name="AuthorizedDomainURL" value="/alloweddomains.txt">

 
  

 

 
INTERFACE & DISPLAY

 
NameDescriptionSyntax 
HorizontalSeekYou can specify a the progress indicator graphics to be to the right of the play/pause instead of the traditional location below them.

<param name="HorizontalSeek" value="true/false">

-default is false
-eliminates the logo graphics

ex. param name="HorizontalSeek" value="true">

 
FlashOnWaitingToggle whether you want the applet to animate between the PlayUp and PlayOver buttonstates to prompt the user to click on the play button.

<param name="FlashOnWaiting" value="true/false">

<param name="FlashOnWaiting" value="true">
 
ButtonPlayUpYou can specify a different graphic to be referenced by the applet in place of the default PlayUp button state. <param name="ButtonPlayUp" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonPlayUp" value="./images/playup.gif">
 
ButtonPlayDownYou can specify a different graphic to be referenced by the applet in place of the default PlayDown button state. <param name="ButtonPlayDown" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonPlayDown" value="./images/playdown.gif">
 
ButtonPlayOverYou can specify a different graphic to be referenced by the applet in place of the default PlayOver button state. <param name="ButtonPlayOver" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonPlayOver" value="./images/playOver.gif">
 
ButtonPauseUpYou can specify a different graphic to be referenced by the applet in place of the default ButtonPauseUp button state. <param name="ButtonPauseUp" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonPauseUp" value="./images/ButtonPauseUp.gif">
 
ButtonPauseDownYou can specify a different graphic to be referenced by the applet in place of the default ButtonPauseDown button state. <param name="ButtonButtonPauseDown" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonPauseDown" value="./images/ButtonPauseDown.gif">
 
ButtonPauseOverYou can specify a different graphic to be referenced by the applet in place of the default ButtonPauseOver button state. <param name="ButtonButtonPauseOver" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonPauseOver" value="./images/ButtonPauseOver.gif">
 
ButtonStopUpYou can specify a different graphic to be referenced by the applet in place of the default ButtonStopUp button state. <param name="ButtonStopUp" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonStopUp" value="./images/ButtonStopUp.gif">
 
ButtonStopDownYou can specify a different graphic to be referenced by the applet in place of the default ButtonStopDown button state. <param name="ButtonStopDown" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonStopDown" value="./images/ButtonStopDown.gif">
 
ButtonStopOverYou can specify a different graphic to be referenced by the applet in place of the default ButtonStopOver button state. <param name="ButtonStopOver" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="ButtonStopOver" value="./images/ButtonStopOver.gif">
 
LogoIconYou can specify a link to a branding graphic that appears below the three play buttons (play, stop, pause). By default it is the Clipstream brand. By specifying a different graphic you are replacing it. <param name="LogoIcon" value="[URL of .jpg/.gif]">

- can be .jpg or .gif.
- must be located on same server as the applet.
- can be relative or absolute linked from the codebase of the clipstreamaudio.zip.

ex. param name="LogoIcon" value="./images/acme.gif">
 
LogoLinkYou can specify a URL where you want the user's browser to open to if they click on the graphic you specify in LogoIcon. <param name="LogoLink" value="[URL]">

- must be a URL

ex. param name="LogoLink" value="www.dsny.com">
 
EnableSeekToggle on or off the seek functionality of the progress bar: The graphic that shows the progress of the audio from beginning to end.<param name="EnableSeek" value="[True or False]">

ex. param name="EnableSeek" value="True">
 
EnableSeekTextToggle this on if you wish text to appear over the logo graphic portion of the applet player that details the progress of the clip and how much is remaining. This information displays only when the user rolls over the applet. <param name="EnableSeekText" value="[True or False]">

ex. param name="EnableSeekText" value="True">
 
KnobLeftThe left-most starting position in pixels of the Seek Knob: the graphic pointer that shows the progress of the clip over the seek background.

<param name="KnobLeft" value="[# in pixels from the left edge of the applet]">

ex. param name="KnobLeft" value="3">

This will start the Seek Knob 3 pixels from the left edge of the applet.

 

 

KnobLengthThe number of pixels the Seek Knob can travel across the applet.

<param name="KnobLength" value="[# in pixels the seek knob can travel]">

ex. param name="KnobLength" value="25">

 
ButtonSeekBarSpecify the URL of the graphic that becomes the background of the progress bar.This graphic should show the background as unfilled.

<param name="ButtonSeekBar" value="[URL of .jpg/.gif]">

ex. param name="ButtonSeekBar" value="./images/seekbar.gif">

 
ButtonSeekProgressThe URL of the filled progress background graphic. As the Seek Knob proceeds across the applet it should reveal a filled background.

<param name="ButtonSeekProgress" value="[URL of .jpg/.gif]">

ex. param name="ButtonSeekProgress" value="./images/seekbarfilled.gif">

 
ButtonSeekKnobThe URL of the graphic of the pointer that proceeds across the applet as the clip plays.

<param name="ButtonSeekKnob" value="[URL of .jpg/.gif]">

ex. param name="ButtonSeekKnob" value="./images/seeknob.gif">

 
ToggleButtonTurns on whether the play button will switch to the pause state once it is playing. <param name="ToggleButton" value="[True or False]"> 
UseDefaultIconTurns on whether existing default button graphics are used if none are specified. For example, if you choose to only point to a new playbutton but don't have new graphics for the others, having this parameter on will cause the applet to use the already existing set for the missing images.<param name="UseDefaultIcon" value="[True or False]">

Note: by default this is True.
 
BackgroundColorDisplays a background color in the applet based upon a hex #. The Clipstream Audio applet now supports transparent gifs for button images, making it easier to allow a button design to be a chameleon.<param name="BackgroundColor" value="[Hex#]">

ex. param name="BackgroundColor" value="#CCCCCC">
 
EVENTS, HYPERLINKING, JAVASCRIPT, TRACKING

 
NameDescriptionSyntax 
CallbackOnPlayDefine a JavaScript method to be activated once the Audio is played.

<param name="CallbackOnPlay" value="[JavaScript method]">


ex. <param name="CallbackOnPlay" value="JSStart();">

 
EventNumber Defines the number of events in the Audio.

<param name="EventNumber" value="[NUMBER OF EVENTS]">

ex. <param name="EventNumber" value="3">

 
Event[#]

Specifies a URL or JavaScript that is triggered at a certain time in the Audio.

Note: Each event parameter needs its own number.

Very useful for a slideshow JavaScript presentation.

<param name="Event[ORDER #]" value="[LOAD or TIME IN MILLISECONDS or STOP],[TARGET WINDOW],[HTML PAGE TO BE LAUNCHED]">

ex.
<param name="Event1" value="LOAD,info,start.html">
<param name="Event2" value="200,info,link0.html">

 
AudioHyperlinkNumber

Defines the number of hyperlinks the Audio will embed.

*Note: This used to be called AudioHyperlinkSize

<param name="AudioHyperlinkNumber" value="[NUMBER of HYPERLINKS]">

ex.
<param name="AudioHyperlinkNumber" value="20">

 
AudioHyperlink Defines a hyperlink that will launch an HTML page when the user clicks the applet at a certain time.

*Note: The Hyperlinks need to be ordered and equal the number defined in AudioHyperlinkNumber

<param name="AudioHyperlink[ORDER #] " value="[START or NUMBER OF SECONDS or END],[ABSOLUTE or RELATIVE HYPERLINK]">

ex,
<param name="AudioHyperlink1" value="start,http://www.clipstream.com">
<param name="AudioHyperlink2" value="30,http://www.dsny.com">

 
AudioHyperlinkTarget Defines a target window for the hyperlink. Handy if you are working in frames.

<param name="AudioHyperlinkTarget" value="_[TARGET NAME WINDOW]">

ex.
<param name="AudioHyperlinkTarget" value="_blank">
<param name="AudioHyperlinkTarget" value="_topframe">

 
AudioHyperlinkInfo Toggles whether or not information is passed to a tracking script when a Hyperlink is used from the applet.

<param name="AudioHyperlinkInfo" value="[TRUE or FALSE]">

ex.
<param name="AudioHyperlinkInfo" value="false">

 
AudioTrackingURL

Specifies the URL or CGI to call when the user instigates the start or stop of the Audio for tracking purposes. Tracking data is appended to the URL as follows:

clip=CLIP_NAME&action={start|stopped|load}&kbps=
DETECTED_KBPS&pos=START_MSEC,STOP_MSEC

<param name="AudioTrackingURL" value="track.cgi?userid=123"> 

clipstream.com :: copyright © destiny media technologies, inc. | support | investors | broadcast internet radio