Headless Improvements (#41)

This commit is contained in:
Ollie Taylor
2023-07-10 16:35:58 +01:00
committed by GitHub
parent 980588930a
commit 16366ec7f3
54 changed files with 1406 additions and 1034 deletions
+207
View File
@@ -0,0 +1,207 @@
import clamp from 'just-clamp';
import { derived, get, type Readable } from 'svelte/store';
import { user_preferences, user_progress } from '../../user';
import { announce } from '../../utility';
import { audio_element } from './audio-element';
import { episode_details, type EpisodeDetails } from './episode-details';
export type EpisodeState = {
will_autoplay: boolean;
is_paused: boolean;
duration: number;
src: string;
start_at: number;
details: EpisodeDetails | null;
};
const default_episode_state = {
will_autoplay: false,
is_paused: true,
duration: 0,
start_at: 0,
details: null,
} satisfies Omit<EpisodeState, 'src'>;
/**
* Episode state store
*/
const episode_state = derived([audio_element, episode_details], ([$audio, $details], set) => {
if (!$audio) return set(null);
function set_value() {
if (!$audio?.src) return null;
set({
...default_episode_state,
src: $audio.src,
duration: $audio.duration,
details: $details,
will_autoplay: $audio.autoplay,
is_paused: $audio.paused,
start_at: user_progress.get($audio.src) ?? 0,
});
}
$audio.addEventListener('loadeddata', set_value);
$audio.addEventListener('pause', set_value);
$audio.addEventListener('playing', set_value);
return () => {
$audio.removeEventListener('loadeddata', set_value);
$audio.removeEventListener('pause', set_value);
$audio.removeEventListener('playing', set_value);
};
}) satisfies Readable<EpisodeState | null>;
type HANDLE_TYPE = 'toggle' | 'set';
/**
* Use audio element
* @param {string} action - Action to perform
* @returns {HTMLAudioElement} - Audio element
* @throws {string} - Error message if no audio element exists
*/
const use_element = (action: string): HTMLAudioElement => {
const el = get(audio_element);
if (!el) throw announce.warn(`could not ${action} :: no audio element exists yet`);
return el;
};
/**
* Load audio
* @param {string} src - Audio source
* @param {EpisodeDetails} details - Episode details
*/
const load_audio = (src: string, details: EpisodeDetails): void => {
user_progress.save();
const el = use_element('load');
el.src = src;
el.muted = false;
// using user_progress
const start_at = user_progress.get(src) || 0;
el.currentTime = start_at;
// using user_preferences
const preferences = get(user_preferences);
el.playbackRate = preferences.playback_rate;
el.volume = preferences.volume;
episode_details.set(details);
};
/**
* Unload audio
*/
const unload_audio = (): void => {
user_progress.save();
const el = use_element('unload');
el.src = '';
episode_details.set(null);
};
/**
* Play audio
* @param {HANDLE_TYPE} t - Handle type
*/
const play_audio = (t: HANDLE_TYPE = 'set'): void => {
const el = use_element('play');
if (t === 'toggle') {
el.paused ? el.play() : el.pause();
} else {
el.play();
}
};
/**
* Pause audio
* @param {HANDLE_TYPE} t - Handle type
*/
const pause_audio = (t: HANDLE_TYPE = 'set'): void => {
user_progress.save();
const el = use_element('pause');
if (t === 'toggle') {
el.paused ? el.play() : el.pause();
} else {
el.pause();
}
};
/**
* Mute audio
* @param {HANDLE_TYPE} t - Handle type
*/
const mute_audio = (t: HANDLE_TYPE = 'set'): void => {
const el = use_element('mute');
if (t === 'toggle') {
el.muted = !el.muted;
} else {
el.muted = true;
}
};
/**
* Unmute audio
* @param {HANDLE_TYPE} t - Handle type
*/
const unmute_audio = (t: HANDLE_TYPE = 'set'): void => {
const el = use_element('unmute');
if (t === 'toggle') {
el.muted = !el.muted;
} else {
el.muted = false;
}
};
/**
* Seek to time audio
* @param {number} seconds - Seconds to seek
* @param {'from-start' | 'from-end'} from - Seek from start or end
*/
const seek_audio = (seconds: number, from: 'from-start' | 'from-end' = 'from-start'): void => {
const el = use_element('seek');
if (from === 'from-end') {
el.currentTime = clamp(0, el.duration, el.duration - seconds);
} else {
el.currentTime = clamp(0, el.duration, seconds);
}
};
/**
* Skip by about audio
* @param {number} seconds - Seconds to skip
* @param {'forward' | 'backward'} type - Skip forward or backward
*/
const skip_audio = (seconds: number, type: 'forward' | 'backward' = 'forward'): void => {
const el = use_element('skip');
if (type === 'backward') {
el.currentTime = clamp(0, el.duration, el.currentTime - seconds);
} else {
el.currentTime = clamp(0, el.duration, el.currentTime + seconds);
}
};
/**
* Episode audio object
*/
export const episode_audio = {
/**
* Subscribes to episode audio store
*/
subscribe: episode_state.subscribe,
load: load_audio,
unload: unload_audio,
play: play_audio,
pause: pause_audio,
mute: mute_audio,
unmute: unmute_audio,
seek: seek_audio,
skip: skip_audio,
};