PanoRtcWhiteboard.h

浏览该文件的文档.

 
//
//  PanoRtcWhiteboard.h
//  PanoRtc
//
//  Copyright © 2020 Pano. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import "PanoEnumerates.h"
#import "PanoObjects.h"
 
NS_ASSUME_NONNULL_BEGIN
 
#pragma mark - PanoRtcWhiteboardDelegate
 
@protocol PanoRtcWhiteboardDelegate <NSObject>
@optional
 
#pragma mark Core Delegate Methods
 
- (void)onStatusSynced;
- (void)onPageNumberChanged:(PanoWBPageNumber)curPage
             withTotalPages:(UInt32)totalPages;
 
- (void)onImageStateChanged:(PanoWBImageState)state
                    withUrl:(NSString * _Nonnull)url;
 
- (void)onHtmlStateChanged:(PanoWBHtmlState)state
                   withUrl:(NSString * _Nonnull)url
                      file:(NSString * _Nonnull)fileId;
 
- (void)onViewScaleChanged:(Float32)scale;
 
- (void)onRoleTypeChanged:(PanoWBRoleType)newRole;
 
- (void)onContentUpdated;
 
- (void)onSnapshotComplete:(PanoResult)result
                      name:(NSString* _Nonnull)filename;
 
- (void)onUndoStatusChanged:(BOOL)canUndo;
 
- (void)onRedoStatusChanged:(BOOL)canRedo;
 
- (void)onDrawEvent:(PanoWBDrawEvent*)event;
 
#pragma mark Message Delegate Methods
 
- (void)onMessageReceived:(NSData * _Nonnull)message
                 fromUser:(UInt64)userId;
 
#pragma mark Doc Delegate Methods
 
- (void)onAddBackgroundImages:(PanoResult)result
                         file:(NSString* _Nonnull)fileId;
 
- (void) onAddH5File:(PanoResult)result
                file:(NSString* _Nonnull)fileId;
 
- (void)onDocTranscodeStatus:(PanoResult)result
                        file:(NSString* _Nonnull)fileId
                    progress:(UInt32)progress
                   pageCount:(UInt32)count;
 
- (void)onDocCreate:(PanoResult)result
               file:(NSString* _Nonnull)fileId;
 
- (void)onDocDelete:(PanoResult)result
               file:(NSString* _Nonnull)fileId;
 
- (void)onDocSwitch:(PanoResult)result
               file:(NSString* _Nonnull)fileId;
 
- (void)onDocSave:(PanoResult)result
              file:(NSString* _Nonnull)fileId
              path:(NSString* _Nonnull)outputDir;
 
- (void)onDocThumbnailReady:(NSString* _Nonnull)fileId
                     thumbs:(NSArray<NSString *> * _Nonnull)urls;
 
- (void)onExternalHtmlMessageReceived:(NSString* _Nonnull)msg
                               fileId:(NSString* _Nonnull)fileId;
 
#pragma mark Vision Delegate Methods
 
- (void)onVisionShareStarted:(UInt64)userId;
 
- (void)onVisionShareStopped:(UInt64)userId;
 
#pragma mark User Delegate Methods
 
- (void)onUserJoined:(UInt64)userId
            withName:(NSString * _Nullable)userName;
 
- (void)onUserLeft:(UInt64)userId;
 
@end
 
 
#pragma mark - PanoRtcWhiteboard
 
__attribute__((visibility("default"))) @interface PanoRtcWhiteboard : NSObject
 
+ (instancetype)new NS_UNAVAILABLE;
 
- (instancetype)init NS_UNAVAILABLE;
 
#pragma mark Core Service
 
- (PanoResult)setDelegate:(id<PanoRtcWhiteboardDelegate> _Nullable)delegate;
 
- (PanoResult)open:(PanoView * _Nonnull)view;
- (PanoResult)close;
 
- (PanoResult)leave;
 
- (PanoResult)stop;
 
- (PanoResult)importFrom:(NSString * _Nonnull)filename;
- (PanoResult)exportTo:(NSString * _Nonnull)filename;
 
- (NSString * _Nullable)getCurrentWhiteboardId;
 
- (PanoResult)setRoleType:(PanoWBRoleType)type;
 
- (PanoResult)setToolType:(PanoWBToolType)type;
- (PanoWBToolType)getToolType;
- (PanoResult)setLineWidth:(UInt32)width;
- (PanoResult)setFillType:(PanoWBFillType)type;
- (PanoResult)setFillColor:(PanoWBColor * _Nonnull)color;
- (PanoResult)setForegroundColor:(PanoWBColor * _Nonnull)color;
- (PanoResult)setBackgroundColor:(PanoWBColor * _Nonnull)color;
- (PanoResult)setFontStyle:(PanoWBFontStyle)style;
- (PanoResult)setFontSize:(UInt32)size;
- (PanoResult)addStamp:(PanoWBStamp * _Nonnull)stamp;
- (PanoResult)setStamp:(NSString * _Nonnull)stampId;
 
- (PanoResult)setBackgroundImageScalingMode:(PanoWBImageScalingMode)mode;
- (PanoResult)setBackgroundImage:(NSString * _Nonnull)imageUrl;
- (PanoResult)setBackgroundImage:(NSString * _Nonnull)imageUrl
                  withPageNumber:(PanoWBPageNumber)pageNo;
 
- (PanoWBPageNumber)getCurrentPageNumber;
- (UInt32)getTotalNumberOfPages;
- (PanoResult)addPage:(BOOL)autoSwitch;
- (PanoResult)insertPage:(PanoWBPageNumber)pageNo
              autoSwitch:(BOOL)autoSwitch;
- (PanoResult)removePage:(PanoWBPageNumber)pageNo;
- (PanoResult)removePage:(PanoWBPageNumber)pageNo switchNext:(BOOL)switchNext;
- (PanoResult)gotoPage:(PanoWBPageNumber)pageNo;
- (PanoResult)nextPage;
- (PanoResult)prevPage;
- (PanoResult)nextStep;
- (PanoResult)prevStep;
- (PanoResult)addImageFile:(NSString * _Nonnull)imageUrl;
- (PanoResult)addAudioFile:(NSString * _Nonnull)mediaUrl;
- (PanoResult)addVideoFile:(NSString * _Nonnull)mediaUrl;
- (NSString * _Nullable)addBackgroundImages:(NSArray<NSString *> * _Nonnull)urls;
- (NSString * _Nullable)addH5File:(NSString * _Nonnull)url download:(NSString * _Nullable)downloadUrl;
- (NSString * _Nullable)addDoc:(PanoWBDocContents *)contents;
- (NSString * _Nullable)addDocWithExtHtml:(PanoWBDocExtHtml *)extHtml;
- (NSString * _Nullable)addDocWithExternal:(PanoWBDocExtContents *)contents;
 
- (NSString * _Nullable)createDocWithImages:(NSArray<NSString *> * _Nonnull)urls;
- (NSString * _Nullable)createDocWithFilePath:(NSString * _Nonnull)filePath;
- (NSString * _Nullable)createDocWithFilePath:(NSString * _Nonnull)filePath convertParam:(PanoWBConvertConfig*)config;
- (PanoResult)deleteDoc:(NSString * _Nonnull)fileId;
- (PanoResult)switchDoc:(NSString * _Nonnull)fileId;
- (PanoResult)saveDocToImages:(NSString * _Nonnull)fileId
                         path:(NSString * _Nonnull)outputDir;
- (NSMutableArray<NSString*> * _Nullable)enumerateFiles;
- (NSString * _Nullable)getCurrentFileId;
- (PanoWBDocInfo * _Nullable)getFileInfo:(NSString * _Nonnull)fileId;
- (PanoResult)sendToExternalHtml:(NSString* _Nonnull)fileId
                         message:(NSString* _Nonnull)msg;
- (PanoResult)clearContents:(BOOL)curPage withType:(PanoWbClearType)type;
- (PanoResult)clearUserContents:(UInt64)userId
                    currentPage:(BOOL)curPage
                       withType:(PanoWbClearType)type;
- (PanoResult)clearDocContents:(NSString* _Nonnull)fileId
                      withType:(PanoWbClearType)type;
 
- (PanoResult)undo;
- (PanoResult)redo;
 
- (Float32)getCurrentScaleFactor;
 
- (PanoResult)setCurrentScaleFactor:(Float32)scale;
 
- (Float32)getCurrentMinScaleFactor;
- (Float32)getCurrentMaxScaleFactor;
 
- (PanoResult)snapshot:(PanoWBSnapshotMode)mode
                  path:(NSString * _Nonnull)outputDir;
 
- (PanoResult)initVision:(PanoWBVisionConfig*)config;
- (PanoResult)resetVision;
- (PanoResult)startShareVision;
- (PanoResult)stopShareVision;
- (PanoResult)startFollowVision;
- (PanoResult)stopFollowVision;
- (PanoResult)syncVision;
 
#pragma mark Message Methods
 
- (PanoResult)sendMessage:(NSData * _Nonnull)message
                   toUser:(UInt64)userId;
- (PanoResult)broadcastMessage:(NSData * _Nonnull)message;
 
#pragma mark Option Methods
 
- (PanoResult)setOption:(NSObject * _Nullable)option
                forType:(PanoWBOptionType)type;
 
@end
 
NS_ASSUME_NONNULL_END