需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

com.herewhite.sdk.Displayer class 参考

  • Android

更新时间不可用

详细描述

适用版本：Whiteboard Android SDK 2.16.134。

Displayer 类。该类为 Room 类和 Player 类的父类。 Room 和 Player 类可以继承该类下的方法。

属性与 JSON 字段

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

字段声明源码初值说明
backgroundColorint backgroundColorColor.WHITE

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

syncedStoreSyncedStore syncedStore未显式赋值

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

表格内容超出当前宽度，可横向滚动查看更多列。
公开成员签名
voidpostIframeMessage (String string)
voidpostIframeMessage (WhiteObject object)
voidgetScenePathType (String path, Promise<WhiteScenePathType> promise)
voidgetScene (String path, Promise<Scene> promise)
voidgetEntireScenes (Promise<Map<String, Scene[]>> promise)
voidrefreshViewSize ()
voidscaleIframeToFit ()
voidscalePptToFit ()
voidscalePptToFit (AnimationMode mode)
voidaddMagixEventListener (String eventName, EventListener eventListener)
voidaddHighFrequencyEventListener (String eventName, FrequencyEventListener eventListener, Integer fireInterval)
voidremoveMagixEventListener (String eventName)
voidconvertToPointInWorld (double x, double y, Promise<Point> promise)
voidsetCameraBound (CameraBound bound)
intgetBackgroundColor ()
voidsetBackgroundColor (int intColor)
voidgetScenePreviewImage (String scenePath, Promise<Bitmap> promise)
voidgetSceneSnapshotImage (String scenePath, Promise<Bitmap> promise)
voiddisableCameraTransform (Boolean disable)
voidmoveCamera (CameraConfig camera)
voidmoveCameraToContainer (RectangleConfig rectangle)
voidgetWindowManagerAttributes (Promise<String> promise)
SyncedStoregetSyncedStore ()
表格内容超出当前宽度，可横向滚动查看更多列。

变量说明

backgroundColor

Text
int backgroundColor

源码初值：Color.WHITE

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

syncedStore

Text
SyncedStore syncedStore

源码初值：未显式赋值

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

函数说明

postIframeMessage()

void postIframeMessage(String string)

向 iframe 插件发送字符串信息。

自从

2.11.4

参数
参数名描述
string

字符串格式的信息。

表格内容超出当前宽度，可横向滚动查看更多列。

postIframeMessage()

void postIframeMessage(WhiteObject object)

向 iframe 插件发送 key-value 格式的信息。

自从

2.11.4

参数
参数名描述
object

key-value 格式的信息，必须为 WhiteObject 的子类。

表格内容超出当前宽度，可横向滚动查看更多列。

getScenePathType()

void getScenePathType(String path, Promise<WhiteScenePathType> promise)

查询场景路径类型。

你可以在该方法中指定想要查询的场景路径，SDK 会返回该路径对应的场景类型。

参数
参数名描述
path

想要查询的场景路径。

promise

Promise<WhiteScenePathType> 接口实例，详见 Promise。你可以通过该接口获取 getScenePathType 方法的调用结果：

  • 如果方法调用成功，将返回场景路径类型。详见 WhiteScenePathType。
  • 如果方法调用失败，将返回错误信息。
表格内容超出当前宽度，可横向滚动查看更多列。

getScene()

void getScene(String path, Promise<Scene> promise)

获取指定场景的信息。

参数
参数名描述
path

场景的路径。请确保场景路径以 / 开头，并且由场景目录和场景名构成，例如，/math/classA。

promise

Promise<Scene> 接口实例，详见 Promise。你可以通过该接口获取 getScene 方法的调用结果：

  • 如果方法调用成功，将返回场景信息。详见 Scene。
  • 如果方法调用失败，将返回错误信息。
表格内容超出当前宽度，可横向滚动查看更多列。

getEntireScenes()

void getEntireScenes(Promise<Map<String, Scene[]>> promise)

获取当前房间内所有场景的信息。

参数
参数名描述
promise

Promise<Map<String, Scene[]>> 接口实例，详见 Promise。你可以通过该接口获取 getEntireScenes 方法的调用结果：

  • 如果方法调用成功，将返回当前房间内所有场景的信息。
  • 如果方法调用失败，将返回错误信息。
表格内容超出当前宽度，可横向滚动查看更多列。

refreshViewSize()

void refreshViewSize()

刷新白板的界面。

当 WhiteboardView 出现改变时，需要手动调用该方法刷新白板的界面。

scaleIframeToFit()

void scaleIframeToFit()

调整视角，以保证完整显示 H5 课件的内容。

自从

2.12.13

scalePptToFit()

void scalePptToFit()

以渐变模式调整视角，以保证完整显示 PPT 的内容。

自从

2.4.22

scalePptToFit()

void scalePptToFit(AnimationMode mode)

根据指定的动画模式调整视角，以保证完整显示 PPT 的内容。

自从

2.4.28

参数
参数名描述
mode

视角调整时的动画模式，详见 AnimationMode。

表格内容超出当前宽度，可横向滚动查看更多列。

addMagixEventListener()

void addMagixEventListener(String eventName, EventListener eventListener)

注册自定义事件监听。

成功注册后，你可以接收到对应的自定义事件通知。

注解

对于同名的自定义事件，SDK 仅支持触发一个回调。

参数
参数名描述
eventName

想要监听的自定义事件名称。

eventListener

