All properties should be set in the "RMP_PlayerMedia.js" file.
| Property | Type | Example | Comment |
|---|---|---|---|
| detectFlashPlayer | Boolean | detectFlashPlayer=true; | Display a pop up if Flash Player version < 9.0.28 (minimum version required for FullScreen) |
| fullScreenFunction | Boolean | fullScreenFunction=true; | If false, fullscreen mode won't be available. |
| Property | Type | Example | Comment |
|---|---|---|---|
| phpPath | String | phpPath="/movies/flv_provider.php"; | Path of the PHP provider script. Path relative to the "RMP_PlayerMedia.swf" file or absolute path (movies should be located in the same folder) |
| movieName | String | movieName=""; | Name of the movie file without extension. See "bandwidth detection" section if you want to use movies with different bitrates. If you are using the component in list mode, movieName should be set to "" |
| Property | Type | Example | Comment |
|---|---|---|---|
| bufferTime | Number | bufferTime=1; | |
| volume | Number | volume=75; | Volume at start (0 to 100). |
| autostart | Boolean | autostart=false; | If autostart=false, the movie will be paused at start. |
| endBehaviour | Stop | Loop | endBehaviour="Stop"; | Behaviour when the movie ends. |
| endFullScreenBackToNormal | Boolean | endFullScreenBackToNormal=true; | If true, return from full screen to normal mode when the movie ends. |
| endJavascriptFunction | String | endJavascriptFunction="alert('alert function');"; | Your custom javascript function that will be called at the end of the movie. Flash will call getURL("javascript:" + nameOfYourFunction); |
| stopCloseConnect | Boolean | stopCloseConnect=true; | If true, the Nestream connection will be closed when stop button is pressed. |
Set differentVersions to true to enable bandwidth detection.
Define the different bitrates values in kbps (audio+video bitrate).
When the detected bandwidth equals of exceeds the version values, the associated movie will be selected.
If differentVersions=false: upload a single version of a movie to your server : [movieName].flv
if differentVersions=true: upload multiple versions (ex: low, med, hi) of a movie to your server :
- [movieName][version_hi_extension].flv
- [movieName][version_medium_extension].flv
- [movieName][version_low_extension].flv
Set the movie name extension that is associated with each different bitrate version.
Use format of "_text" for each version name; this value will be appended to the movieName.
| Property | Type | Example | Comment |
|---|---|---|---|
| differentVersions | Boolean | differentVersions=true; | |
| version_hi_value | Number | version_hi_value=800; | Hi bitrate value in kbps (audio+video bitrate). |
| version_medium_value | Number | version_medium_value=400; | Medium bitrate value in kbps (audio+video bitrate). |
| version_low_value | Number | version_low_value=200; | Low bitrate value in kbps (audio+video bitrate). |
| version_hi_extension | String | version_hi_extension="_800"; | |
| version_medium_extension | String | version_medium_extension="_400"; | |
| version_lowextension | String | version_low_extension="_200"; |
Set pictures parameters to true to display a picture at start (if autostart=false) and when the movie is stopped.
The picture has to be a jpeg file and must be named exactly the same as the movieName parameter.
If movieName="myVideo", the player will try to load myVideo.jpg file.
The pictures must be located in a unique pictures folder.
| Property | Type | Example | Comment |
|---|---|---|---|
| pictures | Boolean | pictures=true; | |
| picturesFolder | String | picturesFolder="/myFlash/pictures"; | The pictures must be located in this pictures folder. |
| picturesBackgroundColor | Color | picturesBackgroundColor="#000000"; | Set a background color for the picture. |
| picturesKeepAspectRatio | Boolean | picturesKeepAspectRatio=false; | |
| picturesKeepAspectRatioFullScreen | Boolean | picturesKeepAspectRatioFullScreen=false; | Set to true to prevent distortion during full screen mode. |
| Property | Type | Example | Comment |
|---|---|---|---|
| clickOnScreen_useHandCursor | Boolean | clickOnScreen_useHandCursor=true; | Set to true to use hand cursor to indicate the screen is clickable. |
| singleClickPlayPause | Boolean | singleClickPlayPause=true; | Set to true to pause or resume the playback with a single click anywhere on the screen. |
| screenPlayButton | Boolean | screenPlayButton=true; | Set to true to show a play button on screen. |
| screenPlayButtonAlpha | Number | screenPlayButtonAlpha=70; | Set the alpha transparency (0 to 100, low value is most transparent). |
| doubleClickListener | Boolean | doubleClickListener=true; | Set to true to go full screen with a double click. |
Smoothing and bestQuality options.
Note: enabling these options will increase CPU usage.
Users with low-powered computers or that have multiple applications open may have viewing problems. Use these with caution...
| Property | Type | Example | Comment |
|---|---|---|---|
| bestQuality | Boolean | bestQuality=false | |
| smoothing | Boolean | smoothing=true; | |
| smoothingFullScreen | Boolean | smoothingFullScreen=false; | |
| deblocking | Number | deblocking=0; | 0 : Let the video compressor apply the deblocking filter as needed. 1 : Do not use any deblocking filter. 2 : Use the Sorenson deblocking filter. 3 : Use the On2 deblocking filter and no deringing filter. 4 : Use the On2 deblocking and the fast On2 deringing filter. 5 : Use the On2 deblocking and the better On2 deringing filter. |
You can set different parameters to be used in Normal and Full Screen Mode.
| Property | Type | Example | Comment |
|---|---|---|---|
| playerWidth | Number | playerWidth=645; | |
| playerHeight | Number | playerHeight=300; | playerHeight includes the size of the control bar (15 pixels) when in Normal Mode. |
| autoSize | Off | Movie | autoSize="Movie"; |
autoSize="Movie" maintains the movie's aspect ratio during Normal Mode. autoSize="Off" allows the movie to distort and fill the player in Normal Mode. |
| autoSizeFullScreen | Off | Movie | autoSizeFullScreen="Movie"; |
autoSizeFullScreen="Movie" maintains the movie's aspect ratio during Full Screen Mode. autoSizeFullScreen="Off" allows the movie to distort and fill the screen in Full Screen Mode. |
| playerColor | Color | playerColor="#222222"; | Normal Mode |
| barColor | Color | barColor="#FFFFFF"; | Normal Mode |
| playbarColor | Color | playbarColor="#E2F9D9"; | Normal Mode |
| screenBorder | Boolean | screenBorder=true; | Normal Mode |
| screenBorderColor | Color | screenBorderColor="#222222"; | Normal Mode |
| buttonsColor | Color | buttonsColor="#FFFFFF"; | Normal Mode |
| timeColor | Color | timeColor="#FFFFFF"; | Normal Mode |
| backgroundColor | Color | backgroundColor="#000000"; | Normal Mode |
| backgroundAlpha | Number | backgroundAlpha=100; | Set the alpha transparency (0 to 100, low value is most transparent). |
| controlsY | Number | controlsY=10; | Space between the bottom of the screen and the control bar in Normal Mode. |
| controlsYFullScreen | Number | controlsYFullScreen=10; | y position from the bottom of the screen in Full Screen Mode. |
| controlsWidthFullScreen | Number | controlsWidthFullScreen=500; | Size of the control bar in Full Screen Mode. Set controlsWidthFullScreen=0 to fit with the width of the screen. |
| playerColorFullScreen | Color | playerColorFullScreen="#222222"; | Full Screen Mode |
| barColorFullScreen | Color | barColorFullScreen="#FFFFFF"; | Full Screen Mode |
| playbarColorFullScreen | Color | playbarColorFullScreen="#E2F9D9"; | Full Screen Mode |
| buttonsColorFullScreen | Color | buttonsColorFullScreen="#FFFFFF"; | Full Screen Mode |
| timeColorFullScreen | Color | timeColorFullScreen="#FFFFFF"; | Full Screen Mode |
| backgroundColorFullScreen | Color | backgroundColorFullScreen="#000000"; | Full Screen Mode |
| backgroundAlphaFullScreen | Number | backgroundAlphaFullScreen=100; | Set the alpha transparency (0 to 100, low value is most transparent). |
| Property | Type | Example | Comment |
|---|---|---|---|
| controls | Hide | Autohide | Show | controls="Show"; | Normal Mode |
| controlsFullScreen | Hide | Autohide | Show | controlsFullScreen="Autohide"; | Full Screen Mode |
| listButtons | Boolean | listButtons=true; | Enable button : true or false |
| stopButton | Boolean | stopButton=true; | Enable button : true or false |
| stopButtonFirst | Boolean | stopButtonFirst=true; | |
| rewindFastForwardButtons | Boolean | rewindFastForwardButtons=true; | Enable button : true or false |
| rw_ff_interval | Number | rw_ff_interval=4; | Rewind and fast forward intervals (rw_ff_interval) in seconds. |
| volumeSlider | Boolean | volumeSlider=true; | Enable volume slider : true or false |
| showTimecode | Boolean | showTimecode=true; | Enable timecode : true or false |
| controlsBarPress | Boolean | controlsBarPress=true; | |
| timeFormat | 'mm:ss' | 'hh:mm:ss' | 'mm:ss|duration' | 'hh:mm:ss|duration' | timeFormat="mm:ss|duration"; |
| Property | Type | Example | Comment |
|---|---|---|---|
| bufferMessage | Boolean | bufferMessage=true | |
| bufferText | String | bufferText="buffering"; | |
| bufferTextColor | Color | bufferTextColor="#FFFFFF"; | |
| bufferTextBackgroundColor | Color | bufferTextBackgroundColor="#993333"; | |
| bufferTextBackgroundAlpha | Number | bufferTextBackgroundAlpha=70; | Set the alpha transparency (0 to 100, low value is most transparent). |
| bufferTextPosition | Upper Right | Upper Left | Lower Right | Lower Left | Center | bufferTextPosition="Upper Right"; |
| Property | Type | Example | Comment |
|---|---|---|---|
| logo | Boolean | logo=true; | Enables a logo to be displayed on the screen during playback: true | false. |
| logoPath | String | logoPath="/myFlash/swf/logo.swf"; | Set path to the logo file. The logo file has to be a jpg or a swf. |
| logoPosition | Upper Right | Upper Left | Lower Right | Lower Left | logoPosition="Upper Right"; | |
| logoAlpha | Number | logoAlpha=70; | Set the alpha transparency (0 to 100, low value is most transparent). |
| logo_x | Number | logo_x=10; | Set logo position in pixels from edge of player. |
| logo_y | Number | logo_y=10; | Set logo position in pixels from edge of player. |
If differentVersions=false then only upload a single version of a commercial movie to your server: [commercialMovieName].flv
If differentVersions=true, you will need to upload multiple versions (ex: low, med, hi) of a commercial movie to your server.
Use the same bitrate version extensions that were defined in the BANDWIDTH DETECTION section above :
- [commercialMovieName][version_hi_extension].flv
- [commercialMovieName][version_medium_extension].flv
- [commercialMovieName][version_low_extension].flv
| Property | Type | Example | Comment |
|---|---|---|---|
| commercialMovieName | String | commercialMovieName="myCommercial"; | Set the commercialMovieName without extension. |
| commercialFunctionStart | String | commercialFunctionStart="alert('Commercial starts');"; | Javascript function to call when the commercial starts. Flash will call getURL("javascript:"+nameOfYourFunction); |
| commercialFunctionClickScreen | String | commercialFunctionClickScreen="alert('Click on commercial');"; | Javascript function to call when the user clicks on the screen during a commercial. |
| commercialMessage | CommercialText | CommercialText and MovieTitle | commercialMessage="CommercialText"; | Select to show either a commercial text message or a commercial text message plus the "coming next" movie title. |
| movieTitleForComingNext | String | movieTitleForComingNext="my Movie"; | Set movieTitleForComingNext property if commercialMessage = "CommercialText and MovieTitle". |
| commercialText | String | commercialText="Your movie will start after this commercial..."; | Commercial text message. |
| commercialTextColor | Color | commercialTextColor="#FFFFFF"; | |
| commercialTextBold | Boolean | commercialTextBold=true; |
Subtitles must be defined in an XML file.
| Property | Type | Example | Comment |
|---|---|---|---|
| subtitleXML | String | subtitleXML="/myFlash/xml/subtitles.xml"; | Subtitles XML file path. |
| subVisible | Boolean | subVisible=true; | Show subtitles at start : true or false. |
| subButton | Boolean | subButton=true; | Enable button : true or false. |
| subButtonOffColor | Color | subButtonOffColor="#FFFFFF"; | |
| subColor | Color | subColor="#FFFFFF"; | Normal Mode |
| subBackground | Boolean | subBackground=true; | Normal Mode |
| subBackgroundColor | Color | subBackgroundColor="#000000"; | Normal Mode |
| subBackgroundAlpha | Number | subBackgroundAlpha=70; | Set the alpha transparency (0 to 100, low value is most transparent). |
| subFontSize | Number | subFontSize=16; | Normal Mode |
| autohideSubBackground | Boolean | autohideSubBackground=true; | Normal Mode |
| subAlign | left | center | right | subAlign="center"; | Normal Mode |
| subColorFullScreen | Color | subColorFullScreen="#FFFFFF"; | Full Screen Mode |
| subBackgroundFullScreen | Boolean | subBackgroundFullScreen=true; | Full Screen Mode |
| subBackgroundColorFullScreen | Color | subBackgroundColorFullScreen="#000000"; | Full Screen Mode |
| subBackgroundAlphaFullScreen | Number | subBackgroundAlphaFullScreen=70; | Set the alpha transparency (0 to 100, low value is most transparent). |
| subFontSizeFullScreen | Number | subFontSizeFullScreen=16; | Full Screen Mode |
| autohideSubBackgroundFullScreen | Boolean | autohideSubBackgroundFullScreen=true; | Full Screen Mode |
| subAlignFullScreen | left | center | right | subAlignFullScreen="center"; | Full Screen Mode |
| blankLineFullScreen | Number | blankLineFullScreen=0; | Full Screen Mode |
Set mediaXML to "" if you don't want to use media list mode.
| Property | Type | Example | Comment |
|---|---|---|---|
| mediaXML | String | mediaXML="/myFlash/xml/myMedia.xml" | Absolute or relative path to Media List XML file. |
| startBehaviour | "Wait for click" | "Play first media" | "Pause on first media" | startBehaviour="Pause on first media" | |
| displayListAtStart | Boolean | displayListAtStart=true; | Normal Mode |
| displayListInFullScreenMode | Boolean | displayListInFullScreenMode=true; | Full Screen Mode |
| displayListWhenEnteringFullScreenMode | Boolean | displayListWhenEnteringFullScreenMode=true; | Full Screen Mode. This property is used only if displayListInFullScreenMode is set to true. |
| scrollListener | Boolean | scrollListener=true; | |
| scrollSize_auto | Boolean | scrollSize_auto=true; | |
| scrollSize | Number | scrollSize=50; | This property is used only if scrollSize_auto is set to false. |
| scrollAirSkin | Boolean | scrollAirSkin=false; | Skin the scroll bar with Air skin. |
| pictureWidth | Number | pictureWidth=60; | Normal Mode |
| pictureHeight | Number | pictureHeight=45; | Normal Mode |
| listWidth | Number | listWidth=200; | Normal Mode |
| listSpace | Number | listSpace=5; | Normal Mode. Space between movie's border and player's border when playing in list mode. |
| cellHeight | Number | cellHeight=55; | Normal Mode |
| showDescription | Boolean | showDescription=true; | Normal Mode |
| showPicture | Boolean | showPicture=true; | Normal Mode |
| textFontSize | Number | textFontSize=10; | Normal Mode |
| titleFontSize | Number | titleFontSize=10; | Normal Mode |
| titleBold | Boolean | titleBold=true; | Normal Mode |
| blankLineAfterTitle | Boolean | blankLineAfterTitle=false; | Normal Mode |
| textColor | Color | textColor="#FFFFFF"; | Normal Mode |
| titleColor | Color | titleColor="#FFFFFF"; | Normal Mode |
| selectColor | Color | selectColor="#121212"; | Normal Mode |
| selectAlpha | Number | selectAlpha=100; | Normal Mode. Set the alpha transparency (0 to 100, low value is most transparent). |
| focusColor | Color | focusColor="#121212"; | Normal Mode |
| focusAlpha | Number | focusAlpha=50; | Normal Mode. Set the alpha transparency (0 to 100, low value is most transparent). |
| listButtonsColor | Color | listButtonsColor="#FFFFFF"; | Normal Mode |
| listBarColor | Color | listBarColor="#222222"; | Normal Mode |
| skinColor | Color | skinColor="#121212"; | Normal Mode |
| listBackgroundColor | Color | listBackgroundColor="#222222"; | Normal Mode |
| listBackgroundAlpha | Number | listBackgroundAlpha=100; | Normal Mode. Set the alpha transparency (0 to 100, low value is most transparent). |
| border | Boolean | border=true; | Normal Mode. Border line between list and video. |
| borderColor | Color | borderColor="#222222"; | Normal Mode |
| spaceBP | Number | spaceBP=5; | Normal Mode. Space before picture. |
| spaceBT | Number | spaceBT=5; | Normal Mode. Space before text. |
| spaceAT | Number | spaceAT=20; | Normal Mode. Space after text. |
| spaceTT | Number | spaceTT=5; | Normal Mode. Space top text. |
| pictureWidthFullScreen | Number | pictureWidthFullScreen=80; | Full Screen Mode |
| pictureHeightFullScreen | Number | pictureHeightFullScreen=60; | Full Screen Mode |
| listWidthFullScreen | Number | listWidthFullScreen=200; | Full Screen Mode |
| listSpaceFullScreen | Number | listSpaceFullScreen=5; | Full Screen Mode. Space between movie's border and player's border when playing in list mode. |
| cellHeightFullScreen | Number | cellHeightFullScreen=55; | Full Screen Mode |
| showDescriptionFullScreen | Boolean | showDescriptionFullScreen=true; | Full Screen Mode |
| showPictureFullScreen | Boolean | showPictureFullScreen=true; | Full Screen Mode |
| textFontSizeFullScreen | Number | textFontSizeFullScreen=10; | Full Screen Mode |
| titleFontSizeFullScreen | Number | titleFontSizeFullScreen=10; | Full Screen Mode |
| titleBoldFullScreen | Boolean | titleBoldFullScreen=true; | Full Screen Mode |
| blankLineAfterTitleFullScreen | Boolean | blankLineAfterTitleFullScreen=false; | Full Screen Mode |
| textColorFullScreen | Color | textColorFullScreen="#FFFFFF"; | Full Screen Mode |
| titleColorFullScreen | Color | titleColorFullScreen="#FFFFFF"; | Full Screen Mode |
| selectColorFullScreen | Color | selectColorFullScreen="#121212"; | Full Screen Mode |
| selectAlphaFullScreen | Number | selectAlphaFullScreen=100; | Full Screen Mode. Set the alpha transparency (0 to 100, low value is most transparent). |
| focusColorFullScreen | Color | focusColorFullScreen="#121212"; | Full Screen Mode |
| focusAlphaFullScreen | Number | focusAlphaFullScreen=50; | Full Screen Mode. Set the alpha transparency (0 to 100, low value is most transparent). |
| listButtonsColorFullScreen | Color | listButtonsColorFullScreen="#FFFFFF"; | Full Screen Mode |
| listBarColorFullScreen | Color | listBarColorFullScreen="#222222"; | Full Screen Mode |
| skinColorFullScreen | Color | skinColorFullScreen="#121212"; | Full Screen Mode |
| listBackgroundColorFullScreen | Color | listBackgroundColorFullScreen="#222222"; | Full Screen Mode |
| listBackgroundAlphaFullScreen | Number | listBackgroundAlphaFullScreen=100; | Full Screen Mode. Set the alpha transparency (0 to 100, low value is most transparent). |
| borderFullScreen | Boolean | borderFullScreen=true; | Full Screen Mode. Border line between list and video. |
| borderColorFullScreen | Color | borderColorFullScreen="#222222"; | Full Screen Mode |
| spaceBPFullScreen | Number | spaceBPFullScreen=5; | Full Screen Mode. Space before picture. |
| spaceBTFullScreen | Number | spaceBTFullScreen=5; | Full Screen Mode. Space before text. |
| spaceATFullScreen | Number | spaceATFullScreen=20; | Full Screen Mode. Space after text. |
| spaceTTFullScreen | Number | spaceTTFullScreen=5; | Full Screen Mode. Space top text. |
You can use HTML tags to style your text.
Detect Flash Player Text=[detectPopUpText1]+[versionNumber]+[detectPopUpText2]
| Property | Type | Example | Comment |
|---|---|---|---|
| detectPopUpTitle | String | detectPopUpTitle="Adobe Flash Player Version"; | |
| detectPopUpText1 | String | detectPopUpText1="You have Flash Player<br>version "; | |
| detectPopUpText2 | String | detectPopUpText2=" installed.<br><br>Enjoy a fullscreen<br>experience with the new Flash Player."; | |
| detectPopUpButton1 | String | detectPopUpButton1="Get Flash"; | Button label to get update for Flash Player. |
| detectPopUpButton2 | String | detectPopUpButton2="Continue"; | Button label to bypass Flash Player update feature. |
Detect Bandwidth Result Text=[bandwidthDetectPopUpText2]+[bandwidth]+" kbps"
| Property | Type | Example | Comment |
|---|---|---|---|
| displayBandwidthDetectPopUp | Boolean | displayBandwidthDetectPopUp=true; | Enable Bandwidth Detect Pop Up window: true or false |
| bandwidthDetectPopUpTitle | String | bandwidthDetectPopUpTitle="Rich Media Project Speed Detector"; | |
| bandwidthDetectPopUpText1 | String | bandwidthDetectPopUpText1="Detecting Bandwidth <br>Please wait..."; | |
| bandwidthDetectPopUpText2 | String | bandwidthDetectPopUpText2="Your Bandwidth :<br>"; |
Loading Movie Pop Up
| Property | Type | Example | Comment |
|---|---|---|---|
| displayLoadingMoviePopUp | Boolean | displayLoadingMoviePopUp=true; | Enable Loading Movie Pop Up window : true or false |
| loadingMoviePopUpTitle | String | loadingMoviePopUpTitle="Loading..."; | |
| loadingMoviePopUpText | String | loadingMoviePopUpText="Loading Movie<br>Please wait..."; |
Select Bandwidth Pop Up : Enables viewer to select bandwidth manually via this popup window.
Select Bandwidth Text = [bandwidthSelectPopUpText1] + [bandwidthTextForXXXBandwidth] + [bandwidthSelectPopUpText2] + [version_XXX_value] + [bandwidthSelectPopUpText3]
| Property | Type | Example | Comment |
|---|---|---|---|
| bandwidthSelectPopUpTitle | String | bandwidthSelectPopUpTitle="Bandwidth Selector"; | |
| bandwidthSelectPopUpButton1 | String | bandwidthSelectPopUpButton1="Low"; | |
| bandwidthSelectPopUpButton2 | String | bandwidthSelectPopUpButton2="Medium"; | |
| bandwidthSelectPopUpButton3 | String | bandwidthSelectPopUpButton3="Hi"; | |
| bandwidthTextForLowBandwidth | String | bandwidthTextForLowBandwidth="Low"; | |
| bandwidthTextForMediumBandwidth | String | bandwidthTextForMediumBandwidth="Medium"; | |
| bandwidthTextForHiBandwidth | String | bandwidthTextForHiBandwidth="Hi"; | |
| bandwidthSelectPopUpText1 | String | bandwidthSelectPopUpText1=""; | |
| bandwidthSelectPopUpText2 | String | bandwidthSelectPopUpText2=" bandwidth is selected :<br>"; | |
| bandwidthSelectPopUpText3 | String | bandwidthSelectPopUpText3=" kbps movie.<br><br>Please select the desired<br>bandwidth :"; |
Info Pop Up : this pop up is displayed if no movie is loaded at start (movieName="")
| Property | Type | Example | Comment |
|---|---|---|---|
| displayInfoPopUp | Boolean | displayInfoPopUp=true; | Enable Info Pop Up window : true or false |
| infoPopUpTitle | String | infoPopUpTitle="Select a movie"; | |
| infoPopUpText | String | infoPopUpText="Please select a movie in the gallery"; |
| Property | Type | Example | Comment |
|---|---|---|---|
| swfPath | String | swfPath="/myFlash/swf/RMP_PlayerMedia"; | Path of the swf that contains the player (without swf extension). |
| swfID | String | swfID="RMP_PlayerMedia"; | Flash Object ID. |
| speedClipPath | String | speedClipPath="/myFlash/swf/speedClip"; | Path of the swf that contains the speed detector clip (without swf extension). |
| swfWidth | Number | swfWidth=playerWidth; | You should not change this property. |
| swfHeight | Number | swfHeight=playerHeight+controlsY+1; | You should not change this property. |
| swfBackgroundColor | Color | swfBackgroundColor="#FFFFFF"; | Flash Object background color. |