Skip to content

Commit

Permalink
chore: Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
matvp91 committed Oct 19, 2024
1 parent 13a2048 commit 8323748
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docker/build.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ do
cd $dir/packages/$package
echo "👷 Building $package"
pnpm run build
docker build . --no-cache --tag=mixwave/$package:latest
docker build . --no-cache --platform linux/amd64,linux/arm64 --tag=mixwave/$package:latest
done
4 changes: 2 additions & 2 deletions docs/features/stitcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ Let's say you transcoded and packaged a new asset with the id `abbda878-8e08-40f

<video class="video-frame" src="/video/InterstitialBumper.mp4" controls></video>

### VMAP
### VMAP (linear ads)

Instruct stitcher to add interstitials based on [VMAP](https://www.iab.com/guidelines/vmap/) definitions. Each VMAP contains one or more `AdBreak` elements with a position of where the interstitial should be.
[VMAP](https://www.iab.com/guidelines/vmap/) (Video Multiple Ad Playlist) is an XML-based specification that defines how multiple ad breaks can be inserted into a video stream. Instruct stitcher to add interstitials based on VMAP definitions. Each VMAP contains one or more `AdBreak` elements with a position of where the interstitial should be.

```json
{
Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ pnpm dev

If you did not specify other ports for the separate services, you'd have these services running now:

- Dashboard: localhost:52000
- API: localhost:52001
- Stitcher: localhost:52002
- Dashboard - localhost:52000
- API - localhost:52001
- Stitcher - localhost:52002

The artisan workers have also been booted in the background, and they're ready to do some transcoding work.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ layout: home

hero:
name: <img class="logo" src="/mixwave/logo.svg" /> <span class="hidden">Mixwave</span>
text: "Convert, package and manipulate on the fly."
tagline: "A friendly API to simplify the complexities of video delivery."
text: "Mixwave"
tagline: "Simplify the complexities of video delivery. All-in-one toolkit from ingest to adaptive video playback."
actions:
- theme: brand
text: Introduction
Expand Down
16 changes: 10 additions & 6 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,23 @@ next:

Mixwave is a self hostable platform that aims to simplify the complexities of video delivery. Transcode and package your media for online streaming with simple API calls and sane defaults.

Things get more complicated once you go beyond playing a basic mp4 file. To offer different video qualities depending on the viewer's bandwidth, or to include multiple audio or text tracks, you need a different setup.
Video delivery is quite fragmented, especially when it comes to how content is streamed and protected on different platforms and devices. For example, delivering video in an HLS playlist is a whole different beast compared to MPEG-DASH. While there used to be solid reasons for this, like device compatibility, we now believe this kind of fragmentation isn’t necessary anymore — especially with CMAF becoming the standard. So, we’re keeping things simple and focusing on just one playback protocol: HLS with CMAF. Instead of trying to support everything under the sun, we’re sticking with the best tool for the job. When you don’t have to do the same thing over and over, aiming for perfection gets way easier.

Before we go further, it's important to note that Mixwave intentionally keeps its scope limited. We choose to focus on a single playback protocol HLS CMAF rather than trying to support a wide range of options. We aim to avoid fragmentation by picking the right tools for the job. If you don't have to do the same thing multiple times, aiming for perfection is a lot easier.
Delivering video gets more complex once you move beyond just providing a simple MP4 file to your users. If you want to offer different video qualities based on the viewer's bandwidth, or include multiple audio and text tracks, you need a more advanced setup. That's where Mixwave comes in.

## API
## Terminology

Essentially Mixwave is a set of APIs that handle video from ingest to playback. It is designed to be user-friendly, making video transcoding, packaging, and delivery accessible to a wider audience.
You’ll come across a lot of specific video terms in our documentation. We want to go over these first to make sure we're all on the same page. We’ll keep things straightforward, but if you’re curious to dive deeper into video, there's plenty of info at https://howvideo.works/.

Typically, you transcode the video once. The resulting intermediary file is then assigned a generated UUID, which can be used to initiate a packaging job or to configure the stitcher for manipulating or merging playlists.
- Transcoding - Convert video to different formats or quality levels for compatibility and optimization.
- Packaging - Prepare video content for delivery by formatting it into segments and manifest files for streaming protocols (like HLS).
- Stitching - Modifying playlist files to control video playback, such as switching streams or adding content dynamically (like ads, bumpers, ...).
- Interstitials - Insert other content into an HLS stream by dynamically updating the playlist during video playback.
- Codec - A video or audio codec compresses and decompresses media files to reduce their size for storage or streaming.

## Features

Mixwave makes it easier for you to do the following tasks using a user-friendly API:
Mixwave makes it easier for you to do the following tasks using a user-friendly API and our dashboard:

### <img src="/transcode.svg" class="title-image" /> Transcode

Expand Down

0 comments on commit 8323748

Please sign in to comment.