Update docs v6.0.1

.gitignore

@@ -7,4 +7,3 @@ dev
 test.py
 .env
 build
-requirements.txt

docs/TikTokLive.client.web.html

@@ -11,7 +11,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <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=36a5483c" />
-    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=2c2e2638" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />
 
 
 

docs/TikTokLive.client.web.routes.html

@@ -11,7 +11,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <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=36a5483c" />
-    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=2c2e2638" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />
 
 
 
@@ -340,7 +340,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.web.routes.fetch_sign.SignFetchRoute">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.web.routes.fetch_sign.</span></span><span class="sig-name descname"><span class="pre">SignFetchRoute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">web</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="TikTokLive.client.web.html#TikTokLive.client.web.web_base.TikTokHTTPClient" title="TikTokLive.client.web.web_base.TikTokHTTPClient"><span class="pre">TikTokHTTPClient</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.client.web.routes.fetch_sign.SignFetchRoute" 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.web.routes.fetch_sign.</span></span><span class="sig-name descname"><span class="pre">SignFetchRoute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">web</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="TikTokLive.client.web.html#TikTokLive.client.web.web_base.TikTokHTTPClient" title="TikTokLive.client.web.web_base.TikTokHTTPClient"><span class="pre">TikTokHTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign_api_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.client.web.routes.fetch_sign.SignFetchRoute" title="Link to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference internal" href="TikTokLive.client.web.html#TikTokLive.client.web.web_base.ClientRoute" title="TikTokLive.client.web.web_base.ClientRoute"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClientRoute</span></code></a></p>
 <p>Call the signature server to receive the TikTok websocket URL</p>
 </dd></dl>

docs/TikTokLive.html

@@ -11,7 +11,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <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=36a5483c" />
-    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=2c2e2638" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=ff85bd92" />
 
 
 

docs/genindex.html

@@ -2076,6 +2076,8 @@ <h2>I</h2>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastResponseMessage.is_history">is_history (TikTokLive.proto.tiktok_proto.WebcastResponseMessage attribute)</a>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.UserSubscribeInfo.is_in_grace_period">is_in_grace_period (TikTokLive.proto.tiktok_proto.UserSubscribeInfo attribute)</a>
+</li>
+        <li><a href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.is_live">is_live() (TikTokLive.client.client.TikTokLiveClient method)</a>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.UserIdentity.is_moderator_of_anchor">is_moderator_of_anchor (TikTokLive.proto.tiktok_proto.UserIdentity attribute)</a>
 </li>
@@ -2158,6 +2160,8 @@ <h2>J</h2>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.MemberMessageAction.JOINED">JOINED (TikTokLive.proto.tiktok_proto.MemberMessageAction attribute)</a>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.JoinDirectContent.joiner">joiner (TikTokLive.proto.tiktok_proto.JoinDirectContent attribute)</a>
+</li>
+        <li><a href="TikTokLive.events.html#TikTokLive.events.proto_events.JoinEvent">JoinEvent (class in TikTokLive.events.proto_events)</a>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.JoinGroupContent">JoinGroupContent (class in TikTokLive.proto.tiktok_proto)</a>
 </li>
@@ -2560,8 +2564,6 @@ <h2>M</h2>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastLinkMessage.media_change_content">media_change_content (TikTokLive.proto.tiktok_proto.WebcastLinkMessage attribute)</a>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.WebcastMemberMessage.member_count">member_count (TikTokLive.proto.tiktok_proto.WebcastMemberMessage attribute)</a>
-</li>
-        <li><a href="TikTokLive.events.html#TikTokLive.events.proto_events.MemberEvent">MemberEvent (class in TikTokLive.events.proto_events)</a>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.MemberMessageAction">MemberMessageAction (class in TikTokLive.proto.tiktok_proto)</a>
 </li>
@@ -4192,9 +4194,11 @@ <h2>U</h2>
 </li>
         <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.UserEcommerceEntranceCreatorType.UNDEFINED">UNDEFINED (TikTokLive.proto.tiktok_proto.UserEcommerceEntranceCreatorType attribute)</a>
 </li>
-        <li><a href="TikTokLive.events.html#TikTokLive.events.custom_events.ConnectEvent.unique_id">unique_id (TikTokLive.events.custom_events.ConnectEvent attribute)</a>
+        <li><a href="TikTokLive.client.html#TikTokLive.client.client.TikTokLiveClient.unique_id">unique_id (TikTokLive.client.client.TikTokLiveClient property)</a>
 
         <ul>
+          <li><a href="TikTokLive.events.html#TikTokLive.events.custom_events.ConnectEvent.unique_id">(TikTokLive.events.custom_events.ConnectEvent attribute)</a>
+</li>
           <li><a href="TikTokLive.proto.html#TikTokLive.proto.custom_proto.ExtendedUser.unique_id">(TikTokLive.proto.custom_proto.ExtendedUser property)</a>
 </li>
           <li><a href="TikTokLive.proto.html#TikTokLive.proto.tiktok_proto.CommonLiveMessageSei.unique_id">(TikTokLive.proto.tiktok_proto.CommonLiveMessageSei attribute)</a>

docs/index.html

@@ -247,24 +247,26 @@ <h2>TikTokLive<a class="headerlink" href="#tiktoklive" title="Link to this headi
 <h3>Consider Donating &lt;3<a class="headerlink" href="#consider-donating-3" title="Link to this heading">#</a></h3>
 <p>I’m a 2nd-year Biology student in university who likes to program for fun. Please consider supporting development
 through a small donation at <a class="reference external" href="https://www.buymeacoffee.com/isaackogan">https://www.buymeacoffee.com/isaackogan</a>. Anything
