pylib/media
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
media/_docs_/media.html
Dirk Alders 56749b17a3 docs update
2025-08-17 11:18:37 +02:00

506 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>media package &#8212; media documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=67a6116b" />
<link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?v=5ff89526" />
<link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="_static/pygments_dark.css?v=5349f25f" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /><link rel="stylesheet" href="_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
<link rel="shortcut icon" type="image/png" href="_static/py.svg">
<script type="text/javascript" src="_static/copybutton.js"></script>
<script type="text/javascript" src="_static/menu.js"></script>
<script type="text/javascript" src="_static/search-focus.js"></script>
<script type="text/javascript" src="_static/themetoggle.js"></script>
</head>
<body>
<div class="mobile-nav">
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">
<nav class="nav-content" role="navigation">
<label for="menuToggler" class="toggler__label">
<span></span>
</label>
<span class="nav-items-wrapper">
<a href="https://www.python.org/" class="nav-logo">
<img src="_static/py.svg" alt="Python logo">
</a>
<span class="version_switcher_placeholder"></span>
<form role="search" class="search" action="search.html" method="get">
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
<path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
</svg>
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q">
<input type="submit" value="Go">
</form>
</span>
</nav>
<div class="menu-wrapper">
<nav class="menu" role="navigation" aria-label="main navigation">
<div class="language_switcher_placeholder"></div>
<label class="theme-selector-label">
Theme
<select class="theme-selector" oninput="activateTheme(this.value)">
<option value="auto" selected>Auto</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</label>
<div>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">media package</a><ul>
<li><a class="reference internal" href="#media-media-tools">media (Media Tools)</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-media.CDDB">media.CDDB module</a><ul>
<li><a class="reference internal" href="#media.CDDB.cddb"><code class="docutils literal notranslate"><span class="pre">cddb()</span></code></a></li>
<li><a class="reference internal" href="#media.CDDB.discid"><code class="docutils literal notranslate"><span class="pre">discid()</span></code></a></li>
<li><a class="reference internal" href="#media.CDDB.my_disc_metadata"><code class="docutils literal notranslate"><span class="pre">my_disc_metadata()</span></code></a></li>
<li><a class="reference internal" href="#media.CDDB.query"><code class="docutils literal notranslate"><span class="pre">query()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.common">media.common module</a><ul>
<li><a class="reference internal" href="#media.common.get_disc_device"><code class="docutils literal notranslate"><span class="pre">get_disc_device()</span></code></a></li>
<li><a class="reference internal" href="#media.common.get_filetype"><code class="docutils literal notranslate"><span class="pre">get_filetype()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.convert">media.convert module</a><ul>
<li><a class="reference internal" href="#media.convert.FilenameFilter"><code class="docutils literal notranslate"><span class="pre">FilenameFilter()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.disc_track_rip"><code class="docutils literal notranslate"><span class="pre">disc_track_rip()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.get_pil_image"><code class="docutils literal notranslate"><span class="pre">get_pil_image()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.track_to_targetpath"><code class="docutils literal notranslate"><span class="pre">track_to_targetpath()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.wav_to_mp3"><code class="docutils literal notranslate"><span class="pre">wav_to_mp3()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.image">media.image module</a><ul>
<li><a class="reference internal" href="#media.image.image"><code class="docutils literal notranslate"><span class="pre">image</span></code></a><ul>
<li><a class="reference internal" href="#media.image.image.image_data"><code class="docutils literal notranslate"><span class="pre">image.image_data()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.join"><code class="docutils literal notranslate"><span class="pre">image.join()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.load_from_file"><code class="docutils literal notranslate"><span class="pre">image.load_from_file()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.resize"><code class="docutils literal notranslate"><span class="pre">image.resize()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.rotate_by_orientation"><code class="docutils literal notranslate"><span class="pre">image.rotate_by_orientation()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.save"><code class="docutils literal notranslate"><span class="pre">image.save()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.metadata">media.metadata module</a><ul>
<li><a class="reference internal" href="#media.metadata.get_audio_data"><code class="docutils literal notranslate"><span class="pre">get_audio_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_disc_data"><code class="docutils literal notranslate"><span class="pre">get_disc_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_disc_data_dummy"><code class="docutils literal notranslate"><span class="pre">get_disc_data_dummy()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_image_data"><code class="docutils literal notranslate"><span class="pre">get_image_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_media_data"><code class="docutils literal notranslate"><span class="pre">get_media_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_video_data"><code class="docutils literal notranslate"><span class="pre">get_video_data()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/media.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</nav>
</div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>
<li><a href="https://www.python.org/">Python</a> &#187;</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
<a href="index.html">media documentation</a> &#187;
</li>
<li class="nav-item nav-item-this"><a href="">media package</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">
<input type="submit" value="Go">
</form>
</div>
|
</li>
<li class="right">
<label class="theme-selector-label">
Theme
<select class="theme-selector" oninput="activateTheme(this.value)">
<option value="auto" selected>Auto</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</label> |</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-media">
<span id="media-package"></span><h1>media package<a class="headerlink" href="#module-media" title="Link to this heading"></a></h1>
<section id="media-media-tools">
<h2>media (Media Tools)<a class="headerlink" href="#media-media-tools" title="Link to this heading"></a></h2>
<p><strong>Author:</strong></p>
<ul class="simple">
<li><p>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</p></li>
</ul>
<p><strong>Description:</strong></p>
<blockquote>
<div><p>This module helps on all issues with media files, like tags (e.g. exif, id3) and transformations.</p>
</div></blockquote>
<p><strong>Submodules:</strong></p>
<ul class="simple">
<li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">media.get_media_data()</span></code></p></li>
<li><p><a class="reference internal" href="#module-media.image" title="media.image"><code class="xref py py-class docutils literal notranslate"><span class="pre">media.image</span></code></a></p></li>
</ul>
<p><strong>Unittest:</strong></p>
<blockquote>
<div><p>See also the <a class="reference download internal" download="" href="_downloads/14fe83eaba59bfef61e953e0a1be01fd/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p>
</div></blockquote>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-media.CDDB">
<span id="media-cddb-module"></span><h2>media.CDDB module<a class="headerlink" href="#module-media.CDDB" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="media.CDDB.cddb">
<span class="sig-prename descclassname"><span class="pre">media.CDDB.</span></span><span class="sig-name descname"><span class="pre">cddb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">disc_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://gnudb.gnudb.org/~cddb/cddb.cgi'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'dirk'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ahorn'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'root'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.CDDB.cddb" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.CDDB.discid">
<span class="sig-prename descclassname"><span class="pre">media.CDDB.</span></span><span class="sig-name descname"><span class="pre">discid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#media.CDDB.discid" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.CDDB.my_disc_metadata">
<span class="sig-prename descclassname"><span class="pre">media.CDDB.</span></span><span class="sig-name descname"><span class="pre">my_disc_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.CDDB.my_disc_metadata" title="Link to this definition"></a></dt>
<dd><p>Generate my disc metadata</p>
<dl class="simple">
<dt>kwargs needs to include the following data:</dt><dd><ul class="simple">
<li><p>KEY_ARTIST (str)</p></li>
<li><p>KEY_ALBUM (str)</p></li>
<li><p>KEY_YEAR (int) - will be converted here</p></li>
<li><p>KEY_GENRE (str)</p></li>
<li><p>“track_xx” (str) - where xx is the track number which will be converted to int here</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.CDDB.query">
<span class="sig-prename descclassname"><span class="pre">media.CDDB.</span></span><span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://gnudb.gnudb.org/~cddb/cddb.cgi'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'dirk'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ahorn'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'root'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.CDDB.query" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-media.common">
<span id="media-common-module"></span><h2>media.common module<a class="headerlink" href="#module-media.common" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="media.common.get_disc_device">
<span class="sig-prename descclassname"><span class="pre">media.common.</span></span><span class="sig-name descname"><span class="pre">get_disc_device</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#media.common.get_disc_device" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.common.get_filetype">
<span class="sig-prename descclassname"><span class="pre">media.common.</span></span><span class="sig-name descname"><span class="pre">get_filetype</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.common.get_filetype" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-media.convert">
<span id="media-convert-module"></span><h2>media.convert module<a class="headerlink" href="#module-media.convert" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="media.convert.FilenameFilter">
<span class="sig-prename descclassname"><span class="pre">media.convert.</span></span><span class="sig-name descname"><span class="pre">FilenameFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#media.convert.FilenameFilter" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.convert.disc_track_rip">
<span class="sig-prename descclassname"><span class="pre">media.convert.</span></span><span class="sig-name descname"><span class="pre">disc_track_rip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">track_num</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">progress_callback</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.convert.disc_track_rip" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.convert.get_pil_image">
<span class="sig-prename descclassname"><span class="pre">media.convert.</span></span><span class="sig-name descname"><span class="pre">get_pil_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">media_instance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.convert.get_pil_image" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.convert.track_to_targetpath">
<span class="sig-prename descclassname"><span class="pre">media.convert.</span></span><span class="sig-name descname"><span class="pre">track_to_targetpath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">basepath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">track</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.convert.track_to_targetpath" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.convert.wav_to_mp3">
<span class="sig-prename descclassname"><span class="pre">media.convert.</span></span><span class="sig-name descname"><span class="pre">wav_to_mp3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">infile</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">basepath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">track_information</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">progress_callback</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bitrate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">256</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vbr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quaulity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.convert.wav_to_mp3" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-media.image">
<span id="media-image-module"></span><h2>media.image module<a class="headerlink" href="#module-media.image" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="media.image.image">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">media.image.</span></span><span class="sig-name descname"><span class="pre">image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">media_instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="media.image.image.image_data">
<span class="sig-name descname"><span class="pre">image_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image.image_data" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="media.image.image.join">
<span class="sig-name descname"><span class="pre">join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">join_pos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.7</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image.join" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="media.image.image.load_from_file">
<span class="sig-name descname"><span class="pre">load_from_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">media_instance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image.load_from_file" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="media.image.image.resize">
<span class="sig-name descname"><span class="pre">resize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image.resize" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="media.image.image.rotate_by_orientation">
<span class="sig-name descname"><span class="pre">rotate_by_orientation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">orientation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image.rotate_by_orientation" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="media.image.image.save">
<span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.image.image.save" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-media.metadata">
<span id="media-metadata-module"></span><h2>media.metadata module<a class="headerlink" href="#module-media.metadata" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="media.metadata.get_audio_data">
<span class="sig-prename descclassname"><span class="pre">media.metadata.</span></span><span class="sig-name descname"><span class="pre">get_audio_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.metadata.get_audio_data" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.metadata.get_disc_data">
<span class="sig-prename descclassname"><span class="pre">media.metadata.</span></span><span class="sig-name descname"><span class="pre">get_disc_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_callback</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.metadata.get_disc_data" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.metadata.get_disc_data_dummy">
<span class="sig-prename descclassname"><span class="pre">media.metadata.</span></span><span class="sig-name descname"><span class="pre">get_disc_data_dummy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#media.metadata.get_disc_data_dummy" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.metadata.get_image_data">
<span class="sig-prename descclassname"><span class="pre">media.metadata.</span></span><span class="sig-name descname"><span class="pre">get_image_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.metadata.get_image_data" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.metadata.get_media_data">
<span class="sig-prename descclassname"><span class="pre">media.metadata.</span></span><span class="sig-name descname"><span class="pre">get_media_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_callback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.metadata.get_media_data" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="media.metadata.get_video_data">
<span class="sig-prename descclassname"><span class="pre">media.metadata.</span></span><span class="sig-name descname"><span class="pre">get_video_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#media.metadata.get_video_data" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">media package</a><ul>
<li><a class="reference internal" href="#media-media-tools">media (Media Tools)</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-media.CDDB">media.CDDB module</a><ul>
<li><a class="reference internal" href="#media.CDDB.cddb"><code class="docutils literal notranslate"><span class="pre">cddb()</span></code></a></li>
<li><a class="reference internal" href="#media.CDDB.discid"><code class="docutils literal notranslate"><span class="pre">discid()</span></code></a></li>
<li><a class="reference internal" href="#media.CDDB.my_disc_metadata"><code class="docutils literal notranslate"><span class="pre">my_disc_metadata()</span></code></a></li>
<li><a class="reference internal" href="#media.CDDB.query"><code class="docutils literal notranslate"><span class="pre">query()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.common">media.common module</a><ul>
<li><a class="reference internal" href="#media.common.get_disc_device"><code class="docutils literal notranslate"><span class="pre">get_disc_device()</span></code></a></li>
<li><a class="reference internal" href="#media.common.get_filetype"><code class="docutils literal notranslate"><span class="pre">get_filetype()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.convert">media.convert module</a><ul>
<li><a class="reference internal" href="#media.convert.FilenameFilter"><code class="docutils literal notranslate"><span class="pre">FilenameFilter()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.disc_track_rip"><code class="docutils literal notranslate"><span class="pre">disc_track_rip()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.get_pil_image"><code class="docutils literal notranslate"><span class="pre">get_pil_image()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.track_to_targetpath"><code class="docutils literal notranslate"><span class="pre">track_to_targetpath()</span></code></a></li>
<li><a class="reference internal" href="#media.convert.wav_to_mp3"><code class="docutils literal notranslate"><span class="pre">wav_to_mp3()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.image">media.image module</a><ul>
<li><a class="reference internal" href="#media.image.image"><code class="docutils literal notranslate"><span class="pre">image</span></code></a><ul>
<li><a class="reference internal" href="#media.image.image.image_data"><code class="docutils literal notranslate"><span class="pre">image.image_data()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.join"><code class="docutils literal notranslate"><span class="pre">image.join()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.load_from_file"><code class="docutils literal notranslate"><span class="pre">image.load_from_file()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.resize"><code class="docutils literal notranslate"><span class="pre">image.resize()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.rotate_by_orientation"><code class="docutils literal notranslate"><span class="pre">image.rotate_by_orientation()</span></code></a></li>
<li><a class="reference internal" href="#media.image.image.save"><code class="docutils literal notranslate"><span class="pre">image.save()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-media.metadata">media.metadata module</a><ul>
<li><a class="reference internal" href="#media.metadata.get_audio_data"><code class="docutils literal notranslate"><span class="pre">get_audio_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_disc_data"><code class="docutils literal notranslate"><span class="pre">get_disc_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_disc_data_dummy"><code class="docutils literal notranslate"><span class="pre">get_disc_data_dummy()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_image_data"><code class="docutils literal notranslate"><span class="pre">get_image_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_media_data"><code class="docutils literal notranslate"><span class="pre">get_media_data()</span></code></a></li>
<li><a class="reference internal" href="#media.metadata.get_video_data"><code class="docutils literal notranslate"><span class="pre">get_video_data()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/media.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>
<li><a href="https://www.python.org/">Python</a> &#187;</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
<a href="index.html">media documentation</a> &#187;
</li>
<li class="nav-item nav-item-this"><a href="">media package</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">
<input type="submit" value="Go">
</form>
</div>
|
</li>
<li class="right">
<label class="theme-selector-label">
Theme
<select class="theme-selector" oninput="activateTheme(this.value)">
<option value="auto" selected>Auto</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</label> |</li>
</ul>
</div>
<div class="footer">
&copy;
Copyright
2025, Dirk Alders.
<br>
This page is licensed under the Python Software Foundation License Version 2.
<br>
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
<br>
<br>
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br>
<br>
<br>
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink