Skip to content

A self-hosted media server and file management system

feat: playback progress in frontend

aminnausin490eefd47596
diff --git a/resources/js/components/video/VideoPlayer.vue b/resources/js/components/video/VideoPlayer.vue
index 7a7b098a..ee7e9641 100755
--- a/resources/js/components/video/VideoPlayer.vue
+++ b/resources/js/components/video/VideoPlayer.vue
@@ -5,6 +5,7 @@ import { controlsHideTime, playbackDataBuffer, playerHealthBuffer, volumeDelta,
import { getScreenSize, handleStorageURL, isInputLikeElement, isMobileDevice, toFormattedDate, toFormattedDuration } from '@/service/util';
import { computed, nextTick, onBeforeUnmount, onMounted, provide, ref, useTemplateRef, watch } from 'vue';
import { copyVideoFrame, saveVideoFrame } from '@/service/player/frameService';
+import { usePlaybackProgress } from '@/composables/player/usePlaybackProgress';
import { useRoute, useRouter } from 'vue-router';
import { UseCreatePlayback } from '@/service/mutations';
import { useVideoPlayback } from '@/service/queries';
@@ -127,6 +128,16 @@ const currentId = ref<number | null>(null);
const { data: playbackData } = useVideoPlayback(metadataId);
const createPlayback = UseCreatePlayback().mutate;
+// Playback Progress
+const {
+ save: saveProgress,
+ startInterval: startProgressInterval,
+ stopInterval: stopProgressInterval,
+} = usePlaybackProgress(
+ computed(() => (currentId.value ? metadataId.value : NaN)),
+ getCurrentTime,
+);
+
// V-models for inputs
const timeDuration = computed(() => {
return stateVideo.value?.metadata?.duration ?? 1;
@@ -138,7 +149,7 @@ const currentVolume = ref(0.5);
const cachedVolume = ref(0.5);
const currentSpeed = ref(1);
-// Player State
+//#region Player State
const shouldUpdateUI = computed(() => (isShowingControls.value || isShowingStats.value) && !isScrubbing.value && !isLoading.value);
const latestPlayRequestId = ref<number>(0);
@@ -173,7 +184,9 @@ const isNormalView = computed(() => viewMode.value === 'normal');
const isThumbnailVisible = computed(() => !!stateVideo.value.metadata?.poster_url && !isThumbnailDismissed.value);
-// Player Info
+//#endregion
+
+//#region Player Info
const endsAtTime = ref('00:00');
const bufferTime = ref<number>(0);
const bufferPercentage = ref<number>(0);
@@ -182,6 +195,9 @@ const playerHealthCounter = ref(0);
const bufferHealth = computed(() => {
return toFormattedDuration(bufferTime.value, false) ?? '0s';
});
+
+//#endregion
+
const videoButtonOffset = computed(() => {
return 8 + (isNormalView.value ? 0 : 8);
});
@@ -442,6 +458,7 @@ const initVideoPlayer = async () => {
}
await nextTick();
+
onPlayerPlay();
// url.value = await getMediaUrl(stateVideo.value.path ?? '');
};
@@ -475,6 +492,7 @@ const handleInitMediaSession = () => {
//#region Player Events
+// Could use a rename -> this is for the playback heatmap, not playback progress (new as of 2026-04)
const handleProgress = (override = false) => {
if (!player.value || !stateVideo.value.metadata?.id) return;
@@ -545,7 +563,9 @@ const onPlayerPlay = async (override = false, recordProgress = true) => {
isThumbnailDismissed.value = true;
updateViewCount(stateVideo.value.id);
handleProgress(true);
+ startProgressInterval();
getEndTime();
+
if (isMediaSession.value) navigator.mediaSession.playbackState = 'playing';
} catch (error) {
if ((error instanceof DOMException && error.name === 'AbortError') || playRequestId !== latestPlayRequestId.value) {
@@ -564,6 +584,8 @@ const onPlayerPause = () => {
latestPlayRequestId.value++;
player.value.pause();
+ stopProgressInterval(); // stop interval that records playback progress on player pause and player end but not on loop or playlist
+
if (!isPaused.value) isPaused.value = true;
emit('pause');
@@ -791,18 +813,11 @@ const handlePlayerTimeUpdate = (event: any) => {
}
};
-// Causes performance degredation and is unecessary on supported platforms
-const handlePositionState = () => {
- if (!player.value || !isMediaSession.value || !('setPositionState' in navigator.mediaSession)) return;
+function getCurrentTime() {
+ return player.value?.currentTime ?? 0;
+}
- const data = {
- duration: timeDuration.value,
- playbackRate: player.value.playbackRate,
- position: Math.min(player.value.currentTime, timeDuration.value),
- };
-
- navigator.mediaSession.setPositionState(data);
-};
+//#region Seek
const handleManualSeek = async (seconds: number) => {
if (!player.value) return;
@@ -840,6 +855,8 @@ const handleSeekPreview = () => {
if (!isScrubbing.value) isScrubbing.value = true;
};
+//#endregion
+
function resetControlsTimeout() {
isShowingControls.value = true;
@@ -1196,7 +1213,7 @@ defineExpose({
isPictureInPicture,
audioPoster,
viewMode,
- getCurrentTime: () => player.value?.currentTime ?? 0,
+ getCurrentTime,
});
//#endregion
</script>
diff --git a/resources/js/composables/player/usePlaybackProgress.ts b/resources/js/composables/player/usePlaybackProgress.ts
new file mode 100644
index 00000000..bdbc8944
--- /dev/null
+++ b/resources/js/composables/player/usePlaybackProgress.ts
@@ -0,0 +1,63 @@
+import type { Ref } from 'vue';
+
+import { playbackProgressTrackingInterval } from '@/service/player/playerConstants';
+import { getProgress, upsertProgress } from '@/service/api/playbackProgress';
+import { watch, onUnmounted } from 'vue';
+import { useContentStore } from '@/stores/ContentStore';
+
+export function usePlaybackProgress(mediaId: Ref<number>, getCurrentTime: () => number) {
+ const contentStore = useContentStore();
+
+ let interval: ReturnType<typeof setInterval> | null = null;
+
+ const save = async (id = mediaId.value) => {
+ if (isNaN(id)) return;
+
+ const metadata = contentStore.getMetadataById(id);
+ const duration = metadata?.duration ?? 0;
+
+ const offset = Math.floor(getCurrentTime());
+ const pct = duration ? Math.min(Math.round((offset / duration) * 100), 100) : 0;
+
+ if (pct < 5) return;
+
+ await upsertProgress(id, {
+ progress_offset: offset,
+ });
+
+ contentStore.updatePlaybackProgress(id, {
+ progress_offset: offset,
+ progress_percentage: pct,
+ });
+ };
+
+ const startInterval = () => {
+ stopInterval();
+ interval = setInterval(save, playbackProgressTrackingInterval);
+ };
+
+ const stopInterval = () => {
+ if (interval) clearInterval(interval);
+ interval = null;
+ };
+
+ const getResumeOffset = async (id = mediaId.value) => {
+ if (isNaN(id)) return null;
+
+ const { data }: { data: { progress_offset?: number } } = await getProgress(id);
+ return data?.progress_offset ?? null;
+ };
+
+ watch(mediaId, async (_, oldId) => {
+ if (isNaN(oldId)) return;
+ stopInterval();
+ await save(oldId); // Save previous media progress on switch
+ });
+
+ onUnmounted(() => {
+ stopInterval();
+ save(); // save on exit
+ });
+
+ return { startInterval, stopInterval, save, getResumeOffset };
+}
diff --git a/resources/js/service/player/playerConstants.ts b/resources/js/service/player/playerConstants.ts
index 6d7468ef..d02a1767 100644
--- a/resources/js/service/player/playerConstants.ts
+++ b/resources/js/service/player/playerConstants.ts
@@ -6,4 +6,6 @@ const playbackDelta: number = 0.05; // Speed change rate
const playbackMin: number = 0.1; // Min speed
const playbackMax: number = 3; // Max speed
-export { controlsHideTime, playbackDataBuffer, playerHealthBuffer, volumeDelta, playbackDelta, playbackMin, playbackMax };
+const playbackProgressTrackingInterval: number = 5000; // Time between playback progress tracking events (ms)
+
+export { controlsHideTime, playbackDataBuffer, playerHealthBuffer, volumeDelta, playbackDelta, playbackMin, playbackMax, playbackProgressTrackingInterval };
diff --git a/resources/js/stores/ContentStore.ts b/resources/js/stores/ContentStore.ts
index eff10556..01480125 100644
--- a/resources/js/stores/ContentStore.ts
+++ b/resources/js/stores/ContentStore.ts
@@ -1,4 +1,4 @@
-import type { CategoryResource, FolderResource, SeriesResource, VideoResource } from '@/types/resources';
+import type { CategoryResource, FolderResource, MetadataResource, SeriesResource, VideoResource } from '@/types/resources';
import type { SortCriteria, SortKey } from '@/service/sort/types';
import { formatFileSize, toFormattedDuration } from '@/service/util';
@@ -54,8 +54,8 @@ export const useContentStore = defineStore('Content', () => {
video.video_tags?.map((tag) => tag?.name).join(' ') ?? '',
video.file_size ? formatFileSize(video.file_size) : '',
video.metadata?.codec ?? '',
- video.album ?? '',
- video.artist ?? '',
+ video.metadata?.album ?? '',
+ video.metadata?.artist ?? '',
];
return strRepresentation.join(' ').toLowerCase().includes(searchTerm);
} catch (error) {
@@ -243,6 +243,11 @@ export const useContentStore = defineStore('Content', () => {
return false;
}
}
+
+ function getMetadataById(metadataId: number): MetadataResource | undefined {
+ if (stateVideo.value.metadata?.id === metadataId) return stateVideo.value.metadata;
+ return stateFolder.value.videos?.find((v) => v.metadata?.id === metadataId)?.metadata;
+ }
//#endregion
//#region DATA UPDATES
@@ -304,6 +309,30 @@ export const useContentStore = defineStore('Content', () => {
stateVideo.value = emptyMedia;
}
+ function updatePlaybackProgress(id: number, data: { progress_offset: number; progress_percentage: number }) {
+ console.log('updatePlaybackProgress', id, data);
+
+ if (isNaN(id)) return;
+ if (data.progress_offset < 0 || data.progress_percentage < 0 || data.progress_percentage > 100) return;
+
+ const apply = (video: VideoResource) => {
+ if (video.metadata?.id !== id) return;
+
+ const duration = video.metadata?.duration ?? 0;
+
+ video.metadata.progress_offset = Math.min(data.progress_offset, duration);
+ video.metadata.progress_percentage = data.progress_percentage;
+ };
+
+ if (stateVideo.value.metadata?.id === id) {
+ apply(stateVideo.value);
+ }
+
+ for (const video of stateFolder.value.videos ?? []) {
+ apply(video);
+ }
+ }
+
//#endregion
/**
@@ -326,9 +355,11 @@ export const useContentStore = defineStore('Content', () => {
previousVideoURL,
getCategory,
getFolder,
+ getMetadataById,
updateViewCount,
updateVideoData,
updateFolderData,
+ updatePlaybackProgress,
playlistFind,
playlistSort,
};