Product Update Log

JoomlaXTC YouTube Background module

The easiest way to add life to your website, this module places one or more YouTube videos as a rotating background animation on the entire site, or just a portion.




Installation
Installation is done as with any standard Joomla extension following these steps:
  1. Download the extension zip file to your PC
  2. Use the standard Joomla Extension Manager to install the file.
Configuration
Setting up videos to appear is done thru the Extensions / Module Manager menu option and clicking on "JoomlaXTC YouTube Background" module to edit the parameters. For better results, make sure the module is in a Disabled state at first while you configure it to prevent any bad data or other disruption to your website frontend. Enable the module once you are done setting the parameters.

Module parameters are split in two main groups described below:
Basic Options
VideosThese are the YouTube video ID's for the video(s) you want to show. Make sure to place only one value per line.
CSS SelectorThis parameter specifies the placement of the videos. An empty value will show the videos as the background of the entire site, any other value will be used to locate the containing block for the videos. For example, a value of #myarea will show the videos as background of a block with ID="myarea", eg: <div id="myarea">videos go here</div>
Overlay imageThis optional parameter selects an image from images/ folder to be used as an overlay for the video.
Hi-res Overlay imageSame as above, only this image will be shown on high-definition / retina devices.
Overlay PositionCSS background alignment value for the overlay image. Default value is "repeat"
OpacitySelect the opacity of the video player.
MuteChoose to hear or not video sound.
RatioSelect the aspect ratio of videos.
QualityChoose the best video quality for your needs.
Optimize DisplayFits video to display area.
LoopLoop video playback.
ShuffleRandomizes playing order for multiple videos.
VolumeSet video player volume (0=mute 100=max).
Start PositionSet the seconds the video should start at.
Advanced Options
Load jQueryThe module uses jQuery, use this parameter to choose how to load it. Disable if your are already calling it else where.
Load MooToolsMooTools is not needed, but including it helps resolve certain JavaScript conflicts. Enable only if needed.
Alternative LayoutSelect an alternate HTML rendering method, if available. See Joomla! documentation for more information.
Module Class SuffixCustom CSS class to be added on Module display. See Joomla! documentation for more information.
CachingSelect a Joomla! caching method. See Joomla! documentation for more information.
Cache TimeCache Time. See Joomla! documentation for more information.
Publishing
Once parameters are set, it is time to publish the module. The best place to do so is in the debug module position of your template. If for some reason your template does not have such a module position, you can easily add one following these simple steps:
  1. Locate and edit the index.php of your template. In some instances, the file to look for may be different. Consult your template's documentation for more information. In the case of JoomlaXTC templates, the file you need to edit is templates/templatename/layouts/layoutname/layout.php (replace templatename and layoutname with your own values).

  2. Find the </body> tag in the .php file and change it from this:
    </body>
    to this:
    <jdoc:include type="modules" name="debug" />
    </body>
    Once done, save the changes and go back to the module parameters view.

  3. On the module parameters view, type debug as the module position name and click on the Save icon to store your changes.

The module will be active after it has been properly configured and published in the frontend.
Working with YouTube videos
YouTube video playback is subject to many conditions. For example, a video might be configured to prevent playback on mobile devices, or it could have DRM region locks preventing playback on your user's locations. In addition to this, some videos may only be available in non-compatible formats or unwanted resolutions. To make matters worse, different browser technologies may cause one video to play in one browser but not in another.

These rules and locks may be outside of your control so when using videos from a 3rd party, always make sure they work on the browsers and devices you intend to use.

JoomlaXTC YouTube Background uses javaScript code Copyright (c) 2001-2013 Matteo Bicocchi (Pupunzi) used under license.
Copyright 2013 Monev Software LLC www.joomlaxtc.com

JOIN OUR NEWSLETTER