Documentation

Export metadata

Review the provider metadata Cliparr can embed into exported clips.

Cliparr embeds the same source identity and clip interval in video and audio exports. Available provider fields are best-effort; local files and direct URLs still receive the editor title and mandatory timing. GIF exports do not embed rich metadata.

Standard export tags

These tags are sent for every audio and video export format when the source field is available.

Tag Source Value written
title title, then sourceTitle First non-empty value.
artist Episode showTitle Show title for episode sources, so players can group clips by series. This is a Cliparr convention, not an authorship claim.
description description, then tagline First non-empty value.
genre genres Genres joined with , .
date date, then year Parsed date. If only year exists, Cliparr writes YYYY-01-01. Invalid dates are skipped.
comment sourceTitle, title, showTitle, contentRating, clip range Clip from {source}, {start} to {end}. Adds Content rating: {rating}. when available.
images imageUrl Cover art as coverFront when the image fetch succeeds. Unsupported image formats are converted to PNG; artwork failures do not block export.

MP4, MOV, and M4A tags

MP4, MOV, and M4A exports also receive the current raw container keys below. Cliparr patches integer MP4 boxes so hdvd, stik, tves, and tvsn are stored as numeric metadata.

Raw tag Applies to Source Value written
ldes MP4, MOV, M4A description, then tagline Long description.
©dir MP4, MOV, M4A directors Directors joined with , .
hdvd MP4, MOV Output height 1 when output height is at least 720p, otherwise 0. Skipped when output height is unknown.
©TIM MP4, MOV, M4A Clip start time Cliparr timing key containing the source start time as HH:MM:SS.mmm.
csta MP4, MOV, M4A Clip start time Source start seconds with three decimals.
cend MP4, MOV, M4A Clip end time Source end seconds with three decimals.
cdur MP4, MOV, M4A Clip duration Clip duration seconds with three decimals.
clpr MP4, MOV, M4A Clip start, end, duration Version 1 JSON containing source, clip, and an optional transcript; see below.
stik MP4, MOV episodes itemType 10 for episodes.
tvsh MP4, MOV, M4A episode sources showTitle Show title.
tvsn MP4, MOV, M4A episode sources seasonNumber Non-negative integer season number.
tves MP4, MOV, M4A episode sources episodeNumber Non-negative integer episode number.
tven MP4, MOV, M4A episode sources seasonNumber, episodeNumber Episode code as S##E## when both numbers exist.
tvnn MP4, MOV, M4A episode sources network, then studio Network name, falling back to studio.
stik MP4, MOV movies itemType 9 for movies.

M4A receives descriptive and timing tags, including TV source information, but does not receive the video-specific hdvd or stik flags. An episode excerpt remains an episode in its source metadata. Its show title also occupies the artist slot by Cliparr convention; album and music track fields remain unset.

Shared provenance and timing

Source start and end are rounded to integer milliseconds once. Clip duration is the difference between those endpoints. The comment uses HH:MM:SS.mmm; individual timing tags use decimal seconds with three digits. These values describe the editor’s selected source interval, independently of encoder padding or the output file’s playback duration.

Container Individual timing fields Structured payload
MP4 / MOV / M4A csta, cend, cdur, ©TIM clpr
MP3 / WAV (ID3) TXXX descriptions listed below TXXX:CLIPARR_METADATA
Ogg / FLAC Comment keys listed below CLIPARR_METADATA
WebM / MKV SimpleTag keys listed below CLIPARR_METADATA

The named timing fields are CLIPARR_SOURCE_START_SECONDS, CLIPARR_SOURCE_END_SECONDS, CLIPARR_CLIP_DURATION_SECONDS, and CLIPARR_SOURCE_START_TIMECODE. These and the MP4 timing keys are application-defined; general players may not display them.

clpr is Cliparr’s custom metadata tag for MP4, MOV, and M4A files. It is application-defined, not a standard container metadata field. Other supported containers carry the same Cliparr-defined payload under CLIPARR_METADATA, as shown above. WAV explicitly uses an ID3 chunk so Unicode text and cover art remain supported; its provenance is stored in TXXX descriptions.

The shared payload has this shape:

{
  "version": 1,
  "source": { "itemType": "episode", "title": "Example scene" },
  "clip": {
    "sourceStartSeconds": 65.125,
    "sourceEndSeconds": 130.75,
    "durationSeconds": 65.625
  },
  "transcript": "You were the one who knocked.\nSay my name."
}

transcript is present only when the export had subtitle cues (imported subtitles or custom captions) covering the clip range. It contains text from cues that overlap the selected interval, capped at 4000 UTF-16 code units without splitting Unicode characters. Partially overlapping cues contribute their full text because cue timing does not identify individual word boundaries. The transcript is embedded even when subtitle burn-in is disabled, including audio-only exports, so dialogue can be searched with plain-text tools. GIF exports do not carry this metadata.

source also carries available source/show/season titles, season and episode numbers, date/year, descriptions, genres, studio/network, rating, and director/writer/actor credits. Artwork is embedded separately. Parsed external database IDs (externalIds.imdb, externalIds.tmdb, externalIds.tvdb) and available critic/audience scores (criticRating, audienceRating) are included. Scores use a 0-10 scale with one decimal place; missing or invalid scores are omitted. Jellyfin critic scores use a 0-100 scale and are always divided by 10. Internal provider identifiers, lookup keys, raw GUIDs, and artwork URLs are excluded.

External IDs and ratings

Container Native external ID projection
MP4 / MOV / M4A JSON payload only; Cliparr’s Mediabunny output cannot write Apple freeform ID atoms.
MKV / WebM IMDB, TMDB, TVDB SimpleTags.
MP3 TXXX:IMDB, TXXX:TMDB, TXXX:TVDB descriptions.
Ogg / FLAC IMDB, TMDB, TVDB Vorbis comments.
WAV JSON payload in the ID3 chunk only; no separate native ID projection is written.

The version 1 JSON payload is the source of truth. Native ID tags are conveniences for tag readers. Critic and audience scores stay in JSON in every format; MP4’s rtng advisory flag is never used as a numeric score. Exports remain single files, without NFO sidecars.