us.zoom.sdk.InMeetingWebinarController Interface Reference

Webinar controller in meeting. More...

Data Structures
interface	InMeetingWebinarListener
	Callback event of webinar. More...

Public Member Functions
void	addListener (InMeetingWebinarListener listener)
	Register a listener to listen for the callback of webinar event.
void	removeListener (InMeetingWebinarListener listener)
	Unregister the listener.
MobileRTCSDKError	promptAttendee2Panelist (long userId)
	Prompt attendee to panelist. Available only for the host.
MobileRTCSDKError	depromptPanelist2Attendee (long userId)
	Demote the panelist to attendee. Available only for the host.
boolean	isSupportAttendeeTalk ()
	Query if attendee in the current meeting is allowed to talk.
MobileRTCSDKError	allowAttendeeTalk (long userId)
	Allow attendee to talk. Available only for the host.
MobileRTCSDKError	disAllowAttendeeTalk (long userId)
	Disallow attendee to talk. Available only for the host.
MobileRTCSDKError	allowPanelistStartVideo ()
	Allow panelist to start video. Available only for the host.
MobileRTCSDKError	disallowPanelistStartVideo ()
	Disallow panelist to start video. Available only for the host.
boolean	isAllowPanellistStartVideo ()
	Query if panelist is able to start video.
boolean	isAllowAttendeeChat ()
	Query if attendee is able to chat.
boolean	isWebinarEmojiReactionSupported ()
	Determine if current webinar supports emoji reactions.
MobileRTCSDKError	allowWebinarEmojiReaction ()
	Permitted to use emoji reactions.
MobileRTCSDKError	disallowWebinarEmojiReaction ()
	Forbid to use emoji reactions.
boolean	isWebinarEmojiReactionAllowed ()
	Query if emoji reactions status.
MobileRTCSDKError	allowAttendeeRaiseHand ()
	The attendees can raise their hands.
MobileRTCSDKError	disallowAttendeeRaiseHand ()
	Do not let the attendee to raise their hand.
boolean	isAttendeeRaiseHandAllowed ()
	Query If attendee raise hand status.
MobileRTCSDKError	allowAttendeeViewTheParticipantCount ()
	The attendee is permitted to view the participant count.
MobileRTCSDKError	disallowAttendeeViewTheParticipantCount ()
	Forbid the attendee to view the participant count.
boolean	isAttendeeViewTheParticipantCountAllowed ()
	Query if attendee to view the participant count status.
int	getParticipantCount ()
	Get the participant count.
MobileRTCSDKError	setAttendeeViewMode (ZoomSDKAttendeeViewMode mode)
	Set the view mode of the attendee.
ZoomSDKAttendeeViewMode	getAttendeeViewMode ()
	Get the view mode of the attendee.
String	getWebinarRegistrationLegalNoticesPrompt ()
	Return webinar registration legal notice prompt.
WebinarRegistLegalNoticeContent	getWebinarRegistrationLegalNoticesExplained ()
	Return explained content WebinarRegistLegalNoticeContent for webinar registration legal notice.

Detailed Description

Webinar controller in meeting.

Definition at line 8 of file InMeetingWebinarController.java.

Member Function Documentation

addListener()

void us.zoom.sdk.InMeetingWebinarController.addListener

(

InMeetingWebinarListener

listener

)

Register a listener to listen for the callback of webinar event.

Parameters

listener

The listener instance.

allowAttendeeRaiseHand()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.allowAttendeeRaiseHand

(

)

The attendees can raise their hands.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. If the function succeeds, the user receives the InMeetingWebinarListener.onAllowAttendeeRaiseHandStatusChanged(boolean) callback event. Available only for the host.

allowAttendeeTalk()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.allowAttendeeTalk

(

long

userId

)

Allow attendee to talk. Available only for the host.

Parameters

userId

The ID of user who is allowed to talk.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

allowAttendeeViewTheParticipantCount()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.allowAttendeeViewTheParticipantCount

(

)

The attendee is permitted to view the participant count.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. If the function succeeds, the user will receive the InMeetingWebinarListener.onAllowAttendeeViewTheParticipantCountStatusChanged(boolean) callback event. Available only for the host.

allowPanelistStartVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.allowPanelistStartVideo

(

)

Allow panelist to start video. Available only for the host.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

allowWebinarEmojiReaction()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.allowWebinarEmojiReaction

(

)

Permitted to use emoji reactions.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. If the function succeeds, the user receives the InMeetingWebinarListener.onAllowWebinarReactionStatusChanged(boolean) callback event. Available only for the host.

depromptPanelist2Attendee()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.depromptPanelist2Attendee

(

long

userId

)

Demote the panelist to attendee. Available only for the host.

Parameters

userId

Specify the ID of user that you want to demote.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