-you can offer will go towards school &amp; development costs for TikTokLive.</p>
+you can offer will go towards school &amp; development costs for TikTokLive, which has taken hundreds of hours of time to build.</p>
 </section>
 <section id="other-languages">
 <h3>Other Languages<a class="headerlink" href="#other-languages" title="Link to this heading">#</a></h3>
-<p>TikTok LIVE is available in several alternate programming languages:</p>
+<p>TikTokLive is available in several alternate programming languages:</p>
 <ul class="simple">
 <li><p><strong>Node.JS:</strong> <a class="reference external" href="https://github.com/zerodytrash/TikTok-Live-Connector">https://github.com/zerodytrash/TikTok-Live-Connector</a></p></li>
 <li><p><strong>Java:</strong> <a class="reference external" href="https://github.com/jwdeveloper/TikTok-Live-Java">https://github.com/jwdeveloper/TikTok-Live-Java</a></p></li>
 <li><p><strong>C#/Unity:</strong> <a class="reference external" href="https://github.com/frankvHoof93/TikTokLiveSharp">https://github.com/frankvHoof93/TikTokLiveSharp</a></p></li>
 <li><p><strong>Go:</strong> <a class="reference external" href="https://github.com/Davincible/gotiktoklive">https://github.com/Davincible/gotiktoklive</a></p></li>
+<li><p><strong>Rust:</strong> <a class="reference external" href="https://github.com/jwdeveloper/TikTokLiveRust">https://github.com/jwdeveloper/TikTokLiveRust</a></p></li>
 </ul>
 </section>
 <section id="table-of-contents">
 <h3>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link to this heading">#</a></h3>
 <ul class="simple">
 <li><p><a class="reference external" href="https://isaackogan.github.io/TikTokLive/">Documentation</a></p></li>
-<li><p><a class="reference external" href="#license">Licensing</a></p></li>
 <li><p><a class="reference external" href="https://github.com/isaackogan/TikTokLive/tree/master/examples">Examples</a></p></li>
+<li><p><a class="reference external" href="https://github.com/isaackogan/TikTokLive/wiki">Wiki</a></p></li>
+<li><p><a class="reference external" href="#license">Licensing</a></p></li>
 <li><p><a class="reference external" href="#contributors">Contributors</a></p></li>
 </ul>
 </section>
@@ -273,7 +275,7 @@ <h3>Getting Started<a class="headerlink" href="#getting-started" title="Link to
 <ol class="arabic simple">
 <li><p>Install the module via pip from the <a class="reference external" href="https://pypi.org/project/TikTokLive/">PyPi</a> repository</p></li>
 </ol>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>TikTokLive
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>TikTokLive
 </pre></div>
 </div>
 <ol class="arabic simple" start="2">
@@ -323,7 +325,7 @@ <h3>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
 <tr class="row-even"><td><p>unique_id</p></td>
 <td><p>Yes</p></td>
 <td><p>N/A</p></td>
-<td><p>The unique username of the broadcaster. You can find this name in the URL of the user. For example, the <code class="docutils literal notranslate"><span class="pre">unique_id</span></code> for <code class="docutils literal notranslate"><span class="pre">https://www.tiktok.com/&#64;isaackogz/live</span></code> would be <code class="docutils literal notranslate"><span class="pre">isaackogz</span></code>.</p></td>
+<td><p>The unique username of the broadcaster. You can find this name in the URL of the user. For example, the <code class="docutils literal notranslate"><span class="pre">unique_id</span></code> for <a class="reference external" href="https://www.tiktok.com/&#64;isaackogz"><code class="docutils literal notranslate"><span class="pre">https://www.tiktok.com/&#64;isaackogz</span></code></a> would be <code class="docutils literal notranslate"><span class="pre">isaackogz</span></code>.</p></td>
 </tr>
 <tr class="row-odd"><td><p>web_proxy</p></td>
 <td><p>No</p></td>
@@ -572,6 +574,11 @@ <h4><code class="docutils literal notranslate"><span class="pre">SubscribeEvent<
 You can set the session ID with <a class="reference external" href="https://github.com/isaackogan/TikTokLive/blob/master/examples/logged_in.py"><code class="docutils literal notranslate"><span class="pre">client.web.set_session_id(...)</span></code></a>.</p>
 </section>
 </section>
+<section id="checking-if-a-user-is-live">
+<h3>Checking If A User Is Live<a class="headerlink" href="#checking-if-a-user-is-live" title="Link to this heading">#</a></h3>
+<p>It is considered inefficient to use the connect method to check if a user is live. It is better to use the dedicated <code class="docutils literal notranslate"><span class="pre">await</span> <span class="pre">client.is_live()</span></code> method.</p>
+<p>There is a <a class="reference external" href="https://github.com/isaackogan/TikTokLive/blob/master/examples/check_live.py">complete example</a> of how to do this in the <a class="reference external" href="https://github.com/isaackogan/TikTokLive/tree/master/examples">examples</a> folder.</p>
+</section>
 <section id="contributors">
 <h3>Contributors<a class="headerlink" href="#contributors" title="Link to this heading">#</a></h3>
 <ul class="simple">
@@ -653,6 +660,7 @@ <h3>License<a class="headerlink" href="#license" title="Link to this heading">#<
 <li><a class="reference internal" href="#subscribeevent"><code class="docutils literal notranslate"><span class="pre">SubscribeEvent</span></code></a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#checking-if-a-user-is-live">Checking If A User Is Live</a></li>
 <li><a class="reference internal" href="#contributors">Contributors</a></li>
 <li><a class="reference internal" href="#license">License</a></li>
 </ul>