AVDWhiteboard.h

Includes:
"AVDCommon.h"
"AVDWhiteboardInfo.h"
"AVDRoom.h"
"AVDModule.h"

Introduction

Use the links in the table of contents to the left to access the documentation.



Methods

+attachView:boardInfo:
+closeBoard:
+createBoard:
+getWhiteboard:
+onCloseBoardNotify:
+onCreateBoardNotify:
+onRemoveBoardNotify:
+onShareBoardNotify:
+onUpdateBoardNotify:
+removeBoard:
+setBackgroundColor:alpha:red:green:blue:
+setBackgroundImage:imageName:
+setHeight:height:
+setWidth:width:
+shareBoard:
+updateBoard:whiteboard:

attachView:boardInfo:


- (AVDResult)attachView:(UIView*)view boardInfo:(AVDWhiteboardInfo *)boardInfo;  
Parameters
view

视图

whiteboardId

白板id

Return Value

返回错误代码

Discussion

视图与白板id绑定


closeBoard:


- (AVDResult)closeBoard:(AVDBoardId)whiteboardId;  
Parameters
whiteboardId

白板id

Return Value

返回错误代码

Discussion

关闭白板


createBoard:


- (AVDResult)createBoard:(AVDWhiteboardInfo *)whiteboardInfo;  
Parameters
whiteboardInfo

白板信息

Return Value

返回错误代码

Discussion

创建白板


getWhiteboard:


+ (AVDWhiteboard *)getWhiteboard:(AVDRoom *)room;  
Parameters
room

room 房间对象指针

Return Value

返回白板模块对象。

Discussion

获取白板功能模块对象


onCloseBoardNotify:


- (void)onCloseBoardNotify:(AVDBoardId)whiteboardId;  
Parameters
whiteboardId

移除的白板id

Discussion

关闭白板工作


onCreateBoardNotify:


- (void)onCreateBoardNotify:(AVDWhiteboardInfo *)whiteboardInfo;  
Parameters
whiteboardInfo

白板信息

Discussion

接收到白板创建消息通知


onRemoveBoardNotify:


- (void)onRemoveBoardNotify:(AVDBoardId)whiteboardId;  
Parameters
whiteboardId

移除的白板id

Discussion

接收到白板移除建消息通知


onShareBoardNotify:


- (void)onShareBoardNotify:(AVDWhiteboardInfo *)whiteboardInfo;  
Parameters
whiteboardInfo

白板信息

Discussion

共享白板消息通知


onUpdateBoardNotify:


- (void)onUpdateBoardNotify:(AVDWhiteboardInfo *)whiteboardInfo;  
Parameters
whiteboardInfo

白板信息

Discussion

接收到白板更新消息通知


removeBoard:


- (AVDResult)removeBoard:(AVDBoardId)whiteboardId;  
Parameters
whiteboardId

白板id

Return Value

返回错误代码

Discussion

移除白板


setBackgroundColor:alpha:red:green:blue:


- (AVDResult)setBackgroundColor:(AVDBoardId)whiteboardId 
        alpha:(CGFloat)alpha red:(NSInteger)red green:(NSInteger)green 
        blue:(NSInteger)blue;  
Parameters
whiteboardId

白板id

alpha

背景色透明度 0.0-1.0

red

red 0-255

green

green 0-255

blue

blue 0-255

Return Value

返回错误代码

Discussion

设置白板背景颜色


setBackgroundImage:imageName:


- (AVDResult)setBackgroundImage:(AVDBoardId)whiteboardId 
        imageName:(NSString *)imageName;  
Parameters
whiteboardId

白板id

imageName

图片名称

Return Value

返回错误代码

Discussion

设置白板背景图片


setHeight:height:


- (AVDResult)setHeight:(AVDBoardId)whiteboardId height:(NSInteger)height;  
Parameters
whiteboardId

白板id

height

白板高度

Return Value

返回错误代码

Discussion

设置白板的高度


setWidth:width:


- (AVDResult)setWidth:(AVDBoardId)whiteboardId width:(NSInteger)width;  
Parameters
whiteboardId

白板id

width

白板宽度

Return Value

返回错误代码

Discussion

设置白板的宽度


shareBoard:


- (AVDResult)shareBoard:(AVDBoardId)whiteboardId;  
Parameters
whiteboardId

白板id

Return Value

返回错误代码

Discussion

共享白板


updateBoard:whiteboard:


- (AVDResult)updateBoard:(AVDBoardId)whiteboardId whiteboard:(AVDWhiteboardInfo *)whiteboardInfo;  
Parameters
whiteboardId

白板id

whiteboardInfo

白板信息

Return Value

返回错误代码

Discussion

更新白板