@meframe/axii

@meframe/axii

Meframe player component for Axii framework.

Installation

npm install @meframe/axii axii
# or
pnpm add @meframe/axii axii

Configuration

⚠️ Important: Add the Vite plugin to your project:

// vite.config.ts
import { defineConfig } from 'vite';
import { meframePlugin } from '@meframe/core/vite-plugin';

export default defineConfig({
  plugins: [
    meframePlugin(), // Required: copies worker files for production
  ],
});

Usage

import { MeframePlayer } from '@meframe/axii';

function App() {
  const composition = {
    version: '1.0',
    fps: 30,
    durationUs: 10_000_000,
    root: {
      type: 'group',
      id: 'root',
      startUs: 0,
      durationUs: 10_000_000,
      children: [
        {
          type: 'video',
          id: 'video-1',
          src: 'https://example.com/video.mp4',
          startUs: 0,
          durationUs: 5_000_000,
        },
      ],
    },
  };

  return <MeframePlayer composition={composition} />;
}

Features

• Reactive Integration: Seamlessly integrates with Axii's reactive system
• Zero Config: Worker files automatically resolved (with plugin)
• TypeScript: Full type safety
• Extensible: Plugin system for custom features

Development

See DEVELOPMENT.md for development guide.

Deployment

See DEPLOYMENT.md for deployment guide, including:

• Building the library
• Deploying examples/demos
• Production configuration

Documentation

• Architecture
• API Reference
• Integration Guide

License

MIT