A jQueryplugin
that sets a div or span to show a Google Search Videobar.
The current version is 2.0.0 and is available
under the MIT licence.
For more detail see the documentation reference page.
Or see a minimal page that you could
use as a basis for your own investigations.
The
Google Search Videobar functionality can easily be added to a division.
It displays a set of video links based on provided search terms.
The default search term is 'jquery'.
Google places some restrictions on your use of this service, including
obtaining a key
specific to a target URL providing the service, making the Web site
freely accessible, and showing included Google branding.
See the link above for more details.
You can also remove the GSVideobar widget if it is no longer required.
The default is a floating video player, appearing next to the videobar.
Alternately, you can provide the jQuery selector or object for
a container to hold the player somewhere else on the page.
You can also set the player's size in your own CSS.
You can connect multiple videobars to the one player.
Connect the first videobar to the player area,
then mark other videobars as "slaves" to the original "master".
You can set the videobar up to cycle automatically through a set of search terms,
with control over the interval between cycles and the order.
Just pass an array of search terms when attaching the videobar.
Connect a status area to the videobar to show all the search terms,
indicating which is currently being used
and allowing the user to change to another term.
Cycling:
$('#cycleVideobar').gsvideobar({statusArea: '#cycleStatus',
search: ['jquery', 'australia', 'cats', 'dance']});
var times = [$.gsvideobar.cycleVShort, $.gsvideobar.cycleShort,
$.gsvideobar.cycleMedium, $.gsvideobar.cycleLong];
var modes = [$.gsvideobar.cycleRandom, $.gsvideobar.cycleLinear];
$('#cycle select').change(function() {
$('#cycleVideobar').gsvideobar('option',
{cycleTime: times[$('#cycleTime').val()],
cycleMode: modes[$('#cycleMode').val()]});
});
Custom Search
You can provide preset links or free text entry to generate
new video searches by using the 'search' command.
This tab highlights examples of this plugin in use "in the wild".
None as yet.
To add another example, please contact me (wood.keith{at}optusnet.com.au)
and provide the plugin name, the URL of your site, its title,
and a short description of its purpose and where/how the plugin is used.
Quick Reference
A full list of all possible settings is shown below. Note that not all would apply in all cases.
For more detail see the documentation reference page.
$(selector).gsvideobar({
horizontal: true, // True for horizontal display, false for vertical
thumbnailSize: this.thumbnailsMedium, // The size of the video thumbnails
player: '', // jQuery selector, jQuery object, or element
// for the player area, or '' for a floating player
master: '', // jQuery selector, jQuery object, or element
// for the master videobar on the same page
closeText: '', // Text displayed at the top of the player to close it
search: 'jquery', // Single or list of search terms
manyResults: false, // True for many results, false for only a few
cycleTime: this.cycleMedium, // Time between cycles of the search terms
cycleMode: this.cycleRandom, // Mode of cycling through the search terms
statusArea: '' // jQuery selector, jQuery object, or element for a status area
});
$.gsvideobar.setDefaults(settings) // Change settings for all instances
$.gsvideobar.youTube(channel) // Get the identifier for a youTube channel
$(selector).gsvideobar('option', settings) // Change the instance settings
$(selector).gsvideobar('option', name, value) // Change an instance setting
$(selector).gsvideobar('option', name) // Retrieve an instance setting
$(selector).gsvideobar('search', terms) // Perform a search
$(selector).gsvideobar('destroy') // Remove the GSVideobar functionality
Usage
Include the jQuery library in the head section of your page.