peertube-plugin-transposer-connector/README.md

Transposer connector is a PeerTube language tool plugin to transcribe and translate with Whisper

# Transposer Connector

A multilingual video plugin for PeerTube, developed by fairkom.

Transposer enables automatic transcription and translation of video content using Whisper by OpenAI. It's designed to make video content accessible in multiple languages and supports modern web protocols like ActivityPub and REST.

## ✨ Features

- Transcribe and translate videos automatically
- Translate transcripts into 26 languages
- Save transcriptions as captions
- Edit captions directly in the UI
- Translate video metadata into 26 languages
- Switch metadata language in the UI
- Change the UI language dynamically
- Access metadata via:
  - ActivityPub (JSON-LD)
  - REST API endpoint

## 🌍 Supported Languages

Transposer currently supports translation into 26 languages.
(A complete list can be added here if desired.)

- 🇦🇪 Arabic (ar)
- 🇧🇦 Bosnian (bs)
- 🇧🇬 Bulgarian (bg)
- 🇭🇷 Croatian (hr)
- 🇨🇿 Czech (cs)
- 🇳🇱 Dutch (nl)
- 🇬🇧 English (en)
- 🇪🇪 Estonian (et)
- 🇫🇮 Finnish (fi)
- 🇫🇷 French (fr)
- 🇩🇪 German (de)
- 🇬🇷 Greek (el)
- 🇮🇱 Hebrew (he)
- 🇭🇺 Hungarian (hu)
- 🇮🇹 Italian (it)
- 🇵🇱 Polish (pl)
- 🇵🇹 Portuguese (pt)
- 🇷🇴 Romanian (ro)
- 🇷🇺 Russian (ru)
- 🇷🇸 Serbian (sr)
- 🇸🇰 Slovak (sk)
- 🇸🇮 Slovenian (sl)
- 🇪🇸 Spanish (es)
- 🇸🇪 Swedish (sv)
- 🇹🇷 Turkish (tr)
- 🇺🇦 Ukrainian (uk)

## 🚀 Getting Started

Visit: https://tube.dev.displ.eu/p/transposer

From there, you can:

- Trigger transcription, translation, and metadata translation
- Edit and manage captions
- View and switch between language versions of metadata and UI

### Query Parameters

- Switch metadata language:

```bash
  ?metadatalanguage={langcode}
```

- Switch UI language:

```bash
  ?uilanguage={langcode}
```

## 🔗 Accessing Metadata

You can access translated metadata using different endpoints:

- REST API (proxied):

https://api.transposer.eu/dev/peertube/metadata/<videoId>

- REST API (direct PeerTube plugin)

https://<instance>/plugins/transposer-connector/router/language/metadata/video/<videoId>

- REST API (direct PeerTube with version of plugin)

https://<instance>/plugins/transposer-connector/<pluginVersion>/router/language/metadata/video/<videoId>

- ActivityPub (JSON-LD format)

curl -H "Accept: application/activity+json" \
https://<instance-name>/videos/watch/<videoId>

## ⚙️ How It Works

To support high-volume PeerTube instances, Transposer is designed for asynchronous processing using a queuing system.

The architecture includes:

- A dedicated Transposer Engine
- Support for multiple adapters, including one for Whisper
- A Kafka pipeline for distributed processing
- Kong Gateway for exposing APIs and managing routing

This ensures scalable handling of transcription and translation jobs with minimal impact on the PeerTube server.

## 🔧 Dependencies

! Note: This plugin is still under development.

You’ll need a Language Transposer Service account to enable transcription and translation features.

To request test access, email: support@fairkom.eu
After receiving credentials, configure the plugin in the PeerTube admin interface by adding the provided service URL.

## 🧑‍💻 Codebase

- Source code available at: https://git.fairkom.net/emb/displ.eu/transposer
- development doc: [Development Documentation](./DEVELOPMENT.md)

## 📦 Changelog

See here: [Changelog](./CHANGELOG.md)

## TODOs

- 🔐 Restrict Access to Authenticated Users: Ensure the page is only accessible to users who are logged in.
- 🆕 Allow Language Change via Query Parameter: Add the ability to change the caption language using a query parameter, for example, &lang=es.
- 🧪 Add GitLab CI Pipeline: Set up a GitLab CI pipeline with SonarQube for automated testing and quality checks.
- 🔄 Refactor Code: Refactor the codebase to improve maintainability, performance, and clarity.