IMeetingShareHelper.h File Reference

Meeting Share interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	LocalPresentationInfo
	Local presentation info. More...
struct	SharingStatus
	Sharing status. More...
struct	ZRWSharingStatus
	ZRW Sharing status. More...
struct	ShareSetting
	Share setting. More...
struct	ShareSource
	Share source item Every share in the meeting will show up as a share source. More...
struct	AirplayBlackMagicStatus
	Airplay and black magic status Airplay is Apple's Screen Mirroring, black magic is HDMI cable sharing. More...
struct	CameraSharingStatus
	Camera sharing status. More...
struct	SlideControlInfo
	Slide control info. More...
struct	DocsShareSettingsInfo
	Docs share settings info. More...
struct	IncomingMeetingShareNot
	Incoming share notification. More...
class	IMeetingShareHelperSink
	Meeting Share helper event callback. More...
class	IMeetingShareHelper
	Meeting Share helper interface. More...

Enumerations
enum	SharingState {   SharingStateNone , SharingStateConnecting , SharingStateSending , SharingStateReceiving ,   SharingStateSendingAndReceiving }
	Sharing state Here are more detailed structural descriptions. More...
enum	ZRSharePrivilegeType {   ZRSharePrivilegeTypeEnabled = 0 , ZRSharePrivilegeTypeDisabled = 1 , ZRSharePrivilegeTypeDisabledParticipant = 2 , ZRSharePrivilegeTypeDisabledWhileOthersSharing = 3 ,   ZRSharePrivilegeTypeDisabledWhileGuestsInMeeting = 4 , ZRSharePrivilegeTypeDisabledWhileCloudWhiteboard = 5 , ZRSharePrivilegeTypeDisabledInBOWhileMainSessionSharing = 6 , ZRSharePrivilegeTypeDisabledStartShareForSimulive = 7 ,   ZRSharePrivilegeTypeDisabledStartShareForDSOnly = 8 }
	Zoom Room's share privilege type. Here are more detailed structural descriptions. More...
enum	MeetingSharePrivilegeType {   MeetingSharePrivilegeTypeUnknown = -1 , MeetingSharePrivilegeTypeHostGrab = 0 , MeetingSharePrivilegeTypeLockShare , MeetingSharePrivilegeTypeAnyoneGrab ,   MeetingSharePrivilegeTypeMultiShare }
	Meeting share privilege type. Here are more detailed structural descriptions. More...
enum	MeetingShareViewPrivilege { MeetingShareViewPrivilege_FocusModeOff = 0 , MeetingShareViewPrivilege_FocusModeHostOnly , MeetingShareViewPrivilege_FocusModeAllParticipants }
	Meeting share view privilege. Here are more detailed structural descriptions. More...
enum	HDMI60FPSShareDisableReason {   HDMI60FPSShareDisableReasonUnknown = -1 , HDMI60FPSShareDisableReasonNotDisable = 0 , HDMI60FPSShareDisableReasonCaptureCardNotSupport = 1 , HDMI60FPSShareDisableReasonZRNotSupport = 2 ,   HDMI60FPSShareDisableReasonCaptureCardAndZRNotSupport = 3 , HDMI60FPSShareDisableReasonOptimizeVideoShareIsOff = 4 , HDMI60FPSShareDisableReasonMultiShareIsOn = 5 }
	HDMI 60 FPS share disable reason. Here are more detailed structural descriptions. More...
enum	CurrentShareType {   CurrentShareTypeUnknown = 0 , CurrentShareTypeNormal , CurrentShareTypeCamera , CurrentShareTypeAnnotated ,   CurrentShareTypeZoomApp , CurrentShareTypeWhiteboard , CurrentShareTypeLocalHDMI , CurrentShareTypeAnnotatedLocalHDMI }
	Current pinned share type. Here are more detailed structural descriptions. More...
enum	SlideOperationType { SlideOperationTypeLeft = 0 , SlideOperationTypeRight }
	Slide control operation type. Here are more detailed structural descriptions. More...
enum	DocsSharePrivilegeType { DocsSharePrivilegeTypeUnknown = 0 , DocsSharePrivilegeTypeHostGrab = 1 , DocsSharePrivilegeTypeAnyoneGrab }
	Docs share privilege type. Here are more detailed structural descriptions. More...
enum	DocsInitiatePrivilegeType { DocsInitiatePrivilegeTypeUnknown = 0 , DocsInitiatePrivilegeTypeHostOnly = 1 , DocsInitiatePrivilegeTypeInternalUsers , DocsInitiatePrivilegeTypeAllParticipants }
	Docs initiate privilege type. Here are more detailed structural descriptions. More...

Detailed Description

