Update for 2.5.0-beta.2 release

Author: dolbyio-gh-bot

docs/.doctrees/api/sdk/audio.doctree

@@ -61,6 +61,27 @@ The :ref:`api_conference` events that are emitted by the SDK. You can subscribe
 .. doxygenenum:: dolbyio::comms::conference_status
         :project: C++ SDK
 
+.. doxygenstruct:: dolbyio::comms::local_participant_updated
+        :project: C++ SDK
+
+.. doxygenstruct:: dolbyio::comms::remote_participant_updated
+        :project: C++ SDK
+
+.. doxygenstruct:: dolbyio::comms::remote_participant_added
+        :project: C++ SDK
+
+.. doxygenstruct:: dolbyio::comms::local_video_track_added
+        :project: C++ SDK
+
+.. doxygenstruct:: dolbyio::comms::local_video_track_removed
+        :project: C++ SDK
+
+.. doxygenstruct:: dolbyio::comms::remote_video_track_added
+        :project: C++ SDK
+
+.. doxygenstruct:: dolbyio::comms::remote_video_track_removed
+        :project: C++ SDK
+
 .. doxygenstruct:: dolbyio::comms::participant_added
         :project: C++ SDK
 

docs/.doctrees/api/sdk/conference.doctree

@@ -406,11 +406,8 @@ <h2>Audio Processing<a class="headerlink" href="#audio-processing" title="Permal
 <span id="_CPPv3NK7dolbyio5comms18audio_capture_mode11unprocessedeqERK11unprocessed"></span><span id="_CPPv2NK7dolbyio5comms18audio_capture_mode11unprocessedeqERK11unprocessed"></span><span id="dolbyio::comms::audio_capture_mode::unprocessed::eq-operator__unprocessedCRC"></span><span class="target" id="structdolbyio_1_1comms_1_1audio__capture__mode_1_1unprocessed_1aeff0832d385bb37da4cb1ff0dd73539a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">==</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N7dolbyio5comms18audio_capture_mode11unprocessedE" title="dolbyio::comms::audio_capture_mode::unprocessed"><span class="n"><span class="pre">unprocessed</span></span></a><span class="p"><span class="pre">&amp;</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms18audio_capture_mode11unprocessedeqERK11unprocessed" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Compare operator for comparison against other unprocessed audio capture mode. </p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>other</strong> – The unprocessed audio capture modemode to be compared against </p>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>true if the other structure is of the same type </p>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>true if the other structure is of the same type </p>
 </dd>
 </dl>
 </dd></dl>
@@ -450,7 +447,7 @@ <h2>Audio Processing<a class="headerlink" href="#audio-processing" title="Permal
 <dd><p>Compare operator for comparison against other standard audio capture mode. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>other</strong> – The standard audio capture mode to be compared against </p>
+<dd class="field-odd"><p><strong>rhs</strong> – The standard audio capture mode to be compared against </p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>true if the other denotes the same mode as this, false otherwise. </p>

docs/.doctrees/api/sdk/sdk.doctree

@@ -216,6 +216,9 @@
 <dd><p>Registers the component version for internal telemetry. </p>
 <p>The component name and version are free-form strings, which will be added to the Dolby.io telemetry reports. If a component with given name has already been registered with a different version, this method fails and returns error information asynchronously.</p>
 <p><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">sdk</span><span class="o">-&gt;</span><span class="n">register_component_version</span><span class="p">(</span><span class="s">&quot;MyApp&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.0.0&quot;</span><span class="p">)</span>
+<span class="w">     </span><span class="p">.</span><span class="n">then</span><span class="p">([](</span><span class="n">sdk</span><span class="o">::</span><span class="n">component_data</span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">data</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
+<span class="w">       </span><span class="n">component_logger_</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">move</span><span class="p">(</span><span class="n">data</span><span class="p">.</span><span class="n">logger</span><span class="p">);</span>
+<span class="w">     </span><span class="p">})</span>
 <span class="w">     </span><span class="p">.</span><span class="n">on_error</span><span class="p">([](</span><span class="k">auto</span><span class="o">&amp;&amp;</span><span class="p">){</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">cerr</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;Failed to register my app to</span>
 <span class="n">telemetry</span><span class="s">&quot; &lt;&lt; std::endl; }); </span>
 </pre></div>
@@ -395,12 +398,14 @@
 <dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms3sdk14component_dataE">
 <span id="_CPPv3N7dolbyio5comms3sdk14component_dataE"></span><span id="_CPPv2N7dolbyio5comms3sdk14component_dataE"></span><span id="dolbyio::comms::sdk::component_data"></span><span class="target" id="structdolbyio_1_1comms_1_1sdk_1_1component__data"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">component_data</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms3sdk14component_dataE" title="Permalink to this definition"></a><br /></dt>
