Zoom Rooms Controller SDK Reference 7.1.0
Loading...
Searching...
No Matches
ScreenStatusForPin Struct Reference

Screen status for pin video or pin share. More...

#include <IMeetingVideoHelper.h>

Data Fields

int32_t screenIndex = 0
 Screen index, see MeetingScreen enum.
 
bool canPinVideo = false
 TRUE indicates screen can be pinned video.
 
std::vector< int32_t > pinnedUserIDs
 Pinned user id list.
 
ScreenLayoutSourceType screenLayout = ScreenLayoutSourceTypeActiveVideo
 Screen layout source type, see ScreenLayoutSourceType enum.
 
int32_t pinnedShareSourceID = 0
 Screen pinned share source ID.
 
ShareSourceType pinnedShareSourceType = ShareSourceTypeUnknown
 Share source type, see ShareSourceType enum.
 
std::vector< ShareSourceTypepinnableShareTypes
 Screen pinnable share types.
 
bool canPinShare = false
 TRUE indicates screen can be pinned share content.
 
CanNotPinShareReason canNotPinShareReason = CanNotPinShareReasonUnknown
 Can not pin share reason, see CanNotPinShareReason enum.
 
bool isZRWScreen = false
 TRUE indicates screen is a Zoom Room Whiteboard screen.
 
bool isThumbnailScreen = false
 TRUE indicates screen is a Thumbnail screen.
 
int32_t pinnedShareUserID = 0
 Screen pinned share user ID.
 
bool canAdjustShareContent = false
 TRUE indicates share content zoom/pan is available on this screen.
 
bool isShareContentFitToWindow = false
 TRUE indicates share content fits the screen at current zoom level.
 
int32_t currentShareContentZoomPercent = 0
 Current share content zoom percentage, range 50–300.
 

Detailed Description

Screen status for pin video or pin share.

Definition at line 49 of file IMeetingVideoHelper.h.

Field Documentation

◆ canAdjustShareContent

bool ScreenStatusForPin::canAdjustShareContent = false

TRUE indicates share content zoom/pan is available on this screen.

Definition at line 63 of file IMeetingVideoHelper.h.

◆ canNotPinShareReason

CanNotPinShareReason ScreenStatusForPin::canNotPinShareReason = CanNotPinShareReasonUnknown

Can not pin share reason, see CanNotPinShareReason enum.

Definition at line 59 of file IMeetingVideoHelper.h.

◆ canPinShare

bool ScreenStatusForPin::canPinShare = false

TRUE indicates screen can be pinned share content.

Definition at line 58 of file IMeetingVideoHelper.h.

◆ canPinVideo

bool ScreenStatusForPin::canPinVideo = false

TRUE indicates screen can be pinned video.

Definition at line 52 of file IMeetingVideoHelper.h.

◆ currentShareContentZoomPercent

int32_t ScreenStatusForPin::currentShareContentZoomPercent = 0

Current share content zoom percentage, range 50–300.

Definition at line 65 of file IMeetingVideoHelper.h.

◆ isShareContentFitToWindow

bool ScreenStatusForPin::isShareContentFitToWindow = false

TRUE indicates share content fits the screen at current zoom level.

Definition at line 64 of file IMeetingVideoHelper.h.

◆ isThumbnailScreen

bool ScreenStatusForPin::isThumbnailScreen = false

TRUE indicates screen is a Thumbnail screen.

Definition at line 61 of file IMeetingVideoHelper.h.

◆ isZRWScreen

bool ScreenStatusForPin::isZRWScreen = false

TRUE indicates screen is a Zoom Room Whiteboard screen.

Definition at line 60 of file IMeetingVideoHelper.h.

◆ pinnableShareTypes

std::vector<ShareSourceType> ScreenStatusForPin::pinnableShareTypes

Screen pinnable share types.

Definition at line 57 of file IMeetingVideoHelper.h.

◆ pinnedShareSourceID

int32_t ScreenStatusForPin::pinnedShareSourceID = 0

Screen pinned share source ID.

Definition at line 55 of file IMeetingVideoHelper.h.

◆ pinnedShareSourceType

ShareSourceType ScreenStatusForPin::pinnedShareSourceType = ShareSourceTypeUnknown

Share source type, see ShareSourceType enum.

Definition at line 56 of file IMeetingVideoHelper.h.

◆ pinnedShareUserID

int32_t ScreenStatusForPin::pinnedShareUserID = 0

Screen pinned share user ID.

Definition at line 62 of file IMeetingVideoHelper.h.

◆ pinnedUserIDs

std::vector<int32_t> ScreenStatusForPin::pinnedUserIDs

Pinned user id list.

Definition at line 53 of file IMeetingVideoHelper.h.

◆ screenIndex

int32_t ScreenStatusForPin::screenIndex = 0

Screen index, see MeetingScreen enum.

Definition at line 51 of file IMeetingVideoHelper.h.

◆ screenLayout

ScreenLayoutSourceType ScreenStatusForPin::screenLayout = ScreenLayoutSourceTypeActiveVideo

Screen layout source type, see ScreenLayoutSourceType enum.

Definition at line 54 of file IMeetingVideoHelper.h.