Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Whiteboard.h
Go to the documentation of this file.
1
5
6#import <MobileRTC/MobileRTC.h>
7
11@interface MobileRTCMeetingService (Whiteboard)
12
18
24
30
37
43
50
58- (MobileRTCSDKError)setParentViewCtroller:(UIViewController* _Nullable)parentVC DEPRECATED_MSG_ATTRIBUTE("Not maintain anymore,Use showWhiteboardByParentViewCtroller instead");
59
66- (MobileRTCSDKError)showWhiteboardByParentViewCtroller:(UIViewController* _Nullable)parentVC;
67
74
80
86- (MobileRTCSDKError)setWhiteboardShareOption:(MobileRTCWhiteboardShareOption)option;
87
93
99- (MobileRTCSDKError)setWhiteboardCreateOption:(MobileRTCWhiteboardCreateOption)option;
100
106
112- (MobileRTCSDKError)enableParticipantsCreateWithoutHost:(BOOL)enable;
113
119
120#pragma mark - UI setting -
126- (void)disableCloudWhiteboard:(BOOL)disabled;
127
133- (BOOL)setCloudWhiteboardFeedbackUrl:(nullable NSString *)feedbackUrl;
134
139- (void)hideCloudWhiteboardHelperCenterButton:(BOOL)hide;
140
145- (void)hideCloudWhiteboardOpenInBrowserButton:(BOOL)hide;
146
151- (void)hideFeedbackButtonOnCloudWhiteboard:(BOOL)hide;
152
157- (void)hideShareButtonOnCloudWhiteboard:(BOOL)hide;
158
163- (void)hideAboutButtonOnCloudWhiteboard:(BOOL)hide;
164
165#pragma mark - legal related -
171
176- (NSString *_Nullable)getWhiteboardLegalNoticesPrompt;
177
183
189
195@end
196
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCCannotShareReasonType
Enumeration of the reasons why sharing is not allowed.
MobileRTCWhiteboardShareOption
Enumeration of the whiteboard share options.
MobileRTCWhiteboardCreateOption
Enumeration of the whiteboard create options.
BOOL canStartShareNewWhiteboard()
Determines whether the current user can create a new whiteboard.
BOOL isWhiteboardLegalNoticeAvailable()
Determines if whiteboard legal notice is available.
MobileRTCSDKError stopWhiteboardShare()
When self sharing whiteboard, stop self; when self not sharing, stop all others.
BOOL isOtherSharingWhiteboard()
Determines if other user is sharing whiteboard.
NSString *_Nullable getWhiteboardLegalNoticesPrompt()
Gets whiteboard legal notices message.
BOOL isSharingWhiteboardOut()
Determines if the current user is sharing whiteboard.
MobileRTCSDKError startNewWhiteboardShare()
Starts sharing a new whiteboard.
void dismissWhiteboardOrDashboard()
Dismisses whiteboard or dashboard.
MobileRTCSDKError showDashboardView()
Shows the dashboard web view window.
MobileRTCCannotShareReasonType canStartShareWhiteboard()
Determines whether the current meeting can start sharing the whiteboard.
BOOL isParticipantsCreateWithoutHostEnabled()
Determines whether enabling the participants to create a new whiteboard without the host in the meeti...
BOOL canStopWhiteboardShare()
Determines whether the current user can stop sharing the new whiteboard.
MobileRTCWhiteboardShareOption getWhiteboardShareOption()
Gets the option for who can share a whiteboard.
BOOL isSupportWhiteBoard()
Determines whether the current meeting supports the whiteboard.
MobileRTCWhiteboardCreateOption getWhiteboardCreateOption()
Gets the option for who can initiate a new whiteboard.
NSString *_Nullable getWhiteboardLegalNoticesExplained()
Gets whiteboard legal notices detailed description.