You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

请输入
  • 文档首页
    • 实时音视频互动白板客户端 API 参考AndroidAPI 详情
复制全文
下载 pdf
我的收藏
Android
API 详情
复制全文
下载 pdf
我的收藏
API 详情

WhiteBoard 
public abstract class com.ss.video.byteboard.WhiteBoard

白板接口类。调用 getCurrentWhiteBoard 将返回当前的白板实例，你可以通过这个类来操作当前白板。

成员函数

返回名称
abstract intgetWhiteBoardId
abstract StringgetWhiteBoardRoomId
abstract voidsetEventHandler
abstract voidsetWritable
abstract voidsetZoomOperation
abstract voidsetEditType
abstract voidsetPenSize
abstract voidsetPenColor
abstract voidsetShapeSize
abstract voidsetShapeColor
abstract voidsetTextFontSize
abstract voidsetTextColor
abstract voidsetSelectionBoxStyle
abstract voidenableCursorSync
abstract voidsetCursorStyle
abstract voidaddImage
abstract voidaddVideo
abstract voidaddAudio
abstract voidundo
abstract voidredo
abstract voidclearPage
abstract voidcreatePages
abstract voidremovePages
abstract voidflipPage
abstract voidflipNextPage
abstract voidflipPrevPage
abstract voidsetPageBackground
abstract voidsetBoardBackground
abstract voidgetCurrentPageInfo
abstract voidgetCurrentPageIndex
abstract voidgetPageInfoByIndex
abstract voidgetAllPageInfo
abstract voidgetPageCount
abstract voidsetViewMode
abstract voidgetViewMode
abstract voidzoomIn
abstract voidzoomOut
abstract voidzoomTo
abstract voidresetZoom
abstract voidgetZoomFactor
abstract voidsetMaxZoom
abstract voidexportSnapshot
abstract voidgetCurrentPageId
abstract voidgetPptInfo
abstract voidpptNextStep
abstract voidpptPrevStep

函数说明

getWhiteBoardId 

public abstract int com.ss.video.byteboard.WhiteBoard.getWhiteBoardId()

获取当前白板 ID。

返回值

白板 ID

getWhiteBoardRoomId 

public abstract String com.ss.video.byteboard.WhiteBoard.getWhiteBoardRoomId()

获取当前白板所在的房间 ID。

返回值

房间 ID

setEventHandler 

public abstract void com.ss.video.byteboard.WhiteBoard.setEventHandler(IWhiteBoardEventHandler handler)

设置白板事件回调。

传入参数

参数名类型说明
handlerIWhiteBoardEventHandler回调

setWritable 

public abstract void com.ss.video.byteboard.WhiteBoard.setWritable(boolean writable)

设置当前白板是否可以编辑。

传入参数

参数名类型说明
writableboolean当前白板是否可编辑

setZoomOperation 

public abstract void com.ss.video.byteboard.WhiteBoard.setZoomOperation(ZoomOperation zoomOperation)

设置手势缩放拖拽。

传入参数

参数名类型说明
zoomOperationZoomOperation手势缩放拖拽，参见 ZoomOperation。

setEditType 

public abstract void com.ss.video.byteboard.WhiteBoard.setEditType(WhiteBoardDefine.EditType editType)

设置编辑动作类型。

传入参数

参数名类型说明
editTypeWhiteBoardDefine.EditType编辑动作类型，详见 EditType。

注意

如果默认的光标图形无法满足你的需求，调用 setCursorStyle，为不同工具过指定光标图形和样式。

setPenSize 

public abstract void com.ss.video.byteboard.WhiteBoard.setPenSize(float width)

设置笔画笔迹宽度。

传入参数

参数名类型说明
widthfloat笔迹宽度，单位为画布宽度的万分之一

setPenColor 

public abstract void com.ss.video.byteboard.WhiteBoard.setPenColor(int color)

设置笔画颜色。

传入参数

参数名类型说明
colorint颜色，十六进制数字表示 ARGB，例如 0xFF112233

setShapeSize 

public abstract void com.ss.video.byteboard.WhiteBoard.setShapeSize(float width)

设置形状线条宽度。

传入参数

