This commit is contained in:
2026-11-15 17:34:41 -08:00
parent bc7c89b528
commit 46152a464d
37 changed files with 1413 additions and 3919 deletions

View File

@@ -1,84 +1,25 @@
# Vyla Go (Android Mobile)
<p class="page-description">The native Android mobile client for the Vyla ecosystem, combining hardware-accelerated shaders, automated runtime management, and mobile streaming.</p>
<p class="page-description">Smooth mobile streaming player for Android phones and tablets.</p>
<img class="vyla-banner" src="/src/assets/images/android/site_preview.webp" alt="Vyla Go mobile application" loading="lazy" decoding="async" fetchpriority="low" />
## Overview
**Vyla Go** brings the Vyla media ecosystem to Android phones and tablets. Built with **Tauri v2 Mobile**, Vyla Go delivers a responsive touch interface with WebGL hardware shaders and background playback support.
---
## Downloads
Official APKs are available on [GitLab Releases](https://gitlab.com/vyla-entertainment/go/-/releases):
Official APK packages are available directly on [GitLab Releases](https://gitlab.com/vyla-entertainment/go/-/releases):
- **[Universal APK](https://gitlab.com/vyla-entertainment/go/-/releases)**: Supports `arm64-v8a`, `armeabi-v7a`, and `x86_64` on Android 7.0+ (API 24+).
- **[ARM64 APK](https://gitlab.com/vyla-entertainment/go/-/releases)**: Optimized for modern 64-bit Android devices.
- **[Universal APK](https://gitlab.com/vyla-entertainment/go/-/releases)**: Recommended for most Android phones and tablets (supports `arm64-v8a`, `armeabi-v7a`, and `x86_64` on Android 7.0+).
- **[ARM64 APK](https://gitlab.com/vyla-entertainment/go/-/releases)**: Smaller download optimized specifically for modern 64-bit devices.
---
## Key Features
## Installation
- **Tauri v2 Mobile**: Native Rust Android layer with secure Chromium WebView rendering.
- **WebGL Hardware Shaders**: Dynamic backdrops and smooth gesture animations.
- **Automated Resource Updates**: Fetches and applies runtime payload updates directly from release channels without requiring full APK reinstalls for minor script updates.
- **Low-Latency Streaming**: Adaptive mobile bitrate switching with background audio playback.
---
## Building from Source
### Prerequisites
- Node.js 20+
- Rust & Cargo
- Android Studio with Android SDK & NDK (API 29+)
Add cross-compilation targets:
```bash
rustup target add aarch64-linux-android x86_64-linux-android
```
### Build Commands
```bash
npm install
npm run build:payload
npm run build:apk
```
Output APK location:
```
src-tauri/gen/android/app/build/outputs/apk/universal/release/app-universal-release.apk
```
---
## Debugging with ADB
### Stream Logs
```powershell
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" logcat -s VylaGo
```
Clear and re-stream:
```powershell
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" logcat -c
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" logcat -s VylaGo
```
### Crash Diagnostics
```powershell
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" logcat -d | Select-String "VylaGo|AndroidRuntime|FATAL"
```
### Install to Connected Device
```powershell
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" install -r "src-tauri\gen\android\app\build\outputs\apk\universal\release\app-universal-release.apk"
```
### Reset App State
```powershell
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" shell am force-stop com.vyla.go
& "$env:LOCALAPPDATA\Android\Sdk\platform-tools\adb.exe" shell pm clear com.vyla.go
```
1. Download the latest `.apk` file using your Android browser from GitLab Releases.
2. Tap the completed download notification or open your **Files** / **Downloads** app.
3. If prompted with *“For your security, your phone is not allowed to install unknown apps from this source”*:
- Tap **Settings** in the dialog.
- Turn on **Allow from this source**.
- Tap the back button to return to the installer.
4. Tap **Install** and wait a moment for installation to complete.
5. Tap **Open** to start enjoying Vyla Go.

View File

@@ -1,53 +1,36 @@
# Vyla Home (Desktop)
<p class="page-description">The native desktop control center and player runtime for Windows, macOS, and Linux built on Tauri v2 and an embedded Node.js sidecar.</p>
<p class="page-description">Fast, lightweight desktop streaming player for Windows, macOS, and Linux.</p>
<img class="vyla-banner" src="/src/assets/images/desktop/site_preview.webp" alt="Vyla Home desktop application preview" loading="lazy" decoding="async" fetchpriority="low" />
## Overview
**Vyla Home** is the desktop client for the Vyla ecosystem. Built with **Tauri v2** and an embedded Node.js sidecar process, Vyla Home uses native system WebViews (WebView2 on Windows, WebKit on macOS/Linux) for fast startups and hardware-accelerated video decoding with minimal memory usage.
---
## Downloads
Binary packages are available on [GitLab Releases](https://gitlab.com/vyla-entertainment/home/-/releases):
Download the latest release for your platform from [GitLab Releases](https://gitlab.com/vyla-entertainment/home/-/releases):
- **Windows**: [Download Setup Installer / Portable (.exe)](https://gitlab.com/vyla-entertainment/home/-/releases) (x86_64)
- **macOS**: [Download Disk Image (.dmg)](https://gitlab.com/vyla-entertainment/home/-/releases) (Universal: Apple Silicon & Intel)
- **Linux**: Build from source using the steps below.
- **Windows**: [Download Setup Installer (.exe)](https://gitlab.com/vyla-entertainment/home/-/releases)
- **macOS**: [Download Disk Image (.dmg)](https://gitlab.com/vyla-entertainment/home/-/releases) (Universal for Apple Silicon & Intel)
- **Linux**: Build from source using the commands below
---
## Architecture
## Installation
- **Tauri Main Process (Rust)**: Manages window state, system tray icons, native menus, and hosts the WebView.
- **Stdio IPC**: Bi-directional JSON-RPC stream passing messages between Rust and the Node.js sidecar over `stdin` and `stdout`.
- **Node.js Sidecar**: Runs `ServiceManager` for local/remote failover, verifies update signatures via `UpdateClient`, manages Discord Rich Presence, and caches local media metadata.
### Windows
1. Download the installer or portable `.exe` from GitLab Releases.
2. Run the downloaded file to launch Vyla Home.
3. If Windows Defender SmartScreen shows a prompt, click **More info** and select **Run anyway**.
### Storage Locations
- **Windows**: `%APPDATA%\vyla-home\vyla-home-files\`
- **macOS**: `~/Library/Application Support/vyla-home/vyla-home-files/`
- **Linux**: `~/.local/share/vyla-home/vyla-home-files/`
*Note: If you receive a WebView2 initialization error, download and install the free Microsoft Edge WebView2 Evergreen Runtime from Microsoft.*
### Sidecar Logs
- **Windows**: `%APPDATA%\vyla-home\vyla-home-files\logs\node-debug.log`
- **macOS/Linux**: `<AppDataDir>/logs/node-debug.log`
### macOS
1. Download the `.dmg` disk image.
2. Double-click the `.dmg` file to open it.
3. Drag the **Vyla Home** icon into your **Applications** folder.
4. Launch Vyla Home from Launchpad or Applications.
---
## Windows Troubleshooting
If you encounter a `WebView2 runtime initialization error`:
1. Install the Microsoft Edge WebView2 Evergreen Runtime from Microsoft.
2. For portable installs, confirm `WebView2Loader.dll` is present in the `bin/` directory adjacent to the executable.
---
## Linux Build Guide
### 1. Install System Dependencies
### Linux
To build and install on Linux:
:::code-group
<!-- tab: Fedora / RHEL -->
@@ -74,34 +57,11 @@ sudo pacman -Syu --needed \
```
:::
### 2. Install Rust Toolchain
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
```
### 3. Clone and Build
Clone the repository and build:
```bash
git clone https://gitlab.com/vyla-entertainment/home.git vyla-home
cd vyla-home
npm install
npm run build:payload
npm run dev
npm run build
```
---
## Developer Workflows
```bash
npm run dev
npm run build:payload
npm run dev -- -- --env VYLA_TEST_UI=1
npm run release:full
```
If a hung process locks the binary during Windows development:
```powershell
Stop-Process -Name "vyla-home", "node", "cargo" -Force -ErrorAction SilentlyContinue
```

View File

@@ -1,135 +0,0 @@
# Building a Custom Player
<p class="page-description">Architectural principles, format handling, and engineering guidelines for building video players backed by Vyla infrastructure.</p>
## Overview
Vyla handles discovery, scraping, and proxying; your app owns the player. Whether building a web player, desktop shell, or mobile UI, this guide outlines the core playback patterns.
---
## Integration Paths
- **Node.js Backends**: Use the Vyla SDK directly in-process via `sdk.getStream()`. Ideal for custom authentication and server-side tracking.
- **Web / Mobile / TV**: Connect to the Stream API gateway via HTTP/SSE (`/movie` or `/tv`). Ideal for frontend players requiring a live streaming feed.
---
## Playback Formats
- **HLS Streams (`type: "hls"`)**: Adaptive master playlists (`.m3u8`). Proxied via Stream API (`/api?url=...`), which rewrites chunk URIs and AES encryption keys with permissive CORS headers. Handled via HLS.js or native Safari.
- **Direct Video (`type: "mp4"`)**: Direct MP4 or MKV files. Proxied with HTTP Range forwarding (`206 Partial Content`) for scrubbing.
---
## Player Guidelines
1. **Start on First Source**: Begin playback as soon as the first `source` event arrives (3–8s). Queue later events as fallbacks.
2. **Auto-Failover**: If the current stream fails, catch fatal playback errors and immediately switch to the next queued source.
3. **Async Subtitles**: Fetch subtitles in the background without blocking video buffering.
4. **Watchdog Timer**: If no working source resolves within 15–20s, show an empty state with a retry option.
5. **Clean Teardown**: When switching media, close the SSE connection and destroy the HLS instance before opening a new stream.
---
## Minimal Web Player Example
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Vyla Custom Player</title>
<script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
<style>
video { width: 100%; max-width: 960px; height: auto; background: #000; border-radius: 8px; }
.status { font-family: sans-serif; margin-top: 8px; color: #666; }
</style>
</head>
<body>
<video id="vyla-video" controls playsinline></video>
<div id="status" class="status">Connecting to Stream API...</div>
<script>
const API_BASE = "https://api.vyla.cc";
const TMDB_ID = 155;
const video = document.getElementById("vyla-video");
const statusEl = document.getElementById("status");
const fallbackSources = [];
let isPlaying = false;
let hlsInstance = null;
const eventSource = new EventSource(`${API_BASE}/movie?id=${TMDB_ID}`);
eventSource.onmessage = (event) => {
const data = JSON.parse(event.data);
if (data.type === "meta") {
statusEl.textContent = `Found: ${data.meta.title} (${data.meta.year})`;
if (data.subtitles) loadSubtitles(data.subtitles);
}
else if (data.type === "source") {
if (!isPlaying) {
playCandidate(data);
} else {
fallbackSources.push(data);
}
}
else if (data.type === "done") {
eventSource.close();
if (!isPlaying && fallbackSources.length === 0) {
statusEl.textContent = "No compatible streaming sources found.";
}
}
};
eventSource.onerror = () => {
eventSource.close();
if (!isPlaying) statusEl.textContent = "Error connecting to Stream API.";
};
function playCandidate(candidate) {
isPlaying = true;
statusEl.textContent = `Streaming from provider: ${candidate.source} (${candidate.quality})`;
if (candidate.type === "hls") {
if (Hls.isSupported()) {
if (hlsInstance) hlsInstance.destroy();
hlsInstance = new Hls({ maxBufferLength: 30 });
hlsInstance.loadSource(candidate.url);
hlsInstance.attachMedia(video);
hlsInstance.on(Hls.Events.MANIFEST_PARSED, () => video.play());
hlsInstance.on(Hls.Events.ERROR, (event, errorData) => {
if (errorData.fatal) {
hlsInstance.destroy();
isPlaying = false;
if (fallbackSources.length > 0) playCandidate(fallbackSources.shift());
}
});
} else if (video.canPlayType("application/vnd.apple.mpegurl")) {
video.src = candidate.url;
video.play();
}
} else {
video.src = candidate.url;
video.play();
}
}
function loadSubtitles(subtitles) {
subtitles.forEach((sub) => {
const track = document.createElement("track");
track.kind = "subtitles";
track.label = sub.label;
track.srclang = sub.label.slice(0, 2).toLowerCase();
track.src = sub.file;
video.appendChild(track);
});
}
</script>
</body>
</html>
```

View File

@@ -1,64 +1,33 @@
# Vyla TV (Android TV)
<p class="page-description">The native 10-foot Leanback streaming experience for Android TV and Google TV, built with Jetpack Compose and ExoPlayer.</p>
<p class="page-description">The 10-foot streaming experience designed for Android TV, Google TV, and Fire TV.</p>
<img class="vyla-banner" src="/src/assets/images/android-tv/site-preview.webp" alt="Vyla TV application Leanback interface" loading="lazy" decoding="async" fetchpriority="low" />
## Overview
**Vyla TV** is the living-room client in the Vyla ecosystem. Built as a native Android app using **Jetpack Compose for TV** and Google's **ExoPlayer (Media3)** engine, Vyla TV brings streaming to televisions and smart boxes with directional remote navigation.
---
## Downloads
Official TV APK builds are published on [GitLab Releases](https://gitlab.com/vyla-entertainment/TV/-/releases):
- **[Vyla TV APK for Android TV / Google TV](https://gitlab.com/vyla-entertainment/TV/-/releases)**: Compatible with Sony Bravia, Chromecast with Google TV, NVIDIA Shield TV, and Xiaomi Mi Box.
- **[Vyla TV APK for Fire TV](https://gitlab.com/vyla-entertainment/TV/-/releases)**: Compatible with Fire TV Stick 4K / Max and Fire TV Cube.
- **[Vyla TV APK for Android TV / Google TV](https://gitlab.com/vyla-entertainment/TV/-/releases)**: For Chromecast with Google TV, Sony Bravia, NVIDIA Shield TV, Xiaomi Mi Box, and other Android TV devices.
- **[Vyla TV APK for Fire TV](https://gitlab.com/vyla-entertainment/TV/-/releases)**: For Fire TV Stick (all generations), Fire TV Cube, and smart TVs running Fire OS.
---
## Features
## Installation
- **D-Pad Navigation**: Optimized exclusively for remote controls with focus management.
- **ExoPlayer Media3**: Hardware-accelerated decoding for HLS (`.m3u8`), MP4, and MKV streams up to 4K/HDR.
- **Playback Controls**: Variable playback speeds (0.5x to 2.0x), multi-track subtitle selector with sync offsets, and in-player source switching.
- **Local Library**: TMDB catalog integration, Watch Later watchlist, and automatic resume playback timestamps.
### Method 1: Using the Downloader App (Recommended)
---
1. Open the **Google Play Store** (on Android TV) or the **Amazon Appstore** (on Fire TV).
2. Search for and install **Downloader** (by AFTVnews).
3. Enable unknown apps for Downloader:
- On **Android TV / Google TV**: Go to **Settings** > **Apps** > **Security & Restrictions** > **Unknown sources** (or **Special app access** > **Install unknown apps**) and toggle **Downloader** to **On**.
- On **Fire TV**: Go to **Settings** > **My Fire TV** > **Developer Options** > **Install unknown apps** and turn **Downloader** to **On**.
4. Launch Downloader, enter `https://gitlab.com/vyla-entertainment/TV/-/releases` in the URL field, and download the latest APK.
5. Click **Install** once the download completes.
## Sideloading via Downloader
### Method 2: Sideloading via USB Drive
1. Install **Downloader by AFTVnews** from the Google Play Store or Amazon Appstore.
2. In TV settings, navigate to Developer Options and enable **Install Unknown Apps** for Downloader.
3. Open Downloader and enter the release link:
```
https://gitlab.com/vyla-entertainment/TV/-/releases
```
4. Download the latest `.apk` and click **Install**.
---
## Building from Source
### Prerequisites
- Node.js 20+
- JDK 17 or JDK 21
- Android SDK with Android TV API 26+
### Build Steps
```bash
git clone https://gitlab.com/vyla-entertainment/TV.git vyla-tv
cd vyla-tv
npm install
npm run dev
```
Output APK location:
```
android/app/build/outputs/apk/debug/vyla.apk
```
### Android Studio
Open the `android/` subfolder in Android Studio to inspect Kotlin source code and Jetpack Compose layouts.
1. Download the latest `.apk` on your computer from GitLab Releases.
2. Copy the `.apk` file to a USB flash drive.
3. Plug the USB drive into your Android TV box or television.
4. Open any TV file manager app (such as File Commander or FX File Explorer), browse to the USB drive, and select the `.apk` to install.