README.md

docme-sdk

This SDK implementation requires you to enter your API key to connect to DocMe servers, for more information click here.

Install

Install using NPM or Yarn

# NPM
$ npm install docme-sdk

# Yarn
$ yarn add docme-sdk

Usage

Node.js

Measure from a video saved in the system

const fs = require('fs');
const getDocMe = require('docme-sdk');

// get version 1
const DocMe = getDocMe(1);

const docMeInstance = new DocMe('<your-api-token-here>');

const video = fs.readFileSync('/path/to/video.mp4');

// option 1
docMeInstance
  .measureFromVideo(video)
  .then(measurement => measurement.getDetails())
  .then(details => console.log(details))
  .catch(e => console.error(e));

// option 2
docMeInstance
  .measureFromVideo(video, true)
  .then(measurement => console.log(measurement.details))
  .catch(e => console.error(e));

Browser

Measure from webcam

import getDocMe, { createBlobFromStream } from 'docme-sdk';

// get version 1
const DocMe = getDocMe(1);

const docMeInstance = new DocMe('<your-api-token-here>');

// option 1
navigator.mediaDevices
  .getUserMedia({ video: true, audio: true })
  .then(stream => {
    // record for 45 seconds (or 45000 ms) and return a promise containing a blob
    return createBlobFromStream(stream, 45000);
  })
  .then(blob => {
    return docMeInstance.measureFromVideo(video, true);
  })
  .then(measurement => console.log(measurement.details))
  .catch(e => console.error(e));

// option 2
navigator.mediaDevices
  .getUserMedia({ video: true, audio: true })
  .then(stream => {
    // record for 45 seconds (or 45000 ms) and return a promise containing a blob
    return createBlobFromStream(stream, 45000);
  })
  .then(blob => {
    return docMeInstance.measureFromVideo(video);
  })
  .then(measurement => measurement.getDetails())
  .then(measurement => console.log(measurement.details))
  .catch(e => console.error(e));