Initial Docs (#39)

This commit is contained in:
Ollie Taylor
2023-07-09 22:18:06 +01:00
committed by GitHub
parent 9232f4d52e
commit e01855b89b
51 changed files with 3056 additions and 613 deletions
+262
View File
@@ -0,0 +1,262 @@
<script lang="ts">
import { Section } from '$content/components';
import {
episode_audio,
episode_progress,
PlayerStack,
PlayerWidget,
user_preferences,
user_progress,
} from 'svelte-podcast';
import PreviewComponent from './preview-component.svelte';
import PreviewDataCode from './preview-data-code.svelte';
import PreviewData from './preview-data.svelte';
const sources = {
syntax: {
src: `/example-syntax.mp3`,
title: `Supper Club × Rich Harris, Author of Svelte`,
artwork: `https://ssl-static.libsyn.com/p/assets/b/3/c/d/b3cdf28da11ad39fe5bbc093207a2619/Syntax_-_499.jpg`,
},
knomii: {
src: `/example-knomii.mp3`,
title: `Empowerment starts with letting go of control`,
artwork: `https://ssl-static.libsyn.com/p/assets/f/a/8/d/fa8d56d5226884335f2e77a3093c12a1/ep-6.png`,
},
} as const;
// let current_time = 0;
// $: current_time = $episode_progress.current_time;
$: console.log('details :: ', $episode_audio?.details);
let player_widget_current_time = true;
$: player_widget = {
current_time: true,
playback_rate: true,
duration: true,
skip_back: 10,
skip_forward: 30,
};
$: player_stack = {
playback_rate: true,
timestamps: true,
skip_back: 10,
skip_forward: 30,
};
</script>
<Section>
<div class="flex flex-col items-stretch space-y-6">
<h1>This page is a work in progress</h1>
</div>
</Section>
<Section>
<PreviewComponent name="PlayerWidget">
<svelte:fragment slot="options">
<div>
<label for="pw_current_time">current_time</label>
<input id="pw_current_time" type="checkbox" bind:checked={player_widget.current_time} />
</div>
<div>
<label for="pw_playback_rate">playback_rate</label>
<input id="pw_playback_rate" type="checkbox" bind:checked={player_widget.playback_rate} />
</div>
<div>
<label for="pw_duration">duration</label>
<input id="pw_duration" type="checkbox" bind:checked={player_widget.duration} />
</div>
<div>
<label for="pw_skip_back">skip_back</label>
<input id="pw_skip_back" type="number" bind:value={player_widget.skip_back} />
</div>
<div>
<label for="pw_skip_forward">skip_forward</label>
<input id="pw_skip_forward" type="number" bind:value={player_widget.skip_forward} />
</div>
</svelte:fragment>
<PlayerWidget include={player_widget} />
</PreviewComponent>
</Section>
<Section>
<PreviewComponent name="PlayerStack">
<svelte:fragment slot="options">
<div>
<label for="pw_playback_rate">playback_rate</label>
<input id="pw_playback_rate" type="checkbox" bind:checked={player_stack.playback_rate} />
</div>
<div>
<label for="pw_timestamps">timestamps</label>
<input id="pw_timestamps" type="checkbox" bind:checked={player_stack.timestamps} />
</div>
<div>
<label for="pw_skip_back">skip_back</label>
<input id="pw_skip_back" type="number" bind:value={player_stack.skip_back} />
</div>
<div>
<label for="pw_skip_forward">skip_forward</label>
<input id="pw_skip_forward" type="number" bind:value={player_stack.skip_forward} />
</div>
</svelte:fragment>
<PlayerStack class="max-w-sm" include={player_stack} />
</PreviewComponent>
</Section>
<Section>
<div class="prose prose-lg prose-slate">
<h2>Data</h2>
<p>
The following are the stores that are available to you based on the active episode being
played in the above examples.
</p>
<PreviewData name="episode_audio" data={episode_audio}>
<PreviewDataCode
code={`episode_audio.subscribe()`}
description="subscribes to the episode_audio data"
/>
<PreviewDataCode
code={`episode_audio.load(\n\tsrc: string,\n\tdetails: { [key: string]: string | number | boolean] }\n)`}
description="loads an episode into the player"
/>
<PreviewDataCode
code={`episode_audio.load(src: string, details: { [key: string]: string | number | boolean] })`}
description="loads an episode into the player"
/>
<PreviewDataCode
code={`episode_audio.unload()`}
description="unloads the episode from the player"
/>
<PreviewDataCode
code={`episode_audio.seek(seconds: number, from: 'from-start' | 'from-end' = 'from-start')`}
description="seeks to a specific part of the audio"
/>
<PreviewDataCode
code={`episode_audio.skip(seconds: number, type: 'forward' | 'backward' = 'forward')`}
description="seeks forward or backward relative to the current time"
/>
<PreviewDataCode
code={`episode_audio.play(action: "toggle" | "set" = "set")`}
description="plays the audio currently loaded in the player"
/>
<PreviewDataCode
code={`episode_audio.pause(action: "toggle" | "set" = "set")`}
description="pauses the audio currently loaded in the player"
/>
<PreviewDataCode
code={`episode_audio.mute(action: "toggle" | "set" = "set")`}
description="mutes the audio player"
/>
<PreviewDataCode
code={`episode_audio.unmute(action: "toggle" | "set" = "set")`}
description="unmutes the audio player"
/>
</PreviewData>
<PreviewData name="episode_progress" data={episode_progress}>
<PreviewDataCode
code={`episode_progress.subscribe()`}
description="subscribes to the episode_progress data"
/>
</PreviewData>
<PreviewData name="user_preferences" data={user_preferences}>
<PreviewDataCode
code={`user_preferences.subscribe()`}
description="subscribes to the user_preferences data"
/>
<PreviewDataCode
code={`user_preferences.clear()`}
description="clears all user preferences and resets them to default values"
/>
<PreviewDataCode
code={`user_preferences.set.playback_rate(value: number)`}
description="sets the users prefered playback_rate (speed)"
/>
<PreviewDataCode
code={`user_preferences.set.volume(value: number)`}
description="sets the users prefered volume"
/>
</PreviewData>
<PreviewData name="user_progress" data={user_progress}>
<PreviewDataCode
code={`user_progress.subscribe()`}
description="subscribes to the user_progress data"
/>
<button type="button" on:click={user_progress.clear}>user_progress.clear()</button>
<PreviewDataCode
code={`user_progress.clear()`}
description="clears all user progress for all episodes"
/>
<button type="button" on:click={user_progress.clear}>user_progress.clear()</button>
<PreviewDataCode
code={`user_progress.get(src:string)`}
description="gets the users progress (seconds) for a specific episode"
/>
<button type="button" on:click={user_progress.save}>user_progress.save()</button>
<PreviewDataCode
code={`user_progress.save()`}
description="saves all user progress for all episodes they have interacted with in the current session"
/>
</PreviewData>
</div>
</Section>
<h1>Demo</h1>
<button type="button" on:click={user_preferences.clear}>Clear all preferences</button>
<hr />
<h5>Load Audio</h5>
<button type="button" on:click={() => episode_audio.load(sources['syntax'].src, sources['syntax'])}>
Syntax
</button>
<button type="button" on:click={() => episode_audio.load(sources['knomii'].src, sources['knomii'])}
>Knomii</button
>
<button type="button" on:click={() => episode_audio.unload()}>None</button>
<hr />
<h5>Custom audio controls</h5>
<h6>Play / Pause Actions</h6>
<button type="button" on:click={() => episode_audio.play()}>Play</button>
<button type="button" on:click={() => episode_audio.pause()}>Pause</button>
<button type="button" on:click={() => episode_audio.pause('toggle')}>Toggle</button>
<hr />
<h6>Audio Actions</h6>
<button type="button" on:click={() => episode_audio.mute()}>Mute</button>
<button type="button" on:click={() => episode_audio.unmute()}>Unmute</button>
<button type="button" on:click={() => episode_audio.mute('toggle')}>Toggle</button>
<hr />
<h6>Seeking</h6>
<button type="button" on:click={() => episode_audio.seek(30)}>Go to 30s from start </button>
<button type="button" on:click={() => episode_audio.seek(30, 'from-end')}>Go to 30s from end</button
>
<button type="button" on:click={() => episode_audio.skip(10, 'forward')}>Skip 10s</button>
<button type="button" on:click={() => episode_audio.skip(10, 'backward')}>Rewind 10s</button>
<hr />
<h6>Playback Rate</h6>
{#each [0.5, 1, 2, 3] as rate}
<button type="button" on:click={() => user_preferences.set.playback_rate(rate)}>
{rate}x
</button>
{/each}
<!-- <PodcastPlayer
artwork={$episode_audio?.details?.artwork}
title={$episode_audio?.details?.title || 'Podcast Name'}
/> -->
+20
View File
@@ -0,0 +1,20 @@
<script lang="ts">
export let name: string;
</script>
<div class="flex flex-col items-stretch space-y-6">
<div class="prose prose-lg prose-slate">
<h3>{name}</h3>
</div>
<fieldset>
<legend>{name} options</legend>
<slot name="options" />
</fieldset>
<div class="w-full rounded-md border p-3">
<div class="mx-auto w-max">
<slot />
</div>
</div>
</div>
+6
View File
@@ -0,0 +1,6 @@
<script lang="ts">
export let code: string;
export let description: string;
</script>
<pre><code class="hljs language-js">{`//${description}\n\n${code}`}</code></pre>
+14
View File
@@ -0,0 +1,14 @@
<script lang="ts">
export let name: string;
export let data: unknown;
</script>
<div class="flex flex-col items-stretch space-y-6">
<h3>{name}</h3>
<h4>subscription: ${name}</h4>
<pre><code class="hljs language-json">{JSON.stringify({ data }, null, 2)}</code></pre>
<h4>methods</h4>
<slot />
</div>