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

The helper to handle the requested of start captions. More...

#include <ZoomSDKCloseCaptionController.h>

Inherits NSObject.

Inherited by ZoomSDKCCRequestTranslationOffHandler, and ZoomSDKCCRequestTranslationOnHandler.

Instance Methods

(ZoomSDKError- deny
 Deny the request to start captions.
 

Properties

unsigned int senderUserID
 The user's user ID who send the start captions request.
 
BOOL isRequestTranslationOn
 

Detailed Description

The helper to handle the requested of start captions.

Note
When isRequestTranslationOn is YES, use ZoomSDKCCRequestTranslationOnHandler::approveStartCaptionsRequest to approve start captions request. When isRequestTranslationOn is NO, use ZoomSDKCCRequestTranslationOffHandler::approveStartCaptionsRequest: to approve start captions request.

Definition at line 17 of file ZoomSDKCloseCaptionController.h.

Method Documentation

◆ deny

- (ZoomSDKError) deny

Deny the request to start captions.

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

Property Documentation

◆ isRequestTranslationOn

- (BOOL) isRequestTranslationOn
readnonatomicassign
Returns
YES if request to start captions with translation on. Otherwise, NO.

Definition at line 26 of file ZoomSDKCloseCaptionController.h.

◆ senderUserID

- (unsigned int) senderUserID
readnonatomicassign

The user's user ID who send the start captions request.

Definition at line 21 of file ZoomSDKCloseCaptionController.h.