参数名类型说明
widthfloat形状线条宽度，单位为画布宽度的万分之一

setShapeColor 

public abstract void com.ss.video.byteboard.WhiteBoard.setShapeColor(int color)

设置形状颜色。

传入参数

参数名类型说明
colorint颜色，十六进制数字表示 ARGB，例如 0xFF112233

setTextFontSize 

public abstract void com.ss.video.byteboard.WhiteBoard.setTextFontSize(float size)

设置文本字号大小。

传入参数

参数名类型说明
sizefloat文字的高度，单位为画布高的万分之一

setTextColor 

public abstract void com.ss.video.byteboard.WhiteBoard.setTextColor(int color)

设置文字颜色。

传入参数

参数名类型说明
colorint颜色，十六进制数字表示 ARGB，例如 0xFF112233

setSelectionBoxStyle 

public abstract void com.ss.video.byteboard.WhiteBoard.setSelectionBoxStyle(ShapeStyle shapeStyle)

设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。默认样式详见 ShapeStyle。

传入参数

参数名类型说明
shapeStyleShapeStyle选择框样式。详见 ShapeStyle。

enableCursorSync 

public abstract void com.ss.video.byteboard.WhiteBoard.enableCursorSync(boolean enable)

开启光标同步功能，默认关闭。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。

传入参数

参数名类型说明
enableboolean是否开启

setCursorStyle 

public abstract void com.ss.video.byteboard.WhiteBoard.setCursorStyle(
    HashMap<UserCursorInfo.CursorType,
    CursorInfo> cursorStyles
)

自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。

传入参数

参数名类型说明
cursorStylesHashMap<UserCursorInfo.CursorType, CursorInfo>自定义光标样式，字典类型的 key 为 CursorType 中的变量，value 为 UserCursorInfo. CursorInfo 类型。

addImage 

public abstract void com.ss.video.byteboard.WhiteBoard.addImage(
    String url,
    Rect imagePosition,
    OnResult<String> onResult
)

在当前页面中添加图片。

传入参数

参数名类型说明
urlString图片的 url
imagePositionRect图片的位置，单位为画布宽度的万分之一。
选填。默认居中放置，如果图片尺寸比白板页面小，不缩放；如果图片尺寸比白板页面大，按原始尺寸的比例缩小后居中放置。
onResultOnResult<String>-

addVideo 

public abstract void com.ss.video.byteboard.WhiteBoard.addVideo(
    String url,
    String title,
    OnResult<String> onResult
)

在当前页面中添加视频，只支持 mp4 格式。

传入参数

参数名类型说明
urlString视频的 url。建议视频文件的大小不超过 1 GB。你需要将用户的视频文件上传到对象存储服务空间中，并获取访问链接。
titleString文件名称。不超过 200 个字符。支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)。选填。默认为 URL 中解析出的文件名。
onResultOnResult<String>接收添加视频结果回调。

注意

  • 你可以在普通白板页和 PPT 白板页添加视频。
  • 每个页面最多只能插入 1 个视频文件和 1 个音频文件。
  • 播放器默认居中放置。
  • 当 EditType 为 Pointer 时，用户可以对视频文件进行控制，包括播放、暂停和进度跳转等。也可以移动、缩放、全屏和删除播放器。这些操作都将实时同步到远端。音量控制只在本端生效。
  • 画笔等笔迹工具不支持在播放器上进行绘制。

addAudio 

public abstract void com.ss.video.byteboard.WhiteBoard.addAudio(
    String url,
    String title,
    OnResult<String> onResult
)

在当前页面中添加音频，只支持 mp3 格式。

传入参数

参数名类型说明
urlString音频的 url。建议音频文件的大小不超过 50 MB。你需要将用户的音频文件上传到对象存储服务空间中，并获取访问链接。
titleString文件名称。不超过 200 个字符。支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)。选填。默认为 URL 中解析出的文件名。
onResultOnResult<String>接收添加音频结果回调。

注意

  • 你可以在普通白板页和 PPT 白板页添加音频。
  • 每个页面最多只能插入 1 个视频文件和 1 个音频文件。
  • 播放器默认居中放置。
  • 当 EditType 为 Pointer 时，用户可以对音频文件进行控制，包括播放、暂停和进度跳转等。也可以移动、缩放和删除播放器。这些操作都将实时同步到远端。音量控制只在本端生效。
  • 画笔等笔迹工具不支持在播放器上进行绘制。

