API Documentation

Documentation to seamlessly integrate Flixmate in your web applications and extensions

Installation and Usage

Download Flixmate-1.0.0.min.js file and include it in your webpage or extension.

<script src="Flixmate-1.0.0.min.js"></script>

Wait for script initialization and generate a url with your media request.


                const flixmate = new Flixmate();

                // Wait for Flixmate to be ready
                flixmate.Ready.then(() => {
                    // Check if Flixmate desktop application is installed
                    if (flixmate.isInstalled) {
                        // Media request to combine audio and video
                        const mediaRequest = {
                            quality: '1080p',
                            videoUrl: 'https://example.com/video.webm',
                            audioUrl: 'https://example.com/audio.webm',
                            startTime: 0,
                            endTime: 120,
                            format: 'mp4',
                            title: 'Track title',
                        };

                        // URL will open Flixmate desktop application and start the conversion
                        const url = flixmate.generateUrl(mediaRequest);
                    }
                });
            

Properties

Ready Promise<void>

A promise that is resolved when flixmate is ready to be used. Always wait for it to be resolved before using any flixmate features.

IsInstalled Boolean

Whether Flixmate desktop application is installed or not.

Methods

generateUrl(mediaRequest)

Generates a URL with encoded media request that is passed to Flixmate desktop application. mediaRequest has following properties.

quality: String Out resolution for a video conversion and bitrate for audio. i.e. 1080p, 720p, 128Kbps

videoUrl: String Stream to be used as the output video

audioUrl: String Stream to be used as the output audio

startTime: Number Start of the output media track in seconds (for cutting)

endTime: Number End of the output media track in seconds (for cutting)

format: String Output media format, can be one of these: mp4, mp3, 3gp, avi, flv, mkv

title: String Output media filename