mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-12 12:05:07 +00:00
7148 lines
214 KiB
HTML
7148 lines
214 KiB
HTML
|
||
<!doctype html>
|
||
<html lang="en" class="no-js">
|
||
<head>
|
||
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
||
<meta name="description" content="Movie, TV, and Music archival software — user guide and REST API reference">
|
||
|
||
|
||
|
||
<link rel="canonical" href="https://docs.unshackle.dev/reference/api/tracks/">
|
||
|
||
|
||
<link rel="prev" href="../config/">
|
||
|
||
|
||
<link rel="next" href="../titles/">
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="icon" href="../../../assets/favicon.svg">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
|
||
|
||
|
||
|
||
<title>Tracks - unshackle</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../../assets/stylesheets/main.484c7ddc.min.css">
|
||
|
||
|
||
<link rel="stylesheet" href="../../../assets/stylesheets/palette.ab4e12ef.min.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
||
|
||
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo">
|
||
|
||
|
||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||
<label class="md-overlay" for="__drawer"></label>
|
||
<div data-md-component="skip">
|
||
|
||
|
||
<a href="#tracks-api" class="md-skip">
|
||
Skip to content
|
||
</a>
|
||
|
||
</div>
|
||
<div data-md-component="announce">
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<header class="md-header" data-md-component="header">
|
||
<nav class="md-header__inner md-grid" aria-label="Header">
|
||
<a href="../../.." title="unshackle" class="md-header__button md-logo" aria-label="unshackle" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24"><path d="m800-274-80-80v-206H514l-80-80h166v-80q0-50-34.5-85T481-840q-50 0-84 34.5T363-720v9l-73-73q22-61 75-98.5T481-920q83 0 141 58.5T680-720v80h40q33 0 56.5 23.5T800-560v286Zm20 246-62-62q-11 5-20 7.5T720-80H240q-33 0-56.5-23.5T160-160v-400q0-25 14.5-46t37.5-30L28-820l56-56L876-84l-56 56ZM686-160 539-309q-11 11-25.5 17t-31.5 6q-33 0-56.5-23.5T402-366q0-17 6-31.5t17-25.5L286-560h-46v400h446ZM486-360Zm131-97Z"/></svg>
|
||
|
||
</a>
|
||
<label class="md-header__button md-icon" for="__drawer">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||
</label>
|
||
<div class="md-header__title" data-md-component="header-title">
|
||
<div class="md-header__ellipsis">
|
||
<div class="md-header__topic">
|
||
<span class="md-ellipsis">
|
||
unshackle
|
||
</span>
|
||
</div>
|
||
<div class="md-header__topic" data-md-component="header-topic">
|
||
<span class="md-ellipsis">
|
||
|
||
Tracks
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<form class="md-header__option" data-md-component="palette">
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5M7 15a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg>
|
||
</label>
|
||
|
||
|
||
</form>
|
||
|
||
|
||
|
||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-header__button md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
</label>
|
||
<div class="md-search" data-md-component="search" role="dialog">
|
||
<label class="md-search__overlay" for="__search"></label>
|
||
<div class="md-search__inner" role="search">
|
||
<form class="md-search__form" name="search">
|
||
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||
<label class="md-search__icon md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</label>
|
||
<nav class="md-search__options" aria-label="Search">
|
||
|
||
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
||
</a>
|
||
|
||
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||
</button>
|
||
</nav>
|
||
|
||
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
||
|
||
</form>
|
||
<div class="md-search__output">
|
||
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||
<div class="md-search-result" data-md-component="search-result">
|
||
<div class="md-search-result__meta">
|
||
Initializing search
|
||
</div>
|
||
<ol class="md-search-result__list" role="presentation"></ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-header__source">
|
||
<a href="https://github.com/unshackle-dl/unshackle" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
unshackle-dl/unshackle
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
</header>
|
||
|
||
<div class="md-container" data-md-component="container">
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
||
<div class="md-grid">
|
||
<ul class="md-tabs__list">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../.." class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Home
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../../getting-started/installation/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Getting Started
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../../guide/downloading/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
User Guide
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../configuration/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Configuration
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../../dev/creating-a-service/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Developer
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item md-tabs__item--active">
|
||
<a href="../service/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
API Reference
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
|
||
<main class="md-main" data-md-component="main">
|
||
<div class="md-main__inner md-grid">
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
||
<label class="md-nav__title" for="__drawer">
|
||
<a href="../../.." title="unshackle" class="md-nav__button md-logo" aria-label="unshackle" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24"><path d="m800-274-80-80v-206H514l-80-80h166v-80q0-50-34.5-85T481-840q-50 0-84 34.5T363-720v9l-73-73q22-61 75-98.5T481-920q83 0 141 58.5T680-720v80h40q33 0 56.5 23.5T800-560v286Zm20 246-62-62q-11 5-20 7.5T720-80H240q-33 0-56.5-23.5T160-160v-400q0-25 14.5-46t37.5-30L28-820l56-56L876-84l-56 56ZM686-160 539-309q-11 11-25.5 17t-31.5 6q-33 0-56.5-23.5T402-366q0-17 6-31.5t17-25.5L286-560h-46v400h446ZM486-360Zm131-97Z"/></svg>
|
||
|
||
</a>
|
||
unshackle
|
||
</label>
|
||
|
||
<div class="md-nav__source">
|
||
<a href="https://github.com/unshackle-dl/unshackle" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
unshackle-dl/unshackle
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../.." class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Home
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Getting Started
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Getting Started
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../getting-started/installation/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Installation
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../getting-started/quickstart/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Quick Start
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../getting-started/configuration-file/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
The Configuration File
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
User Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
User Guide
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/downloading/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Downloading
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/cli-reference/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
CLI Reference
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/drm-and-cdm/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
DRM & CDM Setup
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/proxies-and-vpn/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Proxies & VPN
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/vaults/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Key Vaults
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/output-and-naming/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Output & Naming
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/subtitles/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Subtitles
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../guide/troubleshooting/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Troubleshooting
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Configuration
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Configuration
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../configuration/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Reference
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Developer
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_5">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Developer
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/creating-a-service/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Creating a Service
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/service-architecture/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Service Architecture
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../../dev/rest-api/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
REST API
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_5_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
REST API
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/rest-api/quickstart/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Quick Start
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/rest-api/authentication/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Authentication
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/rest-api/endpoints/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Endpoints
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/rest-api/job-lifecycle/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Job Lifecycle
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/rest-api/remote-sessions/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Remote Sessions
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../../dev/rest-api/errors/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Error Responses
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
API Reference
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
|
||
<label class="md-nav__title" for="__nav_6">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
API Reference
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../service/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Service
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../config/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Config
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active">
|
||
|
||
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Tracks
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Tracks
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> tracks
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Attachment
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Attachment">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment.id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment.to_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> to_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment.from_url" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> from_url
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Audio
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Audio">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio.atmos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> atmos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio.parse_channels" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> parse_channels
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio.get_track_name" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_track_name
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Chapter
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Chapter">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapter.id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapter.named" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> named
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Chapters
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Chapters">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.loads" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> loads
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.load" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> load
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.dumps" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> dumps
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.dump" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> dump
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Hybrid
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Hybrid">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.log" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> log
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.level_5" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> level_5
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.sanitize_l6" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_l6
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.level_6" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> level_6
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.extract_hdr10plus" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> extract_hdr10plus
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.convert_hdr10plus_to_dv" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert_hdr10plus_to_dv
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Subtitle
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Subtitle">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.get_track_name" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_track_name
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_webvtt_timestamps" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_webvtt_timestamps
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.has_webvtt_cue_identifiers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> has_webvtt_cue_identifiers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_webvtt_cue_identifiers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_webvtt_cue_identifiers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.has_overlapping_webvtt_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> has_overlapping_webvtt_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.merge_overlapping_webvtt_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_overlapping_webvtt_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_webvtt" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_webvtt
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.convert" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.extract_fonts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> extract_fonts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_broken_webvtt" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_broken_webvtt
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.space_webvtt_headers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> space_webvtt_headers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.merge_same_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_same_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.filter_unwanted_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> filter_unwanted_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.merge_segmented_wvtt" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_segmented_wvtt
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.strip_hearing_impaired" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> strip_hearing_impaired
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.reverse_rtl" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> reverse_rtl
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.DownloadContext" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> DownloadContext
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" DownloadContext">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.DownloadContext.ensure_session" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> ensure_session
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Track
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Track">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> data
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.download" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> download
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.move" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> move
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.to_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> to_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.base_kwargs_from_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> base_kwargs_from_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.from_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> from_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_track_name" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_track_name
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_drm_for_cdm" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_drm_for_cdm
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_key_id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_key_id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.load_drm_if_needed" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> load_drm_if_needed
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.load_drm_from_playlist" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> load_drm_from_playlist
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_init_segment" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_init_segment
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Tracks
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Tracks">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.exists" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> exists
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.add" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> add
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.sort_videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sort_videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.sort_audio" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sort_audio
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.sort_subtitles" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sort_subtitles
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.filter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> filter
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.merge_video_selections" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_video_selections
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.partition_hybrid_videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> partition_hybrid_videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.flag_hybrid_ingredients" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> flag_hybrid_ingredients
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.mux" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> mux
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Video
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Video">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.Range" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Range
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Range">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.Range.from_cicp" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> from_cicp
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.change_color_range" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> change_color_range
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.normalize_vui" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> normalize_vui
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.ccextractor" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> ccextractor
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.extract_c608" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> extract_c608
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.remove_eia_cc" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> remove_eia_cc
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../titles/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Titles
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../drm/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
DRM
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> tracks
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Attachment
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Attachment">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment.id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment.to_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> to_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Attachment.from_url" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> from_url
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Audio
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Audio">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio.atmos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> atmos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio.parse_channels" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> parse_channels
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Audio.get_track_name" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_track_name
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Chapter
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Chapter">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapter.id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapter.named" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> named
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Chapters
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Chapters">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.loads" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> loads
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.load" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> load
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.dumps" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> dumps
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Chapters.dump" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> dump
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Hybrid
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Hybrid">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.log" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> log
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.level_5" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> level_5
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.sanitize_l6" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_l6
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.level_6" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> level_6
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.extract_hdr10plus" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> extract_hdr10plus
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Hybrid.convert_hdr10plus_to_dv" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert_hdr10plus_to_dv
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Subtitle
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Subtitle">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.get_track_name" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_track_name
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_webvtt_timestamps" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_webvtt_timestamps
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.has_webvtt_cue_identifiers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> has_webvtt_cue_identifiers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_webvtt_cue_identifiers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_webvtt_cue_identifiers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.has_overlapping_webvtt_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> has_overlapping_webvtt_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.merge_overlapping_webvtt_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_overlapping_webvtt_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_webvtt" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_webvtt
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.convert" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.extract_fonts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> extract_fonts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.sanitize_broken_webvtt" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sanitize_broken_webvtt
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.space_webvtt_headers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> space_webvtt_headers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.merge_same_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_same_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.filter_unwanted_cues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> filter_unwanted_cues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.merge_segmented_wvtt" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_segmented_wvtt
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.strip_hearing_impaired" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> strip_hearing_impaired
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Subtitle.reverse_rtl" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> reverse_rtl
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.DownloadContext" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> DownloadContext
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" DownloadContext">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.DownloadContext.ensure_session" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> ensure_session
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Track
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Track">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> data
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.download" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> download
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.move" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> move
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.to_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> to_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.base_kwargs_from_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> base_kwargs_from_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.from_dict" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> from_dict
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_track_name" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_track_name
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_drm_for_cdm" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_drm_for_cdm
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_key_id" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_key_id
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.load_drm_if_needed" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> load_drm_if_needed
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.load_drm_from_playlist" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> load_drm_from_playlist
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Track.get_init_segment" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_init_segment
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Tracks
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Tracks">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.exists" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> exists
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.add" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> add
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.sort_videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sort_videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.sort_audio" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sort_audio
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.sort_subtitles" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> sort_subtitles
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.filter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> filter
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.merge_video_selections" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> merge_video_selections
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.partition_hybrid_videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> partition_hybrid_videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.flag_hybrid_ingredients" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> flag_hybrid_ingredients
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Tracks.mux" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> mux
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Video
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Video">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.Range" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> Range
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" Range">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.Range.from_cicp" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> from_cicp
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.change_color_range" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> change_color_range
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.normalize_vui" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> normalize_vui
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.ccextractor" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> ccextractor
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.extract_c608" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> extract_c608
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#unshackle.core.tracks.Video.remove_eia_cc" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> remove_eia_cc
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h1 id="tracks-api">Tracks API<a class="headerlink" href="#tracks-api" title="Permanent link">¶</a></h1>
|
||
<p>Auto-generated reference for the track model: <a class="autorefs autorefs-internal" title="<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Tracks</span>" href="#unshackle.core.tracks.Tracks"><code>Tracks</code></a>,
|
||
<a class="autorefs autorefs-internal" title="<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Track</span>" href="#unshackle.core.tracks.Track"><code>Track</code></a>, and the media-specific subclasses. See
|
||
<a href="../../../dev/service-architecture/">Service Architecture</a> for how these fit together.</p>
|
||
|
||
|
||
<div class="doc doc-object doc-module">
|
||
|
||
|
||
|
||
<a id="unshackle.core.tracks"></a>
|
||
<div class="doc doc-contents first">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Attachment" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Attachment</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Attachment" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Attachment</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="n">path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">mime_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
<p>Create a new Attachment.</p>
|
||
<p>If providing a path, the file must already exist.
|
||
If providing a URL, the file will be downloaded to the temp directory.
|
||
Either path or url must be provided.</p>
|
||
<p>If name is not provided it will use the file name (without extension).
|
||
If mime_type is not provided, it will try to guess it.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>path</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Union">Union</span>[<span title="pathlib.Path">Path</span>, <span title="str">str</span>, None]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Path to an existing file.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>url</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>URL to download the attachment from.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>name</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Name of the attachment.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>mime_type</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>MIME type of the attachment.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>description</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Description of the attachment.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>session</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="requests.Session">Session</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Optional requests session to use for downloading.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Attachment.id" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">id</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Attachment.id" class="headerlink" title="Permanent link">¶</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="nb">id</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Compute an ID from the attachment data.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Attachment.to_dict" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">to_dict</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Attachment.to_dict" class="headerlink" title="Permanent link">¶</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">to_dict</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Serialise a URL-backed attachment for export/import.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Attachment.from_url" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">from_url</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Attachment.from_url" class="headerlink" title="Permanent link">¶</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">from_url</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="n">url</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">mime_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Create an attachment from a URL.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>url</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>URL to download the attachment from.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>name</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Name of the attachment.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>mime_type</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>MIME type of the attachment.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>description</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Description of the attachment.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>session</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="requests.Session">Session</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Optional requests session to use for downloading.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th> <th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td><code>Attachment</code></td> <td>
|
||
<code>'Attachment'</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A new attachment instance.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Audio" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Audio</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Audio" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Audio</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="o">*</span><span class="n">args</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">codec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">bitrate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">channels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">joc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">descriptive</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title="<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Track</span> (<code>unshackle.core.tracks.track.Track</code>)" href="#unshackle.core.tracks.Track">Track</a></code></p>
|
||
|
||
|
||
|
||
<p>Create a new Audio track object.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>codec</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="unshackle.core.tracks.audio.Audio.Codec">Codec</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>An Audio.Codec enum representing the audio codec.
|
||
If not specified, MediaInfo will be used to retrieve the codec
|
||
once the track has been downloaded.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>bitrate</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="typing.Union">Union</span>[<span title="str">str</span>, <span title="int">int</span>, <span title="float">float</span>]]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A number or float representing the average bandwidth in bytes/s.
|
||
Float values are rounded up to the nearest integer.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>channels</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="typing.Union">Union</span>[<span title="str">str</span>, <span title="int">int</span>, <span title="float">float</span>]]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A number, float, or string representing the number of audio channels.
|
||
Strings may represent numbers or floats. Expanded layouts like 7.1.1 is
|
||
not supported. All numbers and strings will be cast to float.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>joc</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="int">int</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The number of Joint-Object-Coding Channels/Objects in the audio stream.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>descriptive</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Union">Union</span>[<span title="bool">bool</span>, <span title="int">int</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Mark this audio as being descriptive audio for the blind.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>False</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Note: If codec, bitrate, channels, or joc is not specified some checks may be
|
||
skipped or assume a value. Specifying as much information as possible is highly
|
||
recommended.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Audio.atmos" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">atmos</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Audio.atmos" class="headerlink" title="Permanent link">¶</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">atmos</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return True if the audio track contains Dolby Atmos.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Audio.parse_channels" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">parse_channels</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Audio.parse_channels" class="headerlink" title="Permanent link">¶</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">parse_channels</span><span class="p">(</span><span class="n">channels</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Converts a Channel string to a float representing audio channel count and layout.
|
||
E.g. "3" -> "3.0", "2.1" -> "2.1", ".1" -> "0.1".</p>
|
||
<p>This does not validate channel strings as genuine channel counts or valid layouts.
|
||
It does not convert the value to assume a sub speaker channel layout, e.g. 5.1->6.0.
|
||
It also does not support expanded surround sound channel layout strings like 7.1.2.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Audio.get_track_name" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_track_name</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Audio.get_track_name" class="headerlink" title="Permanent link">¶</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">get_track_name</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return the base Track Name.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Chapter" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Chapter</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Chapter" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Chapter</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
<p>Create a new Chapter with a Timestamp and optional name.</p>
|
||
<p>The timestamp may be in the following formats:
|
||
- "HH:MM:SS" string, e.g., <code>25:05:23</code>.
|
||
- "HH:MM:SS.mss" string, e.g., <code>25:05:23.120</code>.
|
||
- a timecode integer in milliseconds, e.g., <code>90323120</code> is <code>25:05:23.120</code>.
|
||
- a timecode float in seconds, e.g., <code>90323.12</code> is <code>25:05:23.120</code>.</p>
|
||
<p>If you have a timecode integer in seconds, just multiply it by 1000.
|
||
If you have a timecode float in milliseconds (no decimal value), just convert
|
||
it to an integer.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapter.id" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">id</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Chapter.id" class="headerlink" title="Permanent link">¶</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="nb">id</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Compute an ID from the Chapter data.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapter.named" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">named</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Chapter.named" class="headerlink" title="Permanent link">¶</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">named</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Check if Chapter is named.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Chapters" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Chapters</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Chapters" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Chapters</span><span class="p">(</span><span class="n">iterable</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="sortedcontainers.SortedKeyList">SortedKeyList</span></code>, <code><span title="abc.ABC">ABC</span></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapters.id" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">id</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Chapters.id" class="headerlink" title="Permanent link">¶</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="nb">id</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Compute an ID from the Chapter data.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapters.loads" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">loads</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Chapters.loads" class="headerlink" title="Permanent link">¶</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">loads</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Load chapter data from a string.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapters.load" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">load</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Chapters.load" class="headerlink" title="Permanent link">¶</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">load</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Load chapter data from a file.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapters.dumps" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">dumps</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Chapters.dumps" class="headerlink" title="Permanent link">¶</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">dumps</span><span class="p">(</span><span class="n">fallback_name</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return chapter data in OGM-based Simple Chapter format.
|
||
https://mkvtoolnix.download/doc/mkvmerge.html#mkvmerge.chapters.simple</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>fallback_name</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Name used for Chapters without a Name set.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>''</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The fallback name can use the following variables in f-string style:</p>
|
||
<ul>
|
||
<li>{i}: The Chapter number starting at 1.
|
||
E.g., <code>"Chapter {i}"</code>: "Chapter 1", "Intro", "Chapter 3".</li>
|
||
<li>{j}: A number starting at 1 that increments any time a Chapter has no name.
|
||
E.g., <code>"Chapter {j}"</code>: "Chapter 1", "Intro", "Chapter 2".</li>
|
||
</ul>
|
||
<p>These are formatted with f-strings, directives are supported.
|
||
For example, <code>"Chapter {i:02}"</code> will result in <code>"Chapter 01"</code>.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Chapters.dump" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">dump</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Chapters.dump" class="headerlink" title="Permanent link">¶</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">dump</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Write chapter data in OGM-based Simple Chapter format to a file.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>path</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Union">Union</span>[<span title="pathlib.Path">Path</span>, <span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The file path to write the Chapter data to, overwriting
|
||
any existing data.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>See <code>Chapters.dumps</code> for more parameter documentation.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Hybrid" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Hybrid</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Hybrid</span><span class="p">(</span><span class="n">videos</span><span class="p">,</span> <span class="n">source</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Hybrid.log" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">log</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid.log" class="headerlink" title="Permanent link">¶</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">log</span> <span class="o">=</span> <span class="n"><span title="logging">logging</span></span><span class="o">.</span><span class="n"><span title="logging.getLogger">getLogger</span></span><span class="p">(</span><span class="s1">'hybrid'</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Takes the Dolby Vision and HDR10(+) streams out of the VideoTracks.
|
||
It will then attempt to inject the Dolby Vision metadata layer to the HDR10(+) stream.
|
||
If no DV track is available but HDR10+ is present, it will convert HDR10+ to DV.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Hybrid.level_5" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">level_5</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid.level_5" class="headerlink" title="Permanent link">¶</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">level_5</span><span class="p">(</span><span class="n">input_video</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Generate Level 5 active area metadata via crop detection on the HDR10 stream.</p>
|
||
<p>This resolves mismatches where DV has no black bars but HDR10 does (or vice versa)
|
||
by telling the display the correct active area.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Hybrid.sanitize_l6" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sanitize_l6</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid.sanitize_l6" class="headerlink" title="Permanent link">¶</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">sanitize_l6</span><span class="p">(</span><span class="n">max_mdl</span><span class="p">,</span> <span class="n">min_mdl</span><span class="p">,</span> <span class="n">max_cll</span><span class="p">,</span> <span class="n">max_fall</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Clamp static L6 values to a valid relationship.</p>
|
||
<p>MaxCLL must not exceed the mastering-display peak (some sources, e.g. ATV
|
||
HDR10+, ship MaxCLL 10000 on a 1000-nit master), and MaxFALL must not exceed
|
||
MaxCLL. A value of 0 means "unknown" and is preserved as-is.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Hybrid.level_6" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">level_6</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid.level_6" class="headerlink" title="Permanent link">¶</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">level_6</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Edit RPU Level 6 values using the static L6 luminance data from the RPU.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Hybrid.extract_hdr10plus" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">extract_hdr10plus</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid.extract_hdr10plus" class="headerlink" title="Permanent link">¶</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">extract_hdr10plus</span><span class="p">(</span><span class="n">_video</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Extract HDR10+ metadata from the video stream</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Hybrid.convert_hdr10plus_to_dv" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">convert_hdr10plus_to_dv</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Hybrid.convert_hdr10plus_to_dv" class="headerlink" title="Permanent link">¶</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">convert_hdr10plus_to_dv</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Convert HDR10+ metadata to Dolby Vision RPU</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Subtitle" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Subtitle</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Subtitle" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Subtitle</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="o">*</span><span class="n">args</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">codec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">cc</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">sdh</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">forced</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title="<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Track</span> (<code>unshackle.core.tracks.track.Track</code>)" href="#unshackle.core.tracks.Track">Track</a></code></p>
|
||
|
||
|
||
|
||
<p>Create a new Subtitle track object.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>codec</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="unshackle.core.tracks.subtitle.Subtitle.Codec">Codec</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A Subtitle.Codec enum representing the subtitle format.
|
||
If not specified, MediaInfo will be used to retrieve the format
|
||
once the track has been downloaded.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>cc</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Closed Caption.
|
||
- Intended as if you couldn't hear the audio at all.
|
||
- Can have Sound as well as Dialogue, but doesn't have to.
|
||
- Original source would be from an EIA-CC encoded stream. Typically all
|
||
upper-case characters.
|
||
Indicators of it being CC without knowing original source:
|
||
- Extracted with CCExtractor, or
|
||
- >>> (or similar) being used at the start of some or all lines, or
|
||
- All text is uppercase or at least the majority, or
|
||
- Subtitles are Scrolling-text style (one line appears, oldest line
|
||
then disappears).
|
||
Just because you downloaded it as a SRT or VTT or such, doesn't mean it
|
||
isn't from an EIA-CC stream. And I wouldn't take the streaming services
|
||
(CC) as gospel either as they tend to get it wrong too.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>False</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>sdh</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Deaf or Hard-of-Hearing. Also known as HOH in the UK (EU?).
|
||
- Intended as if you couldn't hear the audio at all.
|
||
- MUST have Sound as well as Dialogue to be considered SDH.
|
||
- It has no "syntax" or "format" but is not transmitted using archaic
|
||
forms like EIA-CC streams, would be intended for transmission via
|
||
SubRip (SRT), WebVTT (VTT), TTML, etc.
|
||
If you can see important audio/sound transcriptions and not just dialogue
|
||
and it doesn't have the indicators of CC, then it's most likely SDH.
|
||
If it doesn't have important audio/sounds transcriptions it might just be
|
||
regular subtitling (you wouldn't mark as CC or SDH). This would be the
|
||
case for most translation subtitles. Like Anime for example.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>False</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>forced</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Typically used if there's important information at some point in time
|
||
like watching Dubbed content and an important Sign or Letter is shown
|
||
or someone talking in a different language.
|
||
Forced tracks are recommended by the Matroska Spec to be played if
|
||
the player's current playback audio language matches a subtitle
|
||
marked as "forced".
|
||
However, that doesn't mean every player works like this but there is
|
||
no other way to reliably work with Forced subtitles where multiple
|
||
forced subtitles may be in the output file. Just know what to expect
|
||
with "forced" subtitles.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>False</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Note: If codec is not specified some checks may be skipped or assume a value.
|
||
Specifying as much information as possible is highly recommended.</p>
|
||
|
||
|
||
<details class="information-on-subtitle-types" open>
|
||
<summary>Information on Subtitle Types</summary>
|
||
<p>https://bit.ly/2Oe4fLC (3PlayMedia Blog on SUB vs CC vs SDH).
|
||
However, I wouldn't pay much attention to the claims about SDH needing to
|
||
be in the original source language. It's logically not true.</p>
|
||
<p>CC == Closed Captions. Source: Basically every site.
|
||
SDH = Subtitles for the Deaf or Hard-of-Hearing. Source: Basically every site.
|
||
HOH = Exact same as SDH. Is a term used in the UK. Source: https://bit.ly/2PGJatz (ICO UK)</p>
|
||
<p>More in-depth information, examples, and stuff to look for can be found in the Parameter
|
||
explanation list above.</p>
|
||
</details>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.get_track_name" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_track_name</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Subtitle.get_track_name" class="headerlink" title="Permanent link">¶</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">get_track_name</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return the base Track Name.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.sanitize_webvtt_timestamps" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sanitize_webvtt_timestamps</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.sanitize_webvtt_timestamps" class="headerlink" title="Permanent link">¶</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">sanitize_webvtt_timestamps</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Fix invalid timestamps in WebVTT files, particularly negative timestamps.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Sanitized WebVTT content</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.has_webvtt_cue_identifiers" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">has_webvtt_cue_identifiers</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.has_webvtt_cue_identifiers" class="headerlink" title="Permanent link">¶</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">has_webvtt_cue_identifiers</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Check if WebVTT content has cue identifiers that need removal.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>True if cue identifiers are detected, False otherwise</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.sanitize_webvtt_cue_identifiers" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sanitize_webvtt_cue_identifiers</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.sanitize_webvtt_cue_identifiers" class="headerlink" title="Permanent link">¶</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">sanitize_webvtt_cue_identifiers</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Remove WebVTT cue identifiers that can confuse subtitle parsers.</p>
|
||
<p>Some services use cue identifiers like "Q0", "Q1", etc.
|
||
that appear on their own line before the timing line. These can be
|
||
incorrectly parsed as part of the previous cue's text content by
|
||
some parsers (like pysubs2).</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Sanitized WebVTT content with cue identifiers removed</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.has_overlapping_webvtt_cues" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">has_overlapping_webvtt_cues</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.has_overlapping_webvtt_cues" class="headerlink" title="Permanent link">¶</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">has_overlapping_webvtt_cues</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Check if WebVTT content has overlapping cues that need merging.</p>
|
||
<p>Detects cues with start times within 50ms of each other and the same end time,
|
||
which indicates multi-line subtitles split into separate cues.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>True if overlapping cues are detected, False otherwise</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.merge_overlapping_webvtt_cues" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">merge_overlapping_webvtt_cues</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.merge_overlapping_webvtt_cues" class="headerlink" title="Permanent link">¶</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">merge_overlapping_webvtt_cues</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Merge WebVTT cues that have overlapping/near-identical times but different line positions.</p>
|
||
<p>Some services use separate cues for each line of a multi-line subtitle, with
|
||
slightly different start times (1ms apart) and different line: positions.
|
||
This merges them into single cues with proper line ordering based on the
|
||
line: position (lower percentage = higher on screen = first line).</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>WebVTT content with overlapping cues merged</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.sanitize_webvtt" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sanitize_webvtt</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.sanitize_webvtt" class="headerlink" title="Permanent link">¶</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">sanitize_webvtt</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>More thorough sanitization of WebVTT files to handle multiple potential issues.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Sanitized WebVTT content</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.convert" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">convert</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Subtitle.convert" class="headerlink" title="Permanent link">¶</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">convert</span><span class="p">(</span><span class="n">codec</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">forced</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Convert this Subtitle to another format.</p>
|
||
<p>Backend selection is data-driven (see <code>tracks/subtitle_convert.py</code>): the best
|
||
available backend that supports source->target is used, falling back through the
|
||
capability chain on failure. The backend can be pinned via the <code>conversion_method</code>
|
||
config key (<code>auto</code> | <code>subby</code> | <code>pysubs2</code> | <code>subtitleedit</code> | <code>pycaption</code>),
|
||
or nudged per-service via <code>preferred_conversion_method</code>; an explicit config value
|
||
always wins.</p>
|
||
<p><code>forced</code> marks an explicit user request (<code>--sub-format</code>). Lossy downconverts of
|
||
styled formats (SSA/ASS -> SRT) are skipped unless <code>forced</code> is True.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.extract_fonts" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">extract_fonts</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.extract_fonts" class="headerlink" title="Permanent link">¶</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">extract_fonts</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Font names referenced by an ASS/SSA subtitle.</p>
|
||
<p>Covers both sources that need attaching for correct rendering:
|
||
- the <code>Fontname</code> column of every <code>Style:</code> line in <code>[V4+ Styles]</code>/<code>[V4 Styles]</code>
|
||
(column located from the section's <code>Format:</code> line, not assumed by index), and
|
||
- inline <code>\fn</code> font overrides inside <code>Dialogue</code> override blocks.</p>
|
||
<p>Leading <code>@</code> (vertical-writing prefix) is stripped and names are de-duplicated
|
||
case-insensitively, preferring a mixed-case spelling over an all-lowercase one.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.sanitize_broken_webvtt" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sanitize_broken_webvtt</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.sanitize_broken_webvtt" class="headerlink" title="Permanent link">¶</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">sanitize_broken_webvtt</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Remove or fix corrupted WebVTT lines, particularly those with invalid timestamps.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>text</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The WebVTT content as string</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Sanitized WebVTT content with corrupted lines removed</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.space_webvtt_headers" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">space_webvtt_headers</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.space_webvtt_headers" class="headerlink" title="Permanent link">¶</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">space_webvtt_headers</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Space out the WEBVTT Headers from Captions.</p>
|
||
<p>Segmented VTT when merged may have the WEBVTT headers part of the next caption
|
||
as they were not separated far enough from the previous caption and ended up
|
||
being considered as caption text rather than the header for the next segment.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.merge_same_cues" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">merge_same_cues</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.merge_same_cues" class="headerlink" title="Permanent link">¶</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">merge_same_cues</span><span class="p">(</span><span class="n">caption_set</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Merge captions with the same timecodes and text as one in-place.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.filter_unwanted_cues" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">filter_unwanted_cues</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.filter_unwanted_cues" class="headerlink" title="Permanent link">¶</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">filter_unwanted_cues</span><span class="p">(</span><span class="n">caption_set</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Filter out subtitle cues containing only or whitespace.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.merge_segmented_wvtt" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">merge_segmented_wvtt</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.merge_segmented_wvtt" class="headerlink" title="Permanent link">¶</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">merge_segmented_wvtt</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">period_start</span><span class="o">=</span><span class="mf">0.0</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Convert Segmented DASH WebVTT cues into a pycaption Caption List.
|
||
Also returns an ISO 639-2 alpha-3 language code if available.</p>
|
||
<p>Code ported originally by xhlove to Python from shaka-player.
|
||
Has since been improved upon by rlaphoenix using pymp4 and
|
||
pycaption functions.</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>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Subtitle.strip_hearing_impaired" class="headerlink" title="Permanent link">¶</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_hearing_impaired</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Strip captions for hearing impaired (SDH).</p>
|
||
<p>The SDH stripping method is determined by the 'sdh_method' setting in config:
|
||
- 'auto' (default): Tries subby first, then SubtitleEdit, then filter-subs
|
||
- 'subby': Uses subby's SDHStripper
|
||
- 'subtitleedit': Uses SubtitleEdit when available
|
||
- 'filter-subs': Uses subtitle-filter library</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Subtitle.reverse_rtl" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">reverse_rtl</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Subtitle.reverse_rtl" class="headerlink" title="Permanent link">¶</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">reverse_rtl</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Reverse RTL (Right to Left) Start/End on Captions.
|
||
This can be used to fix the positioning of sentence-ending characters.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.DownloadContext" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">DownloadContext</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.DownloadContext" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">DownloadContext</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="n">save_path</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">save_dir</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">progress</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">proxy</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">max_workers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">license_widevine</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">cdm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
<p>Shared arguments passed to each manifest's <code>download_track</code>.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.DownloadContext.ensure_session" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">ensure_session</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.DownloadContext.ensure_session" class="headerlink" title="Permanent link">¶</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">ensure_session</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return the session, or a new <code>Session</code> if none was set.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Track" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Track</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Track</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="n">url</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">language</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">is_original_lang</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">descriptor</span><span class="o">=</span><span class="n"><span title="unshackle.core.tracks.track.Track.Descriptor.URL">URL</span></span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">needs_repack</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">drm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">edition</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">downloader</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n">downloader_args</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">from_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n">id_</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">extra</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.data" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">data</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.data" class="headerlink" title="Permanent link">¶</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">data</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Arbitrary track data dictionary.</p>
|
||
<p>A defaultdict is used with a dict as the factory for easier
|
||
nested saving and safer exists-checks.</p>
|
||
<p>Reserved keys:</p>
|
||
<ul>
|
||
<li>"hls" used by the HLS class.</li>
|
||
<li>playlist: m3u8.model.Playlist - The primary track information.</li>
|
||
<li>media: m3u8.model.Media - The audio/subtitle track information.</li>
|
||
<li>segment_durations: list[int] - A list of each segment's duration.</li>
|
||
<li>"dash" used by the DASH class.</li>
|
||
<li>manifest: lxml.ElementTree - DASH MPD manifest.</li>
|
||
<li>period: lxml.Element - The period of this track.</li>
|
||
<li>adaptation_set: lxml.Element - The adaptation set of this track.</li>
|
||
<li>representation: lxml.Element - The representation of this track.</li>
|
||
<li>timescale: int - The timescale of the track's segments.</li>
|
||
<li>segment_durations: list[int] - A list of each segment's duration.</li>
|
||
</ul>
|
||
<p>You should not add, change, or remove any data within reserved keys.
|
||
You may use their data but do note that the values of them may change
|
||
or be removed at any point.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.download" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">download</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.download" class="headerlink" title="Permanent link">¶</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">download</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="n">session</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">prepare_drm</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">max_workers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">progress</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">cdm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">no_proxy_download</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Download and optionally Decrypt this Track.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.move" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">move</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.move" class="headerlink" title="Permanent link">¶</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">move</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Move the Track's file from current location, to target location.
|
||
This will overwrite anything at the target path.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Raises:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="TypeError">TypeError</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>If the target argument is not the expected type.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="ValueError">ValueError</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>If track has no file to move, or the target does not exist.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="OSError">OSError</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>If the file somehow failed to move.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Returns the new location of the track.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.to_dict" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">to_dict</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.to_dict" class="headerlink" title="Permanent link">¶</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">to_dict</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Serialise the track for export/import (identity/URL/descriptor/language).</p>
|
||
<p>DRM is not serialised here; the export writer attaches the licensed DRM + keys.
|
||
Subclasses add their own codec/quality fields.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.base_kwargs_from_dict" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">base_kwargs_from_dict</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Track.base_kwargs_from_dict" class="headerlink" title="Permanent link">¶</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">base_kwargs_from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Build the shared Track constructor kwargs from a <code>to_dict()</code> payload.</p>
|
||
<p>DRM is not reconstructed here — <code>to_dict</code> does not serialise it, and the import
|
||
flow attaches the licensed DRM + content keys separately.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.from_dict" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">from_dict</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Track.from_dict" class="headerlink" title="Permanent link">¶</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">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Reconstruct the correct Track subclass from a <code>to_dict()</code> payload.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.get_track_name" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_track_name</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.get_track_name" class="headerlink" title="Permanent link">¶</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">get_track_name</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Get the Track Name.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.get_drm_for_cdm" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_drm_for_cdm</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.get_drm_for_cdm" class="headerlink" title="Permanent link">¶</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">get_drm_for_cdm</span><span class="p">(</span><span class="n">cdm</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return the DRM matching the provided CDM, if available.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.get_key_id" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_key_id</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.get_key_id" class="headerlink" title="Permanent link">¶</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">get_key_id</span><span class="p">(</span><span class="n">init_data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Probe the DRM encryption Key ID (KID) for this specific track.</p>
|
||
<p>It currently supports finding the Key ID by probing the track's stream
|
||
with ffprobe for <code>enc_key_id</code> data, as well as for mp4 <code>tenc</code> (Track
|
||
Encryption) boxes.</p>
|
||
<p>It explicitly ignores PSSH information like the <code>PSSH</code> box, as the box
|
||
is likely to contain multiple Key IDs that may or may not be for this
|
||
specific track.</p>
|
||
<p>To retrieve the initialization segment, this method calls :meth:<code>get_init_segment</code>
|
||
with the positional and keyword arguments. The return value of <code>get_init_segment</code>
|
||
is then used to determine the Key ID.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="uuid.UUID">UUID</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The Key ID as a UUID object, or None if the Key ID could not be determined.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.load_drm_if_needed" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">load_drm_if_needed</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.load_drm_if_needed" class="headerlink" title="Permanent link">¶</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">load_drm_if_needed</span><span class="p">(</span><span class="n">service</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Load DRM information for this track if it was deferred during parsing.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>service</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="Service">Service</span> | None</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Service instance that can fetch track-specific DRM info</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<p><span class="doc-section-title">Returns:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>True if DRM was loaded or already present, False if failed</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.load_drm_from_playlist" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">load_drm_from_playlist</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.load_drm_from_playlist" class="headerlink" title="Permanent link">¶</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">load_drm_from_playlist</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Fallback method to load DRM by fetching this track's individual playlist.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Track.get_init_segment" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_init_segment</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Track.get_init_segment" class="headerlink" title="Permanent link">¶</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">get_init_segment</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="n">maximum_size</span><span class="o">=</span><span class="mi">20000</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">byte_range</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Get the Track's Initial Segment Data Stream.</p>
|
||
<p>HLS and DASH tracks must explicitly provide a URL to the init segment or file.
|
||
Providing the byte-range for the init segment is recommended where possible.</p>
|
||
<p>If <code>byte_range</code> is not set, it will make a HEAD request and check the size of
|
||
the file. If the size could not be determined, it will download up to the first
|
||
20KB only, which should contain the entirety of the init segment. You may
|
||
override this by changing the <code>maximum_size</code>.</p>
|
||
<p>The default maximum_size of 20000 (20KB) is a tried-and-tested value that
|
||
seems to work well across the board.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>maximum_size</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="int">int</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Size to assume as the content length if byte-range is not
|
||
used, the content size could not be determined, or the content size
|
||
is larger than it. A value of 20000 (20KB) or higher is recommended.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>20000</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>url</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Explicit init map or file URL to probe from.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>byte_range</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="str">str</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Range of bytes to download from the explicit or implicit URL.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>session</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="requests.Session">Session</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Session context, e.g., authorization and headers.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Tracks" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Tracks</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Tracks</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">manifest_url</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
<p>Video, Audio, Subtitle, Chapter, and Attachment Track Store.
|
||
It provides convenience functions for listing, sorting, and selecting tracks.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.exists" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">exists</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.exists" class="headerlink" title="Permanent link">¶</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">exists</span><span class="p">(</span><span class="n">by_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">by_url</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Check if a track already exists by various methods.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.add" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">add</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.add" class="headerlink" title="Permanent link">¶</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">add</span><span class="p">(</span><span class="n">tracks</span><span class="p">,</span> <span class="n">warn_only</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Add a provided track to its appropriate array and ensuring it's not a duplicate.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.sort_videos" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sort_videos</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.sort_videos" class="headerlink" title="Permanent link">¶</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">sort_videos</span><span class="p">(</span><span class="n">by_language</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Sort video tracks by resolution then bitrate, and optionally language.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.sort_audio" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sort_audio</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.sort_audio" class="headerlink" title="Permanent link">¶</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">sort_audio</span><span class="p">(</span><span class="n">by_language</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">codec_priority</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Sort audio tracks by bitrate, codec priority, Atmos, descriptive, and optionally language.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.sort_subtitles" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sort_subtitles</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.sort_subtitles" class="headerlink" title="Permanent link">¶</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">sort_subtitles</span><span class="p">(</span><span class="n">by_language</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">type_priority</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Sort subtitle tracks by various track attributes to a common P2P standard.
|
||
You may optionally provide a sequence of languages to prioritize to the top.</p>
|
||
|
||
|
||
<details class="section-order" open>
|
||
<summary>Section Order</summary>
|
||
<ul>
|
||
<li>by_language groups prioritized to top, and ascending alphabetically</li>
|
||
<li>then rest ascending alphabetically after the prioritized groups
|
||
(Each section ascending alphabetically, but separated)</li>
|
||
</ul>
|
||
</details>
|
||
|
||
<details class="language-group-order" open>
|
||
<summary>Language Group Order</summary>
|
||
<ul>
|
||
<li>Forced</li>
|
||
<li>Normal</li>
|
||
<li>Hard of Hearing (SDH/CC)
|
||
(Least to most captions expected in the subtitle)</li>
|
||
</ul>
|
||
</details> <p>type_priority overrides the Language Group Order with an explicit ranking of
|
||
"forced", "normal", and "sdh" (cc counts as sdh); unlisted types fall to the end.
|
||
The first track after sorting receives the default flag at mux time, so this also
|
||
controls which subtitle type becomes default.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.filter" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">filter</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.filter" class="headerlink" title="Permanent link">¶</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">filter</span><span class="p">(</span><span class="n">predicate</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return a new Tracks with tracks filtered by predicate, preserving metadata.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.merge_video_selections" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">merge_video_selections</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.merge_video_selections" class="headerlink" title="Permanent link">¶</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">merge_video_selections</span><span class="p">(</span><span class="o">*</span><span class="n">groups</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Concatenate video selections, dropping duplicates (by track id, order-preserving).</p>
|
||
<p>A DV track can be chosen as both the hybrid ingredient (lowest) and an explicit
|
||
deliverable; without dedup the same track would be muxed/downloaded twice.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.partition_hybrid_videos" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">partition_hybrid_videos</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.partition_hybrid_videos" class="headerlink" title="Permanent link">¶</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">partition_hybrid_videos</span><span class="p">(</span><span class="n">videos</span><span class="p">,</span> <span class="n">non_hybrid_ranges</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Split videos into hybrid-ingredient candidates and the standalone-deliverable pool.</p>
|
||
<p>HDR10/HDR10+/DV tracks are hybrid ingredients; they only enter the standalone
|
||
pool when their range was explicitly requested alongside HYBRID, so e.g.
|
||
<code>-r HYBRID</code> muxes only the hybrid while <code>-r HYBRID,HDR10P</code> also delivers HDR10+.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.flag_hybrid_ingredients" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">flag_hybrid_ingredients</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.flag_hybrid_ingredients" class="headerlink" title="Permanent link">¶</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">flag_hybrid_ingredients</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="n">hybrid_selected</span><span class="p">,</span> <span class="n">non_hybrid_selected</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Mark tracks selected only as hybrid ingredients so the standalone mux loop skips them.</p>
|
||
<p>A track that was also picked as an explicit deliverable (same track in both
|
||
selections) stays unflagged and is muxed standalone alongside the hybrid.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Tracks.mux" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">mux</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Tracks.mux" class="headerlink" title="Permanent link">¶</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">mux</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="n">title</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">delete</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">progress</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">audio_expected</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">title_language</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">skip_subtitles</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Multiplex all the Tracks into a Matroska Container file.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>title</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="str">str</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Set the Matroska Container file title. Usually displayed in players
|
||
instead of the filename if set.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<em>required</em>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>delete</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Delete all track files after multiplexing.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>True</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>progress</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="functools.partial">partial</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Update a rich progress bar via <code>completed=...</code>. This must be the
|
||
progress object's update() func, pre-set with task id via functools.partial.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>audio_expected</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Whether audio is expected in the output. Used to determine
|
||
if embedded audio metadata should be added.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>True</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>title_language</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="langcodes.Language">Language</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The title's intended language. Used to select the best video track
|
||
for audio metadata when multiple video tracks exist.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>skip_subtitles</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="bool">bool</span></code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>Skip muxing subtitle tracks into the container.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>False</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h2 id="unshackle.core.tracks.Video" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Video</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video" class="headerlink" title="Permanent link">¶</a></h2>
|
||
<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">Video</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="o">*</span><span class="n">args</span><span class="p">,</span>
|
||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">codec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">range_</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">bitrate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">width</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">height</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">fps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">scan_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">closed_captions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">dv_compatible_bitstream</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title="<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Track</span> (<code>unshackle.core.tracks.track.Track</code>)" href="#unshackle.core.tracks.Track">Track</a></code></p>
|
||
|
||
|
||
|
||
<p>Create a new Video track object.</p>
|
||
|
||
|
||
<p><span class="doc-section-title">Parameters:</span></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>codec</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="unshackle.core.tracks.video.Video.Codec">Codec</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A Video.Codec enum representing the video codec.
|
||
If not specified, MediaInfo will be used to retrieve the codec
|
||
once the track has been downloaded.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>range_</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title="<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Range</span> (<code>unshackle.core.tracks.video.Video.Range</code>)" href="#unshackle.core.tracks.Video.Range">Range</a>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A Video.Range enum representing the video color range.
|
||
Defaults to SDR if not specified.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>bitrate</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="typing.Union">Union</span>[<span title="str">str</span>, <span title="int">int</span>, <span title="float">float</span>]]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A number or float representing the average bandwidth in bytes/s.
|
||
Float values are rounded up to the nearest integer.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>width</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="int">int</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The horizontal resolution of the video.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>height</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="int">int</span>]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>The vertical resolution of the video.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
<tr class="doc-section-item">
|
||
<td>
|
||
<code>fps</code>
|
||
</td>
|
||
<td>
|
||
<code><span title="typing.Optional">Optional</span>[<span title="typing.Union">Union</span>[<span title="str">str</span>, <span title="int">int</span>, <span title="float">float</span>]]</code>
|
||
</td>
|
||
<td>
|
||
<div class="doc-md-description">
|
||
<p>A number, float, or string representing the frames/s of the video.
|
||
Strings may represent numbers, floats, or a fraction (num/den).
|
||
All strings will be cast to either a number or float.</p>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<code>None</code>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Note: If codec, bitrate, width, height, or fps is not specified some checks
|
||
may be skipped or assume a value. Specifying as much information as possible
|
||
is highly recommended.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Video.Range" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Range</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video.Range" class="headerlink" title="Permanent link">¶</a></h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="str">str</span></code>, <code><span title="enum.Enum">Enum</span></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="unshackle.core.tracks.Video.Range.from_cicp" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">from_cicp</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
<a href="#unshackle.core.tracks.Video.Range.from_cicp" class="headerlink" title="Permanent link">¶</a></h4>
|
||
<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">from_cicp</span><span class="p">(</span><span class="n">primaries</span><span class="p">,</span> <span class="n">transfer</span><span class="p">,</span> <span class="n">matrix</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Convert CICP (Coding-Independent Code Points) values to Video Range.</p>
|
||
<p>CICP is defined in ITU-T H.273 and ISO/IEC 23091-2 for signaling video
|
||
color properties independently of the compression codec. These values are
|
||
used across AVC (H.264), HEVC (H.265), VVC, AV1, and other modern codecs.</p>
|
||
<p>The enum values (Primaries, Transfer, Matrix) match the official specifications:
|
||
- ITU-T H.273: Coding-independent code points for video signal type identification
|
||
- ISO/IEC 23091-2: Information technology — Coding-independent code points — Part 2: Video
|
||
- H.264 Table E-3 (Colour Primaries) and Table E-4 (Transfer Characteristics)
|
||
- H.265 Table E.3 and E.4 (identical to H.264)</p>
|
||
<p>Note: Value 0 = "Reserved" and Value 2 = "Unspecified" per specification.
|
||
While both effectively mean "unknown" in practice, the distinction matters for
|
||
spec compliance. Value 2 was added based on user feedback (GitHub issue) and
|
||
verified against FFmpeg's AVColorPrimaries/AVColorTransferCharacteristic enums.</p>
|
||
<p>Sources:
|
||
- https://www.itu.int/rec/T-REC-H.273
|
||
- https://www.itu.int/rec/T-REC-H.Sup19-202104-I
|
||
- https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/pixfmt.h</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Video.change_color_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">change_color_range</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video.change_color_range" class="headerlink" title="Permanent link">¶</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">change_color_range</span><span class="p">(</span><span class="n">range_</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Change the Video's Color Range to Limited (0) or Full (1).</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Video.normalize_vui" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">normalize_vui</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video.normalize_vui" class="headerlink" title="Permanent link">¶</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">normalize_vui</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Rewrite SPS VUI colour metadata to match <code>self.range</code>.</p>
|
||
<p>Some services ship HDR10/HLG bitstreams with stale BT.709 VUI, which makes
|
||
downstream tools mis-classify the file. The manifest-derived range is the
|
||
source of truth. Skips SDR, DV, and HYBRID. Returns True if the bitstream
|
||
was rewritten.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Video.ccextractor" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">ccextractor</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video.ccextractor" class="headerlink" title="Permanent link">¶</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">ccextractor</span><span class="p">(</span><span class="n">track_id</span><span class="p">,</span> <span class="n">out_path</span><span class="p">,</span> <span class="n">language</span><span class="p">,</span> <span class="n">original</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Return a TextTrack object representing CC track extracted by CCExtractor.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Video.extract_c608" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">extract_c608</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video.extract_c608" class="headerlink" title="Permanent link">¶</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">extract_c608</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Extract Apple-Style c608 box (CEA-608) subtitle using ccextractor.</p>
|
||
<p>This isn't much more than a wrapper to the track.ccextractor function.
|
||
All this does, is actually check if a c608 box exists and only if so
|
||
does it actually call ccextractor.</p>
|
||
<p>Even though there is a possibility of more than one c608 box, only one
|
||
can actually be extracted. Not only that but it's very possible this
|
||
needs to be done before any decryption as the decryption may destroy
|
||
some of the metadata.</p>
|
||
|
||
|
||
<details class="todo" open>
|
||
<summary>Need a test file with more than one c608 box to add support for</summary>
|
||
<p>more than one CEA-608 extraction.</p>
|
||
</details>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h3 id="unshackle.core.tracks.Video.remove_eia_cc" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">remove_eia_cc</span>
|
||
|
||
|
||
<a href="#unshackle.core.tracks.Video.remove_eia_cc" class="headerlink" title="Permanent link">¶</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">remove_eia_cc</span><span class="p">()</span>
|
||
</span></code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Remove EIA-CC data from Bitstream while keeping SEI data.</p>
|
||
<p>This works by removing all NAL Unit's with the Type of 6 from the bistream
|
||
and then re-adding SEI data (effectively a new NAL Unit with just the SEI data).
|
||
Only bitstreams with x264 encoding information is currently supported due to the
|
||
obscurity on the MDAT mp4 box structure. Therefore, we need to use hacky regex.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
|
||
|
||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||
</div>
|
||
|
||
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||
Back to top
|
||
</button>
|
||
|
||
</main>
|
||
|
||
<footer class="md-footer">
|
||
|
||
|
||
|
||
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
||
|
||
|
||
<a href="../config/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Config">
|
||
<div class="md-footer__button md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</div>
|
||
<div class="md-footer__title">
|
||
<span class="md-footer__direction">
|
||
Previous
|
||
</span>
|
||
<div class="md-ellipsis">
|
||
Config
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
|
||
<a href="../titles/" class="md-footer__link md-footer__link--next" aria-label="Next: Titles">
|
||
<div class="md-footer__title">
|
||
<span class="md-footer__direction">
|
||
Next
|
||
</span>
|
||
<div class="md-ellipsis">
|
||
Titles
|
||
</div>
|
||
</div>
|
||
<div class="md-footer__button md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
||
</div>
|
||
</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="md-footer-meta md-typeset">
|
||
<div class="md-footer-meta__inner md-grid">
|
||
<div class="md-copyright">
|
||
|
||
|
||
Made with
|
||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||
Material for MkDocs
|
||
</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
<div class="md-dialog" data-md-component="dialog">
|
||
<div class="md-dialog__inner md-typeset"></div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script id="__config" type="application/json">{"annotate": null, "base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "content.tooltips", "navigation.footer", "navigation.indexes", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||
|
||
|
||
<script src="../../../assets/javascripts/bundle.79ae519e.min.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |