@spark-apps/quickpeek
v1.0.1
Published
Core library for QuickPeek - AI-powered demo video generation
Maintainers
Readme
QuickPeek Core
Core library for QuickPeek - AI-powered demo video generation
Installation
npm install @spark-apps/quickpeekOverview
This is the core library used by @spark-apps/quickpeek-cli. It provides:
- API Client - Communication with QuickPeek backend for AI planning
- TTS Engine - Text-to-speech via Edge TTS (60+ languages)
- FFmpeg Wrapper - Video composition, watermarks, effects
- Prompt Builder - System and user prompts for AI planning
- Web Crawler - Page analysis for demo planning
- Utilities - Caption styling, ASS subtitle generation, config management
Usage
import {
callAI,
generateVoiceover,
composeVideo,
crawlPage,
buildSystemPrompt,
buildUserPrompt,
DEFAULT_CONFIG,
VERSION,
} from '@spark-apps/quickpeek';
// Crawl a page for interactive elements
const { title, elements } = await crawlPage('https://example.com');
// Generate AI demo plan
const systemPrompt = buildSystemPrompt(8);
const userPrompt = buildUserPrompt(url, title, elements, 'English', 'A todo app', 8);
const result = await callAI(systemPrompt, userPrompt, '[email protected]');
// Generate voiceover
const { voiceoverPath, stepAudio } = await generateVoiceover(
steps,
config,
workDir,
outputDir,
logError,
task,
info
);
// Compose final video
await composeVideo({
videoPath,
assPath,
outputPath,
voiceoverPath,
musicPath,
// ... options
});Exports
| Module | Description |
|--------|-------------|
| api-client | Backend API communication |
| tts | Text-to-speech generation |
| ffmpeg | Video composition |
| prompts | AI prompt templates |
| crawl | Web page analysis |
| config | Default configuration |
| utils | ASS subtitles, color conversion |
| voices | Voice mappings for 60+ languages |
| styles | Caption styling |
| cursor | Custom cursor CSS/JS |
| watermark | Watermark generation |
Related Packages
@spark-apps/quickpeek-cli- CLI tool
MIT License - Made with ☕ by Spark Apps
