IBYODHelper.h File Reference

BYOD interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	BYODModeInfo
	BYOD mode info. More...
struct	BYODModeResult
	Operate BYOD result. More...
class	IBYODHelperSink
	BYOD helper event callback. More...
class	IBYODHelper
	BYOD helper interface. More...

Enumerations
enum	BYODCapability { BYODCapabilityBYOD = 0 , BYODCapabilityHDMI }
	BYOD capability Here are more detailed structural descriptions. More...
enum	BYODModeStatus { BYODModeStatusIDLE = 0 , BYODModeStatusPlugin , BYODModeStatusInactive , BYODModeStatusActive }
	BYOD mode status. Here are more detailed structural descriptions. More...
enum	BYODAutoFramingStatus { BYODAutoFramingStatusNone = 0 , BYODAutoFramingStatusOn , BYODAutoFramingStatusOff }
	BYOD auto framing status. Here are more detailed structural descriptions. More...
enum	BYODMicrophoneStatus { BYODMicrophoneStatusNone = 0 , BYODMicrophoneStatusMuted , BYODMicrophoneStatusUnmuted }
	BYOD microphone status. Here are more detailed structural descriptions. More...
enum	ActiveBYODAction { ActiveBYODActionNone = 0 , ActiveBYODActionActive , ActiveBYODActionInactive }
	Active BYOD action. Here are more detailed structural descriptions. More...
enum	ActiveHDMIAction { ActiveHDMIActionNone = 0 , ActiveHDMIActionActive , ActiveHDMIActionInactive }
	Active HDMI action. Here are more detailed structural descriptions. More...
enum	BYODManualOperateAction { BYODManualOperateActionNone = 0 , BYODManualOperateActionEnter , BYODManualOperateActionExit }
	BYOD manual operate action. Here are more detailed structural descriptions. More...

Detailed Description

BYOD interfaces.

Since

Added in ZRC SDK 6.0.0.

BYOD workflows:

BYODModeStatusIDLE    ->  Connect personal device  ->  BYODModeStatusPlugin

BYODModeStatusPlugin  ->  Call DeactivateBYOD API  ->  BYODModeStatusInactive
BYODModeStatusPlugin  ->  Call ActiveHDMIShare API ->  BYODModeStatusInactive
BYODModeStatusPlugin  ->  Call ActiveBYODMode API  ->  BYODModeStatusActive    ->  Control byod camera, speaker, microphone  ->  BYODModeStatusActive

BYODModeStatusActive:
if the BYODModeInfo.supportManuallyOperate is true:
    Call DeactivateBYOD API  ->  BYODModeStatusInactive
else 
    Unplug personal device to exit HDMI share  ->  BYODModeStatusIDLE

BYODModeStatusInactive:
if the BYODModeInfo.supportManuallyOperate is true:
    Call ActiveBYODMode API  ->  BYODModeStatusActive

Definition in file IBYODHelper.h.

Enumeration Type Documentation

ActiveBYODAction

enum ActiveBYODAction

Active BYOD action. Here are more detailed structural descriptions.

Enumerator
ActiveBYODActionNone	Active BYOD action is none.
ActiveBYODActionActive	Active BYOD action is active.
ActiveBYODActionInactive	Active BYOD action is inactive.

Definition at line 80 of file IBYODHelper.h.

{
    ActiveBYODActionNone = 0,    
    ActiveBYODActionActive,      
    ActiveBYODActionInactive     
};

ActiveHDMIAction

enum ActiveHDMIAction

Active HDMI action. Here are more detailed structural descriptions.

Since

The enum is supported on Zoom Rooms clients with version 6.0.0 or later.

Enumerator
ActiveHDMIActionNone	Active HDMI action is none.
ActiveHDMIActionActive	Active HDMI action is active.
ActiveHDMIActionInactive	Active HDMI action is inactive.

Definition at line 92 of file IBYODHelper.h.

{
    ActiveHDMIActionNone = 0,    
    ActiveHDMIActionActive,      
    ActiveHDMIActionInactive     
};

BYODAutoFramingStatus

enum BYODAutoFramingStatus

BYOD auto framing status. Here are more detailed structural descriptions.

Enumerator
BYODAutoFramingStatusNone	BYOD auto framing status is none.
BYODAutoFramingStatusOn	BYOD auto framing status is on.
BYODAutoFramingStatusOff	BYOD auto framing status is off.

Definition at line 58 of file IBYODHelper.h.

{
    BYODAutoFramingStatusNone = 0,    
    BYODAutoFramingStatusOn,          
    BYODAutoFramingStatusOff          
};

BYODCapability

enum BYODCapability

BYOD capability Here are more detailed structural descriptions.

Enumerator
BYODCapabilityBYOD	Only support BYOD.
BYODCapabilityHDMI	Support both BYOD and HDMI.

Definition at line 36 of file IBYODHelper.h.

{
    BYODCapabilityBYOD = 0, 
    BYODCapabilityHDMI      
};

BYODManualOperateAction

enum BYODManualOperateAction

BYOD manual operate action. Here are more detailed structural descriptions.

Enumerator
BYODManualOperateActionNone	BYOD manual operate action is none.
BYODManualOperateActionEnter	BYOD manual operate action is enter.
BYODManualOperateActionExit	BYOD manual operate action is exit.

Definition at line 103 of file IBYODHelper.h.

{
    BYODManualOperateActionNone = 0,    
    BYODManualOperateActionEnter,       
    BYODManualOperateActionExit         
};

BYODMicrophoneStatus

enum BYODMicrophoneStatus

BYOD microphone status. Here are more detailed structural descriptions.

Enumerator
BYODMicrophoneStatusNone	BYOD microphone status is none.
BYODMicrophoneStatusMuted	BYOD microphone status is muted.
BYODMicrophoneStatusUnmuted	BYOD microphone status is unmuted.

Definition at line 69 of file IBYODHelper.h.

{
    BYODMicrophoneStatusNone = 0,    
    BYODMicrophoneStatusMuted,       
    BYODMicrophoneStatusUnmuted      
};

BYODModeStatus

enum BYODModeStatus

BYOD mode status. Here are more detailed structural descriptions.

Enumerator
BYODModeStatusIDLE	BYOD mode status is idle.
BYODModeStatusPlugin	BYOD mode status is plugin.
BYODModeStatusInactive	BYOD mode status is inactive.
BYODModeStatusActive	BYOD mode status is active.

Definition at line 46 of file IBYODHelper.h.

{
    BYODModeStatusIDLE = 0,    
    BYODModeStatusPlugin,      
    BYODModeStatusInactive,    
    BYODModeStatusActive       
};