My favorites | Sign in
Project Home Downloads Wiki Issues Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
JcFarcryFlvPlayer_1_0_documentation_FC4  
Installing and usage examples of the jcFarcryFlvPlayer plugin (for FarCry 4.x)
Featured
Updated Jun 19, 2009 by coughlinj@gmail.com

Description

The jcFarcryFlvPlayer plugin for FarCry takes advantage of the JW FLV Media Player (a flash-based audio/video player) to offer your website/web-application users playback of your video and audio content (FLV, MP3, H264, SWF, JPG, PNG and GIF).

Currently there is one rule included in this plugin (for FLV playback), however it can be used for other format playback (either by extending the rules for more configurable options, or create a new rule (using the existing one as a base example).

Author

Jeff Coughlin (http://jeffcoughlin.com)

Download

Download JcFarcryFlvPlayer plugin on the downloads page or get the BER release from SVN.

Examples

Listing Page (teasers)

Example screenshot taken from: http://www.lowellgeneral.org/go/videos

Video Player/Details Page

Example screenshot taken from: http://www.lowellgeneral.org/go/videos/the-birthplace

Minimum Requirements

  • ColdFusion 7.0.2
  • FarCry Core v4.0.9
    • Note: You can use versions earlier than 4.0.9, but if you plan to use the www feature in this plugin (where the plugin inserts the js and/or css in the
      <head>
      </head>
      block) you'll have to disable the object broker in both rules due to a caching bug not fixed until 4.0.9.

Installation

  • Place the plugin folder (jcFarcryFlvPlayer) in the FarCry plugins folder
  • Add jcFarcryFlvPlayer to your plugin list in the farcryinit tag of your project's www/Application.cfm
  • Update the application scope (?updateapp=1)
  • (optional) customize many settings in the plugin (see Configure the Plugin below)
  • (optional) Note: This feature is turned on by default, so to use the plugin out-of-the box, create a web mapping called "jcFarcryFlvPlayer". This can be disabled or configured
    • Description: If you plan to use the included www files (js, css) you must set a web mapping (alias/virtual directory) pointing to the www folder of the plugin. By default the web mapping expects to be called "jcFarcryFlvPlayer", but you can customize this in your project's config/_serverSpecificVars.cfm file.
  • Deploy the type and rules in the COAPI manager

How to Use

  • Add FLV files in the webtop using the provided tools (under Content --> Plugins --> FLV Files)

  • While logged into FarCry, browse to the page where you'd like the list of video teasers
  • Go into design mode (right-click and in the dhtml menu choose show design)
  • click on the container you want to add the rule.
    • In the popup window choose FLV Player: List Media as Teasers
    • Click Move to Active Rules and click Commit Changes

  • Choose desired configuration and/or filter options and save

  • Hide the design mode when done to see the finished look

Configure the Plugin (Optional)

As a best-practice FarCry plugins tend to keep their customizable settings in the variable structure application.stplugins.PLUGINNAME. The list below describes the customizable settings this plugin offers. To set them, edit your project's config/_serverSpecificVars.cfm file (which gets loaded whenever the application scope is updated).

Var Name Type Description Default
application.stplugins.jcfarcryflvplayer.bLoadPluginCssFilebooleanAttempt to load the plugin's css file(s) (you may prefer to use your own css data instead. I've provided plenty of (x)HTML hooks for css flexibility)true
application.stplugins.jcfarcryflvplayer.bLoadJsFilebooleanAttempt to load the plugin's javascript file(s)true
application.stplugins.jcfarcryflvplayer.url.pluginrootstringThe webroot of the pluginapplication.url.webroot & "/jcFarcryFlvPlayer"
application.stplugins.jcfarcryflvplayer.url.expressinstallstringwebroot location of the expressinstall.swf file (a setting for swfobject)application.stplugins.jcfarcryflvplayer.url.pluginroot & "/includes/expressinstall.swf"
application.stplugins.jcfarcryflvplayer.url.missingTeaserImagestringlocation of missing teaser image. This plugin comes with two of them (icon_missingvideo_rndcnr_100x70.jpg and icon_missingvideo_100x70.jpg) or you can use one that is completely your ownapplication.stplugins.jcfarcryflvplayer.url.pluginroot & "/css/images/icon_missingvideo_rndcnr_100x70.jpg"

Other Products & Licenses

This plugin makes use of 4 other products (each having their own license):

Powered by Google Project Hosting