Skip to content

chore: Chapters examples to demonstrate functionality with native playback. #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+57 −79
Draft

chore: Chapters examples to demonstrate functionality with native playback. #1177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions examples/nextjs-with-typescript/pages/MuxPlayerChapters.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,40 @@
import Link from "next/link";
import Head from 'next/head';
import { useState } from "react";
import { useCallback, useState } from "react";
import MuxPlayer from "@mux/mux-player-react";
import type MuxPlayerElement from "@mux/mux-player";

type Chapter = { startTime: number; endTime: number; value: string; };
const chapters: Chapter[] = [
{ startTime: 0, endTime: 3, value: 'Chapter 1' },
{ startTime: 3, endTime: 6, value: 'Chapter 2' },
{ startTime: 6, endTime: 9, value: 'Chapter 3' }
const exampleChapters: Chapter[] = [
{ startTime: 0, endTime: 3, value: 'A beginning chapter' },
{ startTime: 3, endTime: 6, value: 'In the middle' },
{ startTime: 6, endTime: 9, value: 'Is this the end? (No)' }
];


function MuxPlayerPage() {
function MuxPlayerPage({ chapters = exampleChapters }: { chapters: Chapter[] }) {
const [activeChapter, setActiveChapter] = useState<Chapter>(undefined);

function addChaptersToPlayer(playerEl: MuxPlayerElement) {
const addChaptersToPlayer = useCallback((playerEl: MuxPlayerElement) => {
// Not ready for chapters yet!
if (!playerEl || !playerEl.readyState) return;
// Already added chapters!
if (!!playerEl.chapters?.length) return;
playerEl.addChapters(chapters);
}
}, [chapters]);

return (
<>
<Head>
<title>&lt;MuxPlayer/&gt; (CuePoints) Demo</title>
<title>&lt;MuxPlayer/&gt; (Chapters) Demo</title>
</Head>

<MuxPlayer
key="23s11nz72DsoN657h4314PjKKjsF2JG33eBQQt6B95I"
ref={addChaptersToPlayer}
playbackId="23s11nz72DsoN657h4314PjKKjsF2JG33eBQQt6B95I"
preload="auto"
// Using native playback
preferPlayback="mse"
onLoadedMetadata={({ target }) => {
addChaptersToPlayer(target as MuxPlayerElement);
}}
Expand Down
109 changes: 40 additions & 69 deletions examples/vanilla-ts-esm/public/mux-player-chapters.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,85 +42,56 @@ <h1><a href="/">Elements</a></h1>
<img width="32" height="32" src="./images/github-logo.svg" alt="Github logo">
</a>
</div>
<title>&lt;MuxPlayer/&gt; (Chapters) Demo</title>
</header>

<h2>Chapters with explicit end times (with gaps)</h2>

<mux-player
id="playerOne"
stream-type="on-demand"
prefer-playback="mse"
playback-id="23s11nz72DsoN657h4314PjKKjsF2JG33eBQQt6B95I"
muted
preload="auto"
></mux-player>
<p>
<b>Active Chapter:</b> <pre id="chapter-renderer">Unset</pre>
</p>
<p>
<button onclick="window.playerOne.addChapters([{startTime: 15, endTime: 18, value: 'Extra chapter'}]); this.disabled = true;">Add additional fourth chapter</button>
</p>


<h2>Chapters with implicit end times (no gaps, audio UI)</h2>

<mux-player
id="playerTwo"
stream-type="on-demand"
playback-id="23s11nz72DsoN657h4314PjKKjsF2JG33eBQQt6B95I"
muted
preload="auto"
audio
></mux-player>

<p>
<button onclick="window.playerTwo.addChapters([{startTime: 6, value: 'Chapter 2.5'}]); this.disabled = true;">Add chapter between 2 and 3</button>
</p>
<div>
<b>Active chapter:</b>
<pre id="chapter-renderer" style="background-color: #888; padding: 10px; color: #fff;">
</pre>
</div>
<br />

<script>
const playerOneEl = document.querySelector('#playerOne');
const playerTwoEl = document.querySelector('#playerTwo');

function addChapterstoPlayerOne() {
const chaptersOne = [
{ startTime: 1, endTime: 3, value: 'Chapter 1' },
{ startTime: 3, endTime: 6, value: 'Chapter 2 (joined)' },
{ startTime: 10, endTime: 15, value: 'Chapter 3 (after gap)' }
];
playerOneEl.addChapters(chaptersOne);

console.log('Player one chapters added');
}

function addChapterstoPlayerTwo() {
const chaptersTwo = [
{ startTime: 1, value: 'Chapter 1' },
{ startTime: 3, value: 'Chapter 2' },
{ startTime: 10, value: 'Chapter 3 (to the end...)' }
];
playerTwoEl.addChapters(chaptersTwo);

console.log('Player 2 chapters added');
}

function chapterChangeListener() {
console.log('Active Chapter', playerOneEl.activeChapter);
document.getElementById('chapter-renderer').innerText = playerOneEl.activeChapter.value;
}

playerOneEl.addEventListener('chapterchange', chapterChangeListener);

// NOTE: Need to wait until the player has loaded metadata before adding chapters!
if (playerOneEl.readyState >= 1) {
addChapterstoPlayerOne();
} else {
playerOneEl.addEventListener('loadedmetadata', addChapterstoPlayerOne, { once: true });
}

if (playerTwoEl.readyState >= 1) {
addChapterstoPlayerTwo();
} else {
playerTwoEl.addEventListener('loadedmetadata', addChapterstoPlayerTwo, { once: true });
}
const playerEl = document.querySelector('#playerOne');
const chapterRendererEl = document.getElementById('chapter-renderer')

const chapters = [
{ startTime: 0, endTime: 3, value: 'A beginning chapter' },
{ startTime: 3, endTime: 6, value: 'In the middle' },
{ startTime: 6, endTime: 9, value: 'Is this the end? (No)' }
];

const addChaptersToPlayer = (playerEl) => {
// Not ready for chapters yet!
// NOTE: Inverting readyState condition because it's possible the web component hasn't upgraded yet
if (!playerEl || !playerEl.readyState) return;
// Already added chapters!
if (!!playerEl.chapters?.length) return;
playerEl.addChapters(chapters);
};

const setActiveChapter = (activeChapter) => {
chapterRendererEl.innerText = activeChapter.value ?? 'Unset';
};

playerEl.addEventListener('chapterchange', () => {
setActiveChapter(playerEl.activeChapter);
});

addChaptersToPlayer(playerEl);
playerEl.addEventListener(
'loadedmetadata',
({ target }) => addChaptersToPlayer(target),
{ once: true }
);
</script>
<a href="../">Browse Elements</a>
</body>
Expand Down
Loading