Meeting View Layout helper interface. More...

#include <IMeetingViewLayoutHelper.h>

Public Member Functions
virtual	~IMeetingViewLayoutHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingViewLayoutHelperSink *pSink)=0
	Register meeting view layout helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingViewLayoutHelperSink *pSink)=0
	Deregister meeting view layout helper callback sink.

virtual ZRCSDKError	UpdateVideoLayoutStyle (VideoLayoutStyle style)=0
	Update Zoom Room meeting video layout style.

virtual ZRCSDKError	ControlVideoPosition (VideoThumbPosition position, VideoThumbSize size)=0
	Control video thumb position and size.

virtual ZRCSDKError	TurnVideoPage (bool forward, PageVideoType pageVideoType)=0
	Turn video page.

virtual ZRCSDKError	SwitchToFloatingShareForSingleScreen (bool floatingShare)=0
	Switch to floating share content when in single screen.

virtual ZRCSDKError	IsSupportShowNonVideoParticipants (bool &support)=0
	Query if support show non-video participants.

virtual ZRCSDKError	ShowNonVideoParticipants (bool show)=0
	Show non-video participants.

virtual ZRCSDKError	EnableShowUpTo49PerPageInGallery (bool enable)=0
	Enable to show up tp 49 user video per page in gallery.

virtual ZRCSDKError	EnableAutoSwitchSpeaker (bool enable)=0
	Enable auto switch speaker.

virtual ZRCSDKError	SelectVideoOrder (VideoOrderType type)=0
	Select video order.

virtual ZRCSDKError	SetDynamicLayoutOption (DynamicLayoutType layout)=0
	Set dynamic layout option.

virtual ZRCSDKError	SetConfidenceMonitorLayout (ConfidenceMonitorLayoutType layout)=0
	Set confidence monitor layout.

virtual ZRCSDKError	ChangeAttendeeView (AttendeeViewLayoutType layout)=0
	Change attendee view layout.

virtual ZRCSDKError	SelectGalleryGrid (uint32_t row, uint32_t column)=0
	Change attendee view layout, row and column range [2,7].

virtual ZRCSDKError	ExpandConfSelfVideo (bool expand)=0
	Expand conf self video.

virtual ZRCSDKError	SetScreenLayout (MeetingScreen screenIndex, ScreenLayoutSourceType layout)=0
	Set screen layout.

virtual ZRCSDKError	SetShareContentOnly (bool enable)=0
	Set share content only.

virtual ZRCSDKError	ShowScreenIndex (bool show)=0
	Show screen index on Zoom Rooms client.

virtual ZRCSDKError	GetThumbnailsPosition (ThumbnailsPositionType &type)=0
	Get current thumbnails position. When type is ThumbnailsPositionTypeNone, you can't call ChangeThumbnailsPosition API.

virtual ZRCSDKError	ChangeThumbnailsPosition (ThumbnailsPositionType type)=0
	Change thumbnails position in multi-speaker and thumbnails layout.

virtual ZRCSDKError	ShowMyAutoGeneratedVideoStreams (bool show)=0
	Show my auto generated video streams.

Detailed Description

Meeting View Layout helper interface.

Definition at line 388 of file IMeetingViewLayoutHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingViewLayoutHelper()

virtual IMeetingViewLayoutHelper::~IMeetingViewLayoutHelper ( )

inlinevirtual

Definition at line 391 of file IMeetingViewLayoutHelper.h.

391{}

Member Function Documentation

◆ ChangeAttendeeView()

virtual ZRCSDKError IMeetingViewLayoutHelper::ChangeAttendeeView ( AttendeeViewLayoutType layout )

pure virtual

Change attendee view layout.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

layout The attendee view layout type, see AttendeeViewLayoutType enum.

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

◆ ChangeThumbnailsPosition()

virtual ZRCSDKError IMeetingViewLayoutHelper::ChangeThumbnailsPosition ( ThumbnailsPositionType type )

pure virtual

Change thumbnails position in multi-speaker and thumbnails layout.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

type	The position of thumbnails position.

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

◆ ControlVideoPosition()

virtual ZRCSDKError IMeetingViewLayoutHelper::ControlVideoPosition	(	VideoThumbPosition	position,
		VideoThumbSize	size
	)

pure virtual

Control video thumb position and size.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

position	Specify the position to move video thumb to.
size	Specify the size to change video thumb to.

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

◆ DeregisterSink()

virtual ZRCSDKError IMeetingViewLayoutHelper::DeregisterSink ( IMeetingViewLayoutHelperSink * pSink )

pure virtual

Deregister meeting view layout helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingViewLayoutHelperSink that receives the meeting view layout helper event callback.

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

◆ EnableAutoSwitchSpeaker()

virtual ZRCSDKError IMeetingViewLayoutHelper::EnableAutoSwitchSpeaker ( bool enable )

pure virtual

Enable auto switch speaker.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable auto switch speaker. Otherwise not.

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

◆ EnableShowUpTo49PerPageInGallery()

virtual ZRCSDKError IMeetingViewLayoutHelper::EnableShowUpTo49PerPageInGallery ( bool enable )

pure virtual

Enable to show up tp 49 user video per page in gallery.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to show up tp 49 per page in gallery. Otherwise not.

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

◆ ExpandConfSelfVideo()

virtual ZRCSDKError IMeetingViewLayoutHelper::ExpandConfSelfVideo ( bool expand )

pure virtual

Expand conf self video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

expand TRUE indicates to expand. Otherwise not.

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

◆ GetThumbnailsPosition()

