Skip to content

Commit

Permalink
Update docs for 6.1.4
Browse files Browse the repository at this point in the history
  • Loading branch information
isaackogan committed Sep 19, 2024
1 parent 22e7ec2 commit 4c02ade
Show file tree
Hide file tree
Showing 41 changed files with 1,035 additions and 599 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 5a7bf3055a0ce28632330d61d04dd3f1
config: 807a66e13cf6a0ff4d957c5b8e669176
tags: 645f666f9bcd5a90fca523b33c5a78b7
54 changes: 48 additions & 6 deletions docs/TikTokLive.client.html

Large diffs are not rendered by default.

129 changes: 122 additions & 7 deletions docs/TikTokLive.client.web.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/TikTokLive.client.web.routes.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.client.ws package" href="TikTokLive.client.ws.html" /><link rel="prev" title="TikTokLive.client.web package" href="TikTokLive.client.web.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.client.web.routes package - TikTokLive v6.1.2</title>
<title>TikTokLive.client.web.routes package - TikTokLive v6.1.4</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />

Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.1.2</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.1.4</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.1.2</span>
<span class="sidebar-brand-text">TikTokLive v6.1.4</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -818,7 +818,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
<script src="_static/js/rtd_search_config.js"></script>
<script src="_static/js/rtd_sphinx_search.min.js"></script>
<script src="_static/js/rtd_search_config.js?v=b0596c34"></script>
<script src="_static/js/rtd_sphinx_search.min.js?v=5e065386"></script>
</body>
</html>
14 changes: 7 additions & 7 deletions docs/TikTokLive.client.ws.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.events package" href="TikTokLive.events.html" /><link rel="prev" title="TikTokLive.client.web.routes package" href="TikTokLive.client.web.routes.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.client.ws package - TikTokLive v6.1.2</title>
<title>TikTokLive.client.ws package - TikTokLive v6.1.4</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />

Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.1.2</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.1.4</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.1.2</span>
<span class="sidebar-brand-text">TikTokLive v6.1.4</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -276,7 +276,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py class">
<dt class="sig sig-object py" id="TikTokLive.client.ws.ws_client.WebcastWSClient">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.ws.ws_client.</span></span><span class="sig-name descname"><span class="pre">WebcastWSClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ws_kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Proxy</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.client.ws.ws_client.WebcastWSClient" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.ws.ws_client.</span></span><span class="sig-name descname"><span class="pre">WebcastWSClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ws_kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Proxy</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.client.ws.ws_client.WebcastWSClient" 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>
<p>Websocket client responsible for connections to TikTok</p>
<dl class="py method">
Expand Down Expand Up @@ -501,7 +501,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
<script src="_static/js/rtd_search_config.js"></script>
<script src="_static/js/rtd_sphinx_search.min.js"></script>
<script src="_static/js/rtd_search_config.js?v=b0596c34"></script>
<script src="_static/js/rtd_sphinx_search.min.js?v=5e065386"></script>
</body>
</html>
16 changes: 8 additions & 8 deletions docs/TikTokLive.events.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.proto package" href="TikTokLive.proto.html" /><link rel="prev" title="TikTokLive.client.ws package" href="TikTokLive.client.ws.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.events package - TikTokLive v6.1.2</title>
<title>TikTokLive.events package - TikTokLive v6.1.4</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />

Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.1.2</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.1.4</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.1.2</span>
<span class="sidebar-brand-text">TikTokLive v6.1.4</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -302,12 +302,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<span id="tiktoklive-events-custom-events-module"></span><h2>TikTokLive.events.custom_events module<a class="headerlink" href="#module-TikTokLive.events.custom_events" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="TikTokLive.events.custom_events.ConnectEvent">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.events.custom_events.</span></span><span class="sig-name descname"><span class="pre">ConnectEvent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unique_id</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">room_id</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="#TikTokLive.events.custom_events.ConnectEvent" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.events.custom_events.</span></span><span class="sig-name descname"><span class="pre">ConnectEvent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unique_id</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">room_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.events.custom_events.ConnectEvent" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#TikTokLive.events.base_event.BaseEvent" title="TikTokLive.events.base_event.BaseEvent"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseEvent</span></code></a></p>
<p>Manually thrown whenever a connection is started</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="TikTokLive.events.custom_events.ConnectEvent.room_id">
<span class="sig-name descname"><span class="pre">room_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#TikTokLive.events.custom_events.ConnectEvent.room_id" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">room_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#TikTokLive.events.custom_events.ConnectEvent.room_id" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
Expand Down Expand Up @@ -770,7 +770,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
<script src="_static/js/rtd_search_config.js"></script>
<script src="_static/js/rtd_sphinx_search.min.js"></script>
<script src="_static/js/rtd_search_config.js?v=b0596c34"></script>
<script src="_static/js/rtd_sphinx_search.min.js?v=5e065386"></script>
</body>
</html>
14 changes: 8 additions & 6 deletions docs/TikTokLive.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.client package" href="TikTokLive.client.html" /><link rel="prev" title="TikTokLive Docs" href="index.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive package - TikTokLive v6.1.2</title>
<title>TikTokLive package - TikTokLive v6.1.4</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />

Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.1.2</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.1.4</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.1.2</span>
<span class="sidebar-brand-text">TikTokLive v6.1.4</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -274,6 +274,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.html#module-TikTokLive.client.web.web_base">TikTokLive.client.web.web_base module</a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.html#module-TikTokLive.client.web.web_client">TikTokLive.client.web.web_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.html#module-TikTokLive.client.web.web_presets">TikTokLive.client.web.web_presets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.html#module-TikTokLive.client.web.web_settings">TikTokLive.client.web.web_settings module</a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.html#module-TikTokLive.client.web">Module contents</a></li>
</ul>
Expand All @@ -294,6 +295,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.connected"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.connected</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.disconnect"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.disconnect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.gift_info"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.gift_info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.handle_custom_event"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.handle_custom_event()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.has_listener"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.has_listener()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.is_live"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.is_live()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.logger"><code class="docutils literal notranslate"><span class="pre">TikTokLiveClient.logger</span></code></a></li>
Expand Down Expand Up @@ -2839,7 +2841,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
<script src="_static/js/rtd_search_config.js"></script>
<script src="_static/js/rtd_sphinx_search.min.js"></script>
<script src="_static/js/rtd_search_config.js?v=b0596c34"></script>
<script src="_static/js/rtd_sphinx_search.min.js?v=5e065386"></script>
</body>
</html>
Loading

0 comments on commit 4c02ade

Please sign in to comment.