Skip to content
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

Fix custom component guide #84

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Fix custom component guide #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3ee2c3
Use Elephant's Dream in custom component guide
MattiasBuelens Dec 3, 2024
596c4bd
Hide source selector in custom component guide
MattiasBuelens Dec 3, 2024
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
28 changes: 24 additions & 4 deletions docs/guides/custom-component.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,12 @@ Now add your new button to your custom UI. In our example, we'll place it in the

It should look something like this:

<Example className={styles.player} src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-play-button-step1.html')} hideDeviceType />
<Example
className={styles.player}
src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-play-button-step1.html')}
hideDeviceType
hideSource
/>

Try clicking the "Play" button in the middle of the screen.
You should see an alert window popping up saying `My play button was clicked!`.
Expand Down Expand Up @@ -114,7 +119,12 @@ You can also update the text content of your button to reflect the new state:

It should look something like this:

<Example className={styles.player} src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-play-button-step2.html')} hideDeviceType />
<Example
className={styles.player}
src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-play-button-step2.html')}
hideDeviceType
hideSource
/>

Try clicking the "Play" button in the middle of the screen. The player starts playing!<br/>
Clicking it again should pause the player.
Expand Down Expand Up @@ -180,7 +190,12 @@ Now add your new label to your custom UI. In our example, we'll place it inside

It should look something like this:

<Example className={styles.player} src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-quality-label-step1.html')} hideDeviceType />
<Example
className={styles.player}
src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-quality-label-step1.html')}
hideDeviceType
hideSource
/>

### Step 2: Listen to quality changes

Expand All @@ -207,7 +222,12 @@ Right now, the quality label is static, it doesn't actually update when the play

It should look something like this:

<Example className={styles.player} src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-quality-label-step2.html')} hideDeviceType />
<Example
className={styles.player}
src={useBaseUrl('/open-video-ui/v1/guides/web/custom-component/my-quality-label-step2.html')}
hideDeviceType
hideSource
/>

Try changing the active quality by clicking the ⚙️ (Settings) button, and changing "Automatic" to a specific quality.
You should see your custom label update to show the height of the new quality.
Expand Down
2 changes: 1 addition & 1 deletion docs/static/open-video-ui/v1/guides/web/custom-component/my-play-button-step1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
-->
<theoplayer-ui
configuration='{"libraryLocation":"https://cdn.theoplayer.com/dash/theoplayer/","licenseUrl":"../../../../../theoplayer-license.txt"}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/big_buck_bunny/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/elephants-dream/playlist.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/elephants-dream/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
>
<my-play-button slot="centered-chrome"></my-play-button>
</theoplayer-ui>
Expand Down
2 changes: 1 addition & 1 deletion docs/static/open-video-ui/v1/guides/web/custom-component/my-play-button-step2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
-->
<theoplayer-ui
configuration='{"libraryLocation":"https://cdn.theoplayer.com/dash/theoplayer/","licenseUrl":"../../../../../theoplayer-license.txt"}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/big_buck_bunny/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/elephants-dream/playlist.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/elephants-dream/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
>
<my-play-button slot="centered-chrome"></my-play-button>
</theoplayer-ui>
Expand Down
2 changes: 1 addition & 1 deletion docs/static/open-video-ui/v1/guides/web/custom-component/my-quality-label-step1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
-->
<theoplayer-ui
configuration='{"libraryLocation":"https://cdn.theoplayer.com/dash/theoplayer/","licenseUrl":"../../../../../theoplayer-license.txt"}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/big_buck_bunny/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/elephants-dream/playlist.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/elephants-dream/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
>
<theoplayer-control-bar>
<!-- A seek bar -->
Expand Down
2 changes: 1 addition & 1 deletion docs/static/open-video-ui/v1/guides/web/custom-component/my-quality-label-step2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
-->
<theoplayer-ui
configuration='{"libraryLocation":"https://cdn.theoplayer.com/dash/theoplayer/","licenseUrl":"../../../../../theoplayer-license.txt"}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/big_buck_bunny/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
source='{"sources":{"src":"https://cdn.theoplayer.com/video/elephants-dream/playlist.m3u8"},"textTracks":[{"default":true,"src":"https://cdn.theoplayer.com/video/elephants-dream/thumbnails.vtt","label":"thumbnails","kind":"metadata"}]}'
>
<theoplayer-control-bar>
<!-- A seek bar -->
Expand Down
Loading