react-native-video/src/Video.web.tsx

345 lines
8.8 KiB
TypeScript
Raw Normal View History

import React, {
forwardRef,
useCallback,
useEffect,
useImperativeHandle,
useRef,
2024-06-30 07:25:49 -06:00
type RefObject,
useMemo,
} from 'react';
2024-06-30 07:25:49 -06:00
import type {VideoRef, ReactVideoProps, VideoMetadata} from './types';
const Video = forwardRef<VideoRef, ReactVideoProps>(
(
{
source,
paused,
muted,
volume,
2024-06-30 05:38:52 -06:00
rate,
repeat,
controls,
2024-06-30 07:25:49 -06:00
showNotificationControls = false,
2024-06-30 05:38:52 -06:00
poster,
onBuffer,
onLoad,
onProgress,
2024-06-30 05:25:43 -06:00
onPlaybackRateChange,
onError,
2024-06-30 05:25:43 -06:00
onReadyForDisplay,
onSeek,
onVolumeChange,
onEnd,
onPlaybackStateChanged,
},
ref,
) => {
const nativeRef = useRef<HTMLVideoElement>(null);
const errorHandler = useRef<typeof onError>(onError);
errorHandler.current = onError;
2024-06-30 05:25:43 -06:00
const seek = useCallback(
async (time: number, _tolerance?: number) => {
if (isNaN(time)) {
throw new Error('Specified time is not a number');
}
if (!nativeRef.current) {
console.warn('Video Component is not mounted');
return;
}
2024-06-30 07:25:49 -06:00
time = Math.max(0, Math.min(time, nativeRef.current.duration));
2024-06-30 05:25:43 -06:00
nativeRef.current.currentTime = time;
onSeek?.({seekTime: time, currentTime: nativeRef.current.currentTime});
},
[onSeek],
);
const pause = useCallback(() => {
if (!nativeRef.current) {
return;
}
nativeRef.current.pause();
}, []);
const resume = useCallback(() => {
if (!nativeRef.current) {
return;
}
nativeRef.current.play();
}, []);
2024-06-30 05:25:43 -06:00
const setVolume = useCallback((vol: number) => {
if (!nativeRef.current) {
return;
}
nativeRef.current.volume = Math.max(0, Math.min(vol, 100)) / 100;
}, []);
const getCurrentPosition = useCallback(async () => {
if (!nativeRef.current) {
throw new Error('Video Component is not mounted');
}
return nativeRef.current.currentTime;
}, []);
const unsupported = useCallback(() => {
throw new Error('This is unsupported on the web');
}, []);
useImperativeHandle(
ref,
() => ({
seek,
pause,
resume,
2024-06-30 05:25:43 -06:00
setVolume,
getCurrentPosition,
// making the video fullscreen does not work with some subtitles polyfils
// so I decided to not include it.
presentFullscreenPlayer: unsupported,
dismissFullscreenPlayer: unsupported,
2024-06-30 05:25:43 -06:00
setFullScreen: unsupported,
save: unsupported,
restoreUserInterfaceForPictureInPictureStopCompleted: unsupported,
2024-06-30 07:25:49 -06:00
nativeHtmlRef: nativeRef,
}),
2024-06-30 07:25:49 -06:00
[
seek,
pause,
resume,
unsupported,
setVolume,
getCurrentPosition,
nativeRef,
],
);
useEffect(() => {
if (paused) {
pause();
} else {
resume();
}
}, [paused, pause, resume]);
useEffect(() => {
2024-06-30 05:25:43 -06:00
if (volume === undefined) {
return;
}
2024-06-30 05:25:43 -06:00
setVolume(volume);
}, [volume, setVolume]);
useEffect(() => {
2024-06-30 05:25:43 -06:00
// Not sure about how to do this but we want to wait for nativeRef to be initialized
setTimeout(() => {
if (!nativeRef.current) {
return;
}
2024-06-30 05:25:43 -06:00
// Set play state to the player's value (if autoplay is denied)
// This is useful if our UI is in a play state but autoplay got denied so
// the video is actaully in a paused state.
onPlaybackStateChanged?.({isPlaying: !nativeRef.current.paused});
}, 500);
}, [onPlaybackStateChanged]);
2024-06-30 05:38:52 -06:00
useEffect(() => {
if (!nativeRef.current || rate === undefined) {
return;
}
nativeRef.current.playbackRate = rate;
}, [rate]);
2024-06-30 07:25:49 -06:00
useMediaSession(
source?.metadata,
nativeRef,
useMemo(
() => ({
seek,
resume,
pause,
}),
[seek, resume, pause],
),
showNotificationControls,
);
return (
2024-06-30 07:25:49 -06:00
<video
ref={nativeRef}
src={source?.uri as string | undefined}
muted={muted}
autoPlay={!paused}
controls={controls}
loop={repeat}
playsInline
poster={poster}
onCanPlay={() => onBuffer?.({isBuffering: false})}
onWaiting={() => onBuffer?.({isBuffering: true})}
onRateChange={() => {
if (!nativeRef.current) {
return;
}
onPlaybackRateChange?.({
playbackRate: nativeRef.current?.playbackRate,
});
}}
onDurationChange={() => {
if (!nativeRef.current) {
return;
}
onLoad?.({
currentTime: nativeRef.current.currentTime,
duration: nativeRef.current.duration,
videoTracks: [],
textTracks: [],
audioTracks: [],
naturalSize: {
width: nativeRef.current.videoWidth,
height: nativeRef.current.videoHeight,
orientation: 'landscape',
},
});
}}
onTimeUpdate={() => {
if (!nativeRef.current) {
return;
}
onProgress?.({
currentTime: nativeRef.current.currentTime,
playableDuration: nativeRef.current.buffered.length
? nativeRef.current.buffered.end(
nativeRef.current.buffered.length - 1,
)
: 0,
seekableDuration: 0,
});
}}
onLoadedData={() => onReadyForDisplay?.()}
onError={() => {
if (!nativeRef.current?.error) {
return;
}
onError?.({
error: {
errorString: nativeRef.current.error.message ?? 'Unknown error',
code: nativeRef.current.error.code,
},
});
}}
onLoadedMetadata={() => {
if (source?.startPosition) {
seek(source.startPosition / 1000);
}
}}
onPlay={() => onPlaybackStateChanged?.({isPlaying: true})}
onPause={() => onPlaybackStateChanged?.({isPlaying: false})}
onVolumeChange={() => {
if (!nativeRef.current) {
return;
}
onVolumeChange?.({volume: nativeRef.current.volume});
}}
onEnded={onEnd}
2024-06-30 21:32:39 -06:00
style={{
position: 'absolute',
inset: 0,
objectFit: 'contain',
width: '100%',
height: '100%',
}}
2024-06-30 07:25:49 -06:00
/>
);
},
);
2024-06-30 07:25:49 -06:00
const useMediaSession = (
metadata: VideoMetadata | undefined,
nativeRef: RefObject<HTMLVideoElement>,
actions: {
seek: (time: number) => void;
pause: () => void;
resume: () => void;
},
showNotification: boolean,
) => {
const isPlaying = !nativeRef.current?.paused ?? false;
const progress = nativeRef.current?.currentTime ?? 0;
2024-06-30 21:32:39 -06:00
const duration = Number.isFinite(nativeRef.current?.duration)
? nativeRef.current?.duration
: undefined;
2024-06-30 07:25:49 -06:00
const playbackRate = nativeRef.current?.playbackRate ?? 1;
const enabled = 'mediaSession' in navigator && showNotification;
useEffect(() => {
if (enabled) {
navigator.mediaSession.metadata = new MediaMetadata({
title: metadata?.title,
artist: metadata?.artist,
artwork: metadata?.imageUri ? [{src: metadata.imageUri}] : undefined,
});
}
}, [enabled, metadata]);
useEffect(() => {
if (!enabled) {
return;
}
const seekRelative = (offset: number) => {
if (!nativeRef.current) {
return;
}
actions.seek(nativeRef.current.currentTime + offset);
};
const mediaActions: [
MediaSessionAction,
MediaSessionActionHandler | null,
][] = [
['play', () => actions.resume()],
['pause', () => actions.pause()],
[
'seekbackward',
(evt: MediaSessionActionDetails) =>
seekRelative(evt.seekOffset ? -evt.seekOffset : -10),
],
[
'seekforward',
(evt: MediaSessionActionDetails) =>
seekRelative(evt.seekOffset ? evt.seekOffset : 10),
],
[
'seekto',
(evt: MediaSessionActionDetails) => actions.seek(evt.seekTime!),
],
];
for (const [action, handler] of mediaActions) {
try {
navigator.mediaSession.setActionHandler(action, handler);
} catch {
// ignored
}
}
}, [enabled, nativeRef, actions]);
useEffect(() => {
if (enabled) {
navigator.mediaSession.playbackState = isPlaying ? 'playing' : 'paused';
}
}, [isPlaying, enabled]);
useEffect(() => {
if (enabled && duration !== undefined) {
navigator.mediaSession.setPositionState({
position: Math.min(progress, duration),
duration,
playbackRate: playbackRate,
});
}
}, [progress, duration, playbackRate, enabled]);
};
Video.displayName = 'Video';
export default Video;