Meeting Share interfaces.

Since

Added in ZRC SDK 6.0.0

Definition in file IMeetingShareHelper.h.

Enumeration Type Documentation

CurrentShareType

enum CurrentShareType

Current pinned share type. Here are more detailed structural descriptions.

Enumerator
CurrentShareTypeUnknown	Unknown.
CurrentShareTypeNormal	Airplay, meeting HDMI or direct share.
CurrentShareTypeCamera	Camera.
CurrentShareTypeAnnotated	Annotated content, Airplay, meeting HDMI or direct share.
CurrentShareTypeZoomApp	Zoom App.
CurrentShareTypeWhiteboard	Whiteboard.
CurrentShareTypeLocalHDMI	Normal local HDMI share.
CurrentShareTypeAnnotatedLocalHDMI	Local HDMI share converted to annotated mode when connected to Windows Zoom Rooms for touch support.

Definition at line 86 of file IMeetingShareHelper.h.

{
    CurrentShareTypeUnknown = 0,          
    CurrentShareTypeNormal,               
    CurrentShareTypeCamera,               
    CurrentShareTypeAnnotated,            
    CurrentShareTypeZoomApp,              
    CurrentShareTypeWhiteboard,           
    CurrentShareTypeLocalHDMI,            
    CurrentShareTypeAnnotatedLocalHDMI    
};

DocsInitiatePrivilegeType

enum DocsInitiatePrivilegeType

Docs initiate privilege type. Here are more detailed structural descriptions.

Enumerator
DocsInitiatePrivilegeTypeUnknown	Invalid.
DocsInitiatePrivilegeTypeHostOnly	Only host can initiate new docs in the meeting.
DocsInitiatePrivilegeTypeInternalUsers	Internal users can initiate new docs in the meeting.
DocsInitiatePrivilegeTypeAllParticipants	All participants can initiate new docs in the meeting.

Definition at line 123 of file IMeetingShareHelper.h.

{
    DocsInitiatePrivilegeTypeUnknown = 0,        
    DocsInitiatePrivilegeTypeHostOnly = 1,       
    DocsInitiatePrivilegeTypeInternalUsers,      
    DocsInitiatePrivilegeTypeAllParticipants,    
};

DocsSharePrivilegeType

enum DocsSharePrivilegeType

Docs share privilege type. Here are more detailed structural descriptions.

Enumerator
DocsSharePrivilegeTypeUnknown	Invalid.
DocsSharePrivilegeTypeHostGrab	Only host can grab share when someone else is sharing.
DocsSharePrivilegeTypeAnyoneGrab	Anyone can grab share when someone else is sharing.

Definition at line 112 of file IMeetingShareHelper.h.

{
    DocsSharePrivilegeTypeUnknown = 0,     
    DocsSharePrivilegeTypeHostGrab = 1,    
    DocsSharePrivilegeTypeAnyoneGrab,      
};

HDMI60FPSShareDisableReason

enum HDMI60FPSShareDisableReason

HDMI 60 FPS share disable reason. Here are more detailed structural descriptions.

Enumerator
HDMI60FPSShareDisableReasonUnknown	Unknown.
HDMI60FPSShareDisableReasonNotDisable	Not disabled.
HDMI60FPSShareDisableReasonCaptureCardNotSupport	Capture card not support.
HDMI60FPSShareDisableReasonZRNotSupport	ZR not support.
HDMI60FPSShareDisableReasonCaptureCardAndZRNotSupport	Capture and ZR not support.
HDMI60FPSShareDisableReasonOptimizeVideoShareIsOff	Optimize video share is off.
HDMI60FPSShareDisableReasonMultiShareIsOn	Multi share is on.

Definition at line 71 of file IMeetingShareHelper.h.

{
    HDMI60FPSShareDisableReasonUnknown = -1,                      
    HDMI60FPSShareDisableReasonNotDisable = 0,                    
    HDMI60FPSShareDisableReasonCaptureCardNotSupport = 1,         
    HDMI60FPSShareDisableReasonZRNotSupport = 2,                  
    HDMI60FPSShareDisableReasonCaptureCardAndZRNotSupport = 3,    
    HDMI60FPSShareDisableReasonOptimizeVideoShareIsOff = 4,       
    HDMI60FPSShareDisableReasonMultiShareIsOn = 5                 
};

MeetingSharePrivilegeType

enum MeetingSharePrivilegeType

Meeting share privilege type. Here are more detailed structural descriptions.

