Skip to content

A self-hosted media server and file management system

feat: playback progress api

aminnausin9e413fd307dc
diff --git a/app/Http/Controllers/Api/V1/PlaybackProgressController.php b/app/Http/Controllers/Api/V1/PlaybackProgressController.php
new file mode 100644
index 00000000..cf791e53
--- /dev/null
+++ b/app/Http/Controllers/Api/V1/PlaybackProgressController.php
@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Http\Controllers\API\V1;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\PlaybackProgressStoreRequest;
+use App\Models\Metadata;
+use App\Models\PlaybackProgress;
+use App\Traits\HttpResponses;
+use Illuminate\Support\Facades\Auth;
+
+class PlaybackProgressController extends Controller {
+ use HttpResponses;
+
+ public function show(Metadata $metadata) {
+ $progress = PlaybackProgress::where('user_id', Auth::id())->where('metadata_id', $metadata->id)->value('progress_offset');
+
+ return response()->json(['progress_offset' => $progress ?? 0]);
+ }
+
+ /**
+ * Upserts a playback progress tracker associated with a user and a specific metadata
+ */
+ public function upsert(PlaybackProgressStoreRequest $request, Metadata $metadata) {
+ try {
+ $user_id = Auth::id();
+ $validated = $request->validated();
+
+ $duration = $metadata->duration ?? 0;
+ $progress_offset = min($validated['progress_offset'], $duration);
+
+ $progress_pct = $duration ? round($progress_offset * 100 / $duration) : 0;
+
+ if ($progress_pct >= config('playback.completion_percentage_threshold')) {
+ $progress_offset = $metadata->duration;
+ $progress_pct = 100;
+ }
+
+ PlaybackProgress::upsert(
+ [
+ 'user_id' => $user_id,
+ 'metadata_id' => $metadata->id,
+ 'progress_offset' => $progress_offset,
+ 'progress_percentage' => $progress_pct,
+ 'record_id' => $validated['record_id'] ?? null,
+ 'updated_at' => now(),
+ ],
+ ['user_id', 'metadata_id'],
+ ['progress_offset', 'progress_percentage', 'record_id', 'updated_at']
+ );
+
+ return response()->noContent();
+ } catch (\Throwable $th) {
+ return $this->error(null, 'Unable to store playback progress entry. Error: ' . $th->getMessage(), 500);
+ }
+ }
+}
diff --git a/app/Http/Requests/PlaybackProgressStoreRequest.php b/app/Http/Requests/PlaybackProgressStoreRequest.php
new file mode 100644
index 00000000..bd3dbdfc
--- /dev/null
+++ b/app/Http/Requests/PlaybackProgressStoreRequest.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Support\Facades\Auth;
+
+class PlaybackProgressStoreRequest extends FormRequest {
+ /**
+ * Determine if the user is authorized to make this request.
+ */
+ public function authorize(): bool {
+ return Auth::check();
+ }
+
+ /**
+ * Get the validation rules that apply to the request.
+ *
+ * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
+ */
+ public function rules(): array {
+ return [
+ 'progress_offset' => 'required|integer|min:0',
+ 'record_id' => 'nullable|integer',
+ ];
+ }
+}
diff --git a/config/playback.php b/config/playback.php
new file mode 100644
index 00000000..ae9e89eb
--- /dev/null
+++ b/config/playback.php
@@ -0,0 +1,6 @@
+<?php
+
+return [
+ 'completion_percentage_threshold' => 95, // threshold required to count playback progress as "complete"
+ 'minimum_percentage_threshold' => 5, // min duration percentage before playback progress starts
+];
diff --git a/resources/js/service/api/playbackProgress.ts b/resources/js/service/api/playbackProgress.ts
new file mode 100644
index 00000000..d5c4fd88
--- /dev/null
+++ b/resources/js/service/api/playbackProgress.ts
@@ -0,0 +1,5 @@
+import type { PlaybackProgressStoreRequest } from '@/types/requests';
+import { API } from '../api';
+
+export const getProgress = (mediaId: number) => API.get(`/metadata/${mediaId}/progress`);
+export const upsertProgress = (mediaId: number, payload: PlaybackProgressStoreRequest) => API.put(`/metadata/${mediaId}/progress`, payload);
diff --git a/resources/js/types/requests.ts b/resources/js/types/requests.ts
index ad810721..3cb07a02 100644
--- a/resources/js/types/requests.ts
+++ b/resources/js/types/requests.ts
@@ -63,3 +63,8 @@ export interface RecordStoreRequest {
export interface PasswordRequest {
password: string;
}
+
+export interface PlaybackProgressStoreRequest {
+ progress_offset: number;
+ record_id?: number;
+}
diff --git a/routes/api.php b/routes/api.php
index 14655061..23231407 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -12,6 +12,7 @@ use App\Http\Controllers\Api\V1\Metadata\SubtitleController;
use App\Http\Controllers\Api\V1\MetadataController;
use App\Http\Controllers\Api\V1\PasswordController;
use App\Http\Controllers\Api\V1\PlaybackController;
+use App\Http\Controllers\API\V1\PlaybackProgressController;
use App\Http\Controllers\Api\V1\ProfileController;
use App\Http\Controllers\Api\V1\RecordController;
use App\Http\Controllers\Api\V1\SeriesController;
@@ -63,11 +64,15 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::resource('/metadata', MetadataController::class)->only(['show', 'store', 'update']);
Route::resource('/series', SeriesController::class)->only(['index', 'store', 'update']);
Route::resource('/tags', TagController::class)->only(['index', 'store']);
- Route::patch('/metadata/{metadata}/lyrics', [MetadataController::class, 'updateLyrics']);
- // Subtitles
Route::prefix('/metadata/{metadata}')->group(function () {
+ // Lyrics
+ Route::patch('/lyrics', [MetadataController::class, 'updateLyrics']);
+ // Subtitles
Route::delete('/subtitles', [SubtitleController::class, 'reset']); // clear cache
+ // Progress
+ Route::get('/progress', [PlaybackProgressController::class, 'show']);
+ Route::put('/progress', [PlaybackProgressController::class, 'upsert']);
});
// Users and Profiles