stipsan / sanity-plugin-mux-input

An input component that integrates Sanity Studio with MUX.com video encoding/hosting service.

Mux Video Input Sanity Plugin

NOTE

This is the Sanity Studio v3 version of sanity-plugin-mux-input.

For the v2 version, please refer to the studio-v2 branch.

This is a plugin that let you use Mux video assets in your Sanity studio.

The Mux plugin for Sanity gives you a way to upload and preview videos easily.

Read our blog post about this plugin.

Not familiar with Sanity? Visit www.sanity.io

Quick start

• While in your project folder, run npm i sanity-plugin-mux-input@studio-v3. Read more about using plugins in Sanity here.

• Make a schema type that uses the plugin's type mux.video, for example:

  {
    title: "Video blog post",
    name: "videoBlogPost",
    type: "document",
    fields: [
      { title: "Title", name: "title", type: "string" },
      {
        title: "Video file",
        name: "video",
        type: "mux.video"
      }
    ]
  }

  • Add the muxInput import to your plugins:

  import {createConfig} from 'sanity'
  import {muxInput} from 'sanity-plugin-mux-input'
  
  export default createConfig({
    plugins: [muxInput()],
  })

Read more about schemas in Sanity here.

• Get an API Access Token and enter it into the setup screen First time you use the plugin you will be asked to enter your Mux credentials.

The Mux Video API uses an Access Token and Secret Key for authentication.

If you haven't already, generate a new Access Token in the Access Token settings of your Mux account dashboard, and make sure it got permission to both read and write video and read data.

The token is stored in the dataset as a document of the type mux.apiKey with the id secrets.mux. Having the ID be non-root ensures that only editors are able to see it.

The Mux plugin will find its access tokens by fetching this document.

Playing videos in the frontend

We have made our own player which supports poster images for the videos as set with this plugin, see sanity-mux-player

You could use any player which supports HLS, just point the video source to:

https://stream.mux.com/${assetDocument.playbackId}.m3u8

Enabling Signed Urls

To enable signed urls with content uploaded to Mux, you will need to check the "Enable Signed Urls" option in the Mux Plugin configuration. Assuming that the API Access Token and Secret Key are set (as per the Quick start section).

More information for this feature of the plugin can be found on Mux's documentation

Enabling MP4 support

To enable static MP4 renditions, add mp4_support: 'standard' to the options of your mux.video schema type.

import {muxInput} from 'sanity-plugin-mux-input'

export default createConfig({
  plugins: [muxInput({mp4_support: 'standard'})],
})

Currently, mp4_support is the only supported MUX option and this supports a value of either standard or none (the default).

Contributing

Issues are actively monitored and PRs are welcome. When developing this plugin the easiest setup is:

1. Fork this repo.
2. Create a studio v3 project: npm create sanity@dev-preview. Follow the prompts, starting out with the blog template is a good way to go.
3. cd into your project directory, run npm install && npm start - your sanity studio should be running on http://localhost:3333.
4. cd into the plugins directory of your project.
5. Fork this repo and clone your fork into the plugins directory inside your project git clone [email protected]:your-fork/sanity-plugin-mux-input.git.
6. Open sanity.json, go to the plugins array and add mux-input.
7. Re-start the sanity studio server with npm start.
8. Edit schemas/post.js and add follow the plugin documentation to add a mux.video type field.
9. Your studio should reload, and now when you edit the plugin code it should reload the studio, when you're done creating a branch, put in a PR and a maintainer will review it. Thank you!

Publishing

Run the "CI" workflow. Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.

On the studio-v2 branch this will result in:

• a new version on the latest dist-tag.
• running yarn add sanity-plugin-mux-input or npm i sanity-plugin-mux-input will fetch the new version.
• running sanity install mux-input will fetch the new version.
• studio-v3 users are unaffected.

On the main branch this will result in:

• a new prerelease version on the studio-v3 dist-tag.
• running yarn add sanity-plugin-mux-input@studio-v3 or npm i sanity-plugin-mux-input@studio-v3 will fetch the new version.
• running sanity install mux-input won't fetch the new version.

After Studio v3 turns stable this behavior will change. The v2 version will then be available on the studio-v2 dist-tag, and studio-v3 is upgraded to live on latest.

Test

npm test