Documentation
Interactive Whiteboard
Console Agora.io Community Submit ticket
English
search-icon

Agora Java API Reference for Android

Overview WhiteSdk Room Displayer
Inheritance diagram for com.herewhite.sdk.domain.Scene:
com.herewhite.sdk.domain.WhiteObject

Public Member Functions

 Scene ()
 
 Scene (String name)
 
 Scene (String name, PptPage ppt)
 
String getName ()
 
void setName (String name)
 
Long getComponentsCount ()
 
PptPage getPpt ()
 
void setPpt (PptPage ppt)
 
- Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String toString ()
 
JSONObject toJSON ()
 

Detailed Description

Settings for a scene.

Constructor & Destructor Documentation

◆ Scene() [1/3]

com.herewhite.sdk.domain.Scene.Scene ( )

The Scene constructor, for initializing a Scene object.

Note
When you insert the scene initialized by calling this method, the SDK randomly names the new scene.

◆ Scene() [2/3]

com.herewhite.sdk.domain.Scene.Scene ( String  name)

The Scene constructor, for initializing a Scene object.

Parameters
nameThe name of the scene.

◆ Scene() [3/3]

com.herewhite.sdk.domain.Scene.Scene ( String  name,
PptPage  ppt 
)

The Scene constructor, for initializing a Scene object.

Parameters
nameThe name of the scene.
pptSettings of the image or dynamic PPT slide to be inserted into the scene. See PptPage.

Member Function Documentation

◆ getName()

String com.herewhite.sdk.domain.Scene.getName ( )

Gets the name of the scene.

Returns
The name of the scene.

◆ setName()

void com.herewhite.sdk.domain.Scene.setName ( String  name)

Sets the name of the scene.

Parameters
nameThe name of the scene.

◆ getComponentsCount()

Long com.herewhite.sdk.domain.Scene.getComponentsCount ( )

Gets the number of strokes in the scene.

Deprecated:
This method is deprecated.This method call returns null.
Returns
The number of strokes in the scene.

◆ getPpt()

PptPage com.herewhite.sdk.domain.Scene.getPpt ( )

Gets the settings of the image or dynamic PPT slide to be inserted into the scene.

Returns
Settings of the image or dynamic PPT slide to be inserted into the scene. See PptPage.

◆ setPpt()

void com.herewhite.sdk.domain.Scene.setPpt ( PptPage  ppt)

Sets the image or the dynamic PPT slide to be inserted into the scene.

Parameters
pptSettings of the image or dynamic PPT slide to be inserted into the scene. See PptPage.