pyorbbec 1.0.1.33__cp312-cp312-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. OrbbecSDK.dll +0 -0
  2. OrbbecSDK.lib +0 -0
  3. OrbbecSDKConfig.xml +2332 -0
  4. extensions/depthengine/depthengine.dll +0 -0
  5. extensions/depthengine/depthengine.lib +0 -0
  6. extensions/filters/FilterProcessor.dll +0 -0
  7. extensions/filters/ob_priv_filter.dll +0 -0
  8. extensions/firmwareupdater/firmwareupdater.dll +0 -0
  9. extensions/frameprocessor/ob_frame_processor.dll +0 -0
  10. pyorbbec-1.0.1.33.dist-info/METADATA +11 -0
  11. pyorbbec-1.0.1.33.dist-info/RECORD +49 -0
  12. pyorbbec-1.0.1.33.dist-info/WHEEL +5 -0
  13. pyorbbec-1.0.1.33.dist-info/licenses/LICENSE +202 -0
  14. pyorbbec-1.0.1.33.dist-info/top_level.txt +1 -0
  15. pyorbbecsdk/config/OrbbecSDKConfig.md +222 -0
  16. pyorbbecsdk/config/OrbbecSDKConfig.xml +2332 -0
  17. pyorbbecsdk/config/multi_device_sync_config.json +28 -0
  18. pyorbbecsdk/examples/.gitkeep +0 -0
  19. pyorbbecsdk/examples/README.md +26 -0
  20. pyorbbecsdk/examples/callback.py +303 -0
  21. pyorbbecsdk/examples/color.py +64 -0
  22. pyorbbecsdk/examples/coordinate_transform.py +184 -0
  23. pyorbbecsdk/examples/depth.py +107 -0
  24. pyorbbecsdk/examples/depth_work_mode.py +59 -0
  25. pyorbbecsdk/examples/device_firmware_update.py +155 -0
  26. pyorbbecsdk/examples/device_optional_depth_presets_update.py +142 -0
  27. pyorbbecsdk/examples/enumerate.py +118 -0
  28. pyorbbecsdk/examples/hdr.py +216 -0
  29. pyorbbecsdk/examples/hot_plug.py +160 -0
  30. pyorbbecsdk/examples/hw_d2c_align.py +135 -0
  31. pyorbbecsdk/examples/imu.py +60 -0
  32. pyorbbecsdk/examples/infrared.py +148 -0
  33. pyorbbecsdk/examples/logger.py +55 -0
  34. pyorbbecsdk/examples/metadata.py +64 -0
  35. pyorbbecsdk/examples/multi_device.py +169 -0
  36. pyorbbecsdk/examples/multi_streams.py +219 -0
  37. pyorbbecsdk/examples/net_device.py +177 -0
  38. pyorbbecsdk/examples/playback.py +277 -0
  39. pyorbbecsdk/examples/point_cloud.py +90 -0
  40. pyorbbecsdk/examples/post_processing.py +119 -0
  41. pyorbbecsdk/examples/preset.py +67 -0
  42. pyorbbecsdk/examples/quick_start.py +90 -0
  43. pyorbbecsdk/examples/recorder.py +238 -0
  44. pyorbbecsdk/examples/requirements.txt +8 -0
  45. pyorbbecsdk/examples/save_image_to_disk.py +106 -0
  46. pyorbbecsdk/examples/sync_align.py +109 -0
  47. pyorbbecsdk/examples/two_devices_sync.py +233 -0
  48. pyorbbecsdk/examples/utils.py +127 -0
  49. pyorbbecsdk.cp312-win_amd64.pyd +0 -0
