MobileRTCCaptionsControlHandler Class Reference

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

#include <MobileRTCMeetingService+LiveTranscription.h>

Inherits NSObject.

Inherited by MobileRTCCaptionsControlOffHandler, and MobileRTCCaptionsControlOnHandler.

Instance Methods
(MobileRTCSDKError)	- deny
	Denies the start captions request and then self-destroys.
(NSUInteger)	- getSenderUserId
	Gets the sender user ID.
(BOOL)	- isRequestTranslationOn
	Determines if the request is to start captions with translation on.

Detailed Description

The helper to handle the requested of start captions.

Note

When isRequestTranslationOn is YES, use MobileRTCCaptionsControlOnHandler::approveStartCaptionsRequest to approve start captions request.

When isRequestTranslationOn is NO, use MobileRTCCaptionsControlOnHandler::approveStartCaptionsRequest: to approve start captions request.

Definition at line 47 of file MobileRTCMeetingService+LiveTranscription.h.

Method Documentation

deny

- (MobileRTCSDKError) deny

Denies the start captions request and then self-destroys.

Returns

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

getSenderUserId

- (NSUInteger) getSenderUserId

Gets the sender user ID.

Returns

The user ID of the user who sent the request to start captions.

isRequestTranslationOn

- (BOOL) isRequestTranslationOn

Determines if the request is to start captions with translation on.

Returns

YES if the request is to start captions with translation on. Otherwise, NO.