undo 

public abstract void com.ss.video.byteboard.WhiteBoard.undo()

撤销本端对白板的编辑操作。

注意

当 onCanUndoStateChanged 返回的状态为 false 时，调用本接口无效。

redo 

public abstract void com.ss.video.byteboard.WhiteBoard.redo()

重做本端对白板的编辑操作。

注意

当 onCanRedoStateChanged 返回的状态为 false 时，调用本接口无效。

clearPage 

public abstract void com.ss.video.byteboard.WhiteBoard.clearPage()

清除页面。

注意

调用成功后在房间内所有客户端触发 onClearPage 回调

createPages 

public abstract void com.ss.video.byteboard.WhiteBoard.createPages(
    List<PageInfo> pageConfigs,
    int prePageIndex,
    boolean autoFlip
)

新建多个白板页。

传入参数

参数名类型说明
pageConfigsList<PageInfo>新页信息。详见 PageInfo
prePageIndexint插入到目标页之后，为空时表示插入到首页
autoFlipboolean自动翻到新页

注意

调用成功后在本端和远端触发 onCreatePagesProgress 回调。

removePages 

public abstract void com.ss.video.byteboard.WhiteBoard.removePages(
    List<String> pageIds,
    int flipPageIndex
)

批量删除白板页。

传入参数

参数名类型说明
pageIdsList<String>需要删除的页面 ID
flipPageIndexint删除后跳转的页面索引。传 -1 表示自动翻页：
  • 当前页未被删除时，不翻页。
  • 删除包含当前页在内的不连续多页时：翻到第一个被删除的页面的下一页。
  • 删除当前页或包含当前页在内的连续多页时：翻到下一页，如果删除的页面为最末页，则翻到前一页。

注意

flipPage 

public abstract void com.ss.video.byteboard.WhiteBoard.flipPage(int index)

白板翻页。

传入参数

参数名类型说明
indexint目标页 Index

注意

调用成功后在房间内所有客户端触发 onPageIndexChanged。

flipNextPage 

public abstract void com.ss.video.byteboard.WhiteBoard.flipNextPage()

翻到下一页。

注意

调用成功后在房间内所有客户端触发 onPageIndexChanged。

flipPrevPage 

public abstract void com.ss.video.byteboard.WhiteBoard.flipPrevPage()

翻到上一页。

注意

调用成功后在房间内所有客户端触发 onPageIndexChanged。

setPageBackground 

public abstract void com.ss.video.byteboard.WhiteBoard.setPageBackground(BackgroundInfo backgroundInfo)

修改当前页面的背景图、背景色。

传入参数

参数名类型说明
backgroundInfoBackgroundInfo背景设置。详见 BackgroundInfo

注意

  • 调用 setBoardBackground 可以设置白板背景。页面背景显示优先级高于白板背景，与调用顺序无关。
  • 成功调用本接口后在本端和远端触发 onPageBackgroundChanged 回调。

setBoardBackground 

public abstract void com.ss.video.byteboard.WhiteBoard.setBoardBackground(BackgroundInfo backgroundInfo)

修改当前白板的背景设置，例如背景图片颜色等。

传入参数

参数名类型说明
backgroundInfoBackgroundInfo背景设置。详见 BackgroundInfo

注意

  • 调用本回调后会在本端和远端触发 [onBoardBackgroundChanged] 回调。

getCurrentPageInfo 

public abstract void com.ss.video.byteboard.WhiteBoard.getCurrentPageInfo(OnResult<PageInfo> onResult)

获取当前页面信息。

传入参数

参数名类型说明
onResultOnResult<PageInfo>接收页面信息的回调，详见 PageInfo

getCurrentPageIndex 

public abstract void com.ss.video.byteboard.WhiteBoard.getCurrentPageIndex(OnResult<Integer> onResult)

获取当前页面索引。

传入参数

参数名类型说明
onResultOnResult<Integer>接收页面信息的回调，详见 PageInfo

getPageInfoByIndex 

