Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IMeetingViewLayoutHelper.h File Reference

Meeting View Layout interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  VideoPageStatus
 Video page status. More...
 
struct  VideoThumbInfo
 Video thumb info. More...
 
struct  VideoLayoutStatus
 Video layout status. Default is Speaker View layout. More...
 
struct  WallViewStyleStatus
 Wall view style status Gallery view. More...
 
struct  VideoOrderInfo
 Video order info. More...
 
struct  ConfidenceMonitorInfo
 Confidence monitor info. More...
 
struct  ScreenLayoutCtrlInfo
 Meeting screen layout control info. More...
 
struct  ScreenLayoutInfo
 Meeting screen layout info. More...
 
struct  ScreenLayoutStatus
 Meeting screen layout status. More...
 
class  IMeetingViewLayoutHelperSink
 Meeting View Layout helper event callback. More...
 
class  IMeetingViewLayoutHelper
 Meeting View Layout helper interface. More...
 

Enumerations

enum  VideoLayoutStyle {
  VideoLayoutStyleUnknown = 0 , VideoLayoutStyleGallery = 1 , VideoLayoutStyleSpeaker = 2 , VideoLayoutStyleThumbnail = 3 ,
  VideoLayoutStyleContentOnly = 4 , VideoLayoutStyleCancelContentOnly = 5 , VideoLayoutStyleDynamicLayout = 6
}
 Zoom Room video layout style. Here are more detailed structural descriptions. More...
 
enum  VideoThumbPosition {
  VideoThumbPositionCenter = 0 , VideoThumbPositionUp = 1 , VideoThumbPositionRight = 2 , VideoThumbPositionUpRight = 3 ,
  VideoThumbPositionDown = 4 , VideoThumbPositionDownRight = 5 , VideoThumbPositionLeft = 6 , VideoThumbPositionUpLeft = 7 ,
  VideoThumbPositionDownLeft = 8
}
 Video thumb position. Here are more detailed structural descriptions. More...
 
enum  VideoThumbSize {
  VideoThumbSizeOff = 0 , VideoThumbSize1x = 1 , VideoThumbSize2x = 2 , VideoThumbSize3x = 3 ,
  VideoThumbSizeVideoStripe = 4
}
 Video thumb size. Here are more detailed structural descriptions. More...
 
enum  PageVideoType { PageVideoTypeUnknown = -1 , PageVideoTypeGalleryView = 0 , PageVideoTypeThumbnailView = 1 , PageVideoTypeDynamicLayoutView = 2 }
 Page video type. Here are more detailed structural descriptions. More...
 
enum  VideoOrderType {
  VideoOrderTypeUnknown = -1 , VideoOrderTypeDefault = 0 , VideoOrderTypeAlphabetical , VideoOrderTypeReverseAlphabetical ,
  VideoOrderTypeSavedOrder
}
 Video order type. Here are more detailed structural descriptions. More...
 
enum  DynamicLayoutType { DynamicLayoutTypeSpeakersOnUnknown = -1 , DynamicLayoutTypeSpeakersOnBottom = 0 , DynamicLayoutTypeSpeakersOnMiddle , DynamicLayoutTypeSpeakersOnTop }
 Dynamic layout type Here are more detailed structural descriptions. More...
 
enum  ConfidenceMonitorLayoutType { ConfidenceMonitorLayoutTypeUnknown = -1 , ConfidenceMonitorLayoutTypeSelf = 0 , ConfidenceMonitorLayoutTypeActive = 1 , ConfidenceMonitorLayoutTypeShareContent = 2 }
 Confidence monitor layout type Here are more detailed structural descriptions. More...
 
enum  AttendeeViewLayoutType {
  AttendeeViewLayoutTypeNone = 0 , AttendeeViewLayoutTypeStandard , AttendeeViewLayoutTypeSpeaker , AttendeeViewLayoutTypeGallery ,
  AttendeeViewLayoutTypeFollow , AttendeeViewLayoutTypeShareContentOnly
}
 Attendee view layout type when viewing live feed. Here are more detailed structural descriptions. More...
 
