Skip to main content

Video Thumbnails Capacitor plugin

Generate thumbnail images from local and remote video files at specific timestamps

Install

bun add @capgo/capacitor-video-thumbnails bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-video-thumbnails
  • pnpm add @capgo/capacitor-video-thumbnails
  • yarn add @capgo/capacitor-video-thumbnails

Guide

How to use Video Thumbnails in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Video Thumbnails plugin preview QR code

Using @capgo/capacitor-video-thumbnails

Capacitor Video Thumbnails Plugin interface for generating video thumbnails.

Install

bun add @capgo/capacitor-video-thumbnails
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { CapgoVideoThumbnails } from '@capgo/capacitor-video-thumbnails';

API at a glance

Method Description
getThumbnail Generate a thumbnail image from a video file at a specific time position.

Examples

getThumbnail()

Generate a thumbnail image from a video file at a specific time position.

import { CapgoVideoThumbnails } from '@capgo/capacitor-video-thumbnails';

const result = await CapgoVideoThumbnails.getThumbnail({
  sourceUri: 'file:///path/to/video.mp4',
  time: 5000,
  quality: 0.8
});
console.log('Thumbnail URI:', result.uri);
console.log('Dimensions:', result.width, 'x', result.height);

Full reference

Keep going from Using @capgo/capacitor-video-thumbnails

If you are using Using @capgo/capacitor-video-thumbnails to plan native media and interface behavior, connect it with @capgo/capacitor-video-thumbnails for the implementation detail in @capgo/capacitor-video-thumbnails, Getting Started for the implementation detail in Getting Started, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.

FAQ

Video Thumbnails plugin FAQ

How do I install the Video Thumbnails plugin in a Capacitor app?

Run "bun add @capgo/capacitor-video-thumbnails" (or "npm install @capgo/capacitor-video-thumbnails"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-video-thumbnails" in your app code.

Does @capgo/capacitor-video-thumbnails work with React, Vue and Angular?

Yes. Video Thumbnails is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-video-thumbnails support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-video-thumbnails free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-video-thumbnails/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Video Thumbnails without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Video Thumbnails changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo