Inheritance diagram for ZoomSDKMeetingActionController:

Instance Methods
(NSArray *)	- getParticipantsList
	Get the list of participants. More...

(ZoomSDKError)	- actionMeetingWithCmd:userID:onScreen:
	Commands in the meeting. More...

(ZoomSDKError)	- sendChat:toUser:
	Send a chat message. More...

(ZoomSDKUserInfo *)	- getUserByUserID:
	Get the information of the specified user. More...

(ZoomSDKError)	- changeUserName:newName:
	Change user's screen name in the meeting. More...

(ZoomSDKError)	- makeHost:
	Assign a participant to be a new host, or original host who loose the privilege reclaims to be the host. More...

(ZoomSDKError)	- raiseHand:UserID:
	Make the specified user to raise hand or lower hand. More...

(ZoomSDKError)	- expelUser:
	Remove the specified user from meeting. More...

(ZoomSDKError)	- startCMR:
	Start or stop the cloud recording. More...

(ZoomSDKError)	- getMeetingUIType:isFullScreen:meetingUIType:
	Get the meeting UI display type. More...

(ZoomSDKError)	- allowLocalRecord:UserID:
	Allow or disallow the specified user to local recording. More...

(BOOL)	- canReclaimHost
	Query if user can claim host(be host) or not. More...

(ZoomSDKError)	- claimHostByKey:
	Normal participant claims host by host-key. More...

(ZoomSDKError)	- assignCoHost:
	Assign a user as co-host in meeting. More...

(ZoomSDKError)	- revokeCoHost:
	Revoke co-host role of another user in meeting. More...

(ZoomSDKError)	- setShareSettingType:
	Set sharing types for the host or co-host in meeting. More...

(ZoomSDKError)	- getShareSettingType:
	Get the sharing types for the host or co-host in meeting. More...

(BOOL)	- isUseOriginalSoundOn
	Determine if user's original sound is enabled. More...

(ZoomSDKError)	- enableUseOriginalSound:
	Set to output original sound of mic in meeting. More...

(BOOL)	- isSupportUseOriginalSound
	Determine if the meeting supports user's original sound. More...

(ZoomSDKError)	- swapToShowShareViewOrVideo:
	Swap to show sharing screen or video. More...

(BOOL)	- canSwapToShowShareViewOrVideo
	Determine if the user can swap to show sharing screen or video now. More...

(BOOL)	- isDisplayingShareViewOrVideo
	Determine if the meeting is displaying the sharing screen now. More...

(ZoomSDKError)	- setMeetingTopicOnMeetingInfo:
	Set the meeting topic on meeting info. More...

(BOOL)	- isParticipantsShareAllowed
	Determine if the share screen is allowed. More...

(ZoomSDKError)	- allowParticipantsToShare:
	Allow participants to share screen. More...

(BOOL)	- isParticipantsChatAllowed
	Determine if the chat is allowed. More...

(ZoomSDKError)	- allowParticipantsToChat:
	Allow participants to chat. More...

(BOOL)	- isParticipantsRenameAllowed
	Determine if the participant rename is disabled. More...

(ZoomSDKError)	- allowParticipantsToRename:
	Allow participants to rename. More...

Protected Attributes
id< ZoomSDKMeetingActionControllerDelegate >	_delegate

Properties
id< ZoomSDKMeetingActionControllerDelegate >	delegate

Method Documentation

◆ actionMeetingWithCmd:userID:onScreen:

- (ZoomSDKError) actionMeetingWithCmd:	(ActionMeetingCmd)	cmd
userID:	(unsigned int)	userID
onScreen:	(ScreenType)	screen

Commands in the meeting.

Parameters

cmd	The commands in the meeting.
userID	The ID of user. Zero(0) means that the current user can control the commands. If it is other participant, it will return the corresponding user ID.
screen	Specify the screen on which you want to do action.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ allowLocalRecord:UserID:

