Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCShareAction Class Reference

Representing a share action, including subscription and rendering controls. More...

#include <MobileRTCMeetingService+AppShare.h>

Inherits NSObject.

Instance Methods

(void) - setShareActionDelegate:
 Sets the share action delegate.
(UIView *_Nullable) - getActiveShareView
 Gets active share view from share action.
(NSUInteger) - getShareID
 Gets the sharing ID.
(NSString *_Nullable) - getSharingUserName
 Gets the name of the sharing user.
(MobileRTCSDKError- subscribe
 Subscribes to the sharing content.
(MobileRTCSDKError- unsubscribe
 Unsubscribes from the sharing content.

Detailed Description

Representing a share action, including subscription and rendering controls.

Definition at line 31 of file MobileRTCMeetingService+AppShare.h.

Method Documentation

◆ getActiveShareView

- (UIView *_Nullable) getActiveShareView

Gets active share view from share action.

Returns
If the function succeeds, it returns the active share view. Otherwise, this function fails and returns nil.

References getActiveShareView.

Referenced by getActiveShareView.

◆ getShareID

- (NSUInteger) getShareID

Gets the sharing ID.

Returns
If the function succeeds, the return value is the sharing ID. Otherwise the function fails, and the return value is ZERO (0).

References getShareID.

Referenced by getShareID.

◆ getSharingUserName

- (NSString *_Nullable) getSharingUserName

Gets the name of the sharing user.

Returns
The name.

References getSharingUserName.

Referenced by getSharingUserName.

◆ setShareActionDelegate:

- (void) setShareActionDelegate: (id< MobileRTCShareActionDelegate >_Nullable) delegate

Sets the share action delegate.

Parameters
delegateThe share action delegate.

◆ subscribe

- (MobileRTCSDKError) subscribe

Subscribes to the sharing content.

Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

References subscribe.

Referenced by subscribe.

◆ unsubscribe

- (MobileRTCSDKError) unsubscribe

Unsubscribes from the sharing content.

Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

References unsubscribe.

Referenced by unsubscribe.