Skip to content

Commit 7b4ea2b

Browse files
zhonghong322zhonghong322
committed
Add Api change document and Update README.md
1 parent 360b5ac commit 7b4ea2b

File tree

2 files changed

+125
-0
lines changed

2 files changed

+125
-0
lines changed

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Introduction
22
The v2-main branch provides an Android wrapper based on the [Orbbec SDK v2.x](https://github.com/orbbec/OrbbecSDK_v2). Orbbec SDK v2.x is an open-source, cross-platform SDK for interfacing with Orbbec RGB-D cameras. For a comparison between SDK v2.x and [Orbbec SDK v1.x](https://github.com/orbbec/OrbbecSDK), see the [README](https://github.com/orbbec/OrbbecSDK_v2).
33

4+
Additionally, a comprehensive overview of the API changes from Android Wrapper v1.x to v2.x can be found here: [api_changes_at_v2.x](doc/api_changes_at_v2.x.md).
5+
46
> [!IMPORTANT]
57
>
68
> Welcome to the Android wrapper . Before you begin using this version of Android wrapper , it's crucial to check the following device support list to verify the compatibility.

‎doc/api_changes_at_v2.x.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# API Changes at v2.x.x
2+
This document outlines the key differences in APIs between Android Wrapper v2.x(v2-main branch) and the Android Wrapper v1.x(main branch).
3+
4+
## 1. Added New interfaces for Android Wrapper v2.x
5+
6+
### Class Name: AlignFilter
7+
- void setMatchTargetResolution(boolean state)
8+
### Class Name: Config
9+
- void enableStream(StreamType streamType)
10+
- void enableStream(SensorType sensorType)
11+
- void enableVideoStream(SensorType sensorType, int width, int height, int fps, Format format)
12+
- void enableAccelStream()
13+
- void enableGyroStream()
14+
- void disableStream(SensorType sensorType)
15+
- void disableAllStream()
16+
- void setFrameAggregateOutputMode(FrameAggregateOutputMode mode)
17+
### Class Name: Device
18+
- boolean isExtensionInfoExist(String infoKey)
19+
- void updateOptionalDepthPresets(String[] filePathList, int pathCount, UpgradeCallback callback)
20+
- String getExtensionInfo(String infoKey)
21+
- void setHdrConfig(HdrConfig config)
22+
- HdrConfig getHdrConfig()
23+
- void enableHeartbeat(boolean enable)
24+
### Class Name: Filter
25+
- String getName()
26+
- String getConfigSchema()
27+
- List getConfigSchemaList()
28+
- void setConfigValue(String configName, double value)
29+
- double getConfigValue(String configName)
30+
### Class Name: OBContext
31+
- void setUvcBackendType(UvcBackendType type)
32+
### Class Name: PointCloudFilter
33+
- void setCoordinateSystem(CoordinateSystemType type)
34+
### Class Name: PointFrame
35+
- float getCoordinateValueScale()
36+
### Class Name: Sensor
37+
- List createRecommendedFilters()
38+
### Class Name: StreamProfileList
39+
- AccelStreamProfile getAccelStreamProfile(AccelFullScaleRange fullScaleRange, IMUSampleRate sampleRate)
40+
- GyroStreamProfile getGyroStreamProfile(GyroFullScaleRange fullScaleRange, IMUSampleRate sampleRate)
41+
### Class Name: VideoFrame
42+
- PixelType getPixelType()
43+
44+
## 2. Added New Class for Android Wrapper v2.x
45+
- FilterFactory
46+
- FrameFactory
47+
- SensorList
48+
- StreamProfileFactory
49+
- TypeHelper
50+
- CameraDistortionModel
51+
- CoordinateSystemType
52+
- DataTranState
53+
- DepthWorkModeTag
54+
- DispOffsetConfig
55+
- FileTranState
56+
- FilterConfigSchemaItem
57+
- FilterConfigValueType
58+
- FrameAggregateOutputMode
59+
- Float3D
60+
- PixelType
61+
- UvcBackendType
62+
- UpgradeState
63+
64+
## 3. Modified Interfaces for Android Wrapper v2.x
65+
66+
| Class Name | Android Wrapper v1.x | Android Wrapper v2.x |
67+
| --- | --- | --- |
68+
| PointCloudFilter | void setPositionDataScale(float scale) | void setCoordinateDataScaled(float factor) |
69+
| StreamProfileList | int getStreamProfileCount() | int getCount() |
70+
| Frame | FrameType getStreamType() | FrameType getType() |
71+
| Frame| long getFrameIndex() | long getIndex() |
72+
| Frame | long getMetaValue(FrameMetadataType frameMetadataType) | long getMetadataValue(FrameMetadataType frameMetadataType) |
73+
| AccelStreamProfile | AccelFullScaleRange getAccelFullScaleRange() | AccelFullScaleRange getFullScaleRange() |
74+
| AccelStreamProfile | SampleRate getGyroSampleRate() | IMUSampleRate getSampleRate() |
75+
| GyroStreamProfile | GyroFullScaleRange getGyroFullScaleRange() | GyroFullScaleRange getFullScaleRange() |
76+
| GyroStreamProfile | SampleRate getGyroSampleRate() | IMUSampleRate getSampleRate() |
77+
| HoleFillingFilter | void setMode(HoleFillingMode mode) | void setFilterMode(HoleFillingMode mode) |
78+
|HoleFillingFilter | HoleFillingMode getMode() | HoleFillingMode getFilterMode() |
79+
80+
81+
### 4. Rename Class Names for Android Wrapper v2.x
82+
83+
| Android Wrapper v1.x | Android Wrapper v2.x |
84+
| --- | --- |
85+
| HdrMergeFilter | HdrMerge |
86+
| CoordinateUtil | CoordinateTransformHelper |
87+
| FormatConvertType | ConvertFormat |
88+
| TimestampResetConfig | DeviceTimestampResetConfig |
89+
| D2CTransform | Extrinsic |
90+
| EdgeNoiseRemovalParams | EdgeNoiseRemovalFilterParams |
91+
| SyncMode | MultiDeviceSyncMode |
92+
| OBNetworkConfig | NetIpConfig |
93+
| NoiseRemovalParams | NoiseRemovalFilterParams |
94+
| OBRect | Rect |
95+
| SpatialAdvancedParams | SpatialAdvancedFilterParams |
96+
97+
### 5. Removed Class or interfaces for Android Wrapper v2.x
98+
99+
| Class Name | Function |
100+
| --- | --- |
101+
| Config | void setD2CTargetResolution(int width, int height) |
102+
| OBContext | void setLoggerToFile(LogSeverity severity, String directory, long maxFileSize, long maxFileNum) |
103+
| OBContext| void loadLicense(String licenseFilePath, String key) |
104+
| OBContext | boolean isNetDeviceEnumerationEnable() |
105+
| Pipeline | OBRect getD2CValidArea(int distance) |
106+
| Pipeline | OBRect getD2CRangeValidArea(int minimumDistance, int maximumDistance) |
107+
| Pipeline | void startRecord(String filePath) |
108+
|Pipeline | void stopRecord() |
109+
| Pipeline | Playback getPlayback() |
110+
| Pipeline | Pipeline(String playbackFile) |
111+
| Playback | Remove this Class |
112+
| Recorder | Remove this Class |
113+
| CompressionFilter | Remove this Class |
114+
| DeCompressionFilter | Remove this Class |
115+
116+
### 6. Deprecated interfaces for Android Wrapper v2.x
117+
118+
| Class Name | Function |
119+
| --- | --- |
120+
| PointCloudFilter | void setD2CAlignStatus(boolean isAlign) |
121+
| Pipeline | CameraParam getCameraParam() |
122+
| Pipeline| CameraParam getCameraParamWithProfile(int colorWidth, int colorHeight, int depthWidth, int depthHeight) |
123+
| Pipeline | CalibrationParam getCalibrationParam(Config config) |

0 commit comments

Comments
 (0)