Skip to content

Repository navigation

recipes.md

Latest commit

 

History

History
183 lines (127 loc) · 7.3 KB

recipes.md

File metadata and controls

183 lines (127 loc) · 7.3 KB
Raw

Flow recipes

Use these examples as starting points for your own library. Build them under Flows, save the flow, and run a dry run before assigning it to automatic processing.

In the editor, Start connects to the first step. Each step has outputs that lead to another step or a result. Done accepts the converted file, Skip leaves it alone, and Veto rejects the result.

Video targets

To convert video to HEVC in an MKV container:

  1. Add Video transcode and set its target to HEVC.
  2. Connect Start to that step.
  3. Connect its plan output to a Done result and skip to Skip.
  4. Save the flow and preview it against a few files.

Leave the encoder unset to use libx265 for HEVC, libx264 for AVC, or libsvtav1 for AV1. Use quality mode to choose quality without a fixed bitrate. Try a sample to judge the quality and file size.

Import this example as JSON

Save this as a JSON file and choose Flows -> Import flow:

{
  "_type": "flow",
  "_version": 1,
  "name": "HEVC Archive",
  "definition": {
    "entry": "encode",
    "nodes": [
      {"id": "encode", "type": "plugin", "plugin": "transcode.video", "inputs": {"target": "hevc"}},
      {"id": "done", "type": "terminal", "outcome": "done"},
      {"id": "skip", "type": "terminal", "outcome": "skip"}
    ],
    "edges": [
      {"src": "encode", "port": "plan", "dst": "done"},
      {"src": "encode", "port": "skip", "dst": "skip"}
    ]
  }
}

Target a source bitrate ratio

Select bitrate mode and set a ratio. A ratio of 0.5 targets half the source bitrate, not half the file size.

The step inputs are:

{"target": "hevc", "rate_control": "bitrate", "ratio": 0.5, "bitrate_source": "video"}

Use quality mode if the source bitrate is unavailable.

Prefer a hardware encoder

To prefer Intel QSV and use software encoding on nodes without it, leave the fixed encoder unset and use this priority list:

{"target": "hevc", "encoder_priority": ["hevc_qsv", "libx265"]}

The first available encoder is used. A fixed encoder overrides this list. Failed encodes aren't retried with another encoder. See GPU access if your preferred encoder isn't available.

Route by size, codec, or language

Add a condition before the transcode step to limit which files reach it. For example, convert only AVC files larger than 2 GiB, or skip files without Japanese audio.

The condition editor lets you choose media fields and comparisons. Equivalent JSON conditions are:

Select files with Condition
Size of at least 2 GiB {"media.file.size_bytes":{"gte":2147483648}}
AVC video {"media.video.codec_family":"avc"}
Video that isn't AV1 {"media.video.codec_family":{"ne":"av1"}}
Japanese audio {"media.audio.languages":{"contains":"jpn"}}

Connect the condition's true branch to processing and its false branch to Skip. Conditions only choose a path. A Japanese-audio condition doesn't remove other audio tracks.

Remux and convert selected audio

Use Remux when you want to change containers without re-encoding video. For example, choose MKV, AAC audio at 192k, and DTS as the audio codec to convert. Other audio tracks remain copied.

These are the step inputs, not a complete flow import:

{"container": "mkv", "audio_codec": "aac", "audio_bitrate": "192k", "audio_when_codecs": ["dts"]}

Connect plan to Done and skip to Skip, as in the video example. Leave the audio-codec filter empty to convert all selected audio. Use the language and commentary options if you also want to narrow the track selection.

The transcode trash mode keeps the original when audio is re-encoded.

Reject an output that shrinks too far

Add Minimum output ratio after the conversion step, before Done. For example, a minimum size ratio of 0.4 rejects output smaller than 40% of the input:

{"metric": "size", "min_ratio": 0.4}

Connect the inspector's match output to Done, veto to Veto, and skip to Skip. This checks size, not visual quality. Rejected output doesn't replace your original.

Embed sidecar metadata

Use Embed sidecar metadata to copy metadata from Kodi NFO or yt-dlp JSON files into MKV or MP4 files.

For Example.mkv, put Example.nfo or Example.info.json beside it. Add Embed sidecar metadata before the remux or video step, and connect its next output to that step.

The step offers these settings:

Setting Default Choice
existing_tags fill_missing Fill missing tags, or use overwrite to replace supplied fields
source_priority ["nfo", "info_json"] Prefer NFO or JSON when both supply a tag
when_no_media_changes skip Use remux to update tags without re-encoding

NFO files must describe a Kodi movie or episode. JSON must describe one yt-dlp video, not a playlist or channel. Missing sidecars are allowed. If tags aren't added, check the job log and confirm that the step runs before conversion.

MP4 tag support varies by player. Try a file in your player before applying this to a library.

Job notifications

Create a target under Notifications using an Apprise URL. For example, name a target ops, then add Notify to your flow before its first conversion step. Connect its next output to the conversion.

Choose the target and the outcomes you want to receive. For success, failure, and cancellation:

{"targets": ["ops"], "on": ["job.succeeded", "job.failed", "job.cancelled"]}

Turn off Enabled to stop notifications without removing the step. Notifications can occasionally arrive more than once.

Notify external applications

Use Notify external application to tell another application when Millwright replaces a file. Supported applications are Radarr, Sonarr, Plex, Jellyfin, and Emby.

  1. Add the step to the flow's successful path.
  2. Select the application and enter its URL and API key or token.
  3. Add Path mappings if the application uses different paths for your files.
  4. Save the flow.

Use the application's base URL, such as https://example.org/sonarr, without an API endpoint. Add a separate step for each application.

Each mapping pairs a Millwright path with an Application path. For example:

Millwright path Application path
/mnt/movies /media/Movies
/mnt/series /media/TV

For Radarr and Sonarr, enable Unmonitor after refresh to stop automatic upgrades for the converted movie or episodes.

Check the job's Notification deliveries for status and errors.

Flow and job exports can contain the API key or token. Keep them private.

To receive imports from applications, use Incoming webhooks.