Meeting Webinar helper interface. More...

#include <IMeetingWebinarHelper.h>

Public Member Functions
virtual	~IMeetingWebinarHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingWebinarHelperSink *pSink)=0
	Register meeting webinar helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingWebinarHelperSink *pSink)=0
	Deregister meeting webinar helper callback sink.

virtual ZRCSDKError	StartWebinarFromPracticeSession ()=0
	Start webinar from practice session.

virtual ZRCSDKError	IsInWebinarPracticeSession (bool &inPracticeSession)=0
	Query if you are in webinar practice session.

virtual ZRCSDKError	PromoteAttendeeToPanelist (int32_t userID)=0
	Promote attendee to panelist.

virtual ZRCSDKError	DemotePanelistToAttendee (int32_t userID)=0
	Demote panelist to attendee.

virtual ZRCSDKError	AllowWebinarAttendeeTalk (int32_t userID)=0
	Allow webinar attendee talk.

virtual ZRCSDKError	DisallowWebinarAttendeeTalk (int32_t userID)=0
	Disallow webinar attendee talk.

virtual ZRCSDKError	AllowWebinarAttendeeViewParticipantCount ()=0
	Allow webinar attendee view participants count.

virtual ZRCSDKError	DisallowWebinarAttendeeViewParticipantCount ()=0
	Disallow webinar attendee view participants count.

virtual ZRCSDKError	ListUnencryptedWebinarAttendees ()=0
	List unencrypted webinar attendees.

virtual ZRCSDKError	ListWebinarAttendees (const std::string &keywords)=0
	List webinar attendees.

virtual ZRCSDKError	GetCurrentAttendeeList (std::vector< MeetingParticipant > &attendeeList)=0
	Get current attendee list.

virtual ZRCSDKError	MoveAllToBackstage (bool includeSelf)=0
	Move all users from webinar into backstage.

virtual ZRCSDKError	MoveAllToWebinar (bool includeSelf)=0
	Move all users from backstage into webinar.

virtual ZRCSDKError	MoveToBackstage (const std::vector< int32_t > &userIDs)=0
	Move selected users from webinar into backstage.

virtual ZRCSDKError	MoveToWebinar (const std::vector< int32_t > &userIDs)=0
	Move selected users from backstage into webinar.

virtual ZRCSDKError	CanGoToWebinar (bool &canGo)=0
	Query if can go to webinar.

virtual ZRCSDKError	CanGoToBackstage (bool &canGo)=0
	Query if can go to backstage.

virtual ZRCSDKError	GoToBackstage ()=0
	Go to backstage.

virtual ZRCSDKError	GoToWebinar ()=0
	Go to webinar.

virtual ZRCSDKError	EndWebinarForAttendees ()=0
	End webinar for attendees and send all panelists to a private debriefing session.

virtual ZRCSDKError	SetWebinarVolume (float webinarVolume)=0
	Set webinar volume.

virtual ZRCSDKError	AllowPanelistMoveBetweenWebinarAndBackstage (bool allowMove)=0
	Allow panelist move between webinar and backstage.

virtual ZRCSDKError	NeedShowVideoPreviewBeforeGoToWebinar (bool &needShow)=0
	Query if needs to show video preview before going to webinar.

virtual ZRCSDKError	ShowVideoPreview (bool showVideoPreview)=0
	Show video preview.

virtual ZRCSDKError	UpdateMediaStatusInVideoPreview (bool audioOn, bool videoOn)=0
	Update media status in video preview before you enter into webinar.

virtual ZRCSDKError	CanSwitchBetweenBackstageContentAndLiveFeed (bool &canSwitch)=0
	Query if can switch between webinar live feed and backstage content.

virtual ZRCSDKError	SwitchWebinarLiveFeed (bool showWebinarLiveFeed)=0
	Switch between webinar live feed and backstage content.

Detailed Description

Meeting Webinar helper interface.

Definition at line 268 of file IMeetingWebinarHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingWebinarHelper()

virtual IMeetingWebinarHelper::~IMeetingWebinarHelper ( )

inlinevirtual

Definition at line 271 of file IMeetingWebinarHelper.h.

271{}

Member Function Documentation

◆ AllowPanelistMoveBetweenWebinarAndBackstage()

