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

A handle that represents a meeting indicator item and allows control of its visibility. More...

#include <MobileRTCMeetingService+InMeeting.h>

Inherits NSObject.

Instance Methods

(NSString *_Nullable) - getIndicatorItemId
 Gets the indicator item ID.
 
(NSString *_Nullable) - getIndicatorName
 Gets the indicator name.
 
(NSString *_Nullable) - getIndicatorIcon
 Gets the indicator icon URL.
 
(MobileRTCSDKError- showIndicatorPane:originPoint:
 Shows indicator panel window.
 
(MobileRTCSDKError- hideIndicatorPanel
 Hides indicator panel window.
 

Detailed Description

A handle that represents a meeting indicator item and allows control of its visibility.

Definition at line 186 of file MobileRTCMeetingService+InMeeting.h.

Method Documentation

◆ getIndicatorIcon

- (NSString *_Nullable) getIndicatorIcon

Gets the indicator icon URL.

Returns
The indicator icon URL.

◆ getIndicatorItemId

- (NSString *_Nullable) getIndicatorItemId

Gets the indicator item ID.

Returns
The indicator item ID.

◆ getIndicatorName

- (NSString *_Nullable) getIndicatorName

Gets the indicator name.

Returns
The indicator name.

◆ hideIndicatorPanel

- (MobileRTCSDKError) hideIndicatorPanel

Hides indicator panel window.

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

◆ showIndicatorPane:originPoint:

- (MobileRTCSDKError) showIndicatorPane: (UIView *_Nullable) containerView
originPoint: (CGPoint) originXY 

Shows indicator panel window.

Parameters
containerViewThe view container to show app signaling panel.
originXYThe origin position of app signaling panel in container view.
Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.
Warning
OriginXY only takes effect on iPad device. Behavior of iPhone always pops up from the bottom with the device width.