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:
 Sets the frame of video preview and tells Zoom client the parent view where the video preview is drawn.
 
(ZoomSDKError- StartPreview:
 Preview user's video.
 
(ZoomSDKError- StartPreview
 Preview user's video with default camera.
 
(ZoomSDKError- StopPreview
 Stops 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 

Sets the frame of video preview and tells Zoom client the parent view where the video preview is drawn.

Parameters
parentViewThe parent view where the video preview will be drawn.
containerRectThe frame displaying video preview.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ StartPreview

- (ZoomSDKError) StartPreview

Preview user's video with default camera.

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

◆ StartPreview:

- (ZoomSDKError) StartPreview: (NSString *) deviceID

Preview user's video.

Parameters
deviceIDThe ID of camera device.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.
Deprecated
This method is no longer used.

◆ StopPreview

- (ZoomSDKError) StopPreview

Stops previewing user's video.

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

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.