MobileRTCMeetingService(VirtualBackground) Category Reference

meeting service for virtual background More...

#import <MobileRTCMeetingService+VirtualBackground.h>

Instance Methods
(BOOL)	- startPreviewWithFrame:
	Start preview for inspect the virtual background effect. More...
(BOOL)	- isSupportVirtualBG
	is support virtual background. More...
(BOOL)	- isSupportSmartVirtualBG
	is Support smart virtual background. More...
(NSArray< MobileRTCVirtualBGImageInfo * > *_Nonnull)	- getBGImageList
	get the virtual background list. More...
(MobileRTCMeetError)	- addBGImage:
	add and use the image for virtual background. More...
(MobileRTCMeetError)	- removeBGImage:
	Remove image item form image list. More...
(MobileRTCMeetError)	- useBGImage:
	use the specify image item for virtual background. More...
(MobileRTCMeetError)	- useNoneImage
	Disable the virtrual background, same as use a none image item. More...
(BOOL)	- isUsingGreenVB
	is using green virtual background. More...
(MobileRTCMeetError)	- enableGreenVB:
	Enable green virtual background mode. More...
(MobileRTCMeetError)	- selectGreenVBPoint:
	Select the point that regard as background. More...

Properties
UIView *_Nullable	previewView
	The preview for inspect the virtual background effect.

Detailed Description

meeting service for virtual background

Method Documentation

addBGImage:()

- (MobileRTCMeetError) addBGImage:

(UIImage *_Nonnull)

image

add and use the image for virtual background.

Returns

Add and use virtual background result.

Extends class MobileRTCMeetingService.

enableGreenVB:()

- (MobileRTCMeetError) enableGreenVB:

(BOOL)

enable

Enable green virtual background mode.

Parameters

enable

or disable.

Returns

result of enable green virtual background.

Warning

only iPad support Virtual background GreenScreen, iPhone does not support the feature.

Extends class MobileRTCMeetingService.

getBGImageList()

- (NSArray <MobileRTCVirtualBGImageInfo *>* _Nonnull) getBGImageList

get the virtual background list.

Returns

Return Narray of the items which include the None item.

Extends class MobileRTCMeetingService.

isSupportSmartVirtualBG()

- (BOOL) isSupportSmartVirtualBG

is Support smart virtual background.

Returns

YES mean support, you can use it.

Extends class MobileRTCMeetingService.

isSupportVirtualBG()

- (BOOL) isSupportVirtualBG

is support virtual background.

Returns

YES mean support, you can use it.

Warning

device should be iPhone 8/ 8 plus X or above or be iPad Pro 9.7 above, OS should be iOS 11 or above.

Extends class MobileRTCMeetingService.

isUsingGreenVB()

- (BOOL) isUsingGreenVB

is using green virtual background.

Returns

Return yes if using green virtual background.

Extends class MobileRTCMeetingService.

removeBGImage:()

- (MobileRTCMeetError) removeBGImage:

(MobileRTCVirtualBGImageInfo *_Nonnull)

bgImageInfo

Remove image item form image list.

Will use the previous one for virtual background.

Returns

Remove result.

Extends class MobileRTCMeetingService.

selectGreenVBPoint:()

- (MobileRTCMeetError) selectGreenVBPoint:

(CGPoint)

point

Select the point that regard as background.

Parameters

point

in preview view.

Returns

result of set background point action.

Warning

only iPad support Virtual background GreenScreen, iPhone does not support the feature.

Extends class MobileRTCMeetingService.

startPreviewWithFrame:()

- (BOOL) startPreviewWithFrame:

(CGRect)

frame

Start preview for inspect the virtual background effect.

Returns

YES mean preview is ready.

Extends class MobileRTCMeetingService.

useBGImage:()

- (MobileRTCMeetError) useBGImage:

(MobileRTCVirtualBGImageInfo *_Nonnull)

bgImage

use the specify image item for virtual background.

Returns

The result of use image item.

Extends class MobileRTCMeetingService.

useNoneImage()

- (MobileRTCMeetError) useNoneImage

Disable the virtrual background, same as use a none image item.

Returns

The result of disable virtual background.

Extends class MobileRTCMeetingService.

---

The documentation for this category was generated from the following file:

• MobileRTCMeetingService+VirtualBackground.h