PLAYBACK
|
|
| Name |
Description |
Syntax |
|
| AudioStreamURL |
Specify 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 the high bit rate
file name. If you have a low bit rate file to offer, as
well, use the AutoBitRate parameter (set to True) too so
that the applet will choose the lower bit rate file if needed.
ex.
<param name="AudioStreamURL" value="clips/mymusic.32"> |
|
| AutoPlay |
Toggle
whether you want the applet to automatically play on page
load. |
<param
name="AutoPlay" value="[True or False]"> |
|
| AutoLoop |
Toggle 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]"> |
|
| AutoBitRate |
Toggle 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]"> |
|
| AudioBufferSize |
Specify number
of seconds you want the clip to buffer before playing. This
is to ensure that users with low connections can play the
clip without rebuffering. |
<param
name="AudioBufferSize" value="[# of seconds]">
ex.
<param name="AudioBufferSize" value="10">
|
|
| AudioStreamURLSize |
Specifies
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"> |
|
| UseCaches |
Toggle whether
you want the user's browser to cache the audio stream. |
<param
name="UseCaches" value="[True or False]"> |
|
LICENSING
& SECURITY
|
|
| Name |
Description |
Syntax |
|
| Key |
Licenses 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.
ex.
<param name="Key" value="ABEY53YH6UJFD455DFHG"> |
|
| KeyURL |
If
you have multiple licensing models for your site, 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"> |
|
| SID |
The security
ID for your clip. If you have received a Security ID from
your Clipstream representative, you would include this in
your applet so that no one can play back this clip from anywhere
but your website. |
<param
name="SID" value="[The alphanumeric codekey
string given to you by your Clipstream representative]">
Note: This does not replace your Key or KeyURL. You still
need a key license.
ex.
<param name="SID" value="ABEY53Y3563w4dsf234635674674
3w4635 H6UJFD455DFHG"> |
|
| AuthorizedDomainURL |
You 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. |
<param
name="AuthorizedDomainURL" value="[URL of
the text file containing the list of allowed domains]">
ex.
<param name="AuthorizedDomainURL" value="/alloweddomains.txt"> |
|
INTERFACE
& DISPLAY
|
|
| Name |
Description |
Syntax |
|
| FlashOnWaiting |
Toggle 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 or False]"> |
|
| ButtonPlayUp |
You 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 audioclipstream.zip.
ex. param name="ButtonPlayUp" value="./images/playup.gif"> |
|
| ButtonPlayDown |
You 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 audioclipstream.zip.
ex. param name="ButtonPlayDown" value="./images/playdown.gif"> |
|
| ButtonPlayOver |
You 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 audioclipstream.zip.
ex. param name="ButtonPlayOver" value="./images/playOver.gif"> |
|
| ButtonPauseUp |
You 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 audioclipstream.zip.
ex. param name="ButtonPauseUp" value="./images/ButtonPauseUp.gif"> |
|
| ButtonPauseDown |
You 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 audioclipstream.zip.
ex. param name="ButtonPauseDown" value="./images/ButtonPauseDown.gif"> |
|
| ButtonPauseOver |
You 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 audioclipstream.zip.
ex. param name="ButtonPauseOver" value="./images/ButtonPauseOver.gif"> |
|
| ButtonStopUp |
You 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 audioclipstream.zip.
ex. param name="ButtonStopUp" value="./images/ButtonStopUp.gif"> |
|
| ButtonStopDown |
You 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 audioclipstream.zip.
ex. param name="ButtonStopDown" value="./images/ButtonStopDown.gif"> |
|
| ButtonStopOver |
You 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 audioclipstream.zip.
ex. param name="ButtonStopOver" value="./images/ButtonStopOver.gif"> |
|
| LogoIcon |
You 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 audioclipstream.zip.
ex. param name="LogoIcon" value="./images/acme.gif"> |
|
| LogoLink |
You 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.acme.com"> |
|
| EnableSeek |
Toggle on or off the display
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"> |
|
| EnableSeekText |
Toggle 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"> |
|
| KnobLeft |
The 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. |
|
| KnobLength |
The 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"> |
|
| ButtonSeekBar |
Specify 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"> |
|
| ButtonSeekProgress |
The 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"> |
|
| ButtonSeekKnob |
The 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"> |
|
| ToggleButton |
Turns on whether
the play button will switch to the pause state once it is
playing. |
<param
name="ToggleButton" value="[True or False]"> |
|
| UseDefaultIcon |
Turns 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. |
|
EVENTS,
HYPERLINKING, JAVASCRIPT, TRACKING
|
|
| Name |
Description |
Syntax |
|
| CallbackOnPlay |
Define 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"> |
|