virtual ZRCSDKError IMeetingWebinarHelper::AllowPanelistMoveBetweenWebinarAndBackstage ( bool allowMove )

pure virtual

Allow panelist move between webinar and backstage.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allowMove TRUE indicates to allow move.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowWebinarAttendeeTalk()

virtual ZRCSDKError IMeetingWebinarHelper::AllowWebinarAttendeeTalk ( int32_t userID )

pure virtual

Allow webinar attendee talk.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to allow talking.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowWebinarAttendeeViewParticipantCount()

virtual ZRCSDKError IMeetingWebinarHelper::AllowWebinarAttendeeViewParticipantCount ( )

pure virtual

Allow webinar attendee view participants count.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CanGoToBackstage()

virtual ZRCSDKError IMeetingWebinarHelper::CanGoToBackstage ( bool & canGo )

pure virtual

Query if can go to backstage.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] canGo TRUE indicates can go.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CanGoToWebinar()

virtual ZRCSDKError IMeetingWebinarHelper::CanGoToWebinar ( bool & canGo )

pure virtual

Query if can go to webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] canGo TRUE indicates can go.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CanSwitchBetweenBackstageContentAndLiveFeed()

virtual ZRCSDKError IMeetingWebinarHelper::CanSwitchBetweenBackstageContentAndLiveFeed ( bool & canSwitch )

pure virtual

Query if can switch between webinar live feed and backstage content.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] canSwitch TRUE indicates can switch between contents.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DemotePanelistToAttendee()

virtual ZRCSDKError IMeetingWebinarHelper::DemotePanelistToAttendee ( int32_t userID )

pure virtual

Demote panelist to attendee.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to demote.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IMeetingWebinarHelper::DeregisterSink ( IMeetingWebinarHelperSink * pSink )

pure virtual

Deregister meeting webinar helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingWebinarHelperSink that receives the meeting webinar helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DisallowWebinarAttendeeTalk()

virtual ZRCSDKError IMeetingWebinarHelper::DisallowWebinarAttendeeTalk ( int32_t userID )

pure virtual

Disallow webinar attendee talk.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to disallow talking.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DisallowWebinarAttendeeViewParticipantCount()

virtual ZRCSDKError IMeetingWebinarHelper::DisallowWebinarAttendeeViewParticipantCount ( )

pure virtual

Disallow webinar attendee view participants count.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EndWebinarForAttendees()

virtual ZRCSDKError IMeetingWebinarHelper::EndWebinarForAttendees ( )

pure virtual

End webinar for attendees and send all panelists to a private debriefing session.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetCurrentAttendeeList()

virtual ZRCSDKError IMeetingWebinarHelper::GetCurrentAttendeeList ( std::vector< MeetingParticipant > & attendeeList )

pure virtual

Get current attendee list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

The API only contains part of all the attendees. It may the first 100 attendees or the keywords filtered attendees you last request by ListWebinarAttendees.

Parameters

[out] attendeeList The attendee list.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GoToBackstage()

virtual ZRCSDKError IMeetingWebinarHelper::GoToBackstage ( )

pure virtual

Go to backstage.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GoToWebinar()

virtual ZRCSDKError IMeetingWebinarHelper::GoToWebinar ( )

pure virtual

Go to webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsInWebinarPracticeSession()

virtual ZRCSDKError IMeetingWebinarHelper::IsInWebinarPracticeSession ( bool & inPracticeSession )

pure virtual

Query if you are in webinar practice session.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] inPracticeSession TRUE indicates you are in webinar practice session.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ListUnencryptedWebinarAttendees()

virtual ZRCSDKError IMeetingWebinarHelper::ListUnencryptedWebinarAttendees ( )

pure virtual

List unencrypted webinar attendees.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ListWebinarAttendees()

virtual ZRCSDKError IMeetingWebinarHelper::ListWebinarAttendees ( const std::string & keywords )

pure virtual

List webinar attendees.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

If keywords are empty, this api will request the first 100 attendees. Otherwise, this api will request attendees filtered by the keywords.

Parameters

keywords The search keywords.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MoveAllToBackstage()

virtual ZRCSDKError IMeetingWebinarHelper::MoveAllToBackstage ( bool includeSelf )

pure virtual

Move all users from webinar into backstage.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

includeSelf TRUE indicates include ZR self.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MoveAllToWebinar()

