WindowsSDK的RtcEngineWhiteboard接口_音视频通信(RTC)-阿里云帮助中心

通过阅读本文，您可以了解到Windows SDK的RtcEngineWhiteboard接口详情。

接口说明

API	描述	支持的最低版本
Open	打开白板。	3.6
Close	关闭白板。	3.6
Join	加入白板。	3.6
Leave	离开白板。	3.6
Stop	结束白板。	3.6
SetRole	设置白板角色。	3.6
SetToolType	设置工具类型。	3.6
SetLineWidth	设置线宽。	3.6
SetColor	设置颜色。	3.6
SetFillColor	设置填充颜色。	3.6
SetFillType	设置填充类型。	3.6
SetFontStyle	设置字体样式。	3.6
SetFontSize	设置字体大小。	3.6
Undo	撤消。	3.6
Redo	重做。	3.6
GetToolType	获取工具类型。	3.6
GetUndoStatus	是否可以撤消。	3.6
GetRedoStatus	是否可以恢复重做。	3.6
AddStamp	添加图章资源。	3.6
SetStamp	设置图章资源。	3.6
SetZoomScale	设置缩放比例。	3.6
SetZoomScaleWithTranslate	设置缩放比例及基于原始中心点缩放后的平移。	3.6
SetMinZoomScale	设置最小缩放比例。	3.6
SetMaxZoomScale	设置最大缩放比例。	3.6
GetZoomScale	获取缩放比例。	3.6
GetMinZoomScale	获取最小缩放比例。	3.6
GetMaxZoomScale	获取最大缩放比例。	3.6
SetScalingMode	设置缩放模式。	3.6
GetCurrentPageNumber	获取当前白板页码。	3.6
GetTotalNumberOfPages	获取白板页数。	3.6
AddPage	添加一页到最后。	3.6
InsertPage	插入一页到指定页之后。	3.6
RemovePage	删除一页。	3.6
GotoPage	跳转到指定页。	3.6
NextPage	下一页。	3.6
PrevPage	上一页。	3.6
GetCurrentDocID	获取当前白板文档ID。	3.6
GetDocInfo	获取白板文档信息。	3.6

接口详情

Open：打开白板。
```
int Open (void *window)=0
```
返回说明

int
Close：关闭白板。
```
int Close ()=0
```
返回说明

int
Join：加入白板。
```
int Join ()=0
```
返回说明

int
Leave：离开白板。
```
int Leave ()=0
```
返回说明

int
Stop：结束白板。
```
int Stop ()=0
```
返回说明

int

SetRole：设置白板角色。

int SetRole (WBRoleType role)=0

参数	类型	描述
role	WBRoleType	白板角色。

返回说明

int

SetToolType：设置工具类型。

int SetToolType (WBToolType toolType)=0

参数	类型	描述
toolType	WBToolType	工具类型。

返回说明

int

SetLineWidth：设置线宽。

int SetLineWidth (int size)=0

参数	类型	描述
size	int	线宽。有效值为1-20。

返回说明

int

SetColor：设置颜色。

int SetColor (WBColor color)=0

参数	类型	描述
color	WBColor	颜色。

返回说明

int

SetFillColor：设置填充颜色。

int SetFillColor (WBColor color)=0

参数	类型	描述
color	WBColor	填充颜色。

返回说明

int

SetFillType：设置填充类型。

int SetFillType (WBFillType type)=0

参数	类型	描述
type	WBFillType	填充类型。

返回说明

int

SetFontStyle：设置字体样式。

int SetFontStyle (WBFontStyle style)=0

参数	类型	描述
style	WBFontStyle	字体样式。

返回说明

int

SetFontSize：设置字体大小。

int SetFontSize (int size)=0

参数	类型	描述
size	int	字体大小。

返回说明

int

Undo：撤消。
```
int Undo ()=0
```
返回说明

int
Redo：重做。
```
int Redo ()=0
```
返回说明

