ZMVideoSDKRemoteControlHelper Class Reference

Helper class to manage sending, approving, or canceling remote control requests in a session. More...

#include <ZMVideoSDKRemoteControlHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canRequestControl
	Determines if the user is able to ask to remote control the specified user.
(ZMVideoSDKErrors)	- requestRemoteControl
	Sends the remote control request to the specified user.
(ZMVideoSDKErrors)	- endRemoteControl
	End remote control of the specified user.
(BOOL)	- canRemoteControl
	Determines if the user is able to remote control the specified user.
(ZMVideoSDKErrors)	- enterRemoteControl
	Remote control the specified user.
(BOOL)	- isRemoteControlling
	Determines if the specified user is in the process of being remotely controlled.
(ZMVideoSDKErrors)	- leaveRemoteControl
	The user has temporarily paused remote control, to continue, there is no need to request remote control again.

Detailed Description

Helper class to manage sending, approving, or canceling remote control requests in a session.

Definition at line 31 of file ZMVideoSDKRemoteControlHelper.h.

Method Documentation

canRemoteControl

- (BOOL) canRemoteControl

Determines if the user is able to remote control the specified user.

Returns

If the user is able to remote control the specified user, it returns YES. Otherwise, NO.

References canRemoteControl.

Referenced by canRemoteControl.

canRequestControl

- (BOOL) canRequestControl

Determines if the user is able to ask to remote control the specified user.

Returns

If the user is able to request to remote control the specified user, it returns YES. Otherwise, NO.

References canRequestControl.

Referenced by canRequestControl.

endRemoteControl

- (ZMVideoSDKErrors) endRemoteControl

End remote control of the specified user.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise, this function returns an error.

References endRemoteControl.

Referenced by endRemoteControl.

enterRemoteControl

- (ZMVideoSDKErrors) enterRemoteControl

Remote control the specified user.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise, this function returns an error.

References enterRemoteControl.

Referenced by enterRemoteControl.

isRemoteControlling

- (BOOL) isRemoteControlling

Determines if the specified user is in the process of being remotely controlled.

Returns

If the specified user is being remotely controlled, it returns YES. Otherwise, NO.

References isRemoteControlling.

Referenced by isRemoteControlling.

leaveRemoteControl

- (ZMVideoSDKErrors) leaveRemoteControl

The user has temporarily paused remote control, to continue, there is no need to request remote control again.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise, this function returns an error.

References leaveRemoteControl.

Referenced by leaveRemoteControl.

requestRemoteControl

- (ZMVideoSDKErrors) requestRemoteControl

Sends the remote control request to the specified user.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise, this function returns an error.

References requestRemoteControl.

Referenced by requestRemoteControl.