Compare commits

...
3 Commits
Author SHA1 Message Date
c889ec725a Deployed e804d09 with MkDocs version: 1.6.1 2026-08-24 22:38:43 +00:00
759ce1d4e8 Deployed 8c43250 with MkDocs version: 1.6.1 2026-08-24 22:22:50 +00:00
a107e130de Deployed d9d6115 with MkDocs version: 1.6.1 2026-08-24 19:29:49 +00:00
15 changed files with 418 additions and 63 deletions
+3 -3
View File
@@ -2412,12 +2412,12 @@ Click <code>cli</code> entry point plus three abstract methods.</p>
<tr>
<td><code>ALIASES</code></td>
<td><code>tuple[str, ...]</code></td>
<td>Extra tags that resolve to this service (e.g. <code>("EX", "DOMAIN")</code>). Default <code>()</code>.</td>
<td>Extra tags that resolve to this service (e.g. <code>("EX", "DOMAIN")</code>). Case does not matter. Default <code>()</code>.</td>
</tr>
<tr>
<td><code>GEOFENCE</code></td>
<td><code>tuple[str, ...]</code></td>
<td>IP region codes the service requires. Empty = no geofence. The <strong>first</strong> entry is treated as the main region for auto-proxy.</td>
<td>IP region codes the service requires. Empty = no geofence. unshackle treats the <strong>first</strong> entry as the main region for auto-proxy.</td>
</tr>
<tr>
<td><code>VAULT_TAG</code></td>
@@ -2442,7 +2442,7 @@ Click <code>cli</code> entry point plus three abstract methods.</p>
<tr>
<td><code>DAILY</code></td>
<td><code>bool</code></td>
<td>Set <code>True</code> when the catalogue is daily/date-based (talk shows, news, sports), so episodes are named by air date. A title's own <code>daily</code> flag overrides it.</td>
<td>Set <code>True</code> when the catalogue is daily/date-based (talk shows, news, sports), so unshackle names episodes by air date. A title's own <code>daily</code> flag overrides it.</td>
</tr>
</tbody>
</table>
+1 -1
View File
@@ -3641,7 +3641,7 @@ ignore it safely. See <a href="../../creating-a-service/#split-episodes">Split e
<td>Track-type restriction (at most one).</td>
</tr>
<tr>
<td><code>no_subs</code> / <code>no_audio</code> / <code>no_chapters</code> / <code>no_video</code></td>
<td><code>no_subs</code> / <code>no_audio</code> / <code>no_chapters</code> / <code>no_video</code> / <code>no_attachments</code></td>
<td>boolean</td>
<td><code>false</code></td>
<td>Skip a track type.</td>
+5 -5
View File
@@ -2651,12 +2651,12 @@ Two kinds of members matter: <strong>class variables</strong> that give the deta
<tr>
<td><code>ALIASES</code></td>
<td><code>tuple[str, ...]</code></td>
<td>Alternate tags the service answers to (resolved by <code>Services.get_tag</code>).</td>
<td>Alternate tags the service answers to, in any case (resolved by <code>Services.get_tag</code>).</td>
</tr>
<tr>
<td><code>GEOFENCE</code></td>
<td><code>tuple[str, ...]</code></td>
<td>ISO region codes the service requires; empty means no geofence. The first entry is treated as the "main region" for automatic proxy selection.</td>
<td>ISO region codes the service requires; empty means no geofence. unshackle treats the first entry as the "main region" for automatic proxy selection.</td>
</tr>
<tr>
<td><code>VAULT_TAG</code></td>
@@ -2676,7 +2676,7 @@ Two kinds of members matter: <strong>class variables</strong> that give the deta
<tr>
<td><code>DAILY</code></td>
<td><code>bool</code></td>
<td>The catalogue is daily/date-based, so episodes are named by air date. A title's own <code>daily</code> flag overrides it.</td>
<td>The catalogue is daily/date-based, so unshackle names episodes by air date. A title's own <code>daily</code> flag overrides it.</td>
</tr>
</tbody>
</table>
@@ -2799,7 +2799,7 @@ families, one per media kind:</p>
<p>All items subclass <code>Title</code>, which carries the shared identity: a <strong>unique <code>id</code></strong>, the
originating <code>service</code> class, an optional original <code>language</code>, arbitrary <code>data</code>, and a
freshly-constructed <code>self.tracks = Tracks()</code> that <code>get_tracks</code> will fill. Collections
are sorted lists, so titles stay in a stable order.</p>
use sorted lists, so titles stay in a stable order.</p>
<div class="admonition warning">
<p class="admonition-title">The unique ID is validated</p>
<p><code>Title.__init__</code> rejects a falsy <code>id_</code>, and rejects any ID shorter than 4 characters
@@ -3001,7 +3001,7 @@ in <code>unshackle.core.manifests</code>. Each parser has the same three-part co
<h3 id="the-parser-contract">The parser contract<a class="headerlink" href="#the-parser-contract" title="Permanent link">&para;</a></h3>
<ol>
<li><strong>Construct</strong>: <code>DASH.from_url(url, session=...)</code> or <code>DASH.from_text(text, url)</code>
(and likewise for <code>HLS</code> / <code>ISM</code>). A <code>url</code> is always required, even for <code>from_text</code>,
(and likewise for <code>HLS</code> / <code>ISM</code>). Always pass a <code>url</code>, even to <code>from_text</code>,
because the parser needs it to make relative segment paths absolute.</li>
<li><strong><code>to_tracks(...)</code></strong>: parses the manifest into a <code>Tracks</code> container of <code>Video</code>,
<code>Audio</code>, and <code>Subtitle</code> objects, each carrying descriptor-specific state.</li>
+9 -1
View File
@@ -3127,7 +3127,7 @@ configuration file.</p>
</tbody>
</table>
<h3 id="track-type-inclusion-exclusion">Track-type inclusion / exclusion<a class="headerlink" href="#track-type-inclusion-exclusion" title="Permanent link">&para;</a></h3>
<p>Keep only certain track types, or skip certain track types. Attachments are always kept.</p>
<p>Keep only certain track types, or skip certain track types.</p>
<table>
<thead>
<tr>
@@ -3152,6 +3152,10 @@ configuration file.</p>
<td><code>-C</code>, <code>--chapters-only</code></td>
<td><code>-nc</code>, <code>--no-chapters</code></td>
</tr>
<tr>
<td></td>
<td><code>-nt</code>, <code>--no-attachments</code> (cover art, subtitle fonts, and files the service attaches)</td>
</tr>
</tbody>
</table>
<table>
@@ -3291,6 +3295,10 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
<td>Use only the CDM, or only Key Vaults, for key acquisition.</td>
</tr>
<tr>
<td><code>--cdm &lt;name&gt;</code></td>
<td>Use the named CDM device from the <code>cdm</code> config mapping for this run, ignoring the service/default mapping.</td>
</tr>
<tr>
<td><code>--skip-dl</code></td>
<td>Skip the download but still retrieve keys.</td>
</tr>
+9 -2
View File
@@ -3748,6 +3748,7 @@ or negatively (everything but these).</p>
<li><code>-na</code> / <code>--no-audio</code></li>
<li><code>-ns</code> / <code>--no-subs</code></li>
<li><code>-nc</code> / <code>--no-chapters</code></li>
<li><code>-nt</code> / <code>--no-attachments</code> (cover art, subtitle fonts, and files the service attaches)</li>
</ul>
<p>Additional track-type flags:</p>
<ul>
@@ -3920,6 +3921,7 @@ configured proxy providers), or a <code>provider:region</code> form.</p>
a content key when the vault misses. You can force one side or the other:</p>
<ul>
<li><code>--cdm-only</code>: only use the CDM (skip vaults).</li>
<li><code>--cdm &lt;name&gt;</code>: use the named CDM device for this run, ignoring the <code>cdm</code> config mapping (including its quality and Widevine/PlayReady sub-entries).</li>
<li><code>--vaults-only</code>: only use key vaults and never license through the CDM. A missing
content key fails.</li>
</ul>
@@ -4237,8 +4239,8 @@ authoritative list.</p>
<td>Restrict track types.</td>
</tr>
<tr>
<td><code>--no-video</code> / <code>--no-audio</code> / <code>--no-subs</code> / <code>--no-chapters</code></td>
<td><code>-nv</code> / <code>-na</code> / <code>-ns</code> / <code>-nc</code></td>
<td><code>--no-video</code> / <code>--no-audio</code> / <code>--no-subs</code> / <code>--no-chapters</code> / <code>--no-attachments</code></td>
<td><code>-nv</code> / <code>-na</code> / <code>-ns</code> / <code>-nc</code> / <code>-nt</code></td>
<td>Skip track types.</td>
</tr>
<tr>
@@ -4297,6 +4299,11 @@ authoritative list.</p>
<td>Content key source control.</td>
</tr>
<tr>
<td><code>--cdm &lt;name&gt;</code></td>
<td></td>
<td>Pin one CDM device, bypassing the <code>cdm</code> config mapping.</td>
</tr>
<tr>
<td><code>--export</code></td>
<td></td>
<td>Export track info and keys to JSON.</td>
+4
View File
@@ -2996,6 +2996,10 @@ control this trade-off on the <code>dl</code> command:</p>
<td><code>--cdm-only</code></td>
<td>Ignore vaults for sourcing keys and always perform a fresh license request.</td>
</tr>
<tr>
<td><code>--cdm &lt;name&gt;</code></td>
<td>Use the named CDM device for this run instead of the one the <code>cdm</code> config maps for the service.</td>
</tr>
</tbody>
</table>
<p>See <a href="../vaults/">key vaults</a> for how to configure vault backends.</p>
+187
View File
@@ -1048,6 +1048,17 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cue-markup-and-html-entities" class="md-nav__link">
<span class="md-ellipsis">
Cue markup and HTML entities
</span>
</a>
</li>
</ul>
@@ -1086,6 +1097,23 @@
</span>
</a>
<nav class="md-nav" aria-label="Subtitle configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#which-settings-to-change" class="md-nav__link">
<span class="md-ellipsis">
Which settings to change
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2281,6 +2309,17 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cue-markup-and-html-entities" class="md-nav__link">
<span class="md-ellipsis">
Cue markup and HTML entities
</span>
</a>
</li>
</ul>
@@ -2319,6 +2358,23 @@
</span>
</a>
<nav class="md-nav" aria-label="Subtitle configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#which-settings-to-change" class="md-nav__link">
<span class="md-ellipsis">
Which settings to change
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2468,6 +2524,9 @@ format-appropriate clean-up to make a single, valid file:</p>
that confuse downstream parsers, and merges multi-line cues that a service split into
separate overlapping cues. By default unshackle keeps the original styling and layout
(see <a href="#subtitle-configuration"><code>preserve_formatting</code></a>).</li>
<li><strong>Cue markup normalisation</strong>: unshackle removes the WebVTT-only parts of a cue
payload, so no player draws them as dialogue. See
<a href="#cue-markup-and-html-entities">Cue markup</a>.</li>
<li><strong>TTML for muxing</strong>: Matroska cannot carry TTML. If you do not request a specific
output format, unshackle automatically converts any plain TTML track to WebVTT before
muxing (the closest lossless equivalent). Boxed <code>fTTML</code> is likewise unwrapped to TTML
@@ -2605,6 +2664,42 @@ you end up with both.</p>
itself. The default (<code>auto</code>) prefers the <code>subby</code> cleaner for SRT, falls back to
SubtitleEdit when you install it, and otherwise uses the built-in <code>filter-subs</code>
approach.</p>
<p>Every engine removes the same three things: bracketed sound effects (<code>[MUSIC PLAYING]</code>,
<code>(door creaks)</code>), speaker labels (<code>MAN:</code>), and font tags. Every engine keeps plain
dialogue and inline <code>&lt;i&gt;</code> styling. They differ on music and lyric lines:</p>
<table>
<thead>
<tr>
<th><code>sdh_method</code></th>
<th>Engine that runs</th>
<th>Lyric lines (<code>♪ ... ♪</code>)</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>auto</code></td>
<td><code>subby</code> for an SRT track. SubtitleEdit for any other format when you install it, otherwise <code>filter-subs</code>.</td>
<td>Kept, unless the fallback reaches <code>filter-subs</code>.</td>
</tr>
<tr>
<td><code>subby</code></td>
<td><code>subby</code>, but only for a track that is already SRT. Any other format falls through to <code>filter-subs</code>.</td>
<td>Kept for SRT, removed otherwise.</td>
</tr>
<tr>
<td><code>subtitleedit</code></td>
<td>SubtitleEdit when you install it, otherwise <code>filter-subs</code>.</td>
<td>Kept with SubtitleEdit, removed without it.</td>
</tr>
<tr>
<td><code>filter-subs</code></td>
<td><code>filter-subs</code> always.</td>
<td>Removed.</td>
</tr>
</tbody>
</table>
<p>Pick <code>filter-subs</code> when you want lyrics gone as well. Pick <code>subby</code> or install
SubtitleEdit when you want to read along with the songs.</p>
<div class="admonition note">
<p class="admonition-title">Why <code>convert_before_strip</code> exists</p>
<p><code>subby</code>'s SDH stripper only operates on SRT. Handed any other codec it returns
@@ -2764,6 +2859,49 @@ do not ship SubtitleEdit, so in practice <code>auto</code> means <code>subby</co
Install <a href="#subtitle-configuration">SubtitleEdit / <code>seconv</code></a> if you need colour or the
highest → SRT fidelity.</p>
</div>
<h3 id="cue-markup-and-html-entities">Cue markup and HTML entities<a class="headerlink" href="#cue-markup-and-html-entities" title="Permanent link">&para;</a></h3>
<p>Styling is not the only thing a conversion has to handle. WebVTT carries markup that no
other format understands, and a player that does not know a tag draws it as dialogue.
unshackle removes that markup before any backend runs, so the result is the same for
every <code>conversion_method</code>:</p>
<table>
<thead>
<tr>
<th>WebVTT markup</th>
<th>Result</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>&lt;c.bg_transparent&gt;text&lt;/c&gt;</code></td>
<td>Tags removed, text kept. A class only selects a CSS <code>::cue</code> rule that no player ever receives, so it carries no styling.</td>
</tr>
<tr>
<td><code>&lt;i.loud&gt;</code>, <code>&lt;b.x&gt;</code>, <code>&lt;u.y&gt;</code></td>
<td>Class list removed, the styling tag kept.</td>
</tr>
<tr>
<td><code>&lt;v Bob&gt;</code>, <code>&lt;lang ja&gt;</code>, <code>&lt;ruby&gt;</code>, <code>&lt;rt&gt;</code></td>
<td>Tags removed, text kept.</td>
</tr>
<tr>
<td><code>&lt;00:00:02.000&gt;</code></td>
<td>Removed. These are karaoke timings that no subtitle player renders.</td>
</tr>
<tr>
<td><code>&amp;amp;</code>, <code>&amp;nbsp;</code>, <code>&amp;#39;</code></td>
<td>Decoded to real characters for SRT, SSA, and ASS output. Kept escaped for WebVTT and TTML, which need them.</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="admonition-title">A class list breaks more than you expect</p>
<p>FFmpeg reads SubRip markup as a tag only while the tag name stays inside
<code>[0-9a-zA-Z_/]</code>. The dot in <code>&lt;i.loud&gt;</code> fails that test, so FFmpeg prints the opening
tag on screen and then closes an italic run that never opened. The FFmpeg WebVTT
reader matches <code>i</code>, <code>b</code>, and <code>u</code> exactly, so there the same class silently loses the
styling. mpv, VLC, Plex, and Jellyfin all use one of those two readers.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Config wins over a service's preference</p>
<p>A service may set a <code>preferred_conversion_method</code> on its own tracks (for example when
@@ -2895,6 +3033,55 @@ relevant font packages.</p>
</tr>
</tbody>
</table>
<h3 id="which-settings-to-change">Which settings to change<a class="headerlink" href="#which-settings-to-change" title="Permanent link">&para;</a></h3>
<p>The defaults give a clean, player-safe file, so most people change nothing. Start here
only when you want something the defaults do not do:</p>
<table>
<thead>
<tr>
<th>If you want</th>
<th>Set</th>
</tr>
</thead>
<tbody>
<tr>
<td>Every original style kept, with no re-encode at all</td>
<td><code>--sub-format original</code>, and <code>sidecar_format: original</code> for sidecars</td>
</tr>
<tr>
<td>The highest conversion fidelity, including colour</td>
<td>Install SubtitleEdit. <code>conversion_method</code> stays <code>auto</code></td>
</tr>
<tr>
<td>Music and lyric lines stripped along with the sound effects</td>
<td><code>sdh_method: filter-subs</code></td>
</tr>
<tr>
<td>Lyric lines kept</td>
<td><code>sdh_method: subby</code>, or install SubtitleEdit</td>
</tr>
<tr>
<td>No stripped copies made at all</td>
<td><code>strip_sdh: false</code></td>
</tr>
<tr>
<td>One backend for every conversion, whatever you install</td>
<td><code>conversion_method: &lt;backend&gt;</code></td>
</tr>
</tbody>
</table>
<p>Two keys read as if they control markup, and do not:</p>
<ul>
<li><strong><code>preserve_formatting</code></strong> decides whether unshackle re-encodes a WebVTT file after
the repair pipeline. Left <code>true</code>, the cue text passes through as written. Set to
<code>false</code>, unshackle re-encodes the file through pycaption, which merges identical cues
and drops empty ones but also flattens styling. Neither setting leaves WebVTT-only
markup in the file: <a href="#cue-markup-and-html-entities">cue markup normalisation</a> runs
either way.</li>
<li><strong><code>convert_before_strip</code></strong> applies to SDH stripping, not to your output format. It
converts the working copy to SRT so a non-SubtitleEdit engine can read it. Turning it
off makes <code>subby</code> and <code>filter-subs</code> no-ops on anything that is not already SRT.</li>
</ul>
<div class="admonition tip">
<p class="admonition-title">SubtitleEdit is optional but recommended</p>
<p>Several high-fidelity paths (the best-quality conversions and the SubtitleEdit SDH
BIN
View File
Binary file not shown.
+8 -8
View File
@@ -3642,8 +3642,8 @@ Ideally re-use the title ID argument (that is, self.title).</p>
<p>This License message contains the encrypted content keys and will be
read by the Cdm and decrypted.</p>
<p>This is a very important request to get correct. A bad, unexpected, or missing
value in the request can cause the service to detect your CDM device. The device
can then be banned, revoked, disabled, or downgraded.</p>
value in the request can cause the service to detect your CDM device.
The service can then ban, revoke, disable, or downgrade that device.</p>
<p>:param challenge: The license challenge from the Widevine CDM.
:param title: The current <code>Title</code> from get_titles that unshackle processes now. unshackle
gives this in case it holds data you need, for example for an HTTP request.
@@ -3679,8 +3679,8 @@ can then be banned, revoked, disabled, or downgraded.</p>
</span><span id="__span-0-489"><a id="__codelineno-0-489" name="__codelineno-0-489"></a><span class="sd"> read by the Cdm and decrypted.</span>
</span><span id="__span-0-490"><a id="__codelineno-0-490" name="__codelineno-0-490"></a>
</span><span id="__span-0-491"><a id="__codelineno-0-491" name="__codelineno-0-491"></a><span class="sd"> This is a very important request to get correct. A bad, unexpected, or missing</span>
</span><span id="__span-0-492"><a id="__codelineno-0-492" name="__codelineno-0-492"></a><span class="sd"> value in the request can cause the service to detect your CDM device. The device</span>
</span><span id="__span-0-493"><a id="__codelineno-0-493" name="__codelineno-0-493"></a><span class="sd"> can then be banned, revoked, disabled, or downgraded.</span>
</span><span id="__span-0-492"><a id="__codelineno-0-492" name="__codelineno-0-492"></a><span class="sd"> value in the request can cause the service to detect your CDM device.</span>
</span><span id="__span-0-493"><a id="__codelineno-0-493" name="__codelineno-0-493"></a><span class="sd"> The service can then ban, revoke, disable, or downgrade that device.</span>
</span><span id="__span-0-494"><a id="__codelineno-0-494" name="__codelineno-0-494"></a>
</span><span id="__span-0-495"><a id="__codelineno-0-495" name="__codelineno-0-495"></a><span class="sd"> :param challenge: The license challenge from the Widevine CDM.</span>
</span><span id="__span-0-496"><a id="__codelineno-0-496" name="__codelineno-0-496"></a><span class="sd"> :param title: The current `Title` from get_titles that unshackle processes now. unshackle</span>
@@ -3712,8 +3712,8 @@ can then be banned, revoked, disabled, or downgraded.</p>
<p>This License message contains the encrypted content keys and will be
read by the CDM and decrypted.</p>
<p>This is a very important request to get correct. A bad, unexpected, or missing
value in the request can cause the service to detect your CDM device. The device
can then be banned, revoked, disabled, or downgraded.</p>
value in the request can cause the service to detect your CDM device.
The service can then ban, revoke, disable, or downgrade that device.</p>
<p>:param challenge: The license challenge from the PlayReady CDM.
:param title: The current <code>Title</code> from get_titles that unshackle processes now. unshackle
gives this in case it holds data you need, for example for an HTTP request.
@@ -3755,8 +3755,8 @@ can then be banned, revoked, disabled, or downgraded.</p>
</span><span id="__span-0-510"><a id="__codelineno-0-510" name="__codelineno-0-510"></a><span class="sd"> read by the CDM and decrypted.</span>
</span><span id="__span-0-511"><a id="__codelineno-0-511" name="__codelineno-0-511"></a>
</span><span id="__span-0-512"><a id="__codelineno-0-512" name="__codelineno-0-512"></a><span class="sd"> This is a very important request to get correct. A bad, unexpected, or missing</span>
</span><span id="__span-0-513"><a id="__codelineno-0-513" name="__codelineno-0-513"></a><span class="sd"> value in the request can cause the service to detect your CDM device. The device</span>
</span><span id="__span-0-514"><a id="__codelineno-0-514" name="__codelineno-0-514"></a><span class="sd"> can then be banned, revoked, disabled, or downgraded.</span>
</span><span id="__span-0-513"><a id="__codelineno-0-513" name="__codelineno-0-513"></a><span class="sd"> value in the request can cause the service to detect your CDM device.</span>
</span><span id="__span-0-514"><a id="__codelineno-0-514" name="__codelineno-0-514"></a><span class="sd"> The service can then ban, revoke, disable, or downgrade that device.</span>
</span><span id="__span-0-515"><a id="__codelineno-0-515" name="__codelineno-0-515"></a>
</span><span id="__span-0-516"><a id="__codelineno-0-516" name="__codelineno-0-516"></a><span class="sd"> :param challenge: The license challenge from the PlayReady CDM.</span>
</span><span id="__span-0-517"><a id="__codelineno-0-517" name="__codelineno-0-517"></a><span class="sd"> :param title: The current `Title` from get_titles that unshackle processes now. unshackle</span>
+148
View File
@@ -2193,6 +2193,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.strip_webvtt_cue_classes" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;strip_webvtt_cue_classes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2436,6 +2447,28 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.drm_preference" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;drm_preference
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.prefers_playready" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;prefers_playready
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3270,6 +3303,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.strip_webvtt_cue_classes" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;strip_webvtt_cue_classes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3513,6 +3557,28 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.drm_preference" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;drm_preference
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.prefers_playready" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;prefers_playready
</span>
</a>
</li>
<li class="md-nav__item">
@@ -5320,6 +5386,41 @@ explanation list above.</p>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.strip_webvtt_cue_classes" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">strip_webvtt_cue_classes</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
</span>
<a href="#unshackle.core.tracks.Subtitle.strip_webvtt_cue_classes" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">strip_webvtt_cue_classes</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Reduce a cue payload to the markup every target format shares: <code>&lt;i&gt;</code>, <code>&lt;b&gt;</code>
and <code>&lt;u&gt;</code> without their class list. It removes class spans (<code>&lt;c.foo&gt;</code>),
<code>&lt;v&gt;</code>, <code>&lt;lang&gt;</code>, <code>&lt;ruby&gt;</code>/<code>&lt;rt&gt;</code> and karaoke timestamps
(<code>&lt;00:00:01.000&gt;</code>).</p>
<p>A class only selects a CSS <code>::cue</code> rule that no player receives, so it never
carries styling, but it does break rendering. FFmpeg's SubRip reader treats a tag
name as a tag only while it matches <code>[0-9a-zA-Z_/]</code>. The dot fails that test, so
FFmpeg prints <code>&lt;i.loud&gt;</code> as cue text and then emits the closing italic-off with
nothing opened. FFmpeg's WebVTT reader matches <code>i</code>/<code>b</code>/<code>u</code> exactly and drops
the rest, so there a class silently loses the styling instead. The tags this
method removes outright are the ones both readers already discard, and that
libass would draw as text if a conversion carried them into ASS.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.strip_webvtt_timestamp_map" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">strip_webvtt_timestamp_map</span>
@@ -6318,9 +6419,56 @@ at any point.</p>
</div>
<div class="doc doc-object doc-attribute">
<h3 id="unshackle.core.tracks.Track.drm_preference" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">drm_preference</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-property"><code>property</code></small>
<small class="doc doc-label doc-label-writable"><code>writable</code></small>
</span>
<a href="#unshackle.core.tracks.Track.drm_preference" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">drm_preference</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>DRM system this track must license with, one of the names in DRM_PREFERENCE_TYPES.</p>
<p>None (the default) lets the loaded CDM choose. Set it when the manifest advertises more
than one DRM system but only one of them licenses this track.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Track.prefers_playready" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">prefers_playready</span>
<a href="#unshackle.core.tracks.Track.prefers_playready" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">prefers_playready</span><span class="p">(</span><span class="n">cdm</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Whether to try PlayReady before Widevine. The track's preference wins over the loaded CDM.</p>
</div>
</div>
<div class="doc doc-object doc-function">
+3 -3
View File
@@ -2241,10 +2241,10 @@ default. In other words, config only fills in options you did not set on the com
<td>Forced subtitle language(s); implies <code>forced_subs</code>. A <code>-</code> prefix excludes.</td>
</tr>
<tr>
<td><code>no_subs</code> / <code>no_audio</code> / <code>no_chapters</code></td>
<td><code>no_subs</code> / <code>no_audio</code> / <code>no_chapters</code> / <code>no_attachments</code></td>
<td>bool</td>
<td><code>false</code></td>
<td>Skip that track type.</td>
<td>Skip that track type. <code>no_attachments</code> also skips attaching subtitle fonts.</td>
</tr>
<tr>
<td><code>downloads</code></td>
@@ -2385,7 +2385,7 @@ in or writes them as sidecar files. See <a href="../../../guide/subtitles/">Subt
<td><code>preserve_formatting</code></td>
<td>bool</td>
<td><code>true</code></td>
<td>Keep styling/positioning when converting or stripping.</td>
<td>Pass WebVTT cue text through as written. <code>false</code> re-encodes it through pycaption, which merges identical cues but flattens styling. unshackle removes WebVTT-only cue markup either way.</td>
</tr>
<tr>
<td><code>convert_before_strip</code></td>
+3 -2
View File
@@ -2083,8 +2083,9 @@ the <a href="../../../guide/drm-and-cdm/">DRM &amp; CDM guide</a>. Device files
<li><strong>Type:</strong> <code>dict</code> &nbsp;·&nbsp; <strong>Default:</strong> <code>{}</code></li>
</ul>
<p>Maps a service tag to the CDM (Widevine/PlayReady device) to use, with a <code>default</code> fallback.
Resolution is case-insensitive: a per-request API override wins, then the per-service entry,
then <code>default</code>.</p>
Resolution is case-insensitive: an override (<code>dl --cdm &lt;name&gt;</code>, or the <code>cdm</code> field of an API
job) wins, then the per-service entry, then <code>default</code>. An override pins one device for the whole
run and skips any quality or Widevine/PlayReady sub-entries.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">cdm</span><span class="p">:</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chromecdm_l3</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">EXAMPLE2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">android_l1</span>
File diff suppressed because one or more lines are too long
+37 -37
View File
@@ -2,150 +2,150 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-08-23</lastmod>
<lastmod>2026-08-24</lastmod>
</url>
</urlset>
BIN
View File
Binary file not shown.