com.herewhite.sdk.domain.PptPage Class Reference

Inheritance diagram for com.herewhite.sdk.domain.PptPage:

Public Member Functions
	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)
Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String	toString ()
JSONObject	toJSON ()

Detailed Description

The PptPage class, for setting the parameters of an image or dynamic PPT slide.

You can pass in a PptPage object when initializing a Scene instance to present the image or dynamic PPT slide on the whiteboard scene.

You can insert the following formats of an image or dynamic PPT slide on the whiteboard scene:

• Static images in PNG, JPG/JPEG, and WEBP formats, or PNG, JPG/JPEG, and WEBP images which are converted from PPT, PPTX, DOC, DOCX, and PDF files.
• Dynamic PPT slides which are converted from PPTX files using the Agora file conversion service.

Constructor & Destructor Documentation

PptPage() [1/2]

com.herewhite.sdk.domain.PptPage.PptPage	(	String	src,
		Double	width,
		Double	height
	)

The PptPage constructor, for initializing a PptPage instance to be inserted on a whiteboard scene.

Note

• Call this method when initializing a whiteboard scene.
• You can insert only one image or dynamic PPT slide on a whiteboard scene.
• The image or dynamic PPT slide displayed on the whiteboard scene takes the origin of the world coordinate system as the center and cannot be changed, which means you cannot change the position of the image or dynamic PPT slide inside the whiteboard.

Parameters

src	The address of the image or dynamic PPT slide. The supported formats are as follows: For image: The URL address, which can be generated by yourself or by using the Agora file conversion service. For example, "https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg". For dynamic PPT slide: The URI address, which is generated by using the Agora file conversion service. For example, "pptx://cover.herewhite.com/dynamicConvert/6a212c90fa5311ea8b9c074232aaccd4/1.slide".
width	The width (px) of the image or dynamic PPT slide.
height	The height (px) of the image or dynamic PPT slide.

PptPage() [2/2]

com.herewhite.sdk.domain.PptPage.PptPage	(	String	src,
		Double	width,
		Double	height,
		String	preview
	)

The PptPage constructor, for initializing a PptPage instance to be inserted on a whiteboard scene.

Note

• Call this method when initializing a whiteboard scene.
• You can insert only one image or dynamic PPT slide on a whiteboard scene.
• The image or dynamic PPT slide displayed on the whiteboard scene takes the origin of the world coordinate system as the center and cannot be changed, which means you cannot change the position of the image or dynamic PPT slide inside the whiteboard.

Parameters

src	The address of the image or dynamic PPT slide. The supported formats are as follows: For image: The URL address, which can be generated by yourself or by using the Agora file conversion service. For example, "https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/staticConvert/2fdxxxxx67e/1.jpeg". For dynamic PPT slide: The URI address, which is generated by using the Agora file conversion service. For example, "pptx://cover.herewhite.com/dynamicConvert/6a212c90fa5311ea8b9c074232aaccd4/1.slide".
width	The width (px) of the image or dynamic PPT slide.
height	The height (px) of the image or dynamic PPT slide.
preview	The URL address of the preview for the image or dynamic PPT slide. You can get the URL address of the dynamic PPT preview in the preview field in the query result of the file conversion task. For example, "https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/dynamicConvert/2fdxxxxx67e/preview/1.png".

Member Function Documentation

getSrc()

String com.herewhite.sdk.domain.PptPage.getSrc

(

)

Gets the URL address of the image or the URI of the dynamic PPT slide.

Returns

The URL address of the image or the URI of the dynamic PPT slide.

setSrc()

void com.herewhite.sdk.domain.PptPage.setSrc

(

String

src

)

Sets the URL address of the image or the URI of the dynamic PPT slide.

Parameters

src	The URL address of the image or the URI of the dynamic PPT slide.

getWidth()

double com.herewhite.sdk.domain.PptPage.getWidth

(

)

Gets the width of the image or dynamic PPT slide.

Returns

The width (px) of the image or dynamic PPT slide.

setWidth()

void com.herewhite.sdk.domain.PptPage.setWidth

(

double

width

)

Sets the width of the image or dynamic PPT slide.

Parameters

width

The width (px) of the image or dynamic PPT slide.

getHeight()

double com.herewhite.sdk.domain.PptPage.getHeight

(

)

Gets the height of the image or dynamic PPT slide.

Returns

The height (px) of the image or dynamic PPT slide.

setHeight()

void com.herewhite.sdk.domain.PptPage.setHeight

(

double

height

)

Sets the height of the image or dynamic PPT slide.

Returns

The height (px) of the image or dynamic PPT slide.

getPreview()

String com.herewhite.sdk.domain.PptPage.getPreview

(

)

Gets the URL address of the image or the URI of the dynamic PPT slide.

Returns

The URL address of the image or the URI of the dynamic PPT slide.

setPreview()

void com.herewhite.sdk.domain.PptPage.setPreview

(

String

preview

)

Sets the URL address of the preview for the image or dynamic PPT slide.

This method displays the preview in the page preview area on the right side of the whiteboard.

Parameters

preview

The URL address of the preview for the image or dynamic PPT slide. You can get the URL address of the dynamic PPT preview in the preview field in the query result of the file conversion task. For example, "https://docs-test-xxx.oss-cn-hangzhou.aliyuncs.com/dynamicConvert/2fdxxxxx67e/preview/1.png".