seiarotg / axeengine Goto Github PK

#AxeEngine

a javascript library for resolving the real URL of online videos which works in both Node.js and browser.

中文说明和如何取得视频ID的相关问题见wiki

> npm install axeengine

> git clone https://github.com/SEIAROTg/AxeEngine.git
> cd AxeEngine
> npm install
> grunt

Output files will be in <git dir>/dest/.

To run test, simply run <git dir>/dest/test.js with Node.js. Make sure test.js is in the same directory as AxeEngine.js.

AxeEngine works in both Node.js and browser. But actually, there can be various of environments, such as Node.js application, web page, and browser extension. Different environment may have different HTTP interface. Therefore, you need to pass HTTP handler to AxeEngine when loading.

After loading, AxeEngine will be in the global namespace (global in Node.js, window in browser).

var loadAxeEngine = require('axeengine');
loadAxeEngine({
    httpGet: < your HTTP handler >
});

Your HTTP handler should be a function that accepts two arguments URL and encoding and returns a Promise object which return HTTP Response Body when resolved.

// loadAxeEngine will be automatically add into window object when including AxeEngine.js
// Suppose you have no permission to make cross-domain request
var jsonp = < your jsonp handler >;
loadAxeEngine({
    jsonp: < your jsonp handler >,
});

Your jsonp handler should accept the same arguments as HTTP handler and return a Promise object which return parsed JSON Object when resolved.

If you have permission to make cross-domain request, or do not need cross-domain, you can also pass httpGet as in Node.js.

var resolver = AxeEngine.resolverManager.create(<resolver name>, <video id>);

• <resolver name> is the registration name of resolver. See the list at bottom.
• <video id> is the id of the video in its site. It may be in different format in different sites and resolvers.

resolver.getTitle().then(function(title){
    // ...
});

resolver.getTitle takes no arguments and return a Promise which returns the title in string when resolved.

A video may have different versions in some sites.

resolver.listVersion().then(function(list){
    // ...
});

resolver.listVersion takes no arguments and return a Promise which returns a array of versions.

resolver.listVersion().then(function(list){
    index = resolver.getCurrentVersion();
    version = list[index];
});

resolver.getCurrentVersion returns current version index in version list.

resolver.switchVersion(< index >).then(function(){
    // ...
});

• <index> is the index of the new version in the version list

A video usually have multiple qualities.

resolver.listQuality().then(function(list){
    // ...
});

resolver.listQuality takes no arguments and return a Promise which returns a array of qualities.

resolver.listVersion().then(function(list){
    index = resolver.getCurrentVersion();
    version = list[index];
});

resolver.getCurrentVersion returns current version index in version list.

resolver.switchVersion(< index >).then(function(){
    // ...
});

• <index> is the index of the new version in the version list

GNU Affero General Public License 3.0