virtual ZRCSDKError IMeetingWebinarHelper::MoveAllToWebinar ( bool includeSelf )

pure virtual

Move all users from backstage into webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

includeSelf TRUE indicates include ZR self.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MoveToBackstage()

virtual ZRCSDKError IMeetingWebinarHelper::MoveToBackstage ( const std::vector< int32_t > & userIDs )

pure virtual

Move selected users from webinar into backstage.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userIDs User IDs. Using ID in IParticipantHelper.GetParticipantsInMeeting to move participant.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MoveToWebinar()

virtual ZRCSDKError IMeetingWebinarHelper::MoveToWebinar ( const std::vector< int32_t > & userIDs )

pure virtual

Move selected users from backstage into webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userIDs User IDs. Using ID in IParticipantHelper.GetParticipantsInMeeting to move participant.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ NeedShowVideoPreviewBeforeGoToWebinar()

virtual ZRCSDKError IMeetingWebinarHelper::NeedShowVideoPreviewBeforeGoToWebinar ( bool & needShow )

pure virtual

Query if needs to show video preview before going to webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] needShow TRUE indicates needs to show video preview before going to webinar.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ PromoteAttendeeToPanelist()

virtual ZRCSDKError IMeetingWebinarHelper::PromoteAttendeeToPanelist ( int32_t userID )

pure virtual

Promote attendee to panelist.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to promote.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingWebinarHelper::RegisterSink ( IMeetingWebinarHelperSink * pSink )

pure virtual

Register meeting webinar helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingWebinarHelperSink that receives the meeting webinar helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetWebinarVolume()

virtual ZRCSDKError IMeetingWebinarHelper::SetWebinarVolume ( float webinarVolume )

pure virtual

Set webinar volume.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

webinarVolume The volume.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ShowVideoPreview()

virtual ZRCSDKError IMeetingWebinarHelper::ShowVideoPreview ( bool showVideoPreview )

pure virtual

Show video preview.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

showVideoPreview TRUE indicates to show video preview. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StartWebinarFromPracticeSession()

virtual ZRCSDKError IMeetingWebinarHelper::StartWebinarFromPracticeSession ( )

pure virtual

Start webinar from practice session.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SwitchWebinarLiveFeed()

virtual ZRCSDKError IMeetingWebinarHelper::SwitchWebinarLiveFeed ( bool showWebinarLiveFeed )

pure virtual

Switch between webinar live feed and backstage content.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

showWebinarLiveFeed TRUE indicates to switch to webinar live feed. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpdateMediaStatusInVideoPreview()

virtual ZRCSDKError IMeetingWebinarHelper::UpdateMediaStatusInVideoPreview	(	bool	audioOn,
		bool	videoOn
	)

pure virtual

Update media status in video preview before you enter into webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

audioOn	TRUE indicates to turn on audio. Otherwise not.
videoOn	TRUE indicates to turn on video. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingWebinarHelper()

Member Function Documentation

◆ AllowPanelistMoveBetweenWebinarAndBackstage()

◆ AllowWebinarAttendeeTalk()

◆ AllowWebinarAttendeeViewParticipantCount()

◆ CanGoToBackstage()

◆ CanGoToWebinar()

◆ CanSwitchBetweenBackstageContentAndLiveFeed()

◆ DemotePanelistToAttendee()

◆ DeregisterSink()

◆ DisallowWebinarAttendeeTalk()

◆ DisallowWebinarAttendeeViewParticipantCount()

◆ EndWebinarForAttendees()

◆ GetCurrentAttendeeList()

◆ GoToBackstage()

◆ GoToWebinar()

◆ IsInWebinarPracticeSession()

◆ ListUnencryptedWebinarAttendees()

◆ ListWebinarAttendees()

◆ MoveAllToBackstage()

◆ MoveAllToWebinar()

◆ MoveToBackstage()

◆ MoveToWebinar()

◆ NeedShowVideoPreviewBeforeGoToWebinar()

◆ PromoteAttendeeToPanelist()

◆ RegisterSink()

◆ SetWebinarVolume()

◆ ShowVideoPreview()

◆ StartWebinarFromPracticeSession()

◆ SwitchWebinarLiveFeed()

◆ UpdateMediaStatusInVideoPreview()