public abstract void com.ss.video.byteboard.WhiteBoard.getPageInfoByIndex(
    int index,
    OnResult<PageInfo> onResult
)

通过索引号获取白板页信息。

传入参数

参数名类型说明
indexint页索引
onResultOnResult<PageInfo>接收页面信息的回调，详见 PageInfo

getAllPageInfo 

public abstract void com.ss.video.byteboard.WhiteBoard.getAllPageInfo(OnResult<List< PageInfo> > onResult)

获取所有页面信息。

传入参数

参数名类型说明
onResultOnResult<List< PageInfo> >接收页面信息的回调，详见 PageInfo

getPageCount 

public abstract void com.ss.video.byteboard.WhiteBoard.getPageCount(OnResult<Integer> onResult)

获取白板总页数。

传入参数

参数名类型说明
onResultOnResult<Integer>接收页面总数的回调

setViewMode 

public abstract void com.ss.video.byteboard.WhiteBoard.setViewMode(WhiteBoardDefine.ViewMode viewMode)

设置白板视角同步方式。

传入参数

参数名类型说明
viewModeWhiteBoardDefine.ViewMode视角同步模式。详见 ViewMode

getViewMode 

public abstract void com.ss.video.byteboard.WhiteBoard.getViewMode(OnResult<Integer> onResult)

获取视图模式。

传入参数

参数名类型说明
onResultOnResult<Integer>接收视图模式的回调

zoomIn 

public abstract void com.ss.video.byteboard.WhiteBoard.zoomIn(double scale)

按照当前中心点和缩放系数放大白板视图。

传入参数

参数名类型说明
scaledouble缩放系数，范围 [0, 20]。1表示放大100%，0.25表示放大25%，建议0.25

注意

  • 缩放中心点为当前视图中心。
  • 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。

zoomOut 

public abstract void com.ss.video.byteboard.WhiteBoard.zoomOut(double scale)

按照当前中心点和缩放系数缩小白板视图。

传入参数

参数名类型说明
scaledouble缩放系数，范围 [0, 20]。1表示缩小100%，0.25表示缩小25%，建议0.25

注意

  • 缩放中心点为当前视图中心。
  • 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。

zoomTo 

public abstract void com.ss.video.byteboard.WhiteBoard.zoomTo(
    double scale,
    int offsetX,
    int offsetY
)

按照指定中心点和缩放系数缩放白板视图。

传入参数

参数名类型说明
scaledouble缩放系数，范围 [1, 20]。1 表示设置到100%尺寸。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。
offsetXint缩放中心点 X 坐标，默认为 0
offsetYint缩放中心点 Y 坐标，默认为 0

注意

  • 缩放中心点为当前视图中心。
  • 当多个用户同时进行缩放设置时，将按服务端收到指令的时间顺序应用设置。

resetZoom 

public abstract void com.ss.video.byteboard.WhiteBoard.resetZoom()

恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。

getZoomFactor 

public abstract void com.ss.video.byteboard.WhiteBoard.getZoomFactor(OnResult<Double> onResult)

获取当前白板视图缩放系数。

传入参数

参数名类型说明
onResultOnResult<Double>接收视图缩放系数的回调。 当前白板视图缩放系数。范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。

setMaxZoom 

public abstract void com.ss.video.byteboard.WhiteBoard.setMaxZoom(double maxScale)

设置白板视图最大放大系数。

传入参数

参数名类型说明
maxScaledouble白板视图最大放大系数，范围 [1, 20]。默认为 20。

注意

  • 设置成功后，将改变调用以下 API 的参数上限： zoomIn， zoomOut 或 zoomTo。
  • PPT 白板的最大放大倍数设置为 2。超过时，可能在 Android 端引起卡顿问题。

exportSnapshot 

public abstract void com.ss.video.byteboard.WhiteBoard.exportSnapshot(
    Integer pageIndex,
    boolean withElements,
    boolean withBackGround
)

将当前白板中指定页面保存为一张本地图片。

传入参数

参数名类型说明
pageIndexInteger保存页面索引
withElementsboolean是否导出笔迹
withBackGroundboolean是否携带背景

