sanity-plugin-mux-input 2.3.3 → 2.3.5

package/README.md

@@ -181,17 +181,22 @@ export default function MuxVideo({playbackId, title}: {playbackId?: string; titl
 
 💡 You can try these recommendations through the [Codesandbox example](https://codesandbox.io/s/github/sanity-io/sanity-plugin-mux-input/tree/main/example).
 
-## Configuring Mux video uploads
+## Configuring Mux Video uploads
 
 ### Signed URLs (private playbacks)
 
-To enable [signed urls](https://docs.mux.com/docs/security-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](#quick-start) section).
+To enable [signed URLs](https://docs.mux.com/docs/security-signed-urls) with content uploaded to Mux, you will need to check the "Enable Signed Urls" option in the Mux Plugin configuration. This feature requires you to set the API Access Token and Secret Key (as per the [Quick start](#quick-start) section).
 
-More information for this feature of the plugin can be found on Mux's [documentation](https://docs.mux.com/docs/headless-cms-sanity#advanced-signed-urls)
+📌 **Note**: When the signed URL option is triggered, the plugin will cache a `signingKeyPrivate` in a private document in the dataset. This key is used by Mux to sign the uploads, and if it's incorrect your uploads will fail. If that's the case, you can delete the secrets document and try again:
 
-### Encoding tier
+```bash
+# Using the Sanity CLI, delete the secrets, then re-open the plugin and configure it again
+sanity documents delete secrets.mux
+```
+
+More information on signed URLs is available on Mux's [docs](https://docs.mux.com/docs/headless-cms-sanity#advanced-signed-urls)
 
-### MP4 support (downloadable videos)
+### MP4 support (downloadable videos or offline viewing)
 
 To enable [static MP4 renditions](https://docs.mux.com/guides/video/enable-static-mp4-renditions), add `mp4_support: 'standard'` to the `options` of your `mux.video` schema type.
 
@@ -205,6 +210,8 @@ export default defineConfig({
 
 If MP4 support is enabled in the plugin's configuration, editors can still choose to enable MP4 renditions on a per-video basis when uploading new assets.
 
+MP4 allows users to download videos for later or offline viewing. More information can be found on Mux's [documentation](https://docs.mux.com/guides/enable-static-mp4-renditions).
+
 ### Video resolution (max_resolution_tier)
 
 To edit [max_resolution_tier](https://docs.mux.com/api-reference#video/operation/create-direct-upload) to support other resolutions other than 1080p, add `max_resolution_tier: '1080p' | '1440p' | '2160p'` to the `options` of your `mux.video` schema type. Defaults to `1080p`.
@@ -217,7 +224,7 @@ export default defineConfig({
 })
 ```
 
-When uploading new assets, editors can still choose a lower resolution for each video than configured globally.
+When uploading new assets, editors can still choose a lower resolution for each video than configured globally. This option controls the maximum resolution encoded or processed for the uploaded video. The option is particularly important to manage costs when uploaded videos are higher than `1080p` resolution. More information on the feature is available on Mux's [docs](https://docs.mux.com/guides/stream-videos-in-4k). Also, read more on this feature announcement on Mux's [blog](https://www.mux.com/blog/more-pixels-fewer-problems-introducing-4k-support-for-mux-video).
 
 ### Encoding tier (smart or baseline)
 
@@ -233,6 +240,29 @@ export default defineConfig({
 
 If `encoding_tier: 'smart'`, editors can still choose to use the `baseline` encoding tier on a per-video basis when uploading new assets.
 
+More information on the feature is available on Mux's [documentation](https://docs.mux.com/guides/use-encoding-tiers). Also, read more on the feature announcement on Mux's [blog](https://www.mux.com/blog/our-next-pricing-lever-baseline-on-demand-assets-with-free-video-encoding)
+
+### Auto-generated subtitles and captions
+
+If you've enabled smart encoding, you can use Mux's [auto-generated subtitles](https://docs.mux.com/guides/video/auto-generated-subtitles) feature. Unless you pass `disableTextTrackConfig: true` to the configuration, users will be able to choose a language to auto-generate subtitles for uploaded videos. Refer to Mux's documentation for the list of supported languages.
+
+You can also define a default language for the upload configuration form:
+
+```js
+import {muxInput} from 'sanity-plugin-mux-input'
+
+export default defineConfig({
+  plugins: [
+    muxInput({
+      encoding_tier: 'smart',
+      defaultAutogeneratedSubtitleLang: 'en', // choose from one of the supported languages
+    }),
+  ],
+})
+```
+
+If your videos are always spoken in a specific language and you want to include captions by default, you can use `disableTextTrackConfig: true` together with `defaultAutogeneratedSubtitleLang` to transcribe captions for every uploaded asset without needing user interaction.
+
 ## Contributing
 
 Issues are actively monitored and PRs are welcome. When developing this plugin the easiest setup is:

package/{lib/index.d.cts → dist/index.d.mts}

@@ -112,10 +112,17 @@ declare interface MuxInputConfig {
    * Auto-generate captions for these languages by default.
    * Requires `"encoding_tier": "smart"`
    *
-   * @see {@link https://docs.mux.com/guides/secure-video-playback}
-   * @defaultValue false
+   * @see {@link https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts}
+   * @deprecated use `defaultAutogeneratedSubtitleLang` instead. Only a single autogenerated
    */
   defaultAutogeneratedSubtitleLangs?: SupportedMuxLanguage[]
+  /**
+   * Auto-generate captions for this language by default. Users can still
+   * Requires `"encoding_tier": "smart"`
+   *
+   * @see {@link https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts}
+   */
+  defaultAutogeneratedSubtitleLang?: SupportedMuxLanguage
   /**
    * Whether or not to allow content editors to override asset upload
    * configuration settings when uploading a video to Mux.

package/{lib → dist}/index.d.ts

@@ -112,10 +112,17 @@ declare interface MuxInputConfig {
    * Auto-generate captions for these languages by default.
    * Requires `"encoding_tier": "smart"`
    *
-   * @see {@link https://docs.mux.com/guides/secure-video-playback}
-   * @defaultValue false
+   * @see {@link https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts}
+   * @deprecated use `defaultAutogeneratedSubtitleLang` instead. Only a single autogenerated
    */
   defaultAutogeneratedSubtitleLangs?: SupportedMuxLanguage[]
+  /**
+   * Auto-generate captions for this language by default. Users can still
+   * Requires `"encoding_tier": "smart"`
+   *
+   * @see {@link https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts}
+   */
+  defaultAutogeneratedSubtitleLang?: SupportedMuxLanguage
   /**
    * Whether or not to allow content editors to override asset upload
    * configuration settings when uploading a video to Mux.