com.herewhite.sdk.domain.PptPage class 参考

适用版本：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；继承接口详见父类。

属性与 JSON 字段

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

字段	声明	源码初值	说明
src	String src	未显式赋值	模型属性；通过对应 getter/setter 访问。
width	Double width	未显式赋值	模型属性；通过对应 getter/setter 访问。
height	Double height	未显式赋值	模型属性；通过对应 getter/setter 访问。
preview	String preview	未显式赋值	模型属性；通过对应 getter/setter 访问。

公开成员签名
	PptPage (String src, Double width, Double height)
	PptPage (String src, Double width, Double height, String preview)
String	getSrc ()
void	setSrc (String src)
double	getWidth ()
void	setWidth (double width)
double	getHeight ()
void	setHeight (double height)
String	getPreview ()
void	setPreview (String preview)

变量说明

src

String src

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

width

Double width

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

height

Double height

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

preview

String preview

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

函数说明

PptPage()

PptPage(String src, Double width, Double height)

PptPage 构造方法，用于创建待插入场景的图片或动态 PPT 实例。

注解

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

参数

参数名	描述
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 字段的值。
width	图片或动态 PPT 在白板中的宽度，单位为像素。
height	图片或动态 PPT 在白板中的高度，单位为像素。

PptPage()

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

PptPage 构造方法，用于创建待插入场景的图片或动态 PPT 实例。

注解

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

参数

参数名	描述
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 字段的值。
width	图片或动态 PPT 在白板中的宽度，单位为像素。
height	图片或动态 PPT 在白板中的高度，单位为像素。
preview	图片或动态 PPT 预览图的 URL 地址。动态 PPT 预览图的 URL 地址可以从查询转换任务的进度中的 preview 字段获取，例如，"https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/dynamicConvert/2fdxxxxx67e/preview/1.png"。

getSrc()

String getSrc()

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

返回值

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

setSrc()

void setSrc(String src)

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

参数

参数名	描述
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 字段的值。

getWidth()

double getWidth()

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

返回值

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

setWidth()

void setWidth(double width)

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

参数

参数名	描述
width	图片或动态 PPT 在白板中的宽度，单位为像素。

getHeight()

double getHeight()

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

返回值

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

setHeight()

void setHeight(double height)

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

返回值

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

getPreview()

String getPreview()

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

返回值

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

setPreview()

void setPreview(String preview)

指定图片或 PPT 预览图。

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

参数

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