注意

  • 调用成功后，将通过 onExportSnapshot 回调图片在本设备的绝对路径。
  • 短时间内多次调用本 API 时，等待获取结果回调时间可能增加。
  • PPT 白板页导出的快照仅包含预加载状态的图片。

getCurrentPageId 

public abstract void com.ss.video.byteboard.WhiteBoard.getCurrentPageId(OnResult<String> onResult)

获取当前页面的 PageId。

传入参数

参数名类型说明
onResultOnResult<String>接收白板页面 ID 的回调

getPptInfo 

public abstract void com.ss.video.byteboard.WhiteBoard.getPptInfo(OnResult<PPTInfo> onResult)

获取当前 PPT 信息，非 PPT 白板返回空

传入参数

参数名类型说明
onResultOnResult<PPTInfo>接收 PPT 信息的回调，详见 PPTInfo

注意

调用 createFileWhiteBoard 可以创建一个 PPT 白板。

pptNextStep 

public abstract void com.ss.video.byteboard.WhiteBoard.pptNextStep()

下一个 PPT 动画，如果是最后一个动画，翻到下一页

注意

pptPrevStep 

public abstract void com.ss.video.byteboard.WhiteBoard.pptPrevStep()

上一个 PPT 动画，如果是第一个动画，翻到上一页

注意

注意

抽象类

WhiteBoardRoom 
public abstract class com.ss.video.byteboard.WhiteBoardRoom

白板房间接口类。 调用 joinRoom 之后，自动返回一个可以操作的 WhiteBoardRoom 实例。你可以通过这个类来进行白板房间相关操作。

成员函数

返回名称
abstract StringgetRoomID
abstract voidgetRoomStatus
abstract voidleaveRoom
abstract voiddestroyRoom
abstract voidcreateWhiteBoard
abstract voidcreateFileWhiteBoard
abstract voidremoveWhiteBoard
abstract voidswitchWhiteBoard
abstract WhiteBoardgetWhiteBoard
abstract WhiteBoardgetCurrentWhiteBoard
abstract intgetCurrentWhiteBoardID
abstract voidgetWhiteBoardInfo
abstract voidgetAllWhiteBoardInfo
abstract voidstartPlayback
abstract voidpausePlayback
abstract voidstopPlayback
abstract voidsetPlaybackProgress

函数说明

getRoomID 

public abstract String com.ss.video.byteboard.WhiteBoardRoom.getRoomID()

获取房间 ID。

返回值

房间 ID

注意

当本端用户已经进入白板房间后，你可以调用本接口查询当前房间 ID。

getRoomStatus 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.getRoomStatus(OnResult<WhiteBoardDefine.StatusType> onResult)

获取房间状态。

传入参数

参数名类型说明
onResultOnResult<WhiteBoardDefine.StatusType>接收白板房间状态的回调。详见 StatusType

leaveRoom 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.leaveRoom()

退房。

注意

  • 互动白板按照每个用户在房间内的时长累加进行计费，你应在当前用户结束白板使用时调用本接口退出房间。
  • 用户退出房间后，可以调用 joinRoom 再次加入该房间。
  • 如果房间内所有用户都已结束互动，你可以调用 destroyRoom 关闭房间。

destroyRoom 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.destroyRoom()

关闭所有白板，重进房间后无法进行写画。

注意

  • 如果你希望在下次进房时仍可以继续进行白板互动，请调用 leaveRoom 退房，此后调用 joinRoom 重新进房，可以继续此前的白板操作。
  • 如果已经在控制台开通和配置了白板录制，白板创建后自动录制。只有当调用本接口关闭白板之后，才可以开始播放录像。

createWhiteBoard 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.createWhiteBoard(
    int boardId,
    List<PageInfo> pages,
    BackgroundInfo boardBKInfo,
    String boardName
)

在房间内创建一个白板。

传入参数

参数名类型说明
boardIdint白板 ID，必填
pagesList<PageInfo>初始的多个白板页信息。详见 PageInfo
boardBKInfoBackgroundInfo默白板背景设置。详见 BoardInfo
boardNameString白板名称。支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)

注意

成功调用后将触发 onCreateWhiteBoard

