# com.herewhite.sdk.domain.PptPage class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page)

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

<a id="details"></a>

## 详细描述 [#详细描述]

适用版本：**Whiteboard Android SDK 2.16.134**。

`PptPage` 类，用于配置待插入场景的图片或动态 PPT 页的参数。

你可以在场景初始化时传入 `PptPage` 实例，以在白板上展示图片或动态 PPT。

场景中可插入的图片或动态 PPT 包括：
- PNG、JPG/JPEG、WEBP 格式的图片，或由 PPT、PPTX、DOC、DOCX、PDF 格式的文件转换成 PNG、JPG/JPEG、WEBP 格式的图片。
- 使用 Agora 互动文档转换功能 转换过的 PPTX 文件。

父类：[WhiteObject](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object)；继承接口详见父类。

## 属性与 JSON 字段 [#属性与-json-字段]

Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [src](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a92c6ca4410d921c7ff968804afa885e2) | `String src` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [width](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#aa5e5399ce5b20da85baff4cb54e87b03) | `Double width` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [height](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a9be8630ebb3f0feca755736542855c5c) | `Double height` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) |
| [preview](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a74622a8e0fb456b5f11d07cb3136b9ce) | `String preview` | 未显式赋值 | [api-center-table-3 details](#table-slot-api-center-table-3) |

<a id="table-slot-api-center-table-0"></a>

**api-center-table-0 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-1"></a>

**api-center-table-1 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-2"></a>

**api-center-table-2 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-3"></a>

**api-center-table-3 details**

模型属性；通过对应 getter/setter 访问。

| 公开成员签名 |  |
| --- | --- |
|  | [PptPage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a577251d4956da9eb8dd216023c5cb3b7) (String src, Double width, Double height) |
|  | [PptPage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#aec14d76824a99642fc4e5364ccbff420) (String src, Double width, Double height, String preview) |
| String | [getSrc](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#ae1e1691f95694c2da54bcb390c01fad0) () |
| void | [setSrc](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a32eaf6b4c7be1415670ad4a1103a856f) (String src) |
| double | [getWidth](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a2334c7c47094700b08df2533a4ab7a90) () |
| void | [setWidth](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a3cceb044435f264e9362aaf17e0fd1c1) (double width) |
| double | [getHeight](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a81eccdf6bc1367cac66349afc1779181) () |
| void | [setHeight](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a2c803e867417dee09d4d553130060c2e) (double height) |
| String | [getPreview](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#ab5bdd263b6454635b1546f412f65f718) () |
| void | [setPreview](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page#a6b0289593399d9264cc634effcb9a472) (String preview) |

## 变量说明 [#变量说明]

<a id="a92c6ca4410d921c7ff968804afa885e2"></a>

### src [#src]

```text
String src
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="aa5e5399ce5b20da85baff4cb54e87b03"></a>

### width [#width]

```text
Double width
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a9be8630ebb3f0feca755736542855c5c"></a>

### height [#height]

```text
Double height
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a74622a8e0fb456b5f11d07cb3136b9ce"></a>

### preview [#preview]

```text
String preview
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

## 函数说明 [#函数说明]

<a id="a577251d4956da9eb8dd216023c5cb3b7"></a>

### PptPage() [#pptpage]

<ApiSignature>

PptPage(String src, Double width, Double height)

</ApiSignature>

[`PptPage`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page) 构造方法，用于创建待插入场景的图片或动态 PPT 实例。

:::info[注解]
- 该方法只能在场景初始化的时候调用。
- 该方法只能展示使用旧版文档转换功能转换过的动态 PPT。
- 每个场景中只能插入一张图片和一页动态 PPT。
- 场景中展示的图片或动态 PPT 中心点默认为白板内部坐标系得原点且无法移动，即无法改变图片或动态 PPT 在白板内部的位置。
:::

<ParameterList title="参数">
<Parameter name="src">

图片或动态 PPT 页的地址，支持的格式如下：

- 图片：URL 地址，可以是你自己生成的 URL 地址，也可以是通过文档转换功能生成的 URL 地址，例如，`"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg"`。
- 动态 PPT 页：通过文档转换功能生成的 URI 地址，例如，`"pptx://cover.herewhite.com/dynamicConvert/6a212c90fa5311ea8b9c074232aaccd4/1.slide"`，即查询转换任务的进度中 `conversionFileUrl` 字段的值。

</Parameter>
<Parameter name="width">

图片或动态 PPT 在白板中的宽度，单位为像素。

</Parameter>
<Parameter name="height">

图片或动态 PPT 在白板中的高度，单位为像素。

</Parameter>
</ParameterList>

<a id="aec14d76824a99642fc4e5364ccbff420"></a>

### PptPage() [#pptpage-1]

<ApiSignature>

PptPage(String src, Double width, Double height, String preview)

</ApiSignature>

[`PptPage`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page) 构造方法，用于创建待插入场景的图片或动态 PPT 实例。

:::info[注解]
- 该方法只能在场景初始化的时候调用。
- 该方法只能展示使用旧版文档转换功能转换过的动态 PPT。
- 每个场景中只能插入一张图片或一页动态 PPT。
- 场景中展示的图片或动态 PPT 中心点默认为白板内部坐标系得原点且无法移动，即无法改变图片或动态 PPT 在白板内部的位置。
:::

<ParameterList title="参数">
<Parameter name="src">

图片或动态 PPT 页的地址，支持的格式如下：

- 图片：URL 地址，可以是你自己生成的 URL 地址，也可以是通过文档转换功能生成的 URL 地址，例如，`"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg"`。
- 动态 PPT 页：通过文档转换功能生成的 URI 地址，例如，`"pptx://cover.herewhite.com/dynamicConvert/6a212c90fa5311ea8b9c074232aaccd4/1.slide"`，即查询转换任务的进度中 `conversionFileUrl` 字段的值。

</Parameter>
<Parameter name="width">

图片或动态 PPT 在白板中的宽度，单位为像素。

</Parameter>
<Parameter name="height">

图片或动态 PPT 在白板中的高度，单位为像素。

</Parameter>
<Parameter name="preview">

图片或动态 PPT 预览图的 URL 地址。动态 PPT 预览图的 URL 地址可以从查询转换任务的进度中的 `preview` 字段获取，例如，`"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/dynamicConvert/2fdxxxxx67e/preview/1.png"`。

</Parameter>
</ParameterList>

<a id="ae1e1691f95694c2da54bcb390c01fad0"></a>

### getSrc() [#getsrc]

<ApiSignature>

String getSrc()

</ApiSignature>

获取场景图片或动态 PPT 的地址。

<h4 data-toc-hidden="true" id={"返回值"}>返回值</h4>

图片的 URL 地址或动态 PPT 的 URI 地址。

<a id="a32eaf6b4c7be1415670ad4a1103a856f"></a>

### setSrc() [#setsrc]

<ApiSignature>

void setSrc(String src)

</ApiSignature>

指定待插入场景的图片或动态 PPT。

<ParameterList title="参数">
<Parameter name="src">

图片或动态 PPT 页的地址，支持的格式如下：

- 图片：URL 地址，可以是你自己生成的 URL 地址，也可以是通过文档转换功能生成的 URL 地址，例如，`"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg"`。
- 动态 PPT 页：通过文档转换功能生成的 URI 地址，例如，`"pptx://cover.herewhite.com/dynamicConvert/6a212c90fa5311ea8b9c074232aaccd4/1.slide"`，即查询转换任务的进度中 `conversionFileUrl` 字段的值。

</Parameter>
</ParameterList>

<a id="a2334c7c47094700b08df2533a4ab7a90"></a>

### getWidth() [#getwidth]

<ApiSignature>

double getWidth()

</ApiSignature>

获取图片或动态 PPT 在白板中的宽度。

<h4 data-toc-hidden="true" id={"返回值-1"}>返回值</h4>

图片或动态 PPT 在白板中的宽度，单位为像素。

<a id="a3cceb044435f264e9362aaf17e0fd1c1"></a>

### setWidth() [#setwidth]

<ApiSignature>

void setWidth(double width)

</ApiSignature>

设置图片或动态 PPT 在白板中的宽度。

<ParameterList title="参数">
<Parameter name="width">

图片或动态 PPT 在白板中的宽度，单位为像素。

</Parameter>
</ParameterList>

<a id="a81eccdf6bc1367cac66349afc1779181"></a>

### getHeight() [#getheight]

<ApiSignature>

double getHeight()

</ApiSignature>

获取图片或动态 PPT 在白板中的高度。

<h4 data-toc-hidden="true" id={"返回值-2"}>返回值</h4>

图片或动态 PPT 在白板中的高度，单位为像素。

<a id="a2c803e867417dee09d4d553130060c2e"></a>

### setHeight() [#setheight]

<ApiSignature>

void setHeight(double height)

</ApiSignature>

设置图片或动态 PPT 在白板中的高度。

<h4 data-toc-hidden="true" id={"返回值-3"}>返回值</h4>

图片或动态 PPT 在白板中的高度，单位为像素。

<a id="ab5bdd263b6454635b1546f412f65f718"></a>

### getPreview() [#getpreview]

<ApiSignature>

String getPreview()

</ApiSignature>

获取图片或动态 PPT 预览图的 URL 地址。

<h4 data-toc-hidden="true" id={"返回值-4"}>返回值</h4>

图片的或动态 PPT 预览图的 URL 地址。

<a id="a6b0289593399d9264cc634effcb9a472"></a>

### setPreview() [#setpreview]

<ApiSignature>

void setPreview(String preview)

</ApiSignature>

指定图片或 PPT 预览图。

通过该方法指定的预览图会展示在白板右侧的页面预览中。

<ParameterList title="参数">
<Parameter name="preview">

图片或动态 PPT 预览图的 URL 地址。动态 PPT 预览图的 URL 地址可以从查询转换任务的进度中的 `preview` 字段获取，例如，`"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/dynamicConvert/2fdxxxxx67e/preview/1.png"`。

</Parameter>
</ParameterList>