Use our API and components to handle embedding, storing, and streaming video in your Remix.js application
When adding video to your Remix.js app, you'll encounter some common hurdles. First, videos are large. Storing them in your public directory can lead to excessive bandwidth consumption and poor Git repository performance. Next, it's important to compress and optimize your videos for the web. Then, as network conditions change, you might want to adapt the quality of your video to ensure a smooth playback experience for your users. Finally, you may want to integrate additional features like captions, thumbnails, and analytics.
You might consider using Mux's APIs and components to handle these challenges, and more.
If you're looking to build your own video workflow that enables uploading, playback, and more in your application, you can use the Mux API and components like Mux Player and Mux Uploader.
One reason you might want to build your own video workflow is when you want to allow users to upload video to your app.
Let's start by adding a new page where users can upload videos. This will involve using the Mux Uploader component, which will upload videos to a Mux Direct Uploads URLAPI.
In the code sample below, we'll create an upload URL using the Mux Node SDK and the Direct Uploads URL API. We'll pass that URL to the Mux Uploader component, which will handle uploading for us.
import { json } from "@remix-run/node";import { useLoaderData } from "@remix-run/react";import MuxUploader from "@mux/mux-uploader-react";import mux from "~/lib/mux.server";export const loader = async () => { const upload = await mux.video.uploads.create({ new_asset_settings: { playback_policy: ["public"], encoding_tier: "baseline", }, cors_origin: "*", }); return json({ url: upload.url });};export default function UploadPage() { const { url } = useLoaderData(); return <MuxUploader endpoint={url} />}In production, you'll want to apply additional security measures to your upload URL. Consider protecting the route with authentication to prevent unauthorized users from uploading videos. Also, use cors_origin and consider playback_policy to further restrict where uploads can be performed and who can view uploaded videos.
Next, we'll create an API endpoint that will listen for Mux webhooks. When we receive the notification that the video has finished uploading and is ready for playback, we'll add the video's metadata to our database.
import { json } from "@remix-run/node";import Mux from "@mux/mux-node";// this reads your MUX_TOKEN_ID and MUX_TOKEN_SECRET// from your environment variables// https://dashboard.mux.com/settings/access-tokensconst mux = new Mux();// Mux webhooks POST, so let's use an actionexport const action = async ({ request }) => { if (request.method !== "POST") { return new Response("Method not allowed", { status: 405 }); } const body = await request.text(); // mux.webhooks.unwrap will validate that the given payload was sent by Mux and parse the payload. // It will also provide type-safe access to the payload. // Generate MUX_WEBHOOK_SIGNING_SECRET in the Mux dashboard // https://dashboard.mux.com/settings/webhooks const event = mux.webhooks.unwrap( body, request.headers, process.env.MUX_WEBHOOK_SIGNING_SECRET ); // you can also unwrap the payload yourself: // const event = await request.json(); switch (event.type) { case "video.upload.asset_created": // we might use this to know that an upload has been completed // and we can save its assetId to our database break; case "video.asset.ready": // we might use this to know that a video has been encoded // and we can save its playbackId to our database break; // there are many more Mux webhook events // check them out at https://docs.mux.com/webhook-reference default: break; } return json({ message: "ok" });};Finally, let's make a playback page. We retrieve the video metadata from our database, and play it by passing its playbackId to Mux Player:
import MuxPlayer from "@mux/mux-player-react";import { useLoaderData, useParams } from "@remix-run/react";export const loader = async ({ params, request }) => { const { title } = getAssetFromDatabase(params); const userId = getUser(request); return json({ title, userId });};export default function Page() { const { title, userId } = useLoaderData(); const { playbackId } = useParams(); return ( <MuxPlayer playbackId={playbackId} metadata={{ video_title: title, viewer_user_id: userId }} /> );}And we've got upload and playback. Nice!
What's next? You can integrate with your CMS. You can optimize your loading experience. Or get started with the example project below:
This is a bare-bones starter application with Remix.js that uses: