文档模块
头文件
VHDocument.h
类名
VHDocument
属性
delegate
@property (nonatomic,weak)id <VHDocumentDelegate> delegate;
view
/**
* 当前选中的文档显示view
*/
@property (nonatomic,weak,readonly)VHDocumentView *selectedView;
documentViewsByIDs
/**
* 文档显示views 字典 以documentView.cid为key
*/
@property (nonatomic,strong,readonly)NSDictionary *documentViewsByIDs;
recordID
/**
* 点播文档模块初始化
*/
- (instancetype)initWithRecordID:(NSString*)recordID;
switchOn
/*
* 是否开启观看端演示
*/
+@property (nonatomic,assign)BOOL switchOn;
backgroundColor
/*
* 文档显示背景色,默认白色
*/
@property (nonatomic,strong)UIColor *backgroundColor;
frame
/*
* 文档view frame
*/
+@property (nonatomic,assign)CGRect frame;
方法
- initWithRecordID: channelID:
/**
* 点播文档模块初始化
* channelID 有点播模块回调数据
*/
- (instancetype)initWithRecordID:(NSString*)recordID channelID:(NSString*)channelID;
- initWithChannelID: roomID: accessToken:
/**
* 直播+文档模块初始化
*/
- (instancetype)initWithChannelID:(NSString*)channelID roomID:(NSString*)roomID accessToken:(NSString*)accessToken;
- createDocumentWithFrame: size: documentID: backgroundColor:
#pragma mark - 演示端方法
/**
* 创建文档 view
* frame 创建文档frame
* size 画板宽高,尽量保持与其他端大小一致,最少也要保证比例相同否则画笔会错位
* documentID 文档ID
* color 创建文档背景颜色
*/
- (VHDocumentView*)createDocumentWithFrame:(CGRect)frame size:(CGSize)size documentID:(NSString*)documentID backgroundColor:(UIColor *)color;
- createBoardWithFrame: size: backgroundColor:
/**
* 创建白板 view
* frame 创建文档frame
* size 画板宽高,尽量保持与其他端大小一致,最少也要保证比例相同否则画笔会错位
* color 创建白板背景颜色
*/
- (VHDocumentView*)createBoardWithFrame:(CGRect)frame size:(CGSize)size backgroundColor:(UIColor *)color;
- destroyWithCID :
/**
* 销毁文档
*/
- (void)destroyWithCID:(NSString*)cid;
- selectWithCID :
/**
* 选择正在演示的文档
*/
- (void)selectWithCID:(NSString*)cid;
- resetDocWithChannelID :accessToken: success: failed:
/**
* 文档演示重置 用于同一频道再次演示 清空上次数据
* @param channelID 文档演示channelID
*/
+ (void)resetDocWithChannelID:(NSString*)channelID
accessToken:(NSString*)accessToken
success:(void(^)(void))success
failed:(void(^)(NSError *error))failedBlock;
代理方法
VHDocumentDelegate
- document:error:
/**
* 错误回调
* @param document 文档实例
* @param error 错误
*/
- (void)document:(VHDocument *)document error:(NSError *)error;
- document:delayChannelID:
/**
* 直播文档同步
* @param document 文档实例
* @param channelID 文档channelID
* @return float 延迟执行时间 即直播延迟时间 realityBufferTime
*/
- (float)document:(VHDocument *)document delayChannelID:(NSString*)channelID;
- document: changePage:
/**
* 翻页消息
* @param document 文档实例
* @param documentView 文档id 为空时没有 文档
*/
- (void)document:(VHDocument *)document changePage:(VHDocumentView*)documentView;
- document: switchStatus:
/**
* 是否显示文档
*/
- (void)document:(VHDocument *)document switchStatus:(BOOL)switchStatus;
- document: selectDocumentView:
/**
* 选择 documentView
*/
- (void)document:(VHDocument *)document selectDocumentView:(VHDocumentView*)documentView;
- document: addDocumentView:
/**
* 添加 documentView
*/
- (void)document:(VHDocument *)document addDocumentView:(VHDocumentView *)documentView;
- document: removeDocumentView:
/**
* 删除 documentView
*/
- (void)document:(VHDocument *)document removeDocumentView:(VHDocumentView *)documentView;