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

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

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

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

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

场景类。

父类：[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。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [name](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a9aa854fb7a31c674f849fc1cceca1511) | `String name` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [componentsCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#ab8a6484bac80064fc494a53adbda78a5) | `Long componentsCount` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [ppt](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a452792c4e15f1ad14a38daca73eec0f4) | `PptPage ppt` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) |

<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 访问。

| 公开成员签名 |  |
| --- | --- |
|  | [Scene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a72a4c34033dc9b895087bee4e85b18d5) () |
|  | [Scene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#af8d66512c31f87ae1a261ceae4440cb2) (String name) |
|  | [Scene](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#afae37ad99f72e40d020bce1eb4a1ccdc) (String name, PptPage ppt) |
| String | [getName](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a7443b00123211e13c71edf56b835c5b5) () |
| void | [setName](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a3e1283ab87638981dca4d4c7927713ea) (String name) |
| Long | [getComponentsCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a34d502da53a9c901c12633589526238d) () |
| PptPage | [getPpt](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a8e942554e8659d876bf626d601c815d3) () |
| void | [setPpt](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene#a2a9924568d6fad50a8a54ed9cf9c1704) (PptPage ppt) |

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

<a id="a9aa854fb7a31c674f849fc1cceca1511"></a>

### name [#name]

```text
String name
```

源码初值：未显式赋值

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

<a id="ab8a6484bac80064fc494a53adbda78a5"></a>

### componentsCount [#componentscount]

```text
Long componentsCount
```

源码初值：未显式赋值

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

<a id="a452792c4e15f1ad14a38daca73eec0f4"></a>

### ppt [#ppt]

```text
PptPage ppt
```

源码初值：未显式赋值

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

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

<a id="a72a4c34033dc9b895087bee4e85b18d5"></a>

### Scene() [#scene]

<ApiSignature>

Scene()

</ApiSignature>

[`Scene`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene) 构造方法，用于初始化场景实例。

:::info[注解]
在插入调用该方法初始化的场景时，SDK 会随机给新场景命名。
:::

<a id="af8d66512c31f87ae1a261ceae4440cb2"></a>

### Scene() [#scene-1]

<ApiSignature>

Scene(String name)

</ApiSignature>

[`Scene`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene) 构造方法，用于初始化场景实例。

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

场景名称。

</Parameter>
</ParameterList>

<a id="afae37ad99f72e40d020bce1eb4a1ccdc"></a>

### Scene() [#scene-2]

<ApiSignature>

Scene(String name, PptPage ppt)

</ApiSignature>

[`Scene`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene) 构造方法，用于初始化场景实例。

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

场景名称。

</Parameter>
<Parameter name="ppt">

在场景中展示的图片或动态 PPT 的参数配置。详见 [`PptPage`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page)。

</Parameter>
</ParameterList>

<a id="a7443b00123211e13c71edf56b835c5b5"></a>

### getName() [#getname]

<ApiSignature>

String getName()

</ApiSignature>

获取场景名称。

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

场景名称。

<a id="a3e1283ab87638981dca4d4c7927713ea"></a>

### setName() [#setname]

<ApiSignature>

void setName(String name)

</ApiSignature>

设置场景名称。

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

场景名称。

</Parameter>
</ParameterList>

<a id="a34d502da53a9c901c12633589526238d"></a>

### getComponentsCount() [#getcomponentscount]

<ApiSignature>

Long getComponentsCount()

</ApiSignature>

获取场景中的笔画数。

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

场景中的笔画数。

<a id="弃用"></a>

:::error[弃用:]
该方法已废弃。如果调用，会返回 `null`。
:::

<a id="a8e942554e8659d876bf626d601c815d3"></a>

### getPpt() [#getppt]

<ApiSignature>

PptPage getPpt()

</ApiSignature>

获取在场景中展示的图片或动态 PPT 的参数配置。

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

在场景中展示的图片或动态 PPT 的参数配置，详见 [`PptPage`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page)。

<a id="a2a9924568d6fad50a8a54ed9cf9c1704"></a>

### setPpt() [#setppt]

<ApiSignature>

void setPpt(PptPage ppt)

</ApiSignature>

设置在场景中展示的图片或动态 PPT 的参数。

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

在场景中展示的图片或动态 PPT 的参数配置，详见 [`PptPage`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-ppt-page)。

</Parameter>
</ParameterList>