sphinx build from Action 8d09c73

python_sdk/_sources/changelog.rst.txt

@@ -13,6 +13,7 @@ Unreleased
 ----------
 
 * Add Setting 125
+* Don't default to hardcoded parameters for set livestream mode
 
 0.16.1 (April-23-2024)
 ----------------------

python_sdk/api.html

@@ -2127,17 +2127,17 @@ <h2>Open GoPro API<a class="headerlink" href="#open-gopro-api" title="Permalink
 
 <dl class="py method">
 <dt class="sig sig-object py" id="open_gopro.api.ble_commands.BleCommands.set_livestream_mode">
-<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_livestream_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</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">window_size</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">minimum_bitrate</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">maximum_bitrate</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">starting_bitrate</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">lens</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">certs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pathlib.Path</span><span class="p"><span class="pre">]</span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#open_gopro.models.response.GoProResp" title="open_gopro.models.response.GoProResp"><span class="pre">GoProResp</span></a><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#open_gopro.api.ble_commands.BleCommands.set_livestream_mode" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_livestream_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</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">minimum_bitrate</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">maximum_bitrate</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">starting_bitrate</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">window_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">lens</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">certs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pathlib.Path</span><span class="p"><span class="pre">]</span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#open_gopro.models.response.GoProResp" title="open_gopro.models.response.GoProResp"><span class="pre">GoProResp</span></a><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#open_gopro.api.ble_commands.BleCommands.set_livestream_mode" title="Permalink to this definition"></a></dt>
 <dd><p>Initiate livestream to any site that accepts an RTMP URL and simultaneously encode to camera.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>url</strong> (<em>str</em>) – url used to stream. Set to empty string to invalidate/cancel stream</p></li>
-<li><p><strong>window_size</strong> (<em>open_gopro.api.proto.EnumWindowSize</em>) – Streaming video resolution</p></li>
 <li><p><strong>minimum_bitrate</strong> (<em>int</em>) – Desired minimum streaming bitrate (&gt;= 800)</p></li>
 <li><p><strong>maximum_bitrate</strong> (<em>int</em>) – Desired maximum streaming bitrate (&lt;= 8000)</p></li>
 <li><p><strong>starting_bitrate</strong> (<em>int</em>) – Initial streaming bitrate (honored if 800 &lt;= value &lt;= 8000)</p></li>
-<li><p><strong>lens</strong> (<em>open_gopro.api.proto.EnumLens</em>) – Streaming Field of View</p></li>
+<li><p><strong>window_size</strong> (<em>open_gopro.api.proto.EnumWindowSize</em><em> | </em><em>None</em>) – Streaming video resolution. Defaults to None (use camera default).</p></li>
+<li><p><strong>lens</strong> (<em>open_gopro.api.proto.EnumLens</em>) – Streaming Field of View. Defaults to None (use camera default).</p></li>
 <li><p><strong>certs</strong> (<em>list</em><em>[</em><em>Path</em><em>] </em><em>| </em><em>None</em>) – list of certificates to use. Defaults to None.</p></li>
 </ul>
 </dd>

python_sdk/changelog.html

@@ -143,6 +143,7 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
 <h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this heading"></a></h2>
 <ul class="simple">
 <li><p>Add Setting 125</p></li>
+<li><p>Don’t default to hardcoded parameters for set livestream mode</p></li>
 </ul>
 </section>
 <section id="april-23-2024">