Zoom Rooms Controller SDK Reference 6.6.0
Loading...
Searching...
No Matches
ProAVVideoOverlaySettings Struct Reference

Pro AV video overlay settings. More...

#include <IProAVService.h>

Data Fields

bool isActiveSpeakerGreenOutlineEnabled = false
 TRUE indicates active speaker green outline is enabled.
 
bool isReactionIconsEnabled = false
 TRUE indicates reaction icons is enabled.
 
bool isRaiseHandIconEnabled = false
 TRUE indicates raise hand icon is enabled.
 
bool isNameStrapEnabled = false
 TRUE indicates name strap is enabled.
 
ProAVVideoNameStrapPosition position = ProAVVideoNameStrapPositionUnknown
 Name strap position, see ProAVVideoNameStrapPosition enum.
 
bool isMuteIconEnabled = false
 TRUE indicates mute icon is enabled.
 
bool isPollOverlayEnabled = false
 TRUE indicates poll overlay is enabled.
 
ProAVGalleryDistributionMode galleryDistributionMode = ProAVGalleryDistributionModeWaterfall
 gallery distribution mode, see ProAVGalleryDistributionMode enum.
 
uint32_t maxGalleryPageCount = 0
 Max gallery page count, only used for round-robin mode.
 
float elementScale = 1.0f
 Scaling factor for the video element; valid range: 0.5 to 3.0.
 

Detailed Description

Pro AV video overlay settings.

Definition at line 60 of file IProAVService.h.

Field Documentation

◆ elementScale

float ProAVVideoOverlaySettings::elementScale = 1.0f

Scaling factor for the video element; valid range: 0.5 to 3.0.

Definition at line 71 of file IProAVService.h.

◆ galleryDistributionMode

ProAVGalleryDistributionMode ProAVVideoOverlaySettings::galleryDistributionMode = ProAVGalleryDistributionModeWaterfall

gallery distribution mode, see ProAVGalleryDistributionMode enum.

Definition at line 69 of file IProAVService.h.

◆ isActiveSpeakerGreenOutlineEnabled

bool ProAVVideoOverlaySettings::isActiveSpeakerGreenOutlineEnabled = false

TRUE indicates active speaker green outline is enabled.

Definition at line 62 of file IProAVService.h.

◆ isMuteIconEnabled

bool ProAVVideoOverlaySettings::isMuteIconEnabled = false

TRUE indicates mute icon is enabled.

Definition at line 67 of file IProAVService.h.

◆ isNameStrapEnabled

bool ProAVVideoOverlaySettings::isNameStrapEnabled = false

TRUE indicates name strap is enabled.

Definition at line 65 of file IProAVService.h.

◆ isPollOverlayEnabled

bool ProAVVideoOverlaySettings::isPollOverlayEnabled = false

TRUE indicates poll overlay is enabled.

Definition at line 68 of file IProAVService.h.

◆ isRaiseHandIconEnabled

bool ProAVVideoOverlaySettings::isRaiseHandIconEnabled = false

TRUE indicates raise hand icon is enabled.

Definition at line 64 of file IProAVService.h.

◆ isReactionIconsEnabled

bool ProAVVideoOverlaySettings::isReactionIconsEnabled = false

TRUE indicates reaction icons is enabled.

Definition at line 63 of file IProAVService.h.

◆ maxGalleryPageCount

uint32_t ProAVVideoOverlaySettings::maxGalleryPageCount = 0

Max gallery page count, only used for round-robin mode.

Definition at line 70 of file IProAVService.h.

◆ position

ProAVVideoNameStrapPosition ProAVVideoOverlaySettings::position = ProAVVideoNameStrapPositionUnknown

Name strap position, see ProAVVideoNameStrapPosition enum.

Definition at line 66 of file IProAVService.h.