createFileWhiteBoard 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.createFileWhiteBoard(
    int boardId,
    String boardName,
    PPTInfo pptInfo
)

在房间内创建一个 PPT 白板，用于本端发起一个 PPT。

传入参数

参数名类型说明
boardIdint白板 ID，必填
boardNameString白板名称，可选，默认和 ID 一样。支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)
pptInfoPPTInfoPPT信息。详见 PPTInfo。其中， fileId 获取方式如下。在 Web 端调用 createTranscodeTask 或服务端调用 WbTranscodeCreate，传入 PPT 的 URL 地址，获取到 fileId。

注意

  • 进行 PPT 共享时，只需要发起端调用本接口，房间中的其他用户端将自动创建 PPT 白板，无需手动调用本接口。
  • 成功调用后将触发 onCreateWhiteBoard

removeWhiteBoard 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.removeWhiteBoard(int boardId)

关闭指定白板。

传入参数

参数名类型说明
boardIdint白板 ID

注意

调用后将触发 onRemoveWhiteBoard

switchWhiteBoard 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.switchWhiteBoard(int boardId)

指定当前白板。在对白板进行编辑等操作前，需要将该白板设置为当前白板。

传入参数

参数名类型说明
boardIdint白板 ID

注意

调用后将触发 onCurrentWhiteBoardChanged

getWhiteBoard 

public abstract WhiteBoard com.ss.video.byteboard.WhiteBoardRoom.getWhiteBoard(int boardID)

通过白板 ID 获取白板对象。

传入参数

参数名类型说明
boardIDint白板 ID

返回值

白板对象。获取失败时，返回 null，例如，传入的 boardID 有误。

getCurrentWhiteBoard 

public abstract WhiteBoard com.ss.video.byteboard.WhiteBoardRoom.getCurrentWhiteBoard()

获取当前白板对象。

返回值

白板对象

getCurrentWhiteBoardID 

public abstract int com.ss.video.byteboard.WhiteBoardRoom.getCurrentWhiteBoardID()

获取当前的白板 ID。

返回值

白板 ID

getWhiteBoardInfo 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.getWhiteBoardInfo(
    int boardId,
    OnResult<BoardInfo> onResult
)

通过白板 ID 获取白板信息。

传入参数

参数名类型说明
boardIdint白板 ID
onResultOnResult<BoardInfo>接收白板信息的回调，详见 BoardInfo

getAllWhiteBoardInfo 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.getAllWhiteBoardInfo(OnResult<List< BoardInfo> > onResult)

获取所有白板信息。

传入参数

参数名类型说明
onResultOnResult<List< BoardInfo> >接收所有白板信息的回调，详见 BoardInfo

startPlayback 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.startPlayback()

开始播放白板录像。

成功调用后，触发 onPlaybackStateChanged 播放状态回调。

注意

  • 使用录像和回放时，需要在控制台开通和配置白板录制功能。
  • 调用时机：房间中至少有一个用户 destroyRoom 关闭白板，之后，所有用户在重新进房后，即调用 leaveRoom 退房，再调用 joinRoom 重新进房后，才可以调用本接口开始播放录像。
  • 录像存储路径 ./files/cache

pausePlayback 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.pausePlayback()

暂停播放白板录像。

成功调用后，触发 onPlaybackStateChanged 播放状态回调。

stopPlayback 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.stopPlayback()

停止播放白板录像。

成功调用后，触发 onPlaybackStateChanged 播放状态回调。

setPlaybackProgress 

public abstract void com.ss.video.byteboard.WhiteBoardRoom.setPlaybackProgress(
    long progress,
    OnResult<Boolean> onResult
)

设置白板回放进度。

传入参数

参数名类型说明
progresslong白板录像播放进度，单位 s
onResultOnResult<Boolean>设置进度结果回调

注意

调用后将触发 onPlaybackProgressUpdate 回调。

WhiteBoardRoomManager 
public abstract class com.ss.video.byteboard.WhiteBoardRoomManager

白板房间管理接口类，你可以通过这个类来操作白板 SDK 接口。

静态函数

返回名称
static voidsetDeviceID
static voidsetLogLocation
static synchronized voidcreate
static synchronized voiddestroy
static StringgetSdkVersion

成员函数

