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

Deployed ecdfb66 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-10-12 00:17:10 +00:00
parent 6172ffcf4e
commit ee2aeb3abd
9 changed files with 433 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files
reference/api/tracks/index.html
+262
View File
@@ -2423,6 +2423,28 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.sample_slice" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;sample_slice
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.trim" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;trim
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2512,6 +2534,39 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.sample_slice" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;sample_slice
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.sample_byte_range" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;sample_byte_range
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.can_sample" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;can_sample
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2685,6 +2740,17 @@
<nav class="md-nav" aria-label=" Tracks">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Tracks.sample_base" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;sample_base
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Tracks.exists" class="md-nav__link">
<span class="md-ellipsis">
@@ -3566,6 +3632,28 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.sample_slice" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;sample_slice
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.trim" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;trim
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3655,6 +3743,39 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.sample_slice" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;sample_slice
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.sample_byte_range" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;sample_byte_range
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Track.can_sample" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;can_sample
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3828,6 +3949,17 @@
<nav class="md-nav" aria-label=" Tracks">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Tracks.sample_base" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;sample_base
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Tracks.exists" class="md-nav__link">
<span class="md-ellipsis">
@@ -6344,6 +6476,47 @@ pycaption functions.</p>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.sample_slice" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sample_slice</span>
<a href="#unshackle.core.tracks.Subtitle.sample_slice" 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">sample_slice</span><span class="p">(</span><span class="n">starts</span><span class="p">,</span> <span class="n">timescale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">window</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Keep every segment: <code>trim</code> cuts a subtitle by its cue times after the download.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.trim" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">trim</span>
<a href="#unshackle.core.tracks.Subtitle.trim" 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">trim</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Keep the cues between <code>start</code> and <code>end</code> seconds and move them to start at zero.</p>
<p>Returns False and leaves the file whole when pysubs2 cannot read or write its format.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.strip_hearing_impaired" 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_hearing_impaired</span>
@@ -6601,6 +6774,71 @@ than one DRM system but only one of them licenses this track.</p>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Track.sample_slice" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sample_slice</span>
<a href="#unshackle.core.tracks.Track.sample_slice" 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">sample_slice</span><span class="p">(</span><span class="n">starts</span><span class="p">,</span> <span class="n">timescale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">window</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Return the slice of segments that hold <code>window</code>, from the start time of each segment.</p>
<p>Sets <code>sample_start</code> to the start time of the first kept segment, in seconds. A video keeps
<code>sample_tail</code> segments after the window: mkvmerge ends the cut only at a video keyframe, and
with no such keyframe the audio and the subtitles continue to their own end.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Track.sample_byte_range" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sample_byte_range</span>
<a href="#unshackle.core.tracks.Track.sample_byte_range" 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">sample_byte_range</span><span class="p">(</span><span class="n">session</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Find the bytes of a one-file track that hold the sample window.</p>
<p>Reads the start of the file for a <code>sidx</code> box. Returns the bytes before that box, which hold
the init data, and the byte range of the window. Returns None when the file has no such index.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Track.can_sample" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">can_sample</span>
<a href="#unshackle.core.tracks.Track.can_sample" 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">can_sample</span><span class="p">(</span><span class="n">session</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Return False when a sample cannot cut this track, because it is one file with no segment index.</p>
</div>
</div>
<div class="doc doc-object doc-function">
@@ -7183,6 +7421,30 @@ It provides convenience functions for listing, sorting, and selecting tracks.</p
<div class="doc doc-object doc-attribute">
<h3 id="unshackle.core.tracks.Tracks.sample_base" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">sample_base</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-property"><code>property</code></small>
</span>
<a href="#unshackle.core.tracks.Tracks.sample_base" 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">sample_base</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>The earliest <code>sample_start</code> of the video and audio tracks, which a sample mux uses as time zero.</p>
</div>
</div>