Enumerator
MeetingSharePrivilegeTypeUnknown	Meeting share privilege type unknown.
MeetingSharePrivilegeTypeHostGrab	Anyone can share, but one sharing only at one moment, and only host can grab other's sharing.
MeetingSharePrivilegeTypeLockShare	Only host can share, the same as "lock share".
MeetingSharePrivilegeTypeAnyoneGrab	Anyone can share, but one sharing only at one moment, and anyone can grab other's sharing.
MeetingSharePrivilegeTypeMultiShare	Anyone can share, Multi-share can exist at the same time.

Definition at line 47 of file IMeetingShareHelper.h.

{
    MeetingSharePrivilegeTypeUnknown = -1,    
    MeetingSharePrivilegeTypeHostGrab = 0,    
    MeetingSharePrivilegeTypeLockShare,       
    MeetingSharePrivilegeTypeAnyoneGrab,      
    MeetingSharePrivilegeTypeMultiShare       
};

MeetingShareViewPrivilege

enum MeetingShareViewPrivilege

Meeting share view privilege. Here are more detailed structural descriptions.

Enumerator
MeetingShareViewPrivilege_FocusModeOff	Meeting share view privilege focus mode off.
MeetingShareViewPrivilege_FocusModeHostOnly	Meeting share view privilege focus mode host only.
MeetingShareViewPrivilege_FocusModeAllParticipants	Meeting share view privilege focus mode all participants.

Definition at line 60 of file IMeetingShareHelper.h.

{
    MeetingShareViewPrivilege_FocusModeOff = 0,           
    MeetingShareViewPrivilege_FocusModeHostOnly,          
    MeetingShareViewPrivilege_FocusModeAllParticipants    
};

SharingState

enum SharingState

Sharing state Here are more detailed structural descriptions.

Enumerator
SharingStateNone	None.
SharingStateConnecting	ZR is connecting share.
SharingStateSending	ZR is sending share to meeting, means ZR is sharing.
SharingStateReceiving	ZR is receiving share from meeting, means ZR is viewing other's share.
SharingStateSendingAndReceiving	ZR is both sending and receiving share in meeting.

Definition at line 17 of file IMeetingShareHelper.h.

{
    SharingStateNone,                  
    SharingStateConnecting,            
    SharingStateSending,               
    SharingStateReceiving,             
    SharingStateSendingAndReceiving    
};

SlideOperationType

enum SlideOperationType

Slide control operation type. Here are more detailed structural descriptions.

Enumerator
SlideOperationTypeLeft	Slide left.
SlideOperationTypeRight	Slide right.

Definition at line 102 of file IMeetingShareHelper.h.

{
    SlideOperationTypeLeft = 0,     
    SlideOperationTypeRight         
};

ZRSharePrivilegeType

enum ZRSharePrivilegeType

Zoom Room's share privilege type. Here are more detailed structural descriptions.

Enumerator
ZRSharePrivilegeTypeEnabled	Zoom Room is enabled to share to meeting.
ZRSharePrivilegeTypeDisabled	Zoom Room is disabled from sharing to meeting.
ZRSharePrivilegeTypeDisabledParticipant	Zoom Room is disabled from sharing to meeting because participants cannot share.
ZRSharePrivilegeTypeDisabledWhileOthersSharing	Zoom Room is disabled from sharing to meeting because others' sharing.
ZRSharePrivilegeTypeDisabledWhileGuestsInMeeting	Zoom Room is disabled from sharing to meeting because guests in meeting.
ZRSharePrivilegeTypeDisabledWhileCloudWhiteboard	Zoom Room is disabled from sharing to meeting because cloud whiteboard sharing.
ZRSharePrivilegeTypeDisabledInBOWhileMainSessionSharing	Zoom Room is disabled from sharing to meeting because in breakout room while main session sharing.
ZRSharePrivilegeTypeDisabledStartShareForSimulive	Zoom Room is disabled from sharing to meeting because ZR is in simulive webinars.
ZRSharePrivilegeTypeDisabledStartShareForDSOnly	Zoom Room is disabled from sharing to meeting because ZR is Digital Signage-only.

Definition at line 30 of file IMeetingShareHelper.h.

{
    ZRSharePrivilegeTypeEnabled = 0,                         
    ZRSharePrivilegeTypeDisabled = 1,                        
    ZRSharePrivilegeTypeDisabledParticipant = 2,             
    ZRSharePrivilegeTypeDisabledWhileOthersSharing = 3,      
    ZRSharePrivilegeTypeDisabledWhileGuestsInMeeting = 4,    
    ZRSharePrivilegeTypeDisabledWhileCloudWhiteboard = 5,    
    ZRSharePrivilegeTypeDisabledInBOWhileMainSessionSharing = 6,    
    ZRSharePrivilegeTypeDisabledStartShareForSimulive = 7,   
    ZRSharePrivilegeTypeDisabledStartShareForDSOnly = 8      
};