virtual ZRCSDKError IMeetingViewLayoutHelper::GetThumbnailsPosition ( ThumbnailsPositionType & type )

pure virtual

Get current thumbnails position. When type is ThumbnailsPositionTypeNone, you can't call ChangeThumbnailsPosition API.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[out] type The current thumbnails position.

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

◆ IsSupportShowNonVideoParticipants()

virtual ZRCSDKError IMeetingViewLayoutHelper::IsSupportShowNonVideoParticipants ( bool & support )

pure virtual

Query if support show non-video participants.

Since: 6.5.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] support TRUE indicates support show non-video participants

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

◆ RegisterSink()

virtual ZRCSDKError IMeetingViewLayoutHelper::RegisterSink ( IMeetingViewLayoutHelperSink * pSink )

pure virtual

Register meeting view layout helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingViewLayoutHelperSink that receives the meeting view layout helper event callback.

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

◆ SelectGalleryGrid()

virtual ZRCSDKError IMeetingViewLayoutHelper::SelectGalleryGrid	(	uint32_t	row,
		uint32_t	column
	)

pure virtual

Change attendee view layout, row and column range [2,7].

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Current we only support row == column. If your row is not equal to column, ZR will adjust row x column to 5 x 5.

Parameters

row	The gallery gird row.
column	The gallery gird column.

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

◆ SelectVideoOrder()

virtual ZRCSDKError IMeetingViewLayoutHelper::SelectVideoOrder ( VideoOrderType type )

pure virtual

Select video order.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	The video order type, see VideoOrderType enum.

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

◆ SetConfidenceMonitorLayout()

virtual ZRCSDKError IMeetingViewLayoutHelper::SetConfidenceMonitorLayout ( ConfidenceMonitorLayoutType layout )

pure virtual

Set confidence monitor layout.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

layout The confidence monitor layout type, see ConfidenceMonitorLayoutType enum.

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

◆ SetDynamicLayoutOption()

virtual ZRCSDKError IMeetingViewLayoutHelper::SetDynamicLayoutOption ( DynamicLayoutType layout )

pure virtual

Set dynamic layout option.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

layout The dynamic layout type, see DynamicLayoutType enum.

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

◆ SetScreenLayout()

virtual ZRCSDKError IMeetingViewLayoutHelper::SetScreenLayout	(	MeetingScreen	screenIndex,
		ScreenLayoutSourceType	layout
	)

pure virtual

Set screen layout.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

screenIndex	The screen index which you want to set, see MeetingScreen enum.
layout	The new layout type, see ScreenLayoutSourceType enum.

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

◆ SetShareContentOnly()

virtual ZRCSDKError IMeetingViewLayoutHelper::SetShareContentOnly ( bool enable )

pure virtual

Set share content only.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

enable TRUE indicates enable share content only

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

◆ ShowMyAutoGeneratedVideoStreams()

virtual ZRCSDKError IMeetingViewLayoutHelper::ShowMyAutoGeneratedVideoStreams ( bool show )

pure virtual

Show my auto generated video streams.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

show	TRUE indicates show my auto generated video streams, otherwise not.

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

◆ ShowNonVideoParticipants()

virtual ZRCSDKError IMeetingViewLayoutHelper::ShowNonVideoParticipants ( bool show )

pure virtual

Show non-video participants.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates to show audio participants. Otherwise not.

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

◆ ShowScreenIndex()

virtual ZRCSDKError IMeetingViewLayoutHelper::ShowScreenIndex ( bool show )

pure virtual

Show screen index on Zoom Rooms client.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

show	TRUE indicates show screen index

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

◆ SwitchToFloatingShareForSingleScreen()

virtual ZRCSDKError IMeetingViewLayoutHelper::SwitchToFloatingShareForSingleScreen ( bool floatingShare )

pure virtual

Switch to floating share content when in single screen.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

floatingShare TRUE indicates to switch to floating share content. Otherwise switch to floating video.

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

◆ TurnVideoPage()

virtual ZRCSDKError IMeetingViewLayoutHelper::TurnVideoPage	(	bool	forward,
		PageVideoType	pageVideoType
	)

pure virtual

Turn video page.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

forward	TRUE indicates to page forward video.
pageVideoType	Specify the current page video type, see PageVideoType enum.

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

◆ UpdateVideoLayoutStyle()

virtual ZRCSDKError IMeetingViewLayoutHelper::UpdateVideoLayoutStyle ( VideoLayoutStyle style )

pure virtual

Update Zoom Room meeting video layout style.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

style Specify the video layout style to update.

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

◆ ~IMeetingViewLayoutHelper()

Member Function Documentation

◆ ChangeAttendeeView()

◆ ChangeThumbnailsPosition()

◆ ControlVideoPosition()

◆ DeregisterSink()

◆ EnableAutoSwitchSpeaker()

◆ EnableShowUpTo49PerPageInGallery()

◆ ExpandConfSelfVideo()

◆ GetThumbnailsPosition()

◆ IsSupportShowNonVideoParticipants()

◆ RegisterSink()

◆ SelectGalleryGrid()

◆ SelectVideoOrder()

◆ SetConfidenceMonitorLayout()

◆ SetDynamicLayoutOption()

◆ SetScreenLayout()

◆ SetShareContentOnly()

◆ ShowMyAutoGeneratedVideoStreams()

◆ ShowNonVideoParticipants()

◆ ShowScreenIndex()

◆ SwitchToFloatingShareForSingleScreen()

◆ TurnVideoPage()

◆ UpdateVideoLayoutStyle()