Xtao-Labs/xtaothon
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
cc0ccddd30
xtaothon/docs/api/methods/download_media.html

293 lines
12 KiB
HTML
Raw Normal View History

🔨 Conduct the first construction
2021-06-11 12:08:29 +00:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>download_media() &mdash; Xtaothon Documentation</title>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="canonical" href="https://docs.xtaolabs.com/api/methods/download_media.html"/>
<script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script>
<script src="../../_static/translations.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="../../_static/tabs.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="索引" href="../../genindex.html" />
<link rel="search" title="搜索" href="../../search.html" />
<link rel="next" title="get_me()" href="get_me.html" />
<link rel="prev" title="send_file()" href="send_file.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html">
<img src="../../_static/xtaothon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">简介</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../intro/quickstart.html">快速开始</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../intro/install.html">安装指南</a></li>
</ul>
<p class="caption"><span class="caption-text">开始</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../start/auth.html">授权</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../start/invoking.html">调用方法</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../start/updates.html">处理消息</a></li>
</ul>
<p class="caption"><span class="caption-text">API</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../client.html">客户端</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">可用方法</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index.html#id3">基础</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#id4">消息</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#id5">上传</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html#id6">下载</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">download_media</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="index.html#id7">用户</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../types/index.html">可用类型</a></li>
<li class="toctree-l1"><a class="reference internal" href="../bound-methods/index.html">绑定方法</a></li>
<li class="toctree-l1"><a class="reference internal" href="../handlers.html">消息更新处理器</a></li>
</ul>
<p class="caption"><span class="caption-text">主题指南</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../topics/proxy.html">SOCKS5 Proxy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../topics/text-formatting.html">文本格式</a></li>
</ul>
<p class="caption"><span class="caption-text">更多</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">常见短语</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../support.html">支持 Xtaothon</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">xtaothon</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="index.html">可用方法</a> &raquo;</li>
<li>download_media()</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/Xtao-Labs/docs-all" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="download-media">
<h1>download_media()<a class="headerlink" href="#download-media" title="永久链接至标题"></a></h1>
<dl class="py method">
<dt id="telethon.Client.download_media">
<code class="sig-prename descclassname"><span class="pre">Client.</span></code><code class="sig-name descname"><span class="pre">download_media</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#telethon.Client.download_media" title="永久链接至目标"></a></dt>
<dd><p>下载消息对象包含的媒体文件。</p>
<div class="admonition note">
<p class="admonition-title">注解</p>
<p>如果下载太慢，则应考虑安装 <code class="docutils literal notranslate"><span class="pre">cryptg</span></code> （<code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">cryptg</span></code>）</p>
</div>
<dl class="simple">
<dt>参数:</dt><dd><dl class="simple">
<dt>entity (<a class="reference internal" href="../types/user.html#telethon.tl.types.user" title="telethon.tl.types.user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">user</span></code></a> | <a class="reference internal" href="../types/chat.html#telethon.tl.types.chat" title="telethon.tl.types.chat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">chat</span></code></a> | <a class="reference internal" href="../types/channel.html#telethon.tl.types.channel" title="telethon.tl.types.channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">channel</span></code></a>):</dt><dd><p>需要发送文件的对话的对象。</p>
</dd>
<dt>file (<code class="docutils literal notranslate"><span class="pre">str</span></code> | <code class="docutils literal notranslate"><span class="pre">file</span></code>):</dt><dd><p>输出文件路径，目录或流等对象。如果该路径存在并且是文件，则将覆盖。</p>
</dd>
</dl>
</dd>
<dt>返回:</dt><dd><p>None: 如果消息中不存在媒体文件，如果为指定路径则将返回文件路径。</p>
</dd>
</dl>
<p class="rubric">示例</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">path</span> <span class="o">=</span> <span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">download_media</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">download_media</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
<span class="c1"># 或者</span>
<span class="n">path</span> <span class="o">=</span> <span class="k">await</span> <span class="n">message</span><span class="o">.</span><span class="n">download_media</span><span class="p">()</span>
<span class="k">await</span> <span class="n">message</span><span class="o">.</span><span class="n">download_media</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="c1"># 提示下载进度</span>
<span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="n">current</span><span class="p">,</span> <span class="n">total</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Downloaded&#39;</span><span class="p">,</span> <span class="n">current</span><span class="p">,</span> <span class="s1">&#39;out of&#39;</span><span class="p">,</span> <span class="n">total</span><span class="p">,</span>
<span class="s1">&#39;bytes: </span><span class="si">{:.2%}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">current</span> <span class="o">/</span> <span class="n">total</span><span class="p">))</span>
<span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">download_media</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">progress_callback</span><span class="o">=</span><span class="n">callback</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="get_me.html" class="btn btn-neutral float-right" title="get_me()" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="send_file.html" class="btn btn-neutral float-left" title="send_file()" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(false);
});
</script>
</body>
</html>
Reference in New Issue Copy Permalink