The Leader in Secure Video Delivery Software
Home
Clipstream™ Help

Clipstream™ Video
Help Pages
Clipstream™ Video Applet Parameters List (by subject)
Parameters are instructions in the Clipstream™ Video applet that govern how the video plays. A full list of the parameters available for the Clipstream™ Video Applet. To learn how to add or edit these parameters, go to our Editing Clipstream™ Video Parameters page.

This page is organized by Subject.

Detection | Playback | Audio | Interface & Display | Licensing | Events, Hyperlinking, JavaScript, Tracking | Security

DETECTION
 
Name Description Syntax  
AutoBitRate

Whether the applet detects the connection speed of the user.

*Note: make this false if there is only one bit-rate .vcs version employed.

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

ex. <param name="AutoBitRate" value="True">		  
PLAYBACK
 
Name Description Syntax  
AutoPlay Toggles whether the video plays on page load or not. Also whether the video will play on a RollOver (user moves mouse cursor over the video screen) <param name="AutoPlay" value="[TRUE, FALSE or ROLLOVER]">

ex.
<param name="AutoPlay" value="True">
<param name="AutoPlay" value="Rollover">
  
AutoLoop Toggles whether the video will restart from the beginning once it reaches the end.

<param name="AutoLoop" value="[TRUE, FALSE]">

ex. <param name="AutoLoop" value="true">

  
PreBuffer

Buffers the video completely prior to playback. This has memory issues for longer videos. This is useful for short clips.

*Note: By default, even if PreBuffer is not set, If minimum connection speed specified by VideoURL is not met, the video will prebuffer prior to playback.

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

ex. <param name="PreBuffer" value="true">

  
SeekEnable

Enables or disables user control of the progress bar (the pointer that allows the user to scroll to another point in the video).

If it is disabled, the progres bar will still show the progress of the video

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

ex. <param name="SeekEnable" value="true">

  
VideoNumber Specifies the number of video files used by the applet. VideoNumber is used when there are more than 8 VideoURLs. Used by the applet to help define total number of videos referenced with VideoURL number parameters not sequential from zero.

<param name="VideoNumber" value="[number of videos within the applet]">

ex. <param name="VideoNumber" value="10">

  
VideoDelay Will delay the video start in relation to the audio stream. This is helpful if for some reason the encoded output is out of sync. Also see: VideoSync.

<param name="VideoDelay" value="[NUMBER IN MILLISECONDS]">

ex. <param name="VideoDelay" value="1000">

  
VideoBufferSize Specify the number in seconds to buffer.

<param name="VideoBufferSize" value="[NUMBER IN SECONDS]">

ex.
<param name="VideoBufferSize" value="10">

  
VideoURL# Defines which video (.vcs) file to play.

<param name="VideoURL[ORDER #]" value="[LABEL NAME, CONNECTION SPEED,ABSOLUTE or RELATIVE HYPERLINK and FILENAME].vcs">

ex.
<param name="VideoURL1" value="Broadband Clip,500,mymovie_500.vcs">
<param name="VideoURL2" value="DSL Clip,350,mymovie_350.vcs">

 
VideoURLEX#

Defines which video (.vcs) file to play when using the VideoBackground feature.

VideoURLEX is used instead of VideoURL because VideoURLEX can also define an x and y coordinate where the video will play against the background image.

See: VideoBackground#

<param name="VideoURLEX[ORDER #]" value="[LABEL NAME, MINIMUM CONNECTION SPEED FOR THIS VIDEO, X COORDINATE, Y COORDINATE,ABSOLUTE or RELATIVE HYPERLINK and FILENAME].vcs">

ex.
<param name='VideoURLEX2' value='400 kbps,400,25,10,p/pirates_of_the_caribbean/pirates_400.vcs'>

 
       
       
     
AUDIO
 
Name Description Syntax  
MuteAudio Turns audio on or off. <param name="MuteAudio" value="[TRUE or FALSE]">

ex. <param name="MuteAudio" value="True">		  
VideoSync How often the video will sync with the audio. Use in clips longer than three minutes. In slower computers there may be a slight pause in the video.

<param name="VideoSync" value="[NUMBER IN SECONDS]">

ex. <param name="VideoSync" value="30">

  

INTERFACE & DISPLAY
 
Name Description Syntax  
BackgroundColor Defines the color of the applet background in hex HTML code.

Here is a good colour chart to help you pick your colors in HTML code.

<param name="BackgroundColor" value="[HEX HTML COLOR CODE]">

ex. <param name="PanelEnable" value="[#00000]">

  
PanelEnable Turns the button graphics on or off. <param name="PanelEnable" value="[TRUE or FALSE]">

True = turn button graphics on; False = turn them off

ex. <param name="PanelEnable" value="True">		  
PanelPosition Position the button graphics to the top or bottom. <param name="PanelPosition" value="[TOP or BOTTOM]">

ex. <param name="PanelPosition" value="bottom">		  
PanelLayout Describe the order of each button or omit certain buttons from displaying.

<param name="PanelLayout" value="[PSRMC]">

P - Play
S - Stop
R - Random (seek bar)
M - Mute
C - Connection Speed, Video Choice or Chapter

Omitting a letter will remove that button from displaying.

ex. <param name="PanelLayout" value="PSRMC">

  
PanelImagesURL Define the URL link where the one-piece button graphic (.jpg or .gif) can be referenced by the applet. <param name="PanelImagesURL" 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 videoclipstream.zip.

ex. param name="PanelImagesURL" value="./images/buttons.gif">		  
PanelImageWidth Define the width of each BUTTON in the one-piece button graphic. This tells the applet which part of the .jpg or.gif corresponds to a certain function. It enables the applet to refer to a single graphic for a range of button functions rather than many individual files.

<param name="PanelImagesURL" value="[PLAY, PAUSE, STOP, SEEK_BEGIN, SEEK_KNOB, SEEK_MID, SEEK_END, MUTE, CONNECTION]">

Where [PLAY] etc. replace with number in pixels that is the width of the button element. It must be in the order given above. If an element is not include, enter zero (o).

ex. <param name="PanelImageWidth" value="15,15,15,7,6,1,6,15,52">

  
PanelResizable

Toggles the applet to resize the control panel for videos of different dimensions (i.e. videos at different bit rates/connection speeds might be different sizes). The panel can be of a larger size than the video, however the overall dimensions of the applet must accommodate this.

*Note: In conjunction with the VideoBackground feature a value of TRUE will keep the button panel attached to the bottom of the video. If FALSE then the button panel will stay at the bottom of the applet.

*Note: If False, there cannot be a VideoEdge.

See: VideoBackground, VideoEdge

<param name="PanelResizable" value="[TRUE or FALSE">

ex. <param name="PanelResizable" value="true">

  
PanelPopup Show the connection speed popup at video startup to prompt the user to select a video or bitrate.

<param name="PanelPopup" value="[TRUE or FALSE">

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

  
PanelFlash Tells the applet to flash the play button given various conditions or not at all.

<param name="PanelFlash" value="[0,1,2 or 3]">

0 - no flash
1 - flash on rollover
2 - Flash play on waiting (only when page loads)
3 - Flash play (always)

ex. <param name="PanelFlash" value="1">

  
SeekMargin Pads the distance in pixels to the left and right of the progress bar within the buttonset.

<param name="SeekMargin" value="[NUMBER IN PIXELS TO PAD LEFT,NUMBER IN PIXELS TO PAD RIGHT">

ex. <param name="SeekMargin" value="10,10">

  
TextColor Defines the colour of any messaging text that appears in the applet. Here is a good colour chart to help you pick your colors in HTML code.

*Note: make sure it is not the same colour as the BackgroundColor or it will appear hidden.

<param name="TextColor" value="[HEXT HTML COLOR CODE]">

ex. <param name="TextColor" value="#FFFFF">

  
VideoBackground# This is part of a larger featureset that allows you to float the actual playing video over a larger background image.For example, a video playing on top of a scene of a beach or company branding. With this parameter you can specify the coordinates where the video will appear.    
VideoTitleImageURL Defines a URL link to a .jpg or .gif that is displayed at the beginning of the video before the video is played. Useful to contain instructions or branding image.

*Note: For aesthetic reasons, make the image the same size as the applet minus the height of the buttonset (-20 pixels).

<param name="VideoTitleImageURL" value="[RELATIVE or ABSOLUTE LINK TO .GIF or .JPG FILE">

ex. <param name="VideoTitleImageURL" value="video/mytitle.jpg">
<param name="VideoTitleImageURL" value="http://mywebsite/video/mytitle.jpg">

 
VideoTitleImageEndURL Same as above but specifying an image that appears AT THE END after the video has been stopped or finishes playing.

<param name="VideoTitleImageEndURL" value="[RELATIVE or ABSOLUTE LINK TO .GIF or .JPG FILE">

ex. <param name="VideoTitleImageEndURL" value="video/mytitle.jpg">
<param name="VideoTitleImageEndURL" value="http://mywebsite/video/mytitle.jpg">

 
VideoSizeHeight Will scale the video to fit a specified height.

<param name="VideoSizeHeight" value="[HEIGHT in PIXELS">

ex. <param name="VideoSizeHeight" value="280">

  
VideoSizeWidth Will scale the video to fit a specified width.

<param name="VideoSizeWidth" value="[HEIGHT in PIXELS">

ex. <param name="VideoSizeWidth" value="320">

  
VideoEdgeWidth Thickness in pixels of a border around the entire applet.

<param name="VideoEdgeWidth" value="[NUMBER in PIXELS]">

ex. <param name="VideoEdgeWidth" value="1">

  
VideoEdgeColor Defines the color of the border. Here is a good colour chart to help you pick your colors in HTML code.

<param name="VideoEdgeColor" value="[HEX HTML COLOR CODE">

ex. <param name="VideoEdgeColor" value="#00000">

  
VideoMessageMode

Toggles between three states of displaying the text messaging that informs the user of the player's status. The text status includes "buffering, connecting" and errors. The default is "3".

Note: Define the color of the text in the TextColor parameter.

<param name="VideoMessageMode" value="[1,2,3]">

1 - on screen
2 - in browser status bar
3 - both

ex. <param name="VideoMessageMode" value="1">

  
VideoPlaylist

Enables the queuing up of different applets with full bit rate versions from one applet.

  
ZoomVideo

Enables the zoom window feature of Clipstream™ Video 2.5.

<param name="ZoomVideo" value="[TRUE, FALSE, ICON, RIGHTCLICK, or ROLLOVER]">

True: the video is already when the applet loads.
False: same as the removal of the parameter
Icon: an Icon will appear on rollover that activates zoom
Rightclick: No icon; zoom appears if user rightclicks on the applet
Rollover: a rollover will activate the zoom

ex. <param name="ZoomVideo" value="true">

  

LICENSING
 
Name Description Syntax  
Key Defines the Code Key that the applet matches to the web server this applet is hosted on. <param name="Key" value="[THE CODE KEY]">

Where [THE CODEKEY] = The Code Key provided to you by your sales representative.

ex. <param name="Key" value="V63576T34H556">		  
KeyURL Defines the URL link to a text file that contains all of the applicable Code Keys for the server this applet is hosted on. <param name="KeyURL" value="[URL LINK TO YOUR CODEKEYS.TXT]">

ex. <param name="KeyURL" value="http://www.clipstream.com/codekeys.txt">		  
EVENTS, HYPERLINKING, JAVASCRIPT, TRACKING
 
Name Description Syntax  
CallbackOnPlay Define a JavaScript method to be activated once the video is played.

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


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

  
EventNumber Defines the number of events in the video.

<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 video.

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">

  
VideoHyperlinkNumber

Defines the number of hyperlinks the video will embed.

*Note: This used to be called VideoHyperlinkSize

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

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

 
VideoHyperlink 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 VideoHyperlinkNumber

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

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

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

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

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

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

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

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

  
VideoTrackingURL

Specifies the URL or CGI to call when the user instigates the start or stop of the video 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="VideoTrackingURL" value="track.cgi?userid=123">  
SECURITY
 
Name Description Syntax  
AuthorizedDomainURL Defines the URL link where a text file containing a list of domains authorized to play the video can be referenced by the applet.

<param name="AuthorizedDomainURL" value="[URL LINK OF TEXT DOCUMENT]">

Only works if you have the SID Security Package (contact your sales rep)

The .txt document must reside on the same web server as the applet.

ex. <param name="AuthorizedDomainURL" value="http://www.clipstream.com/authorizeddomains.txt">

  
VideoPlaybackNumber Will limit the number of times the video will play back on the page (will reset with page reload, however). Useful for security or surveys.

<param name="VideoPlaybackNumber" value="[number of times the video is allowed to play]">

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

  


copyright © 2008 about destiny media technologies, inc. | legal
Go to Java.com Go to dsny.com