- (ZoomSDKError) allowLocalRecord:	(BOOL)	allow
UserID:	(unsigned int)	userid

Allow or disallow the specified user to local recording.

Parameters

allow	YES means allow, NO means disallow.
userid	User ID of the user to be modified.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ allowParticipantsToChat:

- (ZoomSDKError) allowParticipantsToChat: (BOOL) allow

Allow participants to chat.

Parameters

allow YES means allow participants to chat,otherwise not.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ allowParticipantsToRename:

- (ZoomSDKError) allowParticipantsToRename: (BOOL) allow

Allow participants to rename.

Parameters

allow YES means allow participants to rename,otherwise not.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ allowParticipantsToShare:

- (ZoomSDKError) allowParticipantsToShare: (BOOL) allow

Allow participants to share screen.

Parameters

allow YES means allow participants use share screen,otherwise not.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ assignCoHost:

- (ZoomSDKError) assignCoHost: (unsigned int) userid

Assign a user as co-host in meeting.

Parameters

userid The ID of user to be a co-host.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

Note: The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.

◆ canReclaimHost

- (BOOL) canReclaimHost

Query if user can claim host(be host) or not.

Returns: YES means able, otherwise not.

◆ canSwapToShowShareViewOrVideo

- (BOOL) canSwapToShowShareViewOrVideo

Determine if the user can swap to show sharing screen or video now.

Returns: YES means can, otherwise not.

◆ changeUserName:newName:

- (ZoomSDKError) changeUserName:	(unsigned int)	userID
newName:	(NSString *)	name

Change user's screen name in the meeting.

Parameters

userID	The ID of user whose screen name will be changed. Normal participants can change only their personal screen name while the host/co-host can change all participants' names.
name	The new screen name.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ claimHostByKey:

- (ZoomSDKError) claimHostByKey: (NSString *) hostKey

Normal participant claims host by host-key.

Parameters

hostKey Host key.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ enableUseOriginalSound:

- (ZoomSDKError) enableUseOriginalSound: (BOOL) enable

Set to output original sound of mic in meeting.

Parameters

enable YES means using original sound, No disabling.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise failed.

◆ expelUser:

- (ZoomSDKError) expelUser: (unsigned int) userid

Remove the specified user from meeting.

Parameters

userid User ID of the user to be modified.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ getMeetingUIType:isFullScreen:meetingUIType:

- (ZoomSDKError) getMeetingUIType:	(ScreenType)	type
isFullScreen:	(BOOL *)	bFullScreen
meetingUIType:	(MeetingUIType *)	meetingUIType

Get the meeting UI display type.

Parameters

type	Select the screen where you want to operate on.
bFullScreen	A point to A BOOL, if the function call successfully, the value of 'bFullScreen' means whether the specified screen is in full screen mode.
meetingUIType	A point to A MeetingUIType, if the function call successfully, the value of 'meetingUIType' means the meeting UI display type.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ getParticipantsList

- (NSArray*) getParticipantsList

Get the list of participants.

Returns: An array of participant ID.

◆ getShareSettingType:

- (ZoomSDKError) getShareSettingType: (ZoomSDKShareSettingType *) type

Get the sharing types for the host or co-host in meeting.

Parameters

ZoomSDKShareSettingType Custom setting types of ZOOM SDK sharing.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ getUserByUserID:

- (ZoomSDKUserInfo*) getUserByUserID: (unsigned int) userID

Get the information of the specified user.

Parameters

userID The ID of the specified user.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ isDisplayingShareViewOrVideo

- (BOOL) isDisplayingShareViewOrVideo

Determine if the meeting is displaying the sharing screen now.

Returns: YES means is showing sharing screen, NO means is showing video.

◆ isParticipantsChatAllowed

- (BOOL) isParticipantsChatAllowed

Determine if the chat is allowed.

Returns: YES means is disable chat,otherwise not.

◆ isParticipantsRenameAllowed

- (BOOL) isParticipantsRenameAllowed

Determine if the participant rename is disabled.

Returns: YES means is disable participant rename,otherwise not.

◆ isParticipantsShareAllowed

- (BOOL) isParticipantsShareAllowed

Determine if the share screen is allowed.

Returns: YES means is disable share screen,otherwise not.

◆ isSupportUseOriginalSound

- (BOOL) isSupportUseOriginalSound

Determine if the meeting supports user's original sound.

Returns: YES means supported, otherwise not.

◆ isUseOriginalSoundOn

- (BOOL) isUseOriginalSoundOn

Determine if user's original sound is enabled.

Returns: YES means enabled, otherwise not.

◆ makeHost:

- (ZoomSDKError) makeHost: (unsigned int) userID

Assign a participant to be a new host, or original host who loose the privilege reclaims to be the host.

Parameters

userID User ID of new host. Zero(0) means that the original host takes back the privilege.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ raiseHand:UserID:

- (ZoomSDKError) raiseHand:	(BOOL)	raise
UserID:	(unsigned int)	userid

Make the specified user to raise hand or lower hand.

Parameters

raise	YES means to raise hand, NO means lower hand for this specified user.
userid	User ID of the user to be modified.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ revokeCoHost:

- (ZoomSDKError) revokeCoHost: (unsigned int) userid

Revoke co-host role of another user in meeting.

Parameters

userid The ID of co-host who will loose the co-host privilege.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

Note: Only meeting host can run the function.

◆ sendChat:toUser:

- (ZoomSDKError) sendChat:	(NSString *)	content
toUser:	(unsigned int)	userID

Send a chat message.

Parameters

content	The content of message.
userID	The ID of user who will receive the message.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ setMeetingTopicOnMeetingInfo:

- (ZoomSDKError) setMeetingTopicOnMeetingInfo: (NSString *) topic

Set the meeting topic on meeting info.

Parameters

topic The meeting topic.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ setShareSettingType:

- (ZoomSDKError) setShareSettingType: (ZoomSDKShareSettingType) shareType

Set sharing types for the host or co-host in meeting.

Parameters

ZoomSDKShareSettingType Custom setting types of ZOOM SDK sharing.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ startCMR:

- (ZoomSDKError) startCMR: (BOOL) start

Start or stop the cloud recording.

Parameters

start YES means to start, NO means stop.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ swapToShowShareViewOrVideo:

- (ZoomSDKError) swapToShowShareViewOrVideo: (BOOL) share

Swap to show sharing screen or video.

Parameters

share YES means swap to sharing screen, NO means swap to video.

Returns: If the function succeeds, it will return ZoomSDKError_success, otherwise not.

Note: Only available for Zoom native ui mode.

The documentation for this class was generated from the following file:

ZoomSDKMeetingActionController.h

Instance Methods

Protected Attributes

Properties

Method Documentation

◆ actionMeetingWithCmd:userID:onScreen:

◆ allowLocalRecord:UserID:

◆ allowParticipantsToChat:

◆ allowParticipantsToRename:

◆ allowParticipantsToShare:

◆ assignCoHost:

◆ canReclaimHost

◆ canSwapToShowShareViewOrVideo

◆ changeUserName:newName:

◆ claimHostByKey:

◆ enableUseOriginalSound:

◆ expelUser:

◆ getMeetingUIType:isFullScreen:meetingUIType:

◆ getParticipantsList

◆ getShareSettingType:

◆ getUserByUserID:

◆ isDisplayingShareViewOrVideo

◆ isParticipantsChatAllowed

◆ isParticipantsRenameAllowed

◆ isParticipantsShareAllowed

◆ isSupportUseOriginalSound

◆ isUseOriginalSoundOn

◆ makeHost:

◆ raiseHand:UserID:

◆ revokeCoHost:

◆ sendChat:toUser:

◆ setMeetingTopicOnMeetingInfo:

◆ setShareSettingType:

◆ startCMR:

◆ swapToShowShareViewOrVideo: