Quick Start Guide

<script type='text/javascript' src='{your_path_to}/jQuery.jQTubeUtil.js'></script>
			

<script type="text/javascript">
	jQTubeUtil.init({
		key: "[insert your key here]",
		orderby: "viewCount",  // *optional -- "viewCount" is set by default
		time: "this_month",   // *optional -- "this_month" is set by default
		maxResults: 10   // *optional -- defined as 10 results by default
	});
</script>
			

Free Text Search

jQTubeUtil.search("[keywords]", callbackFunction);  // basic: just specify the callback function 
jQTubeUtil.search(parametersObject, callbackFunction);  // advanced: fine tune the search 
			

Standard Feed Search

				
jQTubeUtil.mostViewed(callbackFunction);  // basic: just specify the callback function 
jQTubeUtil.mostViewed(parametersObject, callbackFunction);  // advanced: fine tune the search 

jQTubeUtil.mostRecent(callbackFunction);  // basic: just specify the callback function 
jQTubeUtil.mostRecent(parametersObject, callbackFunction);  // advanced: fine tune the search 

jQTubeUtil.mostPopular(callbackFunction);  // basic: just specify the callback function 
jQTubeUtil.mostPopular(parametersObject, callbackFunction);  // advanced: fine tune the search 

jQTubeUtil.topRated(callbackFunction);  // basic: just specify the callback function 
jQTubeUtil.topRated(parametersObject, callbackFunction);  // advanced: fine tune the search 

jQTubeUtil.topFavs(callbackFunction);  // basic: just specify the callback function 
jQTubeUtil.topFavs(parametersObject, callbackFunction);  // advanced: fine tune the search 

			

Single Video Fetch

jQTubeUtil.video(videoId, callbackFunction);
			

Autucomplete via Google Suggest

jQTubeUtil.suggest("[keywords]", callbackFunction);
			

Free Text Search & Standard Feed Search

callbackFunction = function(response){ 
	var html = "";
	for(vid in response.videos){
		var video = response.videos[vid];
		html += "Video : " + video.title;
	}
	alert(html);
}
			

Single Video Fetch

callbackFunction = function(response){ 
	var html = "";
	var vid = response.videos[0];
	html = "Video : " + vid.title;
	alert(html);
}
			

Autocomplete via Google Suggest

callbackFunction = function(response){ 
	var html = "";
	for(sug in response.suggestions){
		var suggestion = response.suggestions[sug];
		html += "Suggested : " + 
	}
	alert(html);
}
			

Free Text Search

The Free Text search can be simply passed a string argument, and it'll use the defaults when the jQTubeUtil was initialized. If, however, you want to specify more details in a specific search you can pass an object, and pass the string in as a parameter, "q".

The additional parameters you can override, are "time", "orderby" and "max-results". To simplify the selecting of time and orderby, the jQTubeUtil utility provides public getters - getTimes() and getOrders(). All you need to do is select which item of that you want, and pass it with the parametersObject. Max-results is a number and defines the max number of videos you want in the response.

parametersObject = {
	"q": "search query",
	"time": jQTubeUtil.getTimes()[pick an index],
	"orderby": jQTubeUtil.getOrders()[pick an index],
	"max-results": 20
}
			

Standard Feed Search

The three parameters you can override are "time", "orderby" and "max-results". Again, as detailed above, use jQTubeUtil's public getter methods for time.

parametersObject = {
	"time": jQTubeUtil.getTimes()[pick an index],
	"orderby": jQTubeUtil.getOrders()[pick an index],
	"max-results": 20
}
			

Defaults / Internals

var SearchDefaults = {
	"q": "",
	"orderby": jQTubeUtil.getOrders()[2],
	"time": jQTubeUtil.getTimes()[3],
	"max-results": 10
});

var CoreDefaults = {
	"key": "<the key that you pass in>",
	"format": 5, 
	"alt": "json",
	"callback": "?"
});

var SuggestDefaults = {
	"hl": "en",
	"ds": "yt", 
	"client": "youtube",
	"hjson": "t",
	"cp": 1
});

Helpers

The jQTubeUtil's aim is to simplify searching YouTube. There are parameters that the YouTube API specifies and requires as options for particular request params. The two parameters that jQTubeUtil currently support retrieving the options out of, are "orderby" and "time". In an effort to simplify the selection process, the utility provides public getters to retrieve them so you can select an option.

"orderby" options

jQTubeUtil.getOrders() = ["relevance", "published", "viewCount", "rating"];

"time" options

jQTubeUtil.getTimes() = ["today","this_week","this_month","all_time"],

Methods

The jQTubeUtil object is a singleton. It has methods that you can use by passing callbacks along with params (if any).

Initialization

 jQTubeUtil.init({
	 key: "my key",
	 orderby: jQTubeUtil.getOrders()[#],
	 time: jQTubeUtil.getTimes()[#],
	 maxResults: #,
	 lang: "en"
 });

Search - Free Text & Standard Feeds

 jQTubeUtil.search("family guy",function(response){
	 /* The response */ 
 });

 jQTubeUtil.search({
	"q": "family guy",
	"time": jQTubeUtil.getTimes()[#],
	"orderby": jQTubeUtil.getOrders()[#],
	"max-results": 25
 },function(response){
	 /* The response */ 
 });

Single Video Fetch

 jQTubeUtil.video("videoId",function(response){
	 /* The response object */ 
 });

Autocomplete Suggestion

 jQTubeUtil.suggest("family guy", function(response){
	/*  response = { 
		suggestions:[], 
		searchURL: String 
		}  */
 });

Legal

MIT License

Frequently Asked Questions

What version of jQuery is jQTubeUtil dependent on?

jQuery 1.3.2+

Does jQTubeUtil need anything else?

As long as you have a Developer Key you should be all set.