自定义事件回调，详见 EventListener。如果添加多个同名的事件回调，则之前添加的回调会被覆盖。

表格内容超出当前宽度，可横向滚动查看更多列。

addHighFrequencyEventListener()

void addHighFrequencyEventListener(String eventName, FrequencyEventListener eventListener, Integer fireInterval)

注册高频自定义事件监听。

成功注册后，你可以接收到对应的自定义事件通知。

注解

对于同名的自定义事件，SDK 仅支持触发一个回调。

参数
参数名描述
eventName

想要监听的自定义事件名称。

eventListener

自定义事件回调，详见 FrequencyEventListener。如果添加多个同名的事件回调，则之前添加的回调会被覆盖。

fireInterval

SDK 触发回调的频率，单位为毫秒。该参数最小值为 500 ms，如果设置为低于该值会被重置为 500 ms。

表格内容超出当前宽度，可横向滚动查看更多列。

removeMagixEventListener()

void removeMagixEventListener(String eventName)

移除自定义事件监听。

参数
参数名描述
eventName

想要移除监听的自定义事件名称。

表格内容超出当前宽度，可横向滚动查看更多列。

convertToPointInWorld()

void convertToPointInWorld(double x, double y, Promise<Point> promise)

转换白板上点的坐标。

该方法可以将 Android 内部坐标系（以屏幕左上角为原点）中的坐标转换为世界坐标系（以白板初始化时的中点为原点）坐标。

参数
参数名描述
x

点在 Android 坐标系中的 X 轴坐标。

y

点在 Android 坐标系中的 Y 轴坐标。

promise

Promise<Point> 接口实例，详见 Promise。你可以通过该接口获取 convertToPointInWorld 的调用结果：

  • 如果方法调用成功，将返回点在世界坐标系上的坐标。详见 Point。
  • 如果方法调用失败，将返回错误信息。
表格内容超出当前宽度，可横向滚动查看更多列。

setCameraBound()

void setCameraBound(CameraBound bound)

设置视角边界。

自从

2.5.0

参数
参数名描述
bound

视角边界，详见 CameraBound。

表格内容超出当前宽度，可横向滚动查看更多列。

getBackgroundColor()

int getBackgroundColor()

获取本地白板的背景色。

自从

2.4.0

弃用:

该方法已废弃。

返回值

本地白板的背景色，格式为 16 进制 ARGB 定义下的 Hex 值。

setBackgroundColor()

void setBackgroundColor(int intColor)

设置白板的背景色。

自从

2.4.14

弃用:

该方法已废弃，请改用 Android 系统的 setBackgroundColor 方法。

注解

该方法仅对本地白板有效，不会影响房间内其他用户白板的背景色。

参数
参数名描述
intColor

白板的背景色，格式为 16 进制 RGBA 定义下的 Hex 值。注意 A 属性不能达到使白板透明的效果。

表格内容超出当前宽度，可横向滚动查看更多列。

getScenePreviewImage()

void getScenePreviewImage(String scenePath, Promise<Bitmap> promise)

获取指定场景的预览图。

自从

2.3.0

参数
参数名描述
scenePath

场景路径。

promise

Promise<Bitmap> 接口实例，详见 Promise。你可以通过该接口获取 getScenePreviewImage 方法的调用结果：

  • 如果方法调用成功，将返回指定场景的预览图。
  • 如果方法调用失败，将返回错误码。
表格内容超出当前宽度，可横向滚动查看更多列。

getSceneSnapshotImage()

void getSceneSnapshotImage(String scenePath, Promise<Bitmap> promise)

获取指定场景的截图。

自从

2.3.0

参数
参数名描述
scenePath

场景路径。

promise

Promise<Bitmap> 接口实例，详见 Promise。你可以通过该接口获取 getSceneSnapshotImage 方法的调用结果：

  • 如果方法调用成功，将返回指定场景的截图。
  • 如果方法调用失败，将返回错误信息。
表格内容超出当前宽度，可横向滚动查看更多列。

disableCameraTransform()

void disableCameraTransform(Boolean disable)

禁止/允许用户调整视角。

自从

2.11.0

该方法用于禁止或允许用户通过触屏手势移动或缩放视角。

参数
参数名描述
disable

是否禁止用户调整视角：

  • true: 禁止用户调整视角。
  • false: (默认) 允许用户调整视角。
表格内容超出当前宽度，可横向滚动查看更多列。

moveCamera()

void moveCamera(CameraConfig camera)

调整视角。

自从

2.2.0

调用该方法后，SDK 会根据传入的参数调整视角。

参数
参数名描述
camera

视角的参数配置，详见 CameraConfig。

表格内容超出当前宽度，可横向滚动查看更多列。

moveCameraToContainer()

void moveCameraToContainer(RectangleConfig rectangle)

调整视角，以保证完整显示视觉矩形。

自从

2.2.0

参数
参数名描述
rectangle

视觉矩形的参数设置，详见 RectangleConfig。

表格内容超出当前宽度，可横向滚动查看更多列。

getWindowManagerAttributes()

void getWindowManagerAttributes(Promise<String> promise)

获取当前多窗口状态

参数

参数
参数名描述
promise
表格内容超出当前宽度，可横向滚动查看更多列。

getSyncedStore()

SyncedStore getSyncedStore()

getSyncedStore：com.herewhite.sdk.Displayer 的公开成员。参数和返回类型见下方签名。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利