kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-14 13:05:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed d9d6115 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-08-24 19:29:49 +00:00
parent d0a4eaf71c
commit a107e130de
8 changed files with 145 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/creating-a-service/index.html
+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>
dev/service-architecture/index.html
+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>
objects.inv
BIN
View File
Binary file not shown.
reference/api/service/index.html
+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>
reference/api/tracks/index.html
+91
View File
@@ -2436,6 +2436,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">
@@ -3513,6 +3535,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">
@@ -6318,9 +6362,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">
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+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>
sitemap.xml.gz
BIN
View File
Binary file not shown.