enum  ThumbnailsPositionType { ThumbnailsPositionTypeNone = -1 , ThumbnailsPositionTypeBottom = 0 , ThumbnailsPositionTypeTop , ThumbnailsPositionTypeUnknown = 255 }
 thumbnails position type. Here are more detailed structural descriptions. More...
 

Detailed Description

Meeting View Layout interfaces.

Since
Added in ZRC SDK 6.0.0

Definition in file IMeetingViewLayoutHelper.h.

Enumeration Type Documentation

◆ AttendeeViewLayoutType

Attendee view layout type when viewing live feed. Here are more detailed structural descriptions.

Enumerator
AttendeeViewLayoutTypeNone 

None.

AttendeeViewLayoutTypeStandard 

Side-by-side if exist share source.

AttendeeViewLayoutTypeSpeaker 

Speaker.

AttendeeViewLayoutTypeGallery 

Gallery.

AttendeeViewLayoutTypeFollow 

Follow host's view.

AttendeeViewLayoutTypeShareContentOnly 

Share content only.

Definition at line 111 of file IMeetingViewLayoutHelper.h.

112{
119};
@ AttendeeViewLayoutTypeStandard
Side-by-side if exist share source.
@ AttendeeViewLayoutTypeSpeaker
Speaker.
@ AttendeeViewLayoutTypeFollow
Follow host's view.
@ AttendeeViewLayoutTypeNone
None.
@ AttendeeViewLayoutTypeShareContentOnly
Share content only.
@ AttendeeViewLayoutTypeGallery
Gallery.

◆ ConfidenceMonitorLayoutType

Confidence monitor layout type Here are more detailed structural descriptions.

Enumerator
ConfidenceMonitorLayoutTypeUnknown 

None.

ConfidenceMonitorLayoutTypeSelf 

Self view.

ConfidenceMonitorLayoutTypeActive 

Active speaker.

ConfidenceMonitorLayoutTypeShareContent 

Share content.

Definition at line 99 of file IMeetingViewLayoutHelper.h.

100{
105};
@ ConfidenceMonitorLayoutTypeShareContent
Share content.
@ ConfidenceMonitorLayoutTypeSelf
Self view.
@ ConfidenceMonitorLayoutTypeUnknown
None.
@ ConfidenceMonitorLayoutTypeActive
Active speaker.

◆ DynamicLayoutType

Dynamic layout type Here are more detailed structural descriptions.

Enumerator
DynamicLayoutTypeSpeakersOnUnknown 
DynamicLayoutTypeSpeakersOnBottom 
DynamicLayoutTypeSpeakersOnMiddle 
DynamicLayoutTypeSpeakersOnTop 

Definition at line 87 of file IMeetingViewLayoutHelper.h.

◆ PageVideoType

Page video type. Here are more detailed structural descriptions.

Enumerator
PageVideoTypeUnknown 

Page video type unknown.

PageVideoTypeGalleryView 

Page video type Gallery View.

PageVideoTypeThumbnailView 

Page video type Thumbnail View.

PageVideoTypeDynamicLayoutView 

Page video type Dynamic View.

Definition at line 62 of file IMeetingViewLayoutHelper.h.

63{
68};
@ PageVideoTypeThumbnailView
Page video type Thumbnail View.
@ PageVideoTypeGalleryView
Page video type Gallery View.
@ PageVideoTypeDynamicLayoutView
Page video type Dynamic View.
@ PageVideoTypeUnknown
Page video type unknown.

◆ ThumbnailsPositionType

thumbnails position type. Here are more detailed structural descriptions.

Enumerator
ThumbnailsPositionTypeNone 

Thumbnails position is none.

ThumbnailsPositionTypeBottom 

Thumbnails position is bottom.

ThumbnailsPositionTypeTop 

Thumbnails position is top.

ThumbnailsPositionTypeUnknown 

Thumbnails position is unknown.

Definition at line 125 of file IMeetingViewLayoutHelper.h.

126{
131};
@ ThumbnailsPositionTypeBottom
Thumbnails position is bottom.
@ ThumbnailsPositionTypeNone
Thumbnails position is none.
@ ThumbnailsPositionTypeUnknown
Thumbnails position is unknown.
@ ThumbnailsPositionTypeTop
Thumbnails position is top.