Binary file
Binary file
Binary file
Binary file
@@ -0,0 +1,11 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyorbbec
3
+ Version: 1.0.1.33
4
+ Summary: pyorbbecsdk is a python wrapper for the OrbbecSDK
5
+ Author: zhonghong
6
+ Author-email: zhonghong@orbbec.com
7
+ License-File: LICENSE
8
+ Dynamic: author
9
+ Dynamic: author-email
10
+ Dynamic: license-file
11
+ Dynamic: summary
@@ -0,0 +1,49 @@
1
+ OrbbecSDK.dll,sha256=z8IS-6IMIU1EL4zGqjm-es1b3PdwjQ_NF56KcseKd1c,5898240
2
+ OrbbecSDK.lib,sha256=tMwbGojYZOSpMKXeGynYJ8_CJELDpc_ISMtyXKBdCxo,88226
3
+ OrbbecSDKConfig.xml,sha256=tLezO2f22zJdc6fe17qVBkoRK1mAtN9D-mpjc-msu58,116521
4
+ pyorbbecsdk.cp312-win_amd64.pyd,sha256=iO9mNPTiFAWQ1Ix_6tjtd2vjMbMqgVMa1WAGFdEF6mM,1144320
5
+ extensions/depthengine/depthengine.dll,sha256=wBTUpKUOdczTdfocLQP9HIyGu-erP24fgQLK8QPkwww,355328
6
+ extensions/depthengine/depthengine.lib,sha256=jGOeCkxG97Dxe3DXWdx9NjMO8pDhWiVo3uJpO5x_b7A,5194
7
+ extensions/filters/FilterProcessor.dll,sha256=MkdKafj-3_G8JdGlntck2Em_vWS4Xy-qoDpHI9ZvGP4,101376
8
+ extensions/filters/ob_priv_filter.dll,sha256=qwqN-yQBUEuCW5nLUFLa_5-pvyguTA9sXDYFvQLCkiI,69120
9
+ extensions/firmwareupdater/firmwareupdater.dll,sha256=phMqyuz1iePcP2E7J9UBeu1cqgo2KGRlrQkXVKVUMU0,223744
10
+ extensions/frameprocessor/ob_frame_processor.dll,sha256=uiAU81qRwPfEPaLqduYZY7lIe_clONtdqG7bQIiwrBw,179200
11
+ pyorbbec-1.0.1.33.dist-info/licenses/LICENSE,sha256=SbvpEU5JIU3yzMMkyzrI0dGqHDoJR_lMKGdl6GZHsy4,11558
12
+ pyorbbecsdk/config/OrbbecSDKConfig.md,sha256=IZLMDT9TDKSYIe9nN2cGXip4Tu8Q8hxU2ZXGDPV5zE4,11973
13
+ pyorbbecsdk/config/OrbbecSDKConfig.xml,sha256=tLezO2f22zJdc6fe17qVBkoRK1mAtN9D-mpjc-msu58,116521
14
+ pyorbbecsdk/config/multi_device_sync_config.json,sha256=UPXVYICKx7__E6Qdpp-cJhkykEQ_ANzGCFk2twS2Ir8,828
15
+ pyorbbecsdk/examples/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
16
+ pyorbbecsdk/examples/README.md,sha256=RcYtrgMSkRJzV9F1x2pFMOWeufUlXhBx1AU8SA-khvk,6688
17
+ pyorbbecsdk/examples/callback.py,sha256=OIwPl0n7-RqoID-rYQ3lLn0JuW8A_UoKDpivEkmUrHQ,10089
18
+ pyorbbecsdk/examples/color.py,sha256=hoYePHn2nr-87hI9b2HsrGxM1puoQY-L7HcaXdJbxMs,2280
19
+ pyorbbecsdk/examples/coordinate_transform.py,sha256=8PtR5X-CW3HL63f90H1HTW1GIk78x8zHCsxtIA7FGCA,7597
20
+ pyorbbecsdk/examples/depth.py,sha256=UMVLhW2KwmRzyx6iQOE0UQ6w4BxRmKr9zJTe55YwzNk,3843
21
+ pyorbbecsdk/examples/depth_work_mode.py,sha256=s_CynLMNOJ5ho_W3LlQSb6xsOxq9ic9cwNYuQIpiQOQ,2679
22
+ pyorbbecsdk/examples/device_firmware_update.py,sha256=C7PQYJaq9-ZHQ1aHPpWzNAtNLEXYp3RCMn2dhf_F0Ts,5684
23
+ pyorbbecsdk/examples/device_optional_depth_presets_update.py,sha256=Od0it5ZkyASuRLKwWIBg0kb1z-iGK4jyUI3iariczXc,5313
24
+ pyorbbecsdk/examples/enumerate.py,sha256=iBOYtxoj_ONDi96786MBnBNdyIupoeDkzr6E9Vxp7zQ,4542
25
+ pyorbbecsdk/examples/hdr.py,sha256=fIydBjSMoZDYnPA5nZRLHjoTP0qTARbihvfaa-kmzZw,8243
26
+ pyorbbecsdk/examples/hot_plug.py,sha256=j93htlFu1WHG6GQroXReuWfBQeHlSzthhvCI-UFBcTs,5517
27
+ pyorbbecsdk/examples/hw_d2c_align.py,sha256=7YpSp3a39IXwwIcjpRQ-iC-9jC3uVO4-xAdcuI0WFcc,4909
28
+ pyorbbecsdk/examples/imu.py,sha256=AONK3NEo7StlAf0z1tAOAebwP1zm1xveXP8Qk1TUT_s,2470
29
+ pyorbbecsdk/examples/infrared.py,sha256=N8jP0DjwIYo7XeEtlcJMo0yxo08qwO9NnfiibGDjKSE,5235
30
+ pyorbbecsdk/examples/logger.py,sha256=6_QT14NOIA3toIeWiIUkZzeiQqU0X16b5fMbzAOjJ3M,2053
31
+ pyorbbecsdk/examples/metadata.py,sha256=bNXwOLiJL22eZODoDditsJ4gAhSBqAnBoAveYP7Kc-o,2432
32
+ pyorbbecsdk/examples/multi_device.py,sha256=sOY-ibIYFbgTjU6jWz2GxFA_V4V2PozMRbnR4iBVx6E,6574
33
+ pyorbbecsdk/examples/multi_streams.py,sha256=SU_17Hpz8B-H8ZZsId6ikrWiEDwSPZER8dPIxQf8iEI,7435
34
+ pyorbbecsdk/examples/net_device.py,sha256=wnaxNrhMfDmMIoH0jo0cIz4_QQXUZAwKQgA7tUHuZPo,6319
35
+ pyorbbecsdk/examples/playback.py,sha256=pDHHVcnIQQ1NMo-S3xZUMPaAK-K_lnnDHmkelnzLO5k,9714
36
+ pyorbbecsdk/examples/point_cloud.py,sha256=taxO558Mi2EnVe-wUnjHDsmyNK08x2XKDtldbQednVI,3350
37
+ pyorbbecsdk/examples/post_processing.py,sha256=uZiSb8PRPz1xC4Bykq0-Y9Lo6JYO85u7JLmjU5GKJe4,4622
38
+ pyorbbecsdk/examples/preset.py,sha256=tMPw3fvB1DbaS8EZW3Qcllpp2WHR613W3eHusP9Jmp4,2440
39
+ pyorbbecsdk/examples/quick_start.py,sha256=CCCzX7jNqdPA9ToOwmNFo0HiDXjAprRXieIn_s9UxBA,3329
40
+ pyorbbecsdk/examples/recorder.py,sha256=TyTguLIgIzZsVu86DezziLlcKc4zqBSoNuVB9GLiB9A,8122
41
+ pyorbbecsdk/examples/requirements.txt,sha256=ncE3GA8g8AMzgVfczgUT4R1MJtFBakJz8vLhoujejfQ,212
42
+ pyorbbecsdk/examples/save_image_to_disk.py,sha256=IhLVQ1S-l6IX6EVEK5xHLFZD-7fpDxQLC1ufviDtASs,3984
43
+ pyorbbecsdk/examples/sync_align.py,sha256=35x3Rm0K5SbPQL7V16XBUOvQI0o3hQBXhLTRbtg3_nk,4040
44
+ pyorbbecsdk/examples/two_devices_sync.py,sha256=O0tu1YNIHX3WVtnswdx7VkkRnUbdZ4kARf6WyilBU20,9450
45
+ pyorbbecsdk/examples/utils.py,sha256=UHDUGqXhoRyhkkAahcbA1r0KX4le7q68GV4LjkcfXx0,5092
46
+ pyorbbec-1.0.1.33.dist-info/METADATA,sha256=Sf1dUX0IliRIGrZZDqJpATEviV6fzBhQxu-XBAJj4Wg,277
47
+ pyorbbec-1.0.1.33.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
48
+ pyorbbec-1.0.1.33.dist-info/top_level.txt,sha256=VtEe2PLpfyn__4hM0LpuzMtTVwgzui9ou5Tox-0-nDI,12
49
+ pyorbbec-1.0.1.33.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.9.0)
3
+ Root-Is-Purelib: false
4
+ Tag: cp312-cp312-win_amd64
5
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1 @@
1
+ pyorbbecsdk
@@ -0,0 +1,222 @@
1
+ # Orbbec SDK Configuration File Introduction (OrbbecSDKConfig_v1.0.xml)
2
+
3
+ The Orbbec SDK configuration file is an XML file that defines the global configuration of the Orbbec SDK.
4
+
5
+ Upon initialization, the SDK Context will load a configuration file and apply as global configurations. If you have your own configuration file, you can specify it by entering the file path when calling the Context constructor. If you don't provide a path (or input an empty string), the SDK will look for a file named `OrbbecSDKConfig.xml` in the working directory. If neither the specified file nor the default file is found, the SDK will revert to using the built-in default configuration file.
6
+
7
+ ## Log Configuration
8
+
9
+ Log configuration mainly sets the Log level, the Log level output to the console, the Log level output to a file, configures the path for saving Log files, sets the size of each Log file, and sets the number of Log files.
10
+
11
+ ```cpp
12
+ <Log>
13
+ <!--Log output level, int type, optional values: 0-DEBUG, 1-INFO, 2-WARN, 3-ERROR, 4-FATAL, 5-OFF-->
14
+ <!--Log level configuration execution priority: 0. Application code configuration > 1. Detailed configuration of configuration file (file & console configuration) > 2. Global configuration of configuration file > 3. SDK code default configuration (file: 0, terminal: 1)-->
15
+ <!--Global log output level-->
16
+ <LogLevel>0</LogLevel>
17
+ <!--File log output level-->
18
+ <FileLogLevel>0</FileLogLevel>
19
+ <!--Console log output level-->
20
+ <ConsoleLogLevel>1</ConsoleLogLevel>
21
+ <!--Default log output file path, string type. If this item is not configured, the default path will be used: Win/Linux: "./Log"; Android: "/sdcard/Orbbec/Log"-->
22
+ <!--<OutputDir>./log</OutputDir>-->
23
+ <!--Default log output file size, int type, unit: MB-->
24
+ <MaxFileSize>100</MaxFileSize>
25
+ <!--Default log output file number (circular overwrite), int type-->
26
+ <MaxFileNum>3</MaxFileNum>
27
+ <!--Log asynchronous output, changing to asynchronous output can reduce the blocking time of printing logs, but some logs may be lost when the program exits abnormally; true-enable, false-disable (default)-->
28
+ <Async>false</Async>
29
+ </Log>
30
+ ```
31
+
32
+ ## Memory Configuration
33
+
34
+ ```cpp
35
+ <Memory>
36
+ <!--Enable memory pool to reuse frame memory, avoid frequent memory allocation and release. true-enable, false-disable)-->
37
+ <EnableMemoryPool> true </EnableMemoryPool>
38
+ <!--Maximum memory size of all data frames, int type, unit: MB, minimum 100MB-->
39
+ <MaxFrameBufferSize> 2048 </MaxFrameBufferSize>
40
+ <!--Frame buffer queue size in pipeline-->
41
+ <PipelineFrameQueueSize>10</PipelineFrameQueueSize>
42
+ <!--Frame buffer queue size in internal processing unit-->
43
+ <FrameProcessingBlockQueueSize>10</FrameProcessingBlockQueueSize>
44
+ </Memory>
45
+ ```
46
+
47
+ **Notes**
48
+
49
+ 1. The default size of the memory pool is 2GB (2048MB).
50
+ ```cpp
51
+ <MaxFrameBufferSize> 2048 </MaxFrameBufferSize>
52
+ ```
53
+ 2. The default number of frame buffere queue in the Pipeline is 10. If the host machine processes slowly, the SDK will buffer up to 10 frames internally, which may affect the delay time in retrieving frames by the user. If the delay is significant, you can reduce the number of buffers.
54
+ ```cpp
55
+ <PipelineFrameQueueSize>10</PipelineFrameQueueSize>
56
+ ```
57
+
58
+ 3. The default number of queues in the internal processing unit (Processing unit) is 10. If the host machine processes slowly, the SDK will buffer up to 10 frames internally, which may affect the delay time in retrieving frames by the user. If the delay is significant, you can reduce the number of queues.
59
+ ```cpp
60
+ <FrameProcessingBlockQueueSize>10</FrameProcessingBlockQueueSize>
61
+ ```
62
+
63
+ ## Global Timestamp
64
+
65
+ Based on the device's timestamp and considering data transmission delays, the timestamp is converted to the system timestamp dimension through linear regression. It can be used to synchronize timestamps of multiple different devices. The implementation plan is as follows:
66
+
67
+ 1. Global timestamp fitter: Regularly obtain the device timestamp and the current system timestamp, and calculate the fitting equation parameters using a linear regression method.
68
+ 2. Global timestamp converter: Convert the data frame timestamp unit to the same unit as the device timestamp, then calculate the overflow times according to the device timestamp to convert to a 64-bit timestamp, and then convert to a global timestamp according to the fitting parameters output by the global timestamp fitter.
69
+
70
+ ```cpp
71
+ <Misc>
72
+ <GlobalTimestampFitterEnable>true</GlobalTimestampFitterEnable>
73
+ <!--Global timestamp fitter refresh interval, unit: milliseconds, default value: 1000, minimum value: 100, it is recommended not to be greater than 1000 -->
74
+ <GlobalTimestampFitterInterval>1000</GlobalTimestampFitterInterval>
75
+ <!--Global timestamp fitter queue size, default value: 100, minimum value: 20 -->
76
+ <GlobalTimestampFitterQueueSize>100</GlobalTimestampFitterQueueSize>
77
+ </Misc>
78
+ ```
79
+
80
+ 1. By default, the device time is obtained every eight seconds to update the global timestamp fitter.
81
+ ```cpp
82
+ <GlobalTimestampFitterInterval>1000</GlobalTimestampFitterInterval>
83
+ ```
84
+
85
+ 2. The default queue size of the global timestamp fitter is 10.
86
+ ```cpp
87
+ <GlobalTimestampFitterQueueSize>100</GlobalTimestampFitterQueueSize>
88
+ ```
89
+
90
+ **Notes**
91
+
92
+ 1. The global timestamp mainly supports the Gemini 330 series. Gemini 2, Gemini 2L, Femto Mega, and Femto Bolt are also supported but not thoroughly tested. If there are stability issues with these devices, the global timestamp function can be turned off.
93
+ ```cpp
94
+ <GlobalTimestampFitterEnable>false</GlobalTimestampFitterEnable>
95
+ ```
96
+
97
+ ## Pipeline Configuration
98
+
99
+ ```cpp
100
+ <!--Default working configuration of pipeline-->
101
+ <Pipeline>
102
+ <Stream>
103
+ <Depth>
104
+ <!--Use default stream profile, bool type, true: use default stream profile, false: use specified stream profile in the configuration file-->
105
+ <UseDefaultStreamProfile>true</UseDefaultStreamProfile>
106
+ </Depth>
107
+ <Color>
108
+ <UseDefaultStreamProfile>true</UseDefaultStreamProfile>
109
+ </Color>
110
+ <!--If you need to open other streams, you can refer to the above format to add configuration-->
111
+ </Stream>
112
+ <!--Image alignment, int type, optional values: 0 disable, 1 hardware d2c alignment, 2 software d2c alignment-->
113
+ <AlignMode>0</AlignMode>
114
+ <!--Frame synchronization output between different data streams, bool type, true-enable frame synchronization, false-disable frame synchronization-->
115
+ <FrameSync>false</FrameSync>
116
+ </Pipeline>
117
+ ```
118
+
119
+ 1. Pipeline primarily sets which video streams to enable. By default, only Depth and Color streams are enabled. You can add to enable IR streams, left IR, and right IR as follows.
120
+ ```cpp
121
+ <!--If you need to open other streams, you can refer to the above format to add configuration-->
122
+ <IR>
123
+ <UseDefaultStreamProfile>true</UseDefaultStreamProfile>
124
+ </IR>
125
+ <LeftIR>
126
+ <UseDefaultStreamProfile>true</UseDefaultStreamProfile>
127
+ </LeftIR>
128
+ <RightIR>
129
+ <UseDefaultStreamProfile>true</UseDefaultStreamProfile>
130
+ </RightIR>
131
+ ```
132
+ 2. Pipeline can set D2C, such as hardware D2C and software D2C. Some devices do not support hardware D2C, such as Femto Bolt. If you need to use various different types of devices, it is recommended to set this in the user code based on the device type.
133
+ ```cpp
134
+ <AlignMode>0</AlignMode>
135
+ ```
136
+ 3. Pipeline can set frame synchronization. Enabling frame synchronization will match Depth, Color, and other video frames based on the timestamp and output them as FrameSet within the Pipeline.
137
+ ```cpp
138
+ <FrameSync>false</FrameSync>
139
+ ```
140
+
141
+ ## Device Configuration
142
+
143
+ ```cpp
144
+ <!--Default configuration of data streams for different types of devices-->
145
+ <Device>
146
+ <EnumerateNetDevice>false</EnumerateNetDevice>
147
+ <!--UVC Backend select on Linux; optional values: Auto, V4L2, LibUVC; Auto is the default value-->
148
+ <LinuxUVCBackend>LibUVC</LinuxUVCBackend>
149
+
150
+ <!--Gemini 335 config-->
151
+ <Gemini335>
152
+ <!--Whether to enable heartbeat by default-->
153
+ <DefaultHeartBeat>0</DefaultHeartBeat>
154
+
155
+ <Depth>
156
+ <!--Number of retries for open stream failures, 0 means no retries-->
157
+ <StreamFailedRetry>0</StreamFailedRetry>
158
+ <!--Open flow waits for the timeout period of the first frame of data, after which the open flow will fail-->
159
+ <MaxStartStreamDelayMs>5000</MaxStartStreamDelayMs>
160
+ <!--The number of data stream restarts due to abnormal interruption, 0 means no restart-->
161
+ <StreamInterruptedRestart>0</StreamInterruptedRestart>
162
+ <!--The maximum frame interval time, if this value is exceeded, it will be judged that the stream is interrupted-->
163
+ <MaxFrameIntervalMs>2000</MaxFrameIntervalMs>
164
+ <!--The resolution width is enabled by default, int type-->
165
+ <Width>848</Width>
166
+ <!--High resolution is enabled by default, int type-->
167
+ <Height>480</Height>
168
+ <!--The frame rate of the resolution enabled by default, int type-->
169
+ <FPS>30</FPS>
170
+ <Format>Y16</Format>
171
+ </Depth>
172
+ <Color>
173
+ <!--The resolution width is enabled by default, int type-->
174
+ <Width>1280</Width>
175
+ <!--High resolution is enabled by default, int type-->
176
+ <Height>720</Height>
177
+ <!--The frame rate of the resolution enabled by default, int type-->
178
+ <FPS>30</FPS>
179
+ <Format>MJPG</Format>
180
+ </Color>
181
+ <IR>
182
+ <!--The resolution width is enabled by default, int type-->
183
+ <Width>848</Width>
184
+ <!--High resolution is enabled by default, int type-->
185
+ <Height>480</Height>
186
+ <!--The frame rate of the resolution enabled by default, int type-->
187
+ <FPS>30</FPS>
188
+ <Format>Y8</Format>
189
+ </IR>
190
+ <LeftIR>
191
+ <!--The resolution width is enabled by default, int type-->
192
+ <Width>848</Width>
193
+ <!--High resolution is enabled by default, int type-->
194
+ <Height>480</Height>
195
+ <!--The frame rate of the resolution enabled by default, int type-->
196
+ <FPS>30</FPS>
197
+ <Format>Y8</Format>
198
+ </LeftIR>
199
+ <RightIR>
200
+ <!--The resolution width is enabled by default, int type-->
201
+ <Width>848</Width>
202
+ <!--High resolution is enabled by default, int type-->
203
+ <Height>480</Height>
204
+ <!--The frame rate of the resolution enabled by default, int type-->
205
+ <FPS>30</FPS>
206
+ <Format>Y8</Format>
207
+ </RightIR>
208
+ </Gemini335>
209
+ </Device>
210
+ ```
211
+
212
+ 1. Set whether to enumerate network devices. Femto Mega and Gemini 2 XL support network functions. If you need to use the network functions of these two devices, you can set this to true.
213
+ ```cpp
214
+ <EnumerateNetDevice>false</EnumerateNetDevice>
215
+ ```
216
+
217
+ 2. Set whether to use LibUVC or V4L2 to receive data on Linux or ARM. V4L2 is not supported by all devices, and we recommend using LibUVC. The Gemini 330 series devices support V4L2, but kernel patches are needed to obtain Metadata data.
218
+ ```cpp
219
+ <LinuxUVCBackend>LibUVC</LinuxUVCBackend>
220
+ ```
221
+
222
+ 3. Set the resolution, frame rate, and data format.