Update API User Guide Doc

zhonghong322 · zhonghong322 · commit 6e6858a9c8f0 · 2025-08-13T16:34:51.000+08:00
diff --git a/docs/README.html b/docs/README.html
@@ -339,7 +339,7 @@ <h1>定制化部分<a class="headerlink" href="#id6" title="Link to this heading
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/_sources/source/1_overview/Introduction.md.txt b/docs/_sources/source/1_overview/Introduction.md.txt
@@ -1,9 +1,9 @@
 # Introduction
 
-Python Wrapper bindings for the Orbbec SDK，enabling developers to interface with Orbbec devices using Python.
-With the major update of the new branch v2-main in October 2024, python Wrapper is connected to the open source version of [Orbbec SDK v2](https://github.com/orbbec/OrbbecSDK_v2),  which will make python Wrapper more flexible and extensible.
+Python Wrapper bindings for the Orbbec SDK, enabling developers to interface with Orbbec devices using Python.
+With the major update of the new branch v2-main in October 2024, Python Wrapper is connected to the open source version of [Orbbec SDK v2](https://github.com/orbbec/OrbbecSDK_v2),  which will make Python Wrapper more flexible and extensible.
 
-This update in v2-main ensures compatibility with all new Orbbec USB products that comply with the UVC standard. However, python Wrapper v2 no longer supports Orbbec's traditional OpenNI protocol devices. We encourage you to check whether your device is supported by python Wrapper v2 and use the new version if supported.
+This update in v2-main ensures compatibility with all new Orbbec USB products that comply with the UVC standard. However, Python Wrapper v2 no longer supports Orbbec's traditional OpenNI protocol devices. We encourage you to check whether your device is supported by Python Wrapper v2 and use the new version if supported.
 
 The Python Wrapper uses pybind11 to convert the interfaces of the Orbbec SDK into Python interfaces.
 
@@ -14,7 +14,7 @@ The Python Wrapper uses pybind11 to convert the interfaces of the Orbbec SDK int
 
 ## Support Hardware Products
 
-This document is based on the v2-main branch code, which is a Python wrapper built on Orbbec SDK v2. It supports the following devices.
+This document is based on the v2-main branch code, which is a Python Wrapper built on Orbbec SDK v2. It supports the following devices.
 If your device is included in this supported list, we recommend using the v2-main branch. If not, you can use the main branch instead.
 
 | **Products List** | **Minimal Firmware Version** |
diff --git a/docs/_sources/source/1_overview/OrbbecSDK_Overview.md.txt b/docs/_sources/source/1_overview/OrbbecSDK_Overview.md.txt
@@ -1,6 +1,6 @@
 # Orbbec SDK Overview
 
-This section introduces the Orbbec SDK in C++. Its architecture and concepts are consistent with those of the Python wrapper.
+This section introduces the Orbbec SDK in C++. Its architecture and concepts are consistent with those of the Python Wrapper.
 
 ## Terms
 
diff --git a/docs/_sources/source/2_installation/install_the_package.md.txt b/docs/_sources/source/2_installation/install_the_package.md.txt
@@ -5,7 +5,7 @@
 Make sure Python is installed on your local system, and that your Python version is 3.8 or higher.
 
 ### Download the Appropriate .whl Package
-Download the .whl installation package that matches your local Python version from the [Python SDK Wrapper Release](https://github.com/orbbec/pyorbbecsdk/releases)
+Download the .whl installation package that matches your local Python version from the [Python Wrapper Release](https://github.com/orbbec/pyorbbecsdk/releases)
 
 First, check your Python version:
 
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -271,7 +271,7 @@ <h1 id="index">Index</h1>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/index.html b/docs/index.html
@@ -380,7 +380,7 @@ <h1>Orbbec SDK V2 Python Wrapper<a class="headerlink" href="#orbbec-sdk-v2-pytho
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/search.html b/docs/search.html
@@ -279,7 +279,7 @@
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/1_overview/Introduction.html b/docs/source/1_overview/Introduction.html
@@ -262,17 +262,17 @@
              
   <section id="introduction">
 <h1><span class="section-number">1.1. </span>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h1>
-<p>Python Wrapper bindings for the Orbbec SDK，enabling developers to interface with Orbbec devices using Python.
-With the major update of the new branch v2-main in October 2024, python Wrapper is connected to the open source version of <a class="reference external" href="https://github.com/orbbec/OrbbecSDK_v2">Orbbec SDK v2</a>,  which will make python Wrapper more flexible and extensible.</p>
-<p>This update in v2-main ensures compatibility with all new Orbbec USB products that comply with the UVC standard. However, python Wrapper v2 no longer supports Orbbec’s traditional OpenNI protocol devices. We encourage you to check whether your device is supported by python Wrapper v2 and use the new version if supported.</p>
+<p>Python Wrapper bindings for the Orbbec SDK, enabling developers to interface with Orbbec devices using Python.
+With the major update of the new branch v2-main in October 2024, Python Wrapper is connected to the open source version of <a class="reference external" href="https://github.com/orbbec/OrbbecSDK_v2">Orbbec SDK v2</a>,  which will make Python Wrapper more flexible and extensible.</p>
+<p>This update in v2-main ensures compatibility with all new Orbbec USB products that comply with the UVC standard. However, Python Wrapper v2 no longer supports Orbbec’s traditional OpenNI protocol devices. We encourage you to check whether your device is supported by Python Wrapper v2 and use the new version if supported.</p>
 <p>The Python Wrapper uses pybind11 to convert the interfaces of the Orbbec SDK into Python interfaces.</p>
 <ul class="simple">
 <li><p>The implementation principle of the Python Wrapper is as follows:</p></li>
 </ul>
 <p><img alt="python_principle" src="../../_images/python_principle.png" /></p>
 <section id="support-hardware-products">
 <h2><span class="section-number">1.1.1. </span>Support Hardware Products<a class="headerlink" href="#support-hardware-products" title="Link to this heading"></a></h2>
-<p>This document is based on the v2-main branch code, which is a Python wrapper built on Orbbec SDK v2. It supports the following devices.
+<p>This document is based on the v2-main branch code, which is a Python Wrapper built on Orbbec SDK v2. It supports the following devices.
 If your device is included in this supported list, we recommend using the v2-main branch. If not, you can use the main branch instead.</p>
 <table border="1" class="docutils">
 <thead>
@@ -480,7 +480,7 @@ <h2><span class="section-number">1.1.2. </span>Support Platforms<a class="header
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/1_overview/OrbbecSDK_Overview.html b/docs/source/1_overview/OrbbecSDK_Overview.html
@@ -262,7 +262,7 @@
              
   <section id="orbbec-sdk-overview">
 <h1><span class="section-number">1.2. </span>Orbbec SDK Overview<a class="headerlink" href="#orbbec-sdk-overview" title="Link to this heading"></a></h1>
-<p>This section introduces the Orbbec SDK in C++. Its architecture and concepts are consistent with those of the Python wrapper.</p>
+<p>This section introduces the Orbbec SDK in C++. Its architecture and concepts are consistent with those of the Python Wrapper.</p>
 <section id="terms">
 <h2><span class="section-number">1.2.1. </span>Terms<a class="headerlink" href="#terms" title="Link to this heading"></a></h2>
 <table border="1" class="docutils">
@@ -460,7 +460,7 @@ <h2><span class="section-number">1.2.4. </span>SDK Programming Model<a class="he
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/1_overview/overview.html b/docs/source/1_overview/overview.html
@@ -294,7 +294,7 @@ <h1><span class="section-number">1. </span>Overview<a class="headerlink" href="#
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/2_installation/build_the_package.html b/docs/source/2_installation/build_the_package.html
@@ -446,7 +446,7 @@ <h3><span class="section-number">2.3.3.5. </span>Test Examples<a class="headerli
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/2_installation/install_the_package.html b/docs/source/2_installation/install_the_package.html
@@ -270,7 +270,7 @@ <h3><span class="section-number">2.2.1.1. </span>Prerequisites<a class="headerli
 </section>
 <section id="download-the-appropriate-whl-package">
 <h3><span class="section-number">2.2.1.2. </span>Download the Appropriate .whl Package<a class="headerlink" href="#download-the-appropriate-whl-package" title="Link to this heading"></a></h3>
-<p>Download the .whl installation package that matches your local Python version from the <a class="reference external" href="https://github.com/orbbec/pyorbbecsdk/releases">Python SDK Wrapper Release</a></p>
+<p>Download the .whl installation package that matches your local Python version from the <a class="reference external" href="https://github.com/orbbec/pyorbbecsdk/releases">Python Wrapper Release</a></p>
 <p>First, check your Python version:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>--version
 </pre></div>
@@ -410,7 +410,7 @@ <h3><span class="section-number">2.2.2.5. </span>Run the Example<a class="header
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/2_installation/installation.html b/docs/source/2_installation/installation.html
@@ -298,7 +298,7 @@ <h1><span class="section-number">2. </span>Installation<a class="headerlink" hre
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/2_installation/registration_script.html b/docs/source/2_installation/registration_script.html
@@ -306,7 +306,7 @@ <h2><span class="section-number">2.1.2. </span>Registering Metadata Using a Scri
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/3_QuickStarts/QuickStart.html b/docs/source/3_QuickStarts/QuickStart.html
@@ -489,7 +489,7 @@ <h1><span class="section-number">3.3. </span>Sample Features<a class="headerlink
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/3_QuickStarts/QuickStarts.html b/docs/source/3_QuickStarts/QuickStarts.html
@@ -287,7 +287,7 @@ <h1><span class="section-number">3. </span>QuickStarts<a class="headerlink" href
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/4_Application_Guide/ApplicationGuide.html b/docs/source/4_Application_Guide/ApplicationGuide.html
@@ -1868,7 +1868,7 @@ <h3><span class="section-number">4.18.19.2. </span>Multi-Camera Synchronization
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/4_Application_Guide/Application_Guide.html b/docs/source/4_Application_Guide/Application_Guide.html
@@ -392,7 +392,7 @@ <h1><span class="section-number">4. </span>Application Guide<a class="headerlink
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/5_FAQ/FAQ.html b/docs/source/5_FAQ/FAQ.html
@@ -335,7 +335,7 @@ <h1><span class="section-number">5. </span>FAQ<a class="headerlink" href="#faq"
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
diff --git a/docs/source/license.html b/docs/source/license.html
@@ -281,7 +281,7 @@ <h1><span class="section-number">6. </span>License<a class="headerlink" href="#l
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, ORBBEC INC. www.orbbec.com..
-      <span class="lastupdated">Last updated on 2025-08-12 20:21:10.
+      <span class="lastupdated">Last updated on 2025-08-13 16:30:15.
       </span></p>
   </div>
 