返回名称
abstract voidjoinRoom
abstract intdestroyWhiteBoardRoom
abstract WhiteBoardRoomgetWhiteBoardRoom
abstract WebViewgetView

函数说明

setDeviceID 

public static void com.ss.video.byteboard.WhiteBoardRoomManager.setDeviceID(String deviceId)

设置设备 ID。

传入参数

参数名类型说明
deviceIdString设备 ID

setLogLocation 

public static void com.ss.video.byteboard.WhiteBoardRoomManager.setLogLocation(String path)

设置日志路径。

传入参数

参数名类型说明
pathString日志路径。默认路径为 AppData/Library/Caches/Logs

create 

public static synchronized void com.ss.video.byteboard.WhiteBoardRoomManager.create(
    Context context,
    String appID,
    ViewGroup view,
    OnResult<WhiteBoardRoomManager> onResult
)

创建和初始化白板 WhiteBoardRoomManager 实例。

传入参数

参数名类型说明
contextContextAndroid Application Context
appIDString每个应用的唯一标识符，由 RTC 控制台随机生成的。 不同的 AppId 生成的实例在互动白板中是天然隔离的，无法互通。 获取 appId 详见开通服务。
viewViewGroup将白板 UI 绑定到指定视图
onResultOnResult<WhiteBoardRoomManager>初始化成功回调，返回创建的白板实例

destroy 

public static synchronized void com.ss.video.byteboard.WhiteBoardRoomManager.destroy()

销毁 whiteBoardRoomManager 实例，释放资源。

getSdkVersion 

public static String com.ss.video.byteboard.WhiteBoardRoomManager.getSdkVersion()

获取白板 SDK 版本号。

静态方法，无需创建白板实例。

返回值

SDK 版本号

joinRoom 

public abstract void com.ss.video.byteboard.WhiteBoardRoomManager.joinRoom(
    String roomID,
    String userID,
    String token,
    BoardInfo defaultBoardInfo,
    IWhiteBoardRoomEventHandler handler,
    OnResult<WhiteBoardRoom> onResult
)

加入白板房间。

传入参数

参数名类型说明
roomIDString房间 ID，是房间的唯一标志，详见 赋值规范。不能与 RTC 或 RTS 的房间 roomID 相同，否则会引起互踢，建议加前缀
userIDString用户 ID，详见 赋值规范。不能与 RTC 或 RTS 的 userID 相同，否则会引起互踢，建议加前缀
tokenString动态密钥 用户登录必须携带的 Token，用于鉴权验证。 登录 Token 与加入房间时必须携带的 Token 不同。测试时可使用控制台生成临时 Token。正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。 获取 token 详见开通服务。
defaultBoardInfoBoardInfo默认白板参数。详见 BoardInfo
handlerIWhiteBoardRoomEventHandlerSDK 回调给应用层的 Handler，详见 IWhiteBoardRoomEventHandler
onResultOnResult<WhiteBoardRoom>whiteBoardRoom 实例。参数校验失败时返回空的实例

注意

如果当前房间没有白板，将按照传入的参数创建一个白板，成功后将触发 onCreateWhiteBoard 回调。

destroyWhiteBoardRoom 

public abstract int com.ss.video.byteboard.WhiteBoardRoomManager.destroyWhiteBoardRoom(WhiteBoardRoom whiteBoardRoom)

销毁白板房间实例。

传入参数

参数名类型说明
whiteBoardRoomWhiteBoardRoom详见 WhiteBoardRoom

返回值

调用结果 0: 成功

getWhiteBoardRoom 

public abstract WhiteBoardRoom com.ss.video.byteboard.WhiteBoardRoomManager.getWhiteBoardRoom(String roomID)

获取白板实例。创建多个房间后，可以通过调用接口获得相应实例。

传入参数

参数名类型说明
roomIDString房间 ID

返回值

whiteBoard 详见 WhiteBoardRoom。失败时返回空的实例

getView 

public abstract WebView com.ss.video.byteboard.WhiteBoardRoomManager.getView()

获取当前白板视图。

返回值

白板视图

最近更新时间：2026.07.27 16:33:17
这个页面对您有帮助吗？
有用
有用
无用
无用