◆ VideoLayoutStyle

Zoom Room video layout style. Here are more detailed structural descriptions.

Enumerator
VideoLayoutStyleUnknown 

Unknown.

VideoLayoutStyleGallery 

Gallery View layout.

VideoLayoutStyleSpeaker 

Speaker View layout.

VideoLayoutStyleThumbnail 

Thumbnail View layout.

VideoLayoutStyleContentOnly 

Content only layout, all screens show shared content.

VideoLayoutStyleCancelContentOnly 

Cancel content only layout.

VideoLayoutStyleDynamicLayout 

Dynamic View layout.

Definition at line 17 of file IMeetingViewLayoutHelper.h.

18{
26};
@ VideoLayoutStyleUnknown
Unknown.
@ VideoLayoutStyleGallery
Gallery View layout.
@ VideoLayoutStyleCancelContentOnly
Cancel content only layout.
@ VideoLayoutStyleDynamicLayout
Dynamic View layout.
@ VideoLayoutStyleSpeaker
Speaker View layout.
@ VideoLayoutStyleContentOnly
Content only layout, all screens show shared content.
@ VideoLayoutStyleThumbnail
Thumbnail View layout.

◆ VideoOrderType

Video order type. Here are more detailed structural descriptions.

Enumerator
VideoOrderTypeUnknown 

Invalid.

VideoOrderTypeDefault 

Default.

VideoOrderTypeAlphabetical 

Videos are ordered by alphabetical.

VideoOrderTypeReverseAlphabetical 

Videos are ordered by reverse alphabetical.

VideoOrderTypeSavedOrder 

Videos are ordered by saved order.

Definition at line 74 of file IMeetingViewLayoutHelper.h.

75{
81};
@ VideoOrderTypeSavedOrder
Videos are ordered by saved order.
@ VideoOrderTypeReverseAlphabetical
Videos are ordered by reverse alphabetical.
@ VideoOrderTypeAlphabetical
Videos are ordered by alphabetical.
@ VideoOrderTypeUnknown
Invalid.
@ VideoOrderTypeDefault
Default.

◆ VideoThumbPosition

Video thumb position. Here are more detailed structural descriptions.

Enumerator
VideoThumbPositionCenter 

Video thumb position center.

VideoThumbPositionUp 

Video thumb position up.

VideoThumbPositionRight 

Video thumb position right.

VideoThumbPositionUpRight 

Video thumb position up-right.

VideoThumbPositionDown 

Video thumb position down.

VideoThumbPositionDownRight 

Video thumb position down-right.

VideoThumbPositionLeft 

Video thumb position left.

VideoThumbPositionUpLeft 

Video thumb position up-left.

VideoThumbPositionDownLeft 

Video thumb position down-left.

Definition at line 32 of file IMeetingViewLayoutHelper.h.

33{
43};
@ VideoThumbPositionUpRight
Video thumb position up-right.
@ VideoThumbPositionUp
Video thumb position up.
@ VideoThumbPositionDownLeft
Video thumb position down-left.
@ VideoThumbPositionRight
Video thumb position right.
@ VideoThumbPositionCenter
Video thumb position center.
@ VideoThumbPositionUpLeft
Video thumb position up-left.
@ VideoThumbPositionLeft
Video thumb position left.
@ VideoThumbPositionDownRight
Video thumb position down-right.
@ VideoThumbPositionDown
Video thumb position down.

◆ VideoThumbSize

Video thumb size. Here are more detailed structural descriptions.

Enumerator
VideoThumbSizeOff 

Video thumb size off.

VideoThumbSize1x 

Video thumb size normal.

VideoThumbSize2x 

Video thumb size 2x.

VideoThumbSize3x 

Video thumb size 3x.

VideoThumbSizeVideoStripe 

Video thumb in video stripe.

Definition at line 49 of file IMeetingViewLayoutHelper.h.

50{
56};
@ VideoThumbSize3x
Video thumb size 3x.
@ VideoThumbSize1x
Video thumb size normal.
@ VideoThumbSize2x
Video thumb size 2x.
@ VideoThumbSizeVideoStripe
Video thumb in video stripe.
@ VideoThumbSizeOff
Video thumb size off.