Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingTestVideoDeviceHelper Class Reference

Helper class for testing video devices. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- SetVideoParentView:VideoContainerRect:
 This method is used to set the frame of video preview and tell Zoom client the parent view where the video preview will be drawn.
 
(ZoomSDKError- StartPreview:
 Preview user's video.
 
(ZoomSDKError- StartPreview
 Preview user's video with default camera.
 
(ZoomSDKError- StopPreview
 Stop previewing user's video.
 

Protected Attributes

id< ZoomSDKSettingVideoDelegate_delegate
 

Properties

id< ZoomSDKSettingVideoDelegatedelegate
 Delegate to receive video device events.
 

Detailed Description

Helper class for testing video devices.

Definition at line 192 of file ZoomSDKSettingService.h.

Method Documentation

◆ SetVideoParentView:VideoContainerRect:

- (ZoomSDKError) SetVideoParentView: (NSView *) parentView
VideoContainerRect: (NSRect) containerRect 

This method is used to set the frame of video preview and tell Zoom client the parent view where the video preview will be drawn.

Parameters
parentViewThe parent view where the video preview will be drawn.
containerRectThe frame displaying video preview.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ StartPreview

- (ZoomSDKError) StartPreview

Preview user's video with default camera.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ StartPreview:

- (ZoomSDKError) StartPreview: (NSString *) deviceID

Preview user's video.

Parameters
deviceIDThe ID of camera device.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.
Deprecated
This method is no longer used.

◆ StopPreview

- (ZoomSDKError) StopPreview

Stop previewing user's video.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

Field Documentation

◆ _delegate

- (id<ZoomSDKSettingVideoDelegate>) _delegate
protected

Definition at line 194 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingVideoDelegate>) delegate
readwritenonatomicassign

Delegate to receive video device events.

Definition at line 199 of file ZoomSDKSettingService.h.