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
	Determine if the user is able to ask to remote control the specified user.
(ZMVideoSDKErrors)	- requestRemoteControl
	Send the remote control request to the specified user.
(ZMVideoSDKErrors)	- endRemoteControl
	End remote control of the specified user.
(BOOL)	- canRemoteControl
	Determine if the user is able to remote control the specified user.
(ZMVideoSDKErrors)	- enterRemoteControl
	Remote control the specified user.
(BOOL)	- isRemoteControlling
	Determine 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

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

Returns

If the user is able to remote control the specified user, the return value is YES. Otherwise NO.

canRequestControl

- (BOOL) canRequestControl

Determine 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, the return value is YES. Otherwise NO.

endRemoteControl

- (ZMVideoSDKErrors) endRemoteControl

End remote control of the specified user.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise failed.

enterRemoteControl

- (ZMVideoSDKErrors) enterRemoteControl

Remote control the specified user.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise failed.

isRemoteControlling

- (BOOL) isRemoteControlling

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

Returns

If the specified user is being remotely controlled, the return value is YES. Otherwise NO.

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 failed.

requestRemoteControl

- (ZMVideoSDKErrors) requestRemoteControl

Send the remote control request to the specified user.

Returns

ZMVideoSDKErrors_Success If the function succeeds. Otherwise failed.