Mux Video

This example uses Mux Video, an API-first platform for video. The example features video uploading and playback in a Next.js application.

Try it out

• https://with-mux-video.vercel.app/
• This project was used to create stream.new

Deploy your own

Deploy the example using Vercel:

How to use

Step 1. Create a Next app with this example

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-mux-video with-mux-video-app

yarn create next-app --example with-mux-video with-mux-video-app

pnpm create next-app --example with-mux-video with-mux-video-app

bunx create-next-app --example with-mux-video with-mux-video-app

Step 2. Create an account in Mux

All you need to run this example is a Mux account. You can sign up for free. There are no upfront charges -- you get billed monthly only for what you use.

Without entering a credit card on your Mux account all videos are in “test mode” which means they are watermarked and clipped to 10 seconds. If you enter a credit card all limitations are lifted and you get \$20 of free credit. The free credit should be plenty for you to test out and play around with everything.

Step 3. Set up environment variables

Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then, go to the settings page in your Mux dashboard, get a new API Access Token. Use that token to set the variables in .env.local:

• MUX_TOKEN_ID should be the TOKEN ID of your new token
• MUX_TOKEN_SECRET should be TOKEN SECRET

At this point, you're good to npm run dev or yarn dev or pnpm dev. However, if you want to deploy, read on:

Step 4. Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

To deploy on Vercel, you need to set the environment variables using Vercel CLI (Documentation).

Install the Vercel CLI, log in to your account from the CLI, and run the following commands to add the environment variables. Replace the values with the corresponding strings in .env.local:

vercel secrets add next_example_mux_token_id <MUX_TOKEN_ID>
vercel secrets add next_example_mux_token_secret <MUX_TOKEN_SECRET>

Then push the project to GitHub/GitLab/Bitbucket and import to Vercel to deploy.

Notes

Preparing for Production

Important: When creating uploads, this demo sets cors_origin: "*" in the app/(upload)/page.tsx file. For extra security, you should update this value to be something like cors_origin: 'https://your-app.com', to restrict uploads to only be allowed from your application.

How it works

1. Users land on the home page, app/(upload)/page.tsx. The Mux Direct Uploads API provides an endpoint to Mux Uploader React.
2. The user uploads a video with Mux Uploader. When their upload is complete, Mux Uploader calls a server action that redirects to...
3. app/(upload)/asset/[assetId]/page.tsx, which polls the Asset API via server action, waiting for the asset to be ready. Once the asset is ready, it redirects to...
4. app/v/[assetId]/page.tsx, where users can watch their video using Mux Player React. This page uses the Mux Image API and the Next.js Metadata API to provide an og images tailored to each video.