Azure's Media REST API provides a way to store, encode, and deliver media (video and images). This library makes using the API easier.
var AzureMedia = require('azure-media');
var myconfig = require('./myconfig');
var api = new AzureMedia(myconfig); // {client_id: 'your azure media id', client_secret: 'your azure media secret'}
api.init(function (err) {
// do your work here or after this callback
});
This project is not maintained and likely out of date. If you'd like to take over this project (even just by claiming the npm name for your project) open an issue and let me know.
npm install azure-media
All of the data structures and endpoints used in this library are documented in Azure Media Service REST API Reference.
Each subsection is modeled based on its "Entity Properties" section (eg. Asset Entity Properties).
Each model usable at API.rest.[lowercase model name] with create, get, update, list methods.
All REST endpoints are in the initialized api lib at api.rest.someendpoint (eg. api.rest.asset)
"data" is a JavaScript object for the appropriate endpoint model documented in the Properties section of each model in Azure Media Service REST API Reference.
Callbacks generally return an object, called a model. It uses VeryModel. VeryModel instances behave like normal objects. If you want a simpler object, call .toObject() and use the returned value.
Each endpoint will have some of the following methods:
Signature: update(id, data, callback)
Callback: function (err, model)
Signature: create(data, callback)
Callback: function(err, model)
Example:
api.rest.asset.create({Name: 'Some Asset'}, function (err, asset) {
if (err) {
console.log(err);
} else {
console.log("Created asset: " + asset.Id);
}
});
Signature: delete(id, callback)
Callback: function(err)
Signature: get(id, callback)
Callback: function(err, model)
Signature: list(callback, query)
Callback: function(err, model)
The query parameter is a JavaScript object of the query parameters documented in OData Query String Options (eg: {'$filter': "Name eq 'Bill'"})
AccessPolicys should be reused, rather than just creating a new one for every use. So rather than create, or trying to manage this yourself, use
Signature: findOrCreate(durationInMinutes, permissions, callback)
Callback: function (err, accesspolicy_model)
Signature: cancel(id, callback)
Callback: function (err)
Most callbacks return a VeryModel instance. These are based on Microsoft's documentation and are implemented in /models/
Some models have extra ORM-like methods, allowing you to interact with the model itself which will work with the Azure REST API behind the scenes.
api.uploadStream('somefile.mp4', fs.createReadStream('/some/file.mp4'), fs.statSync('/some/file.mp4').size, function (err, path, result) {
}, function (err, path) {
if(!err) {
console.log("done uploading");
}
});
api.downloadStream(assetId, 'video/mp4', fs.createWriteStream('/some/download/path.mp4', function (err) {
});
api.getDownloadURL(assetId, 'video/mp4', fs.createWriteStream('/some/download/path.mp4', function (err, url) {
});
api.encodeVideo(assetId, 'H264 Broadband SD 4x3', function (err, job)) {
});