com.herewhite.sdk.Displayer类 参考
Displayer
类。该类为 Room
类和 Player
类的父类。 Room
和 Player
类可以继承该类下的方法。
成员函数说明
postIframeMessage() [1/2]
向 iframe 插件发送字符串信息。
void com.herewhite.sdk.Displayer.postIframeMessage(String string)
参数
参数名 | 描述 |
---|---|
string | 字符串格式的信息。 |
postIframeMessage() [2/2]
向 iframe 插件发送 key-value 格式的信息。
void com.herewhite.sdk.Displayer.postIframeMessage(WhiteObject object)
参数
参数名 | 描述 |
---|---|
object | key-value 格式的信息,必须为 |
getScenePathType()
查询场景路径类型。
你可以在该方法中指定想要查询的场景路径,SDK 会返回该路径对应的场景类型。
void com.herewhite.sdk.Displayer.getScenePathType(String path, final Promise< WhiteScenePathType > promise )
参数
参数名 | 描述 |
---|---|
path | 想要查询的场景路径。 |
promise |
|
getScene()
getEntireScenes()
refreshViewSize()
刷新白板的界面。
当 WhiteboardView
出现改变时,需要手动调用该方法刷新白板的界面。
void com.herewhite.sdk.Displayer.refreshViewSize()
scaleIframeToFit()
调整视角,以保证完整显示 H5 课件的内容。
void com.herewhite.sdk.Displayer.scaleIframeToFit()
scalePptToFit() [1/2]
以渐变模式调整视角,以保证完整显示 PPT 的内容。
void com.herewhite.sdk.Displayer.scalePptToFit()
scalePptToFit() [2/2]
根据指定的动画模式调整视角,以保证完整显示 PPT 的内容。
void com.herewhite.sdk.Displayer.scalePptToFit(AnimationMode mode)
参数
参数名 | 描述 |
---|---|
mode | 视角调整时的动画模式,详见 |
addMagixEventListener()
注册自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
对于同名的自定义事件,SDK 仅支持触发一个回调。
void com.herewhite.sdk.Displayer.addMagixEventListener(String eventName, EventListener eventListener )
参数
参数名 | 描述 |
---|---|
eventName | 想要监听的自定义事件名称。 |
eventListener | 自定义事件回调,详见 |
addHighFrequencyEventListener()
注册高频自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
对于同名的自定义事件,SDK 仅支持触发一个回调。
void com.herewhite.sdk.Displayer.addHighFrequencyEventListener(String eventName, FrequencyEventListener eventListener, Integer fireInterval )
参数
参数名 | 描述 |
---|---|
eventName | 想要监听的自定义事件名称。 |
eventListener | 自定义事件回调,详见 |
fireInterval | SDK 触发回调的频率,单位为毫秒。该参数最小值为 500 ms,如果设置为低于该值会被重置为 500 ms。 |
removeMagixEventListener()
移除自定义事件监听。
void com.herewhite.sdk.Displayer.removeMagixEventListener(String eventName)
参数
参数名 | 描述 |
---|---|
eventName | 想要移除监听的自定义事件名称。 |
convertToPointInWorld()
转换白板上点的坐标。
该方法可以将 Android 内部坐标系(以屏幕左上角为原点)中的坐标转换为世界坐标系(以白板初始化时的中点为原点)坐标。
void com.herewhite.sdk.Displayer.convertToPointInWorld(double x, double y, final Promise< Point > promise )
参数
参数名 | 描述 |
---|---|
x | 点在 Android 坐标系中的 X 轴坐标。 |
y | 点在 Android 坐标系中的 Y 轴坐标。 |
promise |
|
setCameraBound()
设置视角边界。
void com.herewhite.sdk.Displayer.setCameraBound(CameraBound bound)
参数
参数名 | 描述 |
---|---|
bound | 视角边界,详见 |
setBackgroundColor()
设置白板的背景色。
该方法仅对本地白板有效,不会影响房间内其他用户白板的背景色。
void com.herewhite.sdk.Displayer.setBackgroundColor(@ColorInt int intColor)
参数
参数名 | 描述 |
---|---|
intColor | 白板的背景色,格式为 16 进制 RGBA 定义下的 Hex 值。注意 A 属性不能达到使白板透明的效果。 |
getBackgroundColor()
获取本地白板的背景色。
int com.herewhite.sdk.Displayer.getBackgroundColor()
返回值
本地白板的背景色,格式为 16 进制 ARGB 定义下的 Hex 值。
getScenePreviewImage()
getSceneSnapshotImage()
disableCameraTransform()
禁止/允许用户调整视角。
该方法用于禁止或允许用户通过触屏手势移动或缩放视角。
void com.herewhite.sdk.Displayer.disableCameraTransform(Boolean disable)
参数
参数名 | 描述 |
---|---|
disable | 是否禁止用户调整视角:
|
moveCamera()
调整视角。
调用该方法后,SDK 会根据传入的参数调整视角。
void com.herewhite.sdk.Displayer.moveCamera(CameraConfig camera)
参数
参数名 | 描述 |
---|---|
camera | 视角的参数配置,详见 |
moveCameraToContainer()
调整视角,以保证完整显示视觉矩形。
void com.herewhite.sdk.Displayer.moveCameraToContainer(RectangleConfig rectangle)
参数
参数名 | 描述 |
---|---|
rectangle | 视觉矩形的参数设置,详见 |