# 在线美术教学 API (/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

声网为在线美术场景提供明暗校正和透视校正功能，本文提供相关的 API 参考。

除了在线美术教学相关的 API，你还需要使用 RTC API 来实现实时音视频互动功能。你可以参考 [RTC API](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-api-overview) 文档来了解详细的 RTC API 用法。

:::info[信息]
明暗校正和透视校正 API 仅存在于声网为在线美术教学解决方案提供的声网 RTC 教育特殊版 SDK 中。声网官网的视频 SDK v4.x 版本尚不支持该功能。你可以[提交工单](https://ticket.shengwang.cn)联系我们获取声网 RTC 4.0.0 教育特殊版 SDK。
:::

此外，你还可以参考如下 API 文档，在场景实现中添加相应的功能：

- [RTM SDK](/zh-CN/api-reference/rtm/cpp/configuration)，实现实时消息相关功能
- [云端录制](/zh-CN/api-reference/api-ref/cloud-recording/acquire)，为实时音视频和互动白板提供录制功能

<a id="enablebrightnesscorrection"></a>
## 明暗校正 [#明暗校正]
### enableBrightnessCorrection [#enablebrightnesscorrection]

```cpp
virtual int enableBrightnessCorrection(bool enabled, BRIGHTNESS_CORRECTION_MODE mode, VIDEO_SOURCE_TYPE sourceType = VIDEO_SOURCE_CAMERA_PRIMARY) = 0;
```

开启或关闭本地画面明暗校正。

#### 参数 [#参数]

| 参数 | 说明 |
| --- | --- |
| `enabled` | [correction-windows-html-0-1-1 details](#table-slot-correction-windows-html-0-1-1) |
| `mode` | [correction-windows-html-0-2-1 details](#table-slot-correction-windows-html-0-2-1) |
| `sourceType` | [correction-windows-html-0-3-1 details](#table-slot-correction-windows-html-0-3-1) |

<a id="table-slot-correction-windows-html-0-1-1"></a>

**correction-windows-html-0-1-1 details**

是否开启本地画面明暗校正：

- `true`：开启。
- `false`：不开启。

<a id="table-slot-correction-windows-html-0-2-1"></a>

**correction-windows-html-0-2-1 details**

明暗校正模式：

- `AUTO_MODE(0)`：自动模式，SDK 自动检测亮度，如果检测当前亮度正常，不会启动亮度校正。
- `MANUAL_MODE(1)`： 手动模式，SDK 启动亮度校正。

<a id="table-slot-correction-windows-html-0-3-1"></a>

**correction-windows-html-0-3-1 details**

视频源类型：

- `VIDEO_SOURCE_CAMERA_PRIMARY(0)`：（默认）在第一个摄像头开启或关闭明暗校正。
- `VIDEO_SOURCE_CAMERA_SECONDARY(1)`：在第二个摄像头开启或关闭明暗校正。

#### 返回值 [#返回值]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="applybrightnesscorrectiontoremote"></a>
### applyBrightnessCorrectionToRemote [#applybrightnesscorrectiontoremote]

```cpp
virtual int applyBrightnessCorrectionToRemote(uid_t uid, bool enabled, BRIGHTNESS_CORRECTION_MODE mode) = 0;
```

开启远端用户画面的明暗校正。远端用户需要在 `enableVideo` 前先调用 `addExtension` 和 `enableExtension`，才能成功接收远程开启明暗校正请求。

#### 参数 [#参数-1]

| 参数 | 说明 |
| --- | --- |
| `uid` | 需要开启透视校正的远端用户 ID。 |
| `enabled` | [correction-windows-html-1-2-1 details](#table-slot-correction-windows-html-1-2-1) |
| `mode` | [correction-windows-html-1-3-1 details](#table-slot-correction-windows-html-1-3-1) |

<a id="table-slot-correction-windows-html-1-2-1"></a>

**correction-windows-html-1-2-1 details**

是否开启远端用户画面明暗校正：

- `true`：开启
- `false`：不开启

<a id="table-slot-correction-windows-html-1-3-1"></a>

**correction-windows-html-1-3-1 details**

明暗校正模式：

- `AUTO_MODE(0)`：自动模式，SDK 自动检测亮度，如果检测当前亮度正常，不会启动亮度校正。
- `MANUAL_MODE(1)`：手动模式，SDK 启动亮度校正。

#### 返回值 [#返回值-1]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="applybrightnesscorrectiontoremoteex"></a>
### applyBrightnessCorrectionToRemoteEx [#applybrightnesscorrectiontoremoteex]

```cpp
virtual int applyBrightnessCorrectionToRemoteEx(uid_t uid, bool enabled, BRIGHTNESS_CORRECTION_MODE mode, const RtcConnection& connection) = 0;
```

（适用于多频道）开启对应 Connection 的远端用户画面的明暗校正。远端的用户需要在 `enableVideo` 前先调用 `addExtension` 和 `enableExtension` 才能成功接收远程开启明暗校正请求。

#### 参数 [#参数-2]

| 参数 | 说明 |
| --- | --- |
| `uid` | 需要开启透视校正的远端用户 ID。 |
| `enabled` | [correction-windows-html-2-2-1 details](#table-slot-correction-windows-html-2-2-1) |
| `mode` | [correction-windows-html-2-3-1 details](#table-slot-correction-windows-html-2-3-1) |
| `connection` | Connection 信息。详见 [`RtcConnection`](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 |

<a id="table-slot-correction-windows-html-2-2-1"></a>

**correction-windows-html-2-2-1 details**

是否开启远端用户画面明暗校正：

- `true`：开启
- `false`：不开启

<a id="table-slot-correction-windows-html-2-3-1"></a>

**correction-windows-html-2-3-1 details**

明暗校正模式：

- `AUTO_MODE(0)`：自动模式，SDK 自动检测亮度，如果检测当前亮度正常，不会启动亮度校正。
- `MANUAL_MODE(1)`：手动模式，SDK 启动亮度校正。

#### 返回值 [#返回值-2]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="enableremotetrapezoidcorrection"></a>
## 透视校正 [#透视校正]
### enableRemoteTrapezoidCorrection [#enableremotetrapezoidcorrection]

```cpp
virtual int enableRemoteTrapezoidCorrection(uid_t uid, bool enabled) = 0;
```

在本地启用或关闭远端用户在本地渲染画面的透视校正。远端用户自身的本地预览不会看到透视校正效果。

#### 参数 [#参数-3]

| 参数 | 说明 |
| --- | --- |
| `uid` | 需要开启明暗校正的远端用户 ID。 |
| `enabled` | [correction-windows-html-3-2-1 details](#table-slot-correction-windows-html-3-2-1) |

<a id="table-slot-correction-windows-html-3-2-1"></a>

**correction-windows-html-3-2-1 details**

是否开启远端画面透视校正：

- `true`：开启
- `false`：不开启

#### 返回值 [#返回值-3]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="enableremotetrapezoidcorrectionex"></a>
### enableRemoteTrapezoidCorrectionEx [#enableremotetrapezoidcorrectionex]

```cpp
virtual int enableRemoteTrapezoidCorrectionEx(uid_t uid, bool enabled, const RtcConnection& connection) = 0;
```

（适用于多频道）在本地启用或关闭远端用户在本地渲染画面的透视校正。远端用户自身的本地预览不会看到透视校正效果。

#### 参数 [#参数-4]

| 参数 | 说明 |
| --- | --- |
| `uid` | 需要开启明暗校正的远端用户 ID。 |
| `enabled` | [correction-windows-html-4-2-1 details](#table-slot-correction-windows-html-4-2-1) |
| `connection` | Connection 信息。详见 [`RtcConnection`](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 |

<a id="table-slot-correction-windows-html-4-2-1"></a>

**correction-windows-html-4-2-1 details**

是否开启远端画面透视校正：

- `true`：开启
- `false`：不开启

#### 返回值 [#返回值-4]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="enablelocaltrapezoidcorrection"></a>
### enableLocalTrapezoidCorrection [#enablelocaltrapezoidcorrection]

```cpp
virtual int enableLocalTrapezoidCorrection(bool enabled, VIDEO_SOURCE_TYPE sourceType = VIDEO_SOURCE_CAMERA_PRIMARY) = 0;
```

开启或关闭本地画面的透视校正。本地设置透视校正后，远端就能看到梯形校正后的画面。

#### 参数 [#参数-5]

| 参数 | 说明 |
| --- | --- |
| `enabled` | [correction-windows-html-5-1-1 details](#table-slot-correction-windows-html-5-1-1) |
| `sourceType` | [correction-windows-html-5-2-1 details](#table-slot-correction-windows-html-5-2-1) |

<a id="table-slot-correction-windows-html-5-1-1"></a>

**correction-windows-html-5-1-1 details**

是否开启本地画面透视校正：

- `true`：开启。
- `false`：不开启。

<a id="table-slot-correction-windows-html-5-2-1"></a>

**correction-windows-html-5-2-1 details**

视频源类型：

- `VIDEO_SOURCE_CAMERA_PRIMARY(0)`：（默认）在第一个摄像头开启或关闭透视校正。
- `VIDEO_SOURCE_CAMERA_SECONDARY(1)`：在第二个摄像头开启或关闭透视校正。

#### 返回值 [#返回值-5]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="setlocaltrapezoidcorrectionoptions"></a>
### setLocalTrapezoidCorrectionOptions [#setlocaltrapezoidcorrectionoptions]

```cpp
virtual int setLocalTrapezoidCorrectionOptions(const TrapezoidCorrectionOptions& options, VIDEO_SOURCE_TYPE sourceType = VIDEO_SOURCE_CAMERA_PRIMARY) = 0;
```

配置本地透视校正选项。

#### 参数 [#参数-6]

| 参数 | 说明 |
| --- | --- |
| `options` | 透视校正配置参数。详见 [`TrapezoidCorrectionOptions`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#trapezoidcorrectionoptions)。 |
| `sourceType` | [correction-windows-html-6-2-1 details](#table-slot-correction-windows-html-6-2-1) |

<a id="table-slot-correction-windows-html-6-2-1"></a>

**correction-windows-html-6-2-1 details**

视频源类型：

- `VIDEO_SOURCE_CAMERA_PRIMARY(0)`：（默认）在第一个摄像头开启或关闭透视校正。
- `VIDEO_SOURCE_CAMERA_SECONDARY(1)`：在第二个摄像头开启或关闭透视校正。

#### 返回值 [#返回值-6]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="getlocaltrapezoidcorrectionoptions"></a>
### getLocalTrapezoidCorrectionOptions [#getlocaltrapezoidcorrectionoptions]

```cpp
virtual int getLocalTrapezoidCorrectionOptions(TrapezoidCorrectionOptions& options, VIDEO_SOURCE_TYPE sourceType = VIDEO_SOURCE_CAMERA_PRIMARY) = 0;
```

获取本地透视校正配置参数。

#### 参数 [#参数-7]

| 参数 | 说明 |
| --- | --- |
| `options` | [in/out] 透视校正配置参数。详见 [`TrapezoidCorrectionOptions`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#trapezoidcorrectionoptions)。对于输出参数而言，如果之前多次设置过透视校正参数，则获取的是之前多次设置的参数集合。 |
| `sourceType` | [correction-windows-html-7-2-1 details](#table-slot-correction-windows-html-7-2-1) |

<a id="table-slot-correction-windows-html-7-2-1"></a>

**correction-windows-html-7-2-1 details**

视频源类型：

- `VIDEO_SOURCE_CAMERA_PRIMARY(0)`：（默认）在第一个摄像头开启或关闭透视校正。
- `VIDEO_SOURCE_CAMERA_SECONDARY(1)`：在第二个摄像头开启或关闭透视校正。

#### 返回值 [#返回值-7]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="settrapezoidcorrectionoptions"></a>
### setRemoteTrapezoidCorrectionOptions [#setremotetrapezoidcorrectionoptions]

```cpp
virtual int setRemoteTrapezoidCorrectionOptions(uid_t uid, const TrapezoidCorrectionOptions& options) = 0;
```

配置远端透视校正选项。

#### 参数 [#参数-8]

| 参数 | 说明 |
| --- | --- |
| `uid` | 远端用户 ID。 |
| `options` | 透视校正配置参数。详见 [`TrapezoidCorrectionOptions`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#trapezoidcorrectionoptions)。 |

#### 返回值 [#返回值-8]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="settrapezoidcorrectionoptionsex"></a>
### setRemoteTrapezoidCorrectionOptionsEx [#setremotetrapezoidcorrectionoptionsex]

```cpp
virtual int setRemoteTrapezoidCorrectionOptionsEx(uid_t uid, const TrapezoidCorrectionOptions& options, const RtcConnection& connection) = 0;
```

（适用于多频道）配置远端透视校正选项。

#### 参数 [#参数-9]

| 参数 | 说明 |
| --- | --- |
| `uid` | 远端用户 ID。 |
| `options` | 透视校正配置参数。详见 [`TrapezoidCorrectionOptions`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#trapezoidcorrectionoptions)。 |
| `connection` | Connection 信息。详见 [`RtcConnection`](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 |

#### 返回值 [#返回值-9]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="gettrapezoidcorrectionoptions"></a>
### getRemoteTrapezoidCorrectionOptions [#getremotetrapezoidcorrectionoptions]

```cpp
virtual int getRemoteTrapezoidCorrectionOptions(uid_t uid, TrapezoidCorrectionOptions& options) = 0;
```

获取远端透视校正配置参数。

#### 参数 [#参数-10]

| 参数    | 说明                                                |
| :------ | :-------------------------------------------------- |
| `uid`     | 远端用户 ID。                                      |
| `options` | [in/out] 透视校正配置参数。详见 [`TrapezoidCorrectionOptions`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#trapezoidcorrectionoptions)。对于输出参数而言，如果之前多次设置过透视校正参数，则获取的是之前多次设置的参数集合。 |

#### 返回值 [#返回值-10]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="gettrapezoidcorrectionoptionsex"></a>
### getRemoteTrapezoidCorrectionOptionsEx [#getremotetrapezoidcorrectionoptionsex]

```cpp
virtual int getRemoteTrapezoidCorrectionOptionsEx(uid_t uid, TrapezoidCorrectionOptions& options, const RtcConnection& connection) = 0;
```

（适用于多频道）获取远端透视校正配置参数。

#### 参数 [#参数-11]

| 参数 | 说明 |
| --- | --- |
| `uid` | 远端用户 ID。 |
| `options` | [in/out] 透视校正配置参数。详见 [`TrapezoidCorrectionOptions`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#trapezoidcorrectionoptions)。对于输出参数而言，如果之前多次设置过透视校正参数，则获取的是之前多次设置的参数集合。 |
| `connection` | Connection 信息。详见 [`RtcConnection`](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 |

#### 返回值 [#返回值-11]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="applytrapezoidcorrectiontoremote"></a>
### applyTrapezoidCorrectionToRemote [#applytrapezoidcorrectiontoremote]

```cpp
virtual int applyTrapezoidCorrectionToRemote(uid_t uid, bool enabled) = 0;
```

将透视校正参数应用到远端用户在本地的预览画面。

#### 参数 [#参数-12]

| 参数 | 说明 |
| --- | --- |
| `uid` | 远端用户 ID。 |
| `enabled` | [correction-windows-html-11-2-1 details](#table-slot-correction-windows-html-11-2-1) |

<a id="table-slot-correction-windows-html-11-2-1"></a>

**correction-windows-html-11-2-1 details**

是否将透视校正参数应用到远端用户在本地的预览画面：

- `true`：应用。
- `false`：不应用。

#### 返回值 [#返回值-12]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="applytrapezoidcorrectiontoremoteex"></a>
### applyTrapezoidCorrectionToRemoteEx [#applytrapezoidcorrectiontoremoteex]

```cpp
virtual int applyTrapezoidCorrectionToRemoteEx(uid_t uid, bool enabled, const RtcConnection& connection) = 0;
```

（适用于多频道）将透视校正参数应用到远端用户在本地的预览画面。

#### 参数 [#参数-13]

| 参数 | 说明 |
| --- | --- |
| `uid` | 远端用户 ID。 |
| `enabled` | [correction-windows-html-12-2-1 details](#table-slot-correction-windows-html-12-2-1) |
| `connection` | Connection 信息。详见 [`RtcConnection`](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 |

<a id="table-slot-correction-windows-html-12-2-1"></a>

**correction-windows-html-12-2-1 details**

是否将透视校正参数应用到远端用户在本地的预览画面：

- `true`：应用。
- `false`：不应用。

#### 返回值 [#返回值-13]

- 0：方法调用成功。
- &lt; 0：方法调用失败。

<a id="ontrapezoidcorrectionfinished"></a>
### onTrapezoidAutoCorrectionFinished [#ontrapezoidautocorrectionfinished]

```cpp
virtual void onTrapezoidAutoCorrectionFinished(uid_t uid, TrapezoidAutoCorrectionResult result, int costTime,
      const TrapezoidCorrectionOptions::Point* dragSrcPoints, int dragSrcPointsLen,
      const TrapezoidCorrectionOptions::Point* dragDstPoints, int dragDstPointsLen) {
    (void)uid;
    (void)result;
    (void)costTime;
    (void)dragSrcPoints;
    (void)dragSrcPointsLen;
    (void)dragDstPoints;
    (void)dragDstPointsLen;
  }
```

自动透视校正完成时触发。

#### 参数 [#参数-14]

| 参数 | 说明 |
| --- | --- |
| `uid` | 开启自动透视校正的远端用户 ID。 |
| `result` | [correction-windows-html-13-2-1 details](#table-slot-correction-windows-html-13-2-1) |
| `costTime` | 透视校正花费的时间 (ms)。 |
| `dragSrcPoints` | 拖动起始点时的梯形四个顶点坐标。 |
| `dragSrcPointsLen` | `dragSrcPoints` 数组长度。 |
| `dragDstPoints` | 拖动结束点时的梯形四个顶点坐标。 |
| `dragDstPointsLen` | `dragDstPoints` 数组长度。 |

<a id="table-slot-correction-windows-html-13-2-1"></a>

**correction-windows-html-13-2-1 details**

自动透视校正结果：

- `RESULT_OK(0)`：成功。
- `RESULT_FAILED(-1)`：失败。

<a id="ontrapezoidcorrectionfinished2"></a>
### onTrapezoidAutoCorrectionFinished（多频道） [#ontrapezoidautocorrectionfinished多频道]

```cpp
virtual void onTrapezoidAutoCorrectionFinished(const RtcConnection& connection, uid_t uid,
      TrapezoidAutoCorrectionResult result, int costTime,
      const TrapezoidCorrectionOptions::Point* dragSrcPoints, int dragSrcPointsLen,
      const TrapezoidCorrectionOptions::Point* dragDstPoints, int dragDstPointsLen) {
    (void)connection;
    (void)uid;
    (void)result;
    (void)costTime;
    (void)dragSrcPoints;
    (void)dragSrcPointsLen;
    (void)dragDstPoints;
    (void)dragDstPointsLen;
  }
```

自动透视校正完成时触发。

#### 参数 [#参数-15]

| 参数 | 说明 |
| --- | --- |
| `uid` | 开启自动透视校正的远端用户 ID。 |
| `result` | [correction-windows-html-14-2-1 details](#table-slot-correction-windows-html-14-2-1) |
| `costTime` | 透视校正花费的时间 (ms)。 |
| `dragSrcPoints` | 拖动起始点时的梯形四个顶点坐标。 |
| `dragSrcPointsLen` | `dragSrcPoints` 数组长度。 |
| `dragDstPoints` | 拖动结束点时的梯形四个顶点坐标。 |
| `dragDstPointsLen` | `dragDstPoints` 数组长度。 |
| `connection` | Connection 信息。详见 [`RtcConnection`](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 |

<a id="table-slot-correction-windows-html-14-2-1"></a>

**correction-windows-html-14-2-1 details**

自动透视校正结果：

- `RESULT_OK(0)`：成功。
- `RESULT_FAILED(-1)`：失败。

<a id="trapezoidcorrectionoptions"></a>
## 数据类型 [#数据类型]
### TrapezoidCorrectionOptions [#trapezoidcorrectionoptions]

```cpp
struct TrapezoidCorrectionOptions {
  enum {
      POINT_ARRAY_LEN = 8,
  };
  struct Point {
    float x;    // value in [0.0 - 1.0]
    float y;    // value in [0.0 - 1.0]
  };

  TrapezoidCorrectionOptions():hasMultiPoints(false){}

  void setDragSrcPoint(Point pt)
  {
    dragSrcPoint = pt;
  }

  void setDragDstPoint(Point pt)
  {
    dragDstPoint = pt;
  }

  void setDragFinished(int finished)
  {
    dragFinished = finished;
  }

  void setDragSrcPoints(Point topLeft, Point bottomLeft, Point topRight, Point bottomRight)
  {
    dragSrcPoints[0] = topLeft.x;
    dragSrcPoints[1] = topLeft.y;
    dragSrcPoints[2] = bottomLeft.x;
    dragSrcPoints[3] = bottomLeft.y;
    dragSrcPoints[4] = topRight.x;
    dragSrcPoints[5] = topRight.y;
    dragSrcPoints[6] = bottomRight.x;
    dragSrcPoints[7] = bottomRight.y;
    hasMultiPoints = true;
  }

  void setDragDstPoints(Point topLeft, Point bottomLeft, Point topRight, Point bottomRight)
  {
    dragDstPoints[0] = topLeft.x;
    dragDstPoints[1] = topLeft.y;
    dragDstPoints[2] = bottomLeft.x;
    dragDstPoints[3] = bottomLeft.y;
    dragDstPoints[4] = topRight.x;
    dragDstPoints[5] = topRight.y;
    dragDstPoints[6] = bottomRight.x;
    dragDstPoints[7] = bottomRight.y;
    hasMultiPoints = true;
  }

  void showAssistLine(int show)
  {
    assistLine = show;
  }

  void setAutoCorrect(int autoCorr)
  {
    autoCorrect = autoCorr;
  }

  void setMirror(int mirr)
  {
    mirror = mirr;
  }

  void setResetDragPoints(int reset)
  {
    resetDragPoints = reset;
  }

  Optional<Point> dragSrcPoint;
  Optional<Point> dragDstPoint;
  Optional<int> dragFinished;       //value: 0 or 1
  float dragSrcPoints[POINT_ARRAY_LEN];
  float dragDstPoints[POINT_ARRAY_LEN];
  bool hasMultiPoints; // if true, indicates dragSrcPoints and dragDstPoints have valid values
  Optional<int> assistLine;         //value: 0 or 1
  Optional<int> autoCorrect;        //value: 0 or 1
  Optional<int> mirror;             //value: 0 or 1, only set if not use sdk renderer, such as custom renderer
  Optional<int> resetDragPoints;    //value: 0 or 1
};
```

透视校正参数配置，包含以下成员：

#### Point [#point]

- `x`：x 坐标，根据屏幕宽度归一化为 [0.0~1.0] 的浮点数。
- `y`：y 坐标，根据屏幕高度归一化为 [0.0~1.0] 的浮点数。

#### setDragSrcPoint [#setdragsrcpoint]

设置拖动起始点坐标。

| 参数 | 说明                         |
| :--- | :--------------------------- |
| `pt`   | 拖动起始点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |

#### setDragDstPoint [#setdragdstpoint]

设置拖动终止点坐标。

如果同时调用 `setDragSrcPoint`、`setDragDstPoint`、`setDragFinished` 和 `setDragSrcPoints`、`setDragDstPoints`，则 `setDragSrcPoints`、`setDragDstPoints` 的设置生效。

| 参数 | 说明                         |
| :--- | :--------------------------- |
| `pt`   | 拖动终止点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |

#### setDragFinished [#setdragfinished]

设置该次拖动调整是否结束。

| 参数 | 说明 |
| --- | --- |
| `finished` | [correction-windows-html-15-1-1 details](#table-slot-correction-windows-html-15-1-1) |

<a id="table-slot-correction-windows-html-15-1-1"></a>

**correction-windows-html-15-1-1 details**

本次拖动调整是否结束：

- `0`：未结束。
- `1`：已结束。

#### setDragSrcPoints [#setdragsrcpoints]

同时设置 4 个点的拖动起始点坐标。

| 参数        | 说明                               |
| :---------- | :--------------------------------- |
| `topLeft`     | 左上角拖动起始点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |
| `bottomLeft`  | 左下角拖动起始点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |
| `topRight`    | 右上角拖动起始点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |
| `bottomRight` | 右下角拖动起始点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |

#### setDragDstPoints [#setdragdstpoints]

同时设置 4 个点的拖动终止点坐标。

| 参数        | 说明                               |
| :---------- | :--------------------------------- |
| `topLeft`     | 左上角拖动终止点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |
| `bottomLeft`  | 左下角拖动终止点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |
| `topRight`    | 右上角拖动终止点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |
| `bottomRight` | 右下角拖动终止点坐标。详见 [`Point`](/zh-CN/api-reference/online-art-teaching/cpp-all-platforms/api/correction#point)。 |

#### showAssistLine [#showassistline]

开启或关闭辅助线。初始值为关闭。

| 参数 | 说明 |
| --- | --- |
| `show` | [correction-windows-html-16-1-1 details](#table-slot-correction-windows-html-16-1-1) |

<a id="table-slot-correction-windows-html-16-1-1"></a>

**correction-windows-html-16-1-1 details**

开启或关闭辅助线：

- `0`：关闭。
- `1`：开启。

#### setAutoCorrect [#setautocorrect]

开启或关闭自动透视校正。初始值为关闭。

| 参数 | 说明 |
| --- | --- |
| `autoCorr` | [correction-windows-html-17-1-1 details](#table-slot-correction-windows-html-17-1-1) |

<a id="table-slot-correction-windows-html-17-1-1"></a>

**correction-windows-html-17-1-1 details**

开启或关闭自动透视校正：

- `0`：关闭。关闭之后，你需要手动设置拖动点坐标。
- `1`：开启。开启之后，SDK 会自动进行透视校正。你无法手动设置拖动点坐标。

#### setMirror [#setmirror]

启用或关闭镜像。初始值为关闭。

只有使用自定义渲染功能并且自定义渲染开启水平镜像时，才需要启用镜像参数。

| 参数 | 说明 |
| --- | --- |
| `mirr` | [correction-windows-html-18-1-1 details](#table-slot-correction-windows-html-18-1-1) |

<a id="table-slot-correction-windows-html-18-1-1"></a>

**correction-windows-html-18-1-1 details**

开启或关闭镜像：

- `0`：关闭。
- `1`：开启。设置输入的点坐标与实际输入图像是水平镜像。

#### setResetDragPoints [#setresetdragpoints]

重置透视校正效果。初始值为不重置。

| 参数 | 说明 |
| --- | --- |
| `reset` | [correction-windows-html-19-1-1 details](#table-slot-correction-windows-html-19-1-1) |

<a id="table-slot-correction-windows-html-19-1-1"></a>

**correction-windows-html-19-1-1 details**

是否重置透视校正效果：

- `0`：不重置透视校正效果。
- `1`：重置透视校正效果。重置后，画面恢复为校正前的效果。