Tigerra Converter NODEJS-SDK

Overview

This documentation provides an overview of the Tigerra Converter library, which allows for various file conversions including audio, video, image, document, and font conversions. Additionally, it supports applying audio effects.

Installation

To use the Tigerra Converter library, you need to include the required dependencies using Composer:

git clone https://github.com/Tigerra-com/convert-nodejs-sdk.git
cd convert-nodejs-sdk
npm i
node index.js

Usage

Basic Example

Below is an example of how to use the Tigerra Converter nodejs-sdk to convert an audio file from FLAC to WAV:

const Converter = require('./Converter');
const ConversionStatusChecker = require('./ConversionStatusChecker');
const ConverterFileDownloader = require('./ConverterFileDownloader');
const ConverterDeletePid = require('./ConverterDeletePid');

(async () => {
    try {
        const authToken = "your-auth-token";

        // Start conversion
        console.log("Uploading file..");
        const converter = new Converter(authToken);
        const conversionResponse = await converter.audio("flac-to-wav", "/path/to/file/1.flac");
        const pid = conversionResponse.pid;
        console.log(`Conversion started. PID: ${pid}`);

        // Check status
        const statusChecker = new ConversionStatusChecker(authToken);
        let status;
        let statusResponse;
        do {
            statusResponse = await statusChecker.checkStatus(pid);
            status = statusResponse.status;
            console.log(`Status: ${status}`);

            if (status === ConversionStatusChecker.STATUS_COMPLETED) {
                break;
            } else if ([ConversionStatusChecker.STATUS_UPLOAD_ERROR, ConversionStatusChecker.STATUS_PROCESS_ERROR, ConversionStatusChecker.STATUS_CONVERT_ERROR].includes(status)) {
                throw new Error(`Error occurred: ${status}`);
            }

            await new Promise(resolve => setTimeout(resolve, 2000));
        } while (status === ConversionStatusChecker.STATUS_PENDING);

        // Download file
        const downloadUrl = statusResponse.data;
        const downloader = new ConverterFileDownloader(authToken);
        const outputPath = "/path/to/file/downloaded_file.wav";
        await downloader.downloadFile(downloadUrl, outputPath);
        console.log(`File downloaded to: ${outputPath}`);

        // Delete PID
        const deletePid = new ConverterDeletePid(authToken);
        const deleteResponse = await deletePid.delete(pid);
        if (deleteResponse.success === true) {
            console.log("PID deleted successfully.");
        } else {
            console.log(`Error deleting PID: ${deleteResponse.message}`);
        }

    } catch (error) {
        console.error(`Error: ${error.message}`);
    }
})();

Converter Class

The Converter class provides methods for different types of conversions:

• audio(conversionType, filePath)
• video(conversionType, filePath)
• image(conversionType, filePath)
• document(conversionType, filePath)
• font(conversionType, filePath)
• pdf_compress(filePath)
• audio_effect(effectType, filePath, params = [])

Each method sends a request to the appropriate endpoint to perform the conversion or apply the effect. About the audio_effect method types nad conversionType's, read them from tiggera.com documentation.