JSPM

videoapicloudjs

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q9167F
  • License MIT

NodeJS Module to encode videos with VideoAPI.cloud

Package Exports

  • videoapicloudjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (videoapicloudjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NodeJS client Library for VideoAPI.cloud

Install

npm install videoapicloudjs

Submitting the job

Example of videoapicloud.conf:

var s3 = s3://accesskey:secretkey@mybucket

set webhook = http://mysite.com/webhook/videoapicloud?videoId=$vid

-> mp4  = $s3/videos/video_$vid.mp4
-> webm = $s3/videos/video_$vid.webm
-> jpg:300x = $s3/previews/thumbs_#num#.jpg, number=3

Here is the javascript code to submit the config file:

var videoapicloud = require('videoapicloudjs');

videoapicloud.createJob({
  'api_key': 'k-api-key',
  'conf': 'videoapicloud.conf',
  'source': 'https://s3-eu-west-1.amazonaws.com/videoapi.cloud/test.mp4',
  'vars': {'vid': 1234}
}, function(job) {
  if(job && job.status == 'ok') {
    console.log(job.id);
  } else if (job) {
    console.log(job.error_code);
    console.log(job.error_message);
  } else {
    console.log('Error creating job')
  }
});

You can also create a job without a config file. To do that you will need to give every settings in the method parameters. Here is the exact same job but without a config file:

var videoapicloud = require('videoapicloudjs');

vid = 1234
s3 = 's3://accesskey:secretkey@mybucket'

videoapicloud.createJob({
  'api_key': 'k-api-key',
  'source': 'http://yoursite.com/media/video.mp4',
  'webhook': 'http://mysite.com/webhook/videoapicloud?videoId=' + vid,
  'outputs': {
    'mp4': s3 + '/videos/video_' + vid + '.mp4',
    'webm': s3 + '/videos/video_' + vid + '.webm',
    'jpg:300x': s3 + '/previews/thumbs_#num#.jpg, number=3'
  }
}, function(job) {
  //...
});

Other example usage:

// Getting info about a job
job = videoapicloud.getJob(18370773, function(job) {
  //...
});

// Retrieving metadata
videoapicloud.getAllMetadata(18370773, function(metadata) {
  // ...
});

// Retrieving the source file metadata only
videoapicloud.getMetadataFor(18370773, 'source', function(metadata) {
  // ...
});

Note that you can use the environment variable VIDEOAPICLOUD_API_KEY to set your API key.

Released under the MIT license.