@oversightstudio/mux-video NPM

Mux Video Payload Plugin

Install

pnpm add @oversightstudio/mux-video @mux/mux-player-react

About

This plugin brings Mux Video to Payload! It creates a “Videos” collection within the admin panel, making it simple to upload videos directly to Mux and manage them.

Features include:

Support for both public and signed playback policies.
Ensures that videos deleted in the admin panel are automatically deleted from Mux, and vice versa.
Video gif previews on the videos collection list view, which can be disabled if required.

muxVideoPreview

Payload Setup

There are two possible setups for this plugin: The public setup, and the signed URLs setup. The main difference between the two is that the signed URLs setup requires setting up a little extra configuration, but that's about it.

To get started, you’ll need to generate your MUX tokens and secrets from the MUX Dashboard. When configuring the webhook, set the URL to the automatically generated API endpoint provided by this plugin at /api/mux/webhook.

Public Setup

import { buildConfig } from 'payload'
import { muxVideoPlugin } from '@oversightstudio/mux-video'

export default buildConfig({
  plugins: [
    muxVideoPlugin({
      enabled: true,
      initSettings: {
        tokenId: process.env.MUX_TOKEN_ID || '',
        tokenSecret: process.env.MUX_TOKEN_SECRET || '',
        webhookSecret: process.env.MUX_WEBHOOK_SIGNING_SECRET || '',
      },
      uploadSettings: {
        cors_origin: process.env.NEXT_PUBLIC_SERVER_URL || 'http://localhost:3000',
      },
    }),
  ],
})

Signed URLs Setup

import { buildConfig } from 'payload'
import { muxVideoPlugin } from '@oversightstudio/mux-video'

export default buildConfig({
  plugins: [
    muxVideoPlugin({
      enabled: true,
      initSettings: {
        tokenId: process.env.MUX_TOKEN_ID || '',
        tokenSecret: process.env.MUX_TOKEN_SECRET || '',
        webhookSecret: process.env.MUX_WEBHOOK_SIGNING_SECRET || '',
        jwtSigningKey: process.env.MUX_JWT_KEY_ID || '',
        jwtPrivateKey: process.env.MUX_JWT_KEY || '',
      },
      uploadSettings: {
        cors_origin: process.env.NEXT_PUBLIC_SERVER_URL || 'http://localhost:3000',
        new_asset_settings: {
          playback_policy: ['signed'],
        },
      },
    }),
  ],
})

Options

Option	Type	Default	Description
`enabled`	`boolean`	Required	Whether the plugin is enabled.
`initSettings`	`MuxVideoInitSettings`	Required	Initialization settings for the Mux implementation.
`uploadSettings`	`MuxVideoUploadSettings`	Required	Upload settings for Mux video assets.
`access`	`(request: PayloadRequest) => Promise<boolean> \\| boolean`	Optional	An optional function to determine who can upload files. Should return a boolean or a Promise resolving to a boolean.
`signedUrlOptions`	`MuxVideoSignedUrlOptions`	Optional	Options for signed URL generation.
`adminThumbnail`	`'gif' \\| 'image' \\| 'none'`	`"gif"`	Specifies the type of thumbnail to display for videos in the collection list view.

`initSettings` Options

Option	Type	Default	Description
`tokenId`	`string`	Required	The Mux token ID.
`tokenSecret`	`string`	Required	The Mux token secret.
`webhookSecret`	`string`	Required	The secret used to validate Mux webhooks.
`jwtSigningKey`	`string`	Optional	Optional JWT signing key, required for signed URL setup.
`jwtPrivateKey`	`string`	Optional	Optional JWT private key, required for signed URL setup.

`uploadSettings` Options

Option	Type	Default	Description
`cors_origin`	`string`	Required	The required CORS origin for Mux.
`new_asset_settings`	`MuxVideoNewAssetSettings`	Optional	Additional settings for creating assets in Mux.

`new_asset_settings` Options

Option	Type	Default	Description
`playback_policy`	`Array<'public' \| 'signed'>`	`public`	Controls the playback policy for uploaded videos. Default is `public`.

`signedUrlOptions` Options

Option	Type	Default	Description
`expiration`	`string`	`"1d"`	Expiration time for signed URLs. Default is `"1d"`.

Videos Collection

This is the collection generated by the plugin with the mux-video slug.

Field	Type	Read-Only	Description
`title`	`text`	No	A unique title for this video that will help you identify it later.
`assetId`	`text`	Yes
`duration`	`number`	Yes
`posterTimestamp`	`number`	No	A timestamp (in seconds) from the video to be used as the poster image. When unset, defaults to the middle of the video.
`aspectRatio`	`text`	Yes
`maxWidth`	`number`	Yes
`maxHeight`	`number`	Yes
`playbackOptions`	`array`	Yes

`playbackOptions` Fields

Field	Type	Read-Only	Description
`playbackId`	`text`	Yes
`playbackPolicy`	`select`	Yes	Options: `signed`, `public`
`playbackUrl`	`text (virtual)`	Yes
`posterUrl`	`text (virtual)`	Yes

Payload Usage Example

import { CollectionConfig } from 'payload'

export const ExampleCollection: CollectionConfig = {
  slug: 'example',
  fields: [
    // To link videos to other collection, use the `relationship` field type
    {
      name: 'video',
      label: 'Preview Video',
      type: 'relationship',
      relationTo: 'mux-video',
    },
  ],
}

Frontend Usage Example

import config from '@/payload.config'
import { getPayload } from 'payload'
import MuxPlayer from '@mux/mux-player-react'

async function Page() {
  const payload = await getPayload({ config })

  const video = await payload.findByID({
    collection: 'mux-video',
    id: 'example',
  })

  return (
    <MuxPlayer
      // Using playback id
      playbackId={video.playbackOptions![0].playbackId!}
      // Or use the playback URL
      src={video.playbackOptions![0].playbackUrl!}
      // Poster
      poster={video.playbackOptions![0].posterUrl!}
    />
  )
}

export default Page