disallowAttendeeRaiseHand()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.disallowAttendeeRaiseHand

(

)

Do not let the attendee to raise their hand.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. If the function succeeds, the user receives the InMeetingWebinarListener.onAllowAttendeeRaiseHandStatusChanged(boolean) callback event. Available only for the host.

disAllowAttendeeTalk()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.disAllowAttendeeTalk

(

long

userId

)

Disallow attendee to talk. Available only for the host.

Parameters

userId

The ID of user who is disallowed to talk.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

disallowAttendeeViewTheParticipantCount()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.disallowAttendeeViewTheParticipantCount

(

)

Forbid the attendee to view the participant count.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. If the function succeeds, the user receives the InMeetingWebinarListener.onAllowAttendeeViewTheParticipantCountStatusChanged(boolean) callback event. Available only for the host.

disallowPanelistStartVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.disallowPanelistStartVideo

(

)

Disallow panelist to start video. Available only for the host.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

disallowWebinarEmojiReaction()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.disallowWebinarEmojiReaction

(

)

Forbid to use emoji reactions.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. If the function succeeds, the user receives the InMeetingWebinarListener.onAllowWebinarReactionStatusChanged(boolean) callback event. Available only for the host.

getAttendeeViewMode()

ZoomSDKAttendeeViewMode us.zoom.sdk.InMeetingWebinarController.getAttendeeViewMode

(

)

Get the view mode of the attendee.

Returns

If the function succeeds, it will return the attendee's view mode.

getParticipantCount()

int us.zoom.sdk.InMeetingWebinarController.getParticipantCount

(

)

Get the participant count.

Returns

The participant count of.

getWebinarRegistrationLegalNoticesExplained()

WebinarRegistLegalNoticeContent us.zoom.sdk.InMeetingWebinarController.getWebinarRegistrationLegalNoticesExplained

(

)

Return explained content WebinarRegistLegalNoticeContent for webinar registration legal notice.

Returns

explained content defined in WebinarRegistLegalNoticeContent

getWebinarRegistrationLegalNoticesPrompt()

String us.zoom.sdk.InMeetingWebinarController.getWebinarRegistrationLegalNoticesPrompt

(

)

Return webinar registration legal notice prompt.

Returns

legal notice

isAllowAttendeeChat()

boolean us.zoom.sdk.InMeetingWebinarController.isAllowAttendeeChat

(

)

Query if attendee is able to chat.

Returns

TRUE means that attendee is able to chat. FALSE not.

isAllowPanellistStartVideo()

boolean us.zoom.sdk.InMeetingWebinarController.isAllowPanellistStartVideo

(

)

Query if panelist is able to start video.

Returns

TRUE means that the panelist is able to start video. FALSE not.

isAttendeeRaiseHandAllowed()

boolean us.zoom.sdk.InMeetingWebinarController.isAttendeeRaiseHandAllowed

(

)

Query If attendee raise hand status.

Returns

If it is enabled, the return value is true. Otherwise, the return value is false.

isAttendeeViewTheParticipantCountAllowed()

boolean us.zoom.sdk.InMeetingWebinarController.isAttendeeViewTheParticipantCountAllowed

(

)

Query if attendee to view the participant count status.

Returns

If this is enabled, the return value is true. Otherwise the return value is false.

isSupportAttendeeTalk()

boolean us.zoom.sdk.InMeetingWebinarController.isSupportAttendeeTalk

(

)

Query if attendee in the current meeting is allowed to talk.

Returns

TRUE means that attendee is able to talk. FALSE not.

Deprecated

This interface is marked as deprecated.

isWebinarEmojiReactionAllowed()

boolean us.zoom.sdk.InMeetingWebinarController.isWebinarEmojiReactionAllowed

(

)

Query if emoji reactions status.

Returns

If it Enable, the return value is true.false not.

isWebinarEmojiReactionSupported()

boolean us.zoom.sdk.InMeetingWebinarController.isWebinarEmojiReactionSupported

(

)

Determine if current webinar supports emoji reactions.

Returns

true means the current webinar supports emoji reactions, false means the feature is not supported.

promptAttendee2Panelist()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.promptAttendee2Panelist

(

long

userId

)

Prompt attendee to panelist. Available only for the host.

Parameters

userId

Specify the ID of user that you want to prompt.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

removeListener()

void us.zoom.sdk.InMeetingWebinarController.removeListener

(

InMeetingWebinarListener

listener

)

Unregister the listener.

Parameters

listener

The listener instance.

setAttendeeViewMode()

MobileRTCSDKError us.zoom.sdk.InMeetingWebinarController.setAttendeeViewMode

(

ZoomSDKAttendeeViewMode

mode

)

Set the view mode of the attendee.

Parameters

mode	The view mode of the attendee.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.