NodeJS client Library for encoding Videos with Coconut

This is a fork from https://github.com/opencoconut/coconutjs

Install

npm install @ptitmouton/coconutjs

Submitting the job

Use the API Request Builder to generate a config file that match your specific workflow.

Example of coconut.conf:

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

set webhook = http://mysite.com/webhook/coconut?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:

import Coconut from '@ptitmouton/coconutjs';

const coconut = new Coconut('k-api-key');
// or add via COCONUT_API_KEY env var, just:
const coconut = new Coconut();

const job = await coconut.createJob({
  'conf': 'coconut.conf',
  'source': 'https://s3-eu-west-1.amazonaws.com/files.coconut.co/test.mp4',
  'vars': {'vid': 1234}
});

if (job.status == 'ok') {
  console.log(job.id);
} else {
  console.log(job.error_code);
  console.log(job.error_message);
}

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:

import Coconut from '@ptitmouton/coconutjs';

const coconut = new Coconut('k-api-key');
// or add via COCONUT_API_KEY env var, just:
const coconut = new Coconut();

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

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

Other example usage:

// Getting info about a job
const job = await coconut.getJob(18370773);

// Retrieving metadata
const metadata = await coconut.getAllMetadata(18370773);

// Retrieving the source file metadata only
const metadata = coconut.getMetadataFor(18370773, 'source');

// use every function callback-style
coconut.getJob(18370773, job => {
  // do something with job
});

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

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Released under the MIT license.

• Coconut website: http://coconut.co
• API documentation: http://coconut.co/docs
• Contact: [email protected]
• Twitter: @OpenCoconut