-<dd><div class="breathe-sectiondef docutils container">
+<dd><p>Component specific data returned by the SDK when the components is registered. </p>
+<div class="breathe-sectiondef docutils container">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms3sdk14component_data6loggerE">
 <span id="_CPPv3N7dolbyio5comms3sdk14component_data6loggerE"></span><span id="_CPPv2N7dolbyio5comms3sdk14component_data6loggerE"></span><span id="dolbyio::comms::sdk::component_data::logger__std::shared_ptr:logger_sink:"></span><span class="target" id="structdolbyio_1_1comms_1_1sdk_1_1component__data_1a8592d8ee6aa90f456e4586960e8eac57"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">logger_sink</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">logger</span></span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms3sdk14component_data6loggerE" title="Permalink to this definition"></a><br /></dt>
-<dd></dd></dl>
+<dd><p>Shared pointer to the logger instance created for the component when it is registered with the SDK. This can be used to log using the SDK logger and thus log to the same file as the SDK. </p>
+</dd></dl>
 
 </div>
 </dd></dl>

docs/.doctrees/api/sdk/session.doctree

@@ -190,6 +190,34 @@
 </dl>
 </dd></dl>
 
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms8services7session6updateERR9user_info">
+<span id="_CPPv3N7dolbyio5comms8services7session6updateERR9user_info"></span><span id="_CPPv2N7dolbyio5comms8services7session6updateERR9user_info"></span><span id="dolbyio::comms::services::session::update__user_infoRR"></span><span class="target" id="classdolbyio_1_1comms_1_1services_1_1session_1abe1ca221977f2e09ab3b86f8f6a64fbc"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="common/async_ops.html#_CPPv4I0EN7dolbyio5comms12async_resultE" title="dolbyio::comms::async_result"><span class="n"><span class="pre">async_result</span></span></a><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms8services7session9user_infoE" title="dolbyio::comms::services::session::user_info"><span class="n"><span class="pre">user_info</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">update</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N7dolbyio5comms8services7session9user_infoE" title="dolbyio::comms::services::session::user_info"><span class="n"><span class="pre">user_info</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identification</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms8services7session6updateERR9user_info" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Updates the metadata of a logged in user. </p>
+<p><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="c1">// Synchronous approach:</span>
+<span class="k">auto</span><span class="w"> </span><span class="n">info</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">wait</span><span class="p">(</span><span class="n">sdk</span><span class="o">-&gt;</span><span class="n">session</span><span class="p">().</span><span class="n">update</span><span class="p">(</span><span class="n">identification</span><span class="p">));</span>
+
+<span class="c1">// Asynchronous approach:</span>
+<span class="n">sdk</span><span class="o">-&gt;</span><span class="n">session</span><span class="p">().</span><span class="n">update</span><span class="p">(</span><span class="n">identification</span><span class="p">)</span>
+<span class="w">  </span><span class="p">.</span><span class="n">then</span><span class="p">([](</span><span class="k">auto</span><span class="o">&amp;&amp;</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
+<span class="w">    </span><span class="c1">// The user has been updated.</span>
+<span class="w">  </span><span class="p">})</span>
+<span class="w">  </span><span class="p">.</span><span class="n">on_error</span><span class="p">([](</span><span class="k">auto</span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">e</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
+<span class="w">    </span><span class="c1">// handle exception</span>
+<span class="w">  </span><span class="p">});</span>
+</pre></div>
+</div>
+ </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>identification</strong> – Information about the participant who tries to open a session. Only the name and avatarUrl are updated, other fields of the user identification are ignored.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The result object producing the new <a class="reference internal" href="#structdolbyio_1_1comms_1_1services_1_1session_1_1user__info"><span class="std std-ref">user_info</span></a> asynchronously.</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms8services7session5closeEv">
 <span id="_CPPv3N7dolbyio5comms8services7session5closeEv"></span><span id="_CPPv2N7dolbyio5comms8services7session5closeEv"></span><span id="dolbyio::comms::services::session::close"></span><span class="target" id="classdolbyio_1_1comms_1_1services_1_1session_1ac4e0694e4188431d063428857e58a078"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="common/async_ops.html#_CPPv4I0EN7dolbyio5comms12async_resultE" title="dolbyio::comms::async_result"><span class="n"><span class="pre">async_result</span></span></a><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">void</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">close</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N7dolbyio5comms8services7session5closeEv" title="Permalink to this definition"></a><br /></dt>