CamPrompter (VScript Android)

The Android implementation of VScript: The Creator’s Studio.

CamPrompter is a professional-grade mobile application tailored for content creators, designed to bring the VScript vision to Android. It aims to combine high-fidelity video recording, a synchronized teleprompter, and robust session management into a seamless mobile experience.

---

🚀 Core Features

✅ Implemented

• Studio & Recording:
  • High-quality video recording with CameraView.
  • Real-time switching between front/back cameras.
  • Audio visualization with waveform feedback.
  • Selectable microphone inputs and video resolution (up to 4K).
• Gallery: Built-in media gallery to review recorded videos and audio.
• Settings: Granular control over camera and audio configurations.

🚧 Roadmap (Planned)

• Intelligent Teleprompter:
  • Smart scrolling overlay synchronized with speech or manual speed controls.
  • Draggable wrapper independent of camera view.
  • Custom fonts and opacity settings.
• Session Management:
  • Multi-clip recording sessions (Takes).
  • Cloud Sync via Firebase (Firestore & Storage) to sync with VScript Web.
• Global Dialogs: Unified dialog system for non-blocking alerts.
• Audio Visualization: Real-time waveform visualization of audio input. We need to re-write this enitrely.

---

🛠️ Architecture & Tech Stack

Following the VScript Android Implementation Guide, this project aims to adopt modern Android development standards:

• Language: Kotlin
• Architecture: MVVM with Clean Architecture principles.
• UI: Traversing towards Jetpack Compose (currently ViewBinding/XML).
• Async: Coroutines & Flow.
• Dependency Injection: Hilt (Planned).

Component	Android Implementation	Status
Video Recorder	CameraView / CameraX	✅ Implemented
Teleprompter	LazyColumn overlay	🚧 Planned
State Management	ViewModel + StateFlow	🟡 In Progress
Data Storage	Room + DataStore	🚧 Planned
Cloud Sync	Firebase Android SDK	🚧 Planned

---

🚦 Getting Started

Prerequisites

• Android Studio Arctic Fox or newer.
• JDK 11 or newer.
• Android Device/Emulator (API 24+).

Installation

1. Clone:

   git clone https://github.com/SamarthaKV29/CamPrompter.git

2. Open: Load the project in Android Studio.
3. Sync: Let Gradle download dependencies.
4. Run: Deploy to your device.

🔐 Permissions

• Camera: For video capture.
• Microphone: For audio recording.
• Storage: For saving media and accessing the gallery.

---

🤝 Contributing

Contributions are welcome, especially those that help bridge the gap between the current state and the full VScript vision!

1. Fork the repo.
2. Create your feature branch (git checkout -b feature/TeleprompterOverlay).
3. Commit changes.
4. Open a Pull Request.