int
GetToolType：获取工具类型。
```
WBToolType GetToolType ()=0
```
返回说明

WBToolType工具类型。
GetUndoStatus：是否可以撤消。
```
bool GetUndoStatus ()=0
```
返回说明

bool
GetRedoStatus：是否可以恢复重做。
```
bool GetRedoStatus ()=0
```
返回说明

bool

AddStamp：添加图章资源。

int AddStamp (WBStamp stamp)=0

参数	类型	描述
stamp	WBStamp	图章。

返回说明

int

SetStamp：设置图章资源。

int SetStamp (const char *stampId)=0

参数	类型	描述
stampId	const char *	图章资源ID。

返回说明

int

SetZoomScale：设置缩放比例。

int SetZoomScale (float scale)=0

参数	类型	描述
scale	float	缩放比例。

返回说明

int

SetZoomScaleWithTranslate：设置缩放比例及基于原始中心点缩放后的平移。

int SetZoomScaleWithTranslate (float scale, float tx, float ty)=0

参数	类型	描述
scale	float	缩放比例。
tx	float	缩放后x轴平移。
ty	float	缩放后y轴平移。

返回说明

int

SetMinZoomScale：设置最小缩放比例。

int SetMinZoomScale (float scale)=0

参数	类型	描述
scale	float	缩放比例。

返回说明

int

SetMaxZoomScale：设置最大缩放比例。

int SetMaxZoomScale (float scale)=0

参数	类型	描述
scale	float	缩放比例。

返回说明

int

GetZoomScale：获取缩放比例。
```
float GetZoomScale ()=0
```
返回说明

scale缩放比例。
GetMinZoomScale：获取最小缩放比例。
```
float GetMinZoomScale ()=0
```
返回说明

scale缩放比例。
GetMaxZoomScale：获取最大缩放比例。
```
float GetMaxZoomScale ()=0
```
返回说明

scale缩放比例。

SetScalingMode：设置缩放模式。

int SetScalingMode (WBScalingMode mode)=0

参数	类型	描述
mode	WBScalingMode	缩放模式。

返回说明

int

GetCurrentPageNumber：获取当前白板页码。
```
WBPageNumber GetCurrentPageNumber ()=0
```
返回说明

WBPageNumber
GetTotalNumberOfPages：获取白板页数。
```
size_t GetTotalNumberOfPages ()=0
```
返回说明

size_t

AddPage：添加一页到最后。

int AddPage (bool autoSwitch)=0

参数	类型	描述
autoSwitch	bool	自动切换到新添加的页面。

返回说明

int

InsertPage：插入一页到指定页之后。

int InsertPage (WBPageNumber pageNo, bool autoSwitch)=0

参数	类型	描述
pageNo	WBPageNumber	指定页的页码。
autoSwitch	bool	自动切换到新添加的页面。

返回说明

int

RemovePage：删除一页。

int RemovePage (WBPageNumber pageNo, bool switchNext)=0

参数	类型	描述
pageNo	WBPageNumber	被删除页的页码。
switchNext	bool	切换到删除页的下一页。

返回说明

int

重要

删除页的默认行为是切换到删除页的前一页。设置switchNext为true改为切换到删除页的下一页。

GotoPage：跳转到指定页。

int GotoPage (WBPageNumber pageNo)=0

参数	类型	描述
pageNo	WBPageNumber	跳转页的页码。

返回说明

int

NextPage：下一页。
```
int NextPage ()=0
```
返回说明

int
PrevPage：上一页。
```
int PrevPage ()=0
```
返回说明

int
GetCurrentDocID：获取当前白板文档ID。
```
String GetCurrentDocID ()=0
```
返回说明

当前白板文档ID

GetDocInfo：获取白板文档信息。

WBDocInfo GetDocInfo (String docId)=0

参数	类型	描述
docId	String	白板文档ID。

返回说明

白板文档信息

接口说明

目录

接口详情