nativescript-transcoder v0.1.0-alpha.1

nativescript-transcoder

WARNING, WORK IN PROGRESS, v1.0 excepted end of March

This plugins for nativescript brings video transcoding support.

• Hardware transcoding on android through android-transcoder.
• @todo Hardware transcoding on iOS through AVFoundation
• @todo Software transcoding on iOS/Android through FFMpeg

The plugins support observing events as well as promises.

Only AAC audio is supported right now on Android, simulator camera is using 3GPP audio, so you can not test it with the simulator

For hardware mode, only 720p resolution is supported on android, other resolutions may not work on some devices, a way to select the best profile may be developed (Note for above for future developments on this plugin: CamcorderProfile is the way to go to retrieve all possible encoding resolutions, then we just need to select the best one according to settings).

Installation

tns plugin add nativescript-transcoder

Usage

JavaScript

const {
  Transcoder,
  TranscoderVideoCodec,
  TranscoderEventList,
} = require('nativescript-transcoder');

const transcoder = new Transcoder(inputFilePath, {
  videoBitrate: 1000 * 1000, // 1mbps
  resolutionConstraint: 720,
  videoCodec: TranscoderVideoCodec.H264,
});

transcoder.transcode().then(({ filePath }) => {
  console.log(`Output file path: ${filePath}`);
}).catch((err) => {
  console.log(`Error: ${err.type} - ${err.message}`);
});

transcoder.on(TranscoderEventList.Progress, (progress) => {
  console.log(`Progress: ${progress}`);
})

TypeScript

import {
  Transcoder,
  TranscoderVideoCodec,
} from 'nativescript-transcoder';

const transcoder = new Transcoder(inputFilePath, {
  videoBitrate: 1000 * 1000, // 1mbps
  resolutionConstraint: 720,
  videoCodec: TranscoderVideoCodec.H264,
});

transcoder.transcode().then(({ filePath }) => {
  console.log(`Output file path: ${filePath}`);
}).catch((err: TranscoderException) => {
  console.log(`Error: ${err.type} - ${err.message}`);
});

transcoder.on(TranscoderEventList.Progress, (progress: number) => {
  console.log(`Progress: ${progress}`);
})

API

Transcoder

The main class you need to use, a transcoder can only be used for one transcoding.

Constructor

Methods

Properties

Events

TranscoderOptions

Construct an object to pass as options to new Transcoder(filePath, options).

All options are optionals.

TranscoderException

Exemple

transcoder.on(TranscoderEventList.Failed, (err: TranscoderException) => {
  switch (err.type) {
    case TranscoderExceptionType.InvalidOutputFormat:
      console.log('The device doesn\'t support the asked output')
      break;
    default: // TranscoderExceptionType.Failed:
      console.log('Unable to trasncode')
      break;
  }
})

Properties

TranscoderExceptionType

An enum containing all possible types

Prefered way is to use TranscoderExceptionType.Canceled instead of it's value ('CANCELED').

License

Apache License Version 2.0, January 2004