Skip to content

A self-hosted media server and file management system

feat: extended media info endpoint

aminnausinc891ed88303f
diff --git a/app/Http/Controllers/Api/V1/Metadata/FontController.php b/app/Http/Controllers/Api/V1/Metadata/FontController.php
index 9e3838e2..61be114f 100644
--- a/app/Http/Controllers/Api/V1/Metadata/FontController.php
+++ b/app/Http/Controllers/Api/V1/Metadata/FontController.php
@@ -19,7 +19,7 @@ class FontController extends Controller {
public function __construct(protected FileJobService $fileJobService, protected RateLimitService $rateLimiter) {}
/**
- * List storyboard details for metadata.
+ * List font details for metadata.
*/
public function show(Metadata $metadata) {
return response()->json([
diff --git a/app/Http/Controllers/Api/V1/VideoController.php b/app/Http/Controllers/Api/V1/VideoController.php
index b8d4447e..2fed2aa1 100755
--- a/app/Http/Controllers/Api/V1/VideoController.php
+++ b/app/Http/Controllers/Api/V1/VideoController.php
@@ -4,11 +4,13 @@ namespace App\Http\Controllers\Api\V1;
use App\Http\Controllers\Controller;
use App\Http\Requests\VideoCollectionRequest;
+use App\Http\Resources\Metadata\MediaInfoResource;
use App\Http\Resources\VideoResource;
use App\Models\Record;
use App\Models\Video;
use App\Traits\HttpResponses;
use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Gate;
use Illuminate\Support\Facades\Log;
class VideoController extends Controller {
@@ -34,6 +36,29 @@ class VideoController extends Controller {
}
}
+ /**
+ * Display a listing of the resource.
+ */
+ public function getMediaInfo(Request $_, Video $video) {
+ try {
+ $category = $video->folder->category;
+ if (! $category || ($category->is_private && ! Gate::allows('admin'))) {
+ abort(404);
+ }
+
+ $video->load([
+ 'metadata.fonts',
+ 'metadata.subtitles',
+ 'metadata.images.user',
+ 'metadata.storyboard',
+ ]);
+
+ return response()->json(new MediaInfoResource($video));
+ } catch (\Throwable $th) {
+ Log::error('Unable to get video. Error: ' . $th->getMessage());
+ }
+ }
+
/**
* Update view counter
*
diff --git a/app/Http/Resources/Metadata/FontInfoResource.php b/app/Http/Resources/Metadata/FontInfoResource.php
new file mode 100644
index 00000000..7d7b7484
--- /dev/null
+++ b/app/Http/Resources/Metadata/FontInfoResource.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Http\Resources\Metadata;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class FontInfoResource extends JsonResource {
+ /**
+ * Transform the resource into an array.
+ *
+ * @return array<string, mixed>
+ */
+ public function toArray(Request $request): array {
+ return [
+ 'id' => $this->id,
+ 'file_name' => $this->file_name,
+ 'size' => $this->size,
+ 'path' => $this->path ? "/storage/{$this->path}" : null,
+ 'created_at' => $this->created_at,
+ 'updated_at' => $this->updated_at,
+ ];
+ }
+}
diff --git a/app/Http/Resources/Metadata/MediaInfoResource.php b/app/Http/Resources/Metadata/MediaInfoResource.php
new file mode 100644
index 00000000..6b291b28
--- /dev/null
+++ b/app/Http/Resources/Metadata/MediaInfoResource.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Http\Resources\Metadata;
+
+use App\Http\Resources\ImageResource;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class MediaInfoResource extends JsonResource {
+ /**
+ * Transform the resource into an array.
+ *
+ * @return array<string, mixed>
+ */
+ public function toArray(Request $request): array {
+ throw_unless(
+ $this->relationLoaded('metadata'),
+ \RuntimeException::class,
+ 'VideoResource requires metadata relation to be eager-loaded.'
+ );
+
+ $metadata = $this->metadata;
+
+ return [
+ 'id' => $this->id,
+ 'name' => $this->name,
+
+ 'images' => ImageResource::collection($metadata?->relationLoaded('images') ? $metadata->images : []),
+ 'subtitles' => SubtitleInfoResource::collection($metadata?->relationLoaded('subtitles') ? $metadata->subtitles : []),
+ 'fonts' => FontInfoResource::collection($metadata?->relationLoaded('fonts') ? $metadata->fonts : []),
+ 'storyboard' => $metadata?->relationLoaded('storyboard') ? new StoryboardResource($metadata->storyboard) : null,
+ 'raw_metadata' => $metadata?->raw_metadata,
+ ];
+ }
+}
diff --git a/app/Http/Resources/Metadata/SubtitleInfoResource.php b/app/Http/Resources/Metadata/SubtitleInfoResource.php
new file mode 100644
index 00000000..4f98fd7d
--- /dev/null
+++ b/app/Http/Resources/Metadata/SubtitleInfoResource.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Http\Resources\Metadata;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class SubtitleInfoResource extends JsonResource {
+ /**
+ * Transform the resource into an array.
+ *
+ * @return array<string, mixed>
+ */
+ public function toArray(Request $request): array {
+ return [
+ 'id' => $this->id,
+ 'track_id' => $this->track_id,
+ 'metadata_uuid' => $this->metadata_uuid,
+ 'language' => $this->language,
+ 'title' => $this->title,
+ 'codec' => $this->codec,
+ 'format' => $this->format,
+ 'is_default' => $this->is_default,
+ 'is_forced' => $this->is_forced,
+ 'path' => $this->path,
+ 'external_path' => $this->external_path,
+ 'created_at' => $this->created_at,
+ 'updated_at' => $this->updated_at,
+ ];
+ }
+}
diff --git a/resources/js/contracts/mediaInfo.ts b/resources/js/contracts/mediaInfo.ts
new file mode 100644
index 00000000..5e9bf679
--- /dev/null
+++ b/resources/js/contracts/mediaInfo.ts
@@ -0,0 +1,25 @@
+import type { FontResource, ImageResource, StoryboardResource, SubtitleResource } from './media';
+
+export interface SubtitleInfoResource extends SubtitleResource {
+ path: string;
+ external_path: string | null;
+ created_at: string;
+ updated_at: string;
+}
+
+export interface FontInfoResource extends FontResource {
+ id: number;
+ size: number;
+ created_at: string;
+ updated_at: string;
+}
+
+export interface MediaInfoResource {
+ id: number;
+ name: string;
+
+ images: ImageResource[];
+ subtitles: SubtitleInfoResource[];
+ fonts: FontInfoResource[];
+ storyboard?: StoryboardResource;
+}
diff --git a/resources/js/service/media/media.ts b/resources/js/service/media/media.ts
new file mode 100644
index 00000000..8fddcc98
--- /dev/null
+++ b/resources/js/service/media/media.ts
@@ -0,0 +1,9 @@
+import type { MediaInfoResource } from '@/contracts/mediaInfo';
+import type { AxiosResponse } from 'axios';
+
+import { API } from '@/service/api';
+
+export const getMediaDetails = async (videoId: number): Promise<AxiosResponse<MediaInfoResource>> => {
+ const { data } = await API.get(`/videos/${videoId}/info`, { headers: { 'X-Skip-Toast': 'true' } });
+ return data;
+};
diff --git a/routes/api.php b/routes/api.php
index e95212c8..e3e7df20 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -189,6 +189,7 @@ Route::get('/folders', [FolderController::class, 'getFrom']);
// Video Search and Views
Route::patch('/videos/watch/{video}', [VideoController::class, 'watch']);
+Route::get('/videos/{video}/info', [VideoController::class, 'getMediaInfo']);
Route::get('/videos', [VideoController::class, 'getFrom']);
// Video playback history