mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-12 21:47:22 -05:00
78 lines
2.9 KiB
Plaintext
78 lines
2.9 KiB
Plaintext
# Vyla Documentation
|
|
|
|
Vyla is a community-built media project focused on freedom, privacy, and giving people control over their own experience.
|
|
|
|
## Project Overview
|
|
|
|
Vyla is not a streaming service and does not host or provide media. Instead, Vyla builds software that brings the media experience together while leaving control in the hands of the person using it. The project consists of:
|
|
|
|
- **Vyla Home**: Desktop application for Windows, macOS, and Linux
|
|
- **Vyla Go**: Android mobile application
|
|
- **Vyla TV**: Android TV application
|
|
- **Vyla SDK**: Node.js/TypeScript SDK for developers
|
|
- **Stream API**: Self-hosted HTTP/SSE API for browser and mobile clients
|
|
|
|
## Key Features
|
|
|
|
- Self-hosted and privacy-focused
|
|
- Open source community project
|
|
- Provider-based streaming resolution
|
|
- Multi-platform support (desktop, Android, Android TV)
|
|
- Developer-friendly SDK and API
|
|
- Support for HLS and MP4 streaming
|
|
- Built-in health monitoring and fallback systems
|
|
|
|
## Documentation Structure
|
|
|
|
- `/` - Introduction to Vyla
|
|
- `/architecture` - System architecture and component relationships
|
|
- `/home` - Vyla Home desktop application
|
|
- `/go` - Vyla Go Android application
|
|
- `/tv` - Vyla TV Android TV application
|
|
- `/player` - Building custom media players
|
|
- `/sdk` - SDK reference documentation
|
|
- `/sdk-quickstart` - Quick start guide for SDK
|
|
- `/stream-api/overview` - Stream API overview
|
|
- `/stream-api/paths` - API paths and SSE events
|
|
- `/stream-api/media-data` - Subtitles and downloads API
|
|
- `/stream-api/operations` - Health, testing, and operations
|
|
- `/self-hosting` - Self-hosting deployment guide
|
|
- `/concepts/providers` - Provider configuration and verification
|
|
- `/guides/integrations` - Client integration guide
|
|
- `/guides/error-handling` - Error handling and fallbacks
|
|
- `/misc/credit` - Credits and acknowledgments
|
|
- `/misc/dmca` - DMCA and copyright policy
|
|
|
|
## Technical Stack
|
|
|
|
- Node.js 18+ for SDK and Stream API
|
|
- TypeScript for SDK
|
|
- Server-Sent Events (SSE) for streaming
|
|
- HLS.js for web playback
|
|
- TMDB API for metadata
|
|
- Jetpack Compose for Android TV
|
|
|
|
## Integration Options
|
|
|
|
1. **Direct SDK**: For Node.js applications - embed provider resolution directly
|
|
2. **Stream API**: For browser/mobile clients - HTTP/SSE interface
|
|
3. **Vyla Home**: Managed desktop experience with bundled services
|
|
|
|
## Important Notes
|
|
|
|
- Vyla is self-hosted only - no public hosted instance
|
|
- Requires TMDB API key for metadata-dependent sources
|
|
- Provider availability varies by network environment
|
|
- Supports fallback strategies for resilient playback
|
|
- CORS-enabled by default
|
|
- No database required for Stream API
|
|
|
|
## Community
|
|
|
|
- GitLab: https://gitlab.com/vyla-entertainment/
|
|
- Discord: https://discord.gg/5eqRhKeywG
|
|
|
|
## Legal
|
|
|
|
Vyla does not host or distribute media. Rights holders can request source removal via the DMCA policy. The project is intended for personal, educational, and development use. Users are responsible for complying with applicable laws.
|