IHWIOHelper.h File Reference

HWIO interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	HWIOVideoSettings
	HWIO video settings. More...
struct	HWIOAudioSettings
	HWIO audio settings. More...
struct	HWIOConfiguration
	HWIO configuration. More...
struct	HWIODeviceConfiguration
	HWIO device configuration. More...
struct	HWIOVideoAssignment
	HWIO video assignment. More...
struct	HWIOAudioAssignment
	HWIO audio assignment. More...
struct	HWIOAssignmentStatus
	HWIO assignment status. More...
struct	HWIOAssignDeviceInfo
	HWIO assign deviceInfo. More...
struct	HWIOChannelDetectedInputSignal
	HWIO channel detected input signal. More...
struct	HWIOChannelInfo
	HWIOChannelInfo. More...
struct	HWIODeviceInfo
	HWIO device information. More...
struct	HWIOInfo
	HWIO information. More...
struct	HWIODeviceUpdate
	HWIO device update. More...
struct	HWIOVideoConvertPreference
	HWIO video convert preference. More...
struct	HWIOInputSignalDetection
	HWIO input signal detection. More...
class	IHWIOHelperSink
	HWIO helper event callback. More...
class	IHWIOHelper
	HWIO helper interface. More...

Enumerations
enum	HWIOChannelModality { HWIOChannelModalityNone = 0 , HWIOChannelModalityInput , HWIOChannelModalityOutput , HWIOChannelModalityInputAndOutput }
	HWIO channel modality. Here are more detailed structural descriptions. More...
enum	HWIOChannelConnectorType { HWIOChannelConnectorTypeUnspecified = 0 , HWIOChannelConnectorTypeSDI , HWIOChannelConnectorTypeHDMI , HWIOChannelConnectorTypeEthernet }
	HWIO channel connector type. Here are more detailed structural descriptions. More...
enum	HWIOChannelActivityStatus { HWIOChannelActivityStatusOff = 0 , HWIOChannelActivityStatusOutput = 1 , HWIOChannelActivityStatusInput = 2 }
	HWIO channel activity status. Here are more detailed structural descriptions. More...
enum	HWIOVideoResolution { HWIOVideoResolutionUnspecified = 0 , HWIOVideoResolution720p , HWIOVideoResolution1080p , HWIOVideoResolution2160p }
	HWIO video resolution. Here are more detailed structural descriptions. More...
enum	HWIOVideoFrameRate {   HWIOVideoFrameRateUnspecified = 0 , HWIOVideoFrameRate25fps , HWIOVideoFrameRate29_97fps , HWIOVideoFrameRate30fps ,   HWIOVideoFrameRate60fps , HWIOVideoFrameRate50fps , HWIOVideoFrameRate59_94fps }
	HWIO video frame rate. Here are more detailed structural descriptions. More...
enum	HWIOVideoFormat { HWIOVideoFormatUnspecified = 0 , HWIOVideoFormatYUV420Limited , HWIOVideoFormatYUV422UYVYLimited }
	HWIO video format. Here are more detailed structural descriptions. More...
enum	HWIOAudioSampleRate { HWIOAudioSampleRateUnspecified = 0 , HWIOAudioSampleRate48000 = 48000 }
	HWIO audio sample rate. Here are more detailed structural descriptions. More...
enum	HWIOAudioChannels {   HWIOAudioChannelsUnspecified = 0 , HWIOAudioChannelsMONO = 1 , HWIOAudioChannelsStereo = 2 , HWIOAudioChannelsFour = 4 ,   HWIOAudioChannelsEight = 8 , HWIOAudioChannelsSixteen = 16 , HWIOAudioChannelsThirtyTwo = 32 }
	HWIO audio channels. Here are more detailed structural descriptions. More...
enum	HWIOAudioFormat { HWIOAudioFormatUnspecified = 0 , HWIOAudioFormatLinearPCM16BitInterleaved }
	HWIO audio format. Here are more detailed structural descriptions. More...
enum	HWIOVideoAssignmentType {   HWIOVideoAssignmentTypeUnassigned = 0 , HWIOVideoAssignmentTypeOutputFromUser , HWIOVideoAssignmentTypeInputToVirtualInput , HWIOVideoAssignmentTypeOutputTestSignal ,   HWIOVideoAssignmentTypeOutputScreenShare , HWIOVideoAssignmentTypeOutputActiveSpeaker , HWIOVideoAssignmentTypeOutputPinGroup , HWIOVideoAssignmentTypeOutputSpotlightGroup ,   HWIOVideoAssignmentTypeOutputGalleryView }
	HWIO video assignment type. Here are more detailed structural descriptions. More...
enum	HWIOAudioAssignmentType { HWIOAudioAssignmentTypeUnassigned = 0 , HWIOAudioAssignmentTypeOutputFromUser , HWIOAudioAssignmentTypeInputToVirtualInput , HWIOAudioAssignmentTypeOutputMixedMinus }
	HWIO audio assignment type. Here are more detailed structural descriptions. More...
enum	HWIODeviceManufacturer {   HWIODeviceManufacturerUnspecified = 0 , HWIODeviceManufacturerBlackMagic , HWIODeviceManufacturerAJA , HWIODeviceManufacturerMagewell ,   HWIODeviceManufacturerDeltacast }
	HWIO device manufacturer. Here are more detailed structural descriptions. More...
enum	HWIODeviceConnectionType { HWIODeviceConnectionTypeUnspecified = 0 , HWIODeviceConnectionTypeThunderBolt , HWIODeviceConnectionTypePcie , HWIODeviceConnectionTypeUSB }
	HWIO device connection type. Here are more detailed structural descriptions. More...
enum	HWIODeviceUpdateEventType {   HWIODeviceUpdateEventTypeDeviceAdded = 0 , HWIODeviceUpdateEventTypeDeviceRemoved = 1 , HWIODeviceUpdateEventTypeDeviceChanged = 2 , HWIODeviceUpdateEventTypeDeviceActivityStatus = 3 ,   HWIODeviceUpdateEventTypeDeviceDetectedInputSignal = 4 }
	HWIO device update event type. Here are more detailed structural descriptions. More...
enum	HWIODeviceResult {   HWIODeviceResultSuccess = 0 , HWIODeviceResultInvalidDeviceID = 1 , HWIODeviceResultInvalidChannelID = 2 , HWIODeviceResultInvalidConfiguration = 3 ,   HWIODeviceResultInvalidAssignment = 4 , HWIODeviceResultDeviceInaccessible = 5 , HWIODeviceResultServiceUnavailable = 6 , HWIODeviceResultOperationNotAllowed = 7 ,   HWIODeviceResultUnknownError = 255 }
	HWIO device result Here are more detailed structural descriptions. More...
enum	HWIOVideoConvertPreferenceType { HWIOVideoConvertPreferenceTypeUnknown = -1 , HWIOVideoConvertPreferenceTypeZoom = 0 , HWIOVideoConvertPreferenceTypeDevice = 1 }
	HWIO video convert preference type Here are more detailed structural descriptions. More...

Detailed Description

HWIO interfaces.

Since

Added in ZRC SDK 6.1.0

Definition in file IHWIOHelper.h.

Enumeration Type Documentation

HWIOAudioAssignmentType

enum HWIOAudioAssignmentType

HWIO audio assignment type. Here are more detailed structural descriptions.

Enumerator
HWIOAudioAssignmentTypeUnassigned	HWIO audio assignment type is unspecified.
HWIOAudioAssignmentTypeOutputFromUser	HWIO audio assignment type is output from user.
HWIOAudioAssignmentTypeInputToVirtualInput	HWIO audio assignment type is input to virtual input.
HWIOAudioAssignmentTypeOutputMixedMinus	HWIO audio assignment type is output mixed minus.

Definition at line 142 of file IHWIOHelper.h.

{
    HWIOAudioAssignmentTypeUnassigned = 0,          
    HWIOAudioAssignmentTypeOutputFromUser,          
    HWIOAudioAssignmentTypeInputToVirtualInput,     
    HWIOAudioAssignmentTypeOutputMixedMinus         
};

HWIOAudioChannels

enum HWIOAudioChannels

HWIO audio channels. Here are more detailed structural descriptions.

Enumerator
HWIOAudioChannelsUnspecified	HWIO audio channels is unspecified.
HWIOAudioChannelsMONO	HWIO audio channels is MONO.
HWIOAudioChannelsStereo	HWIO audio channels is stereo.
HWIOAudioChannelsFour	HWIO audio channels is four.
HWIOAudioChannelsEight	HWIO audio channels is eight.
HWIOAudioChannelsSixteen	HWIO audio channels is sixteen.
HWIOAudioChannelsThirtyTwo	HWIO audio channels is thirty two.

Definition at line 100 of file IHWIOHelper.h.

{
    HWIOAudioChannelsUnspecified = 0,   
    HWIOAudioChannelsMONO        = 1,   
    HWIOAudioChannelsStereo      = 2,   
    HWIOAudioChannelsFour        = 4,   
    HWIOAudioChannelsEight       = 8,   
    HWIOAudioChannelsSixteen     = 16,  
    HWIOAudioChannelsThirtyTwo   = 32   
};

HWIOAudioFormat

enum HWIOAudioFormat

HWIO audio format. Here are more detailed structural descriptions.

Enumerator
HWIOAudioFormatUnspecified	HWIO audio format is unspecified.
HWIOAudioFormatLinearPCM16BitInterleaved	HWIO audio format is linear PCM 16 bit Interleaved.

Definition at line 115 of file IHWIOHelper.h.

{
    HWIOAudioFormatUnspecified = 0,             
    HWIOAudioFormatLinearPCM16BitInterleaved    
};

HWIOAudioSampleRate

enum HWIOAudioSampleRate

HWIO audio sample rate. Here are more detailed structural descriptions.

Enumerator
HWIOAudioSampleRateUnspecified	HWIO audio sample rate is unspecified.
HWIOAudioSampleRate48000	HWIO audio sample rate is 48000.

Definition at line 90 of file IHWIOHelper.h.

{
    HWIOAudioSampleRateUnspecified = 0,     
    HWIOAudioSampleRate48000       = 48000  
};

HWIOChannelActivityStatus

enum HWIOChannelActivityStatus

HWIO channel activity status. Here are more detailed structural descriptions.

Enumerator
HWIOChannelActivityStatusOff	HWIO channel is not running.
HWIOChannelActivityStatusOutput	HWIO channel is running for playback/output.
HWIOChannelActivityStatusInput	HWIO channel is running for capture/input.

Definition at line 41 of file IHWIOHelper.h.

{
    HWIOChannelActivityStatusOff = 0,       
    HWIOChannelActivityStatusOutput = 1,    
    HWIOChannelActivityStatusInput = 2,     
};

HWIOChannelConnectorType

enum HWIOChannelConnectorType

HWIO channel connector type. Here are more detailed structural descriptions.

Enumerator
HWIOChannelConnectorTypeUnspecified	HWIO channel connector type is unspecified.
HWIOChannelConnectorTypeSDI	HWIO channel connector type is SDI.
HWIOChannelConnectorTypeHDMI	HWIO channel connector type is HDMI.
HWIOChannelConnectorTypeEthernet	HWIO channel connector type is ethernet.

Definition at line 29 of file IHWIOHelper.h.

{
    HWIOChannelConnectorTypeUnspecified = 0,    
    HWIOChannelConnectorTypeSDI,                
    HWIOChannelConnectorTypeHDMI,               
    HWIOChannelConnectorTypeEthernet            
};

HWIOChannelModality

enum HWIOChannelModality

HWIO channel modality. Here are more detailed structural descriptions.

Enumerator
HWIOChannelModalityNone	HWIO channel modality is none.
HWIOChannelModalityInput	HWIO channel modality is input.
HWIOChannelModalityOutput	HWIO channel modality is output.
HWIOChannelModalityInputAndOutput	HWIO channel modality is input and output.

Definition at line 17 of file IHWIOHelper.h.

{
    HWIOChannelModalityNone = 0,        
    HWIOChannelModalityInput,           
    HWIOChannelModalityOutput,          
    HWIOChannelModalityInputAndOutput   
};

HWIODeviceConnectionType

enum HWIODeviceConnectionType

HWIO device connection type. Here are more detailed structural descriptions.

Enumerator
HWIODeviceConnectionTypeUnspecified	HWIO device connection type is unspecified.
HWIODeviceConnectionTypeThunderBolt	HWIO device connection type is thunder bolt.
HWIODeviceConnectionTypePcie	HWIO device connection type is PCIe.
HWIODeviceConnectionTypeUSB	HWIO device connection type is USB.

Definition at line 167 of file IHWIOHelper.h.

{
    HWIODeviceConnectionTypeUnspecified = 0,    
    HWIODeviceConnectionTypeThunderBolt,        
    HWIODeviceConnectionTypePcie,               
    HWIODeviceConnectionTypeUSB                 
};

HWIODeviceManufacturer

enum HWIODeviceManufacturer

HWIO device manufacturer. Here are more detailed structural descriptions.

Enumerator
HWIODeviceManufacturerUnspecified	HWIO device manufacturer is unspecified.
HWIODeviceManufacturerBlackMagic	HWIO device manufacturer is black magic.
HWIODeviceManufacturerAJA	HWIO device manufacturer is AJA.
HWIODeviceManufacturerMagewell	HWIO device manufacturer is magewell.
HWIODeviceManufacturerDeltacast	HWIO device manufacturer is deltacast.

Definition at line 154 of file IHWIOHelper.h.

{
    HWIODeviceManufacturerUnspecified = 0,  
    HWIODeviceManufacturerBlackMagic,       
    HWIODeviceManufacturerAJA,              
    HWIODeviceManufacturerMagewell,         
    HWIODeviceManufacturerDeltacast         
};

HWIODeviceResult

enum HWIODeviceResult

HWIO device result Here are more detailed structural descriptions.

Enumerator
HWIODeviceResultSuccess	Success.
HWIODeviceResultInvalidDeviceID	Invalid device ID.
HWIODeviceResultInvalidChannelID	Invalid channel ID.
HWIODeviceResultInvalidConfiguration	Invalid configuration.
HWIODeviceResultInvalidAssignment	Invalid assignment.
HWIODeviceResultDeviceInaccessible	Device inaccessible.
HWIODeviceResultServiceUnavailable	Service unavailable.
HWIODeviceResultOperationNotAllowed	Operation not allowed.
HWIODeviceResultUnknownError	Unknown error.

Definition at line 192 of file IHWIOHelper.h.

{
    HWIODeviceResultSuccess = 0,                    
    HWIODeviceResultInvalidDeviceID = 1,            
    HWIODeviceResultInvalidChannelID = 2,           
    HWIODeviceResultInvalidConfiguration = 3,       
    HWIODeviceResultInvalidAssignment = 4,          
    HWIODeviceResultDeviceInaccessible = 5,         
    HWIODeviceResultServiceUnavailable = 6,         
    HWIODeviceResultOperationNotAllowed = 7,        
    
    HWIODeviceResultUnknownError = 255              
};

HWIODeviceUpdateEventType

enum HWIODeviceUpdateEventType

HWIO device update event type. Here are more detailed structural descriptions.

Enumerator
HWIODeviceUpdateEventTypeDeviceAdded	Device added.
HWIODeviceUpdateEventTypeDeviceRemoved	Device removed.
HWIODeviceUpdateEventTypeDeviceChanged	Device changed.
HWIODeviceUpdateEventTypeDeviceActivityStatus	Device channel activity status updated.
HWIODeviceUpdateEventTypeDeviceDetectedInputSignal	Device channel input signal detected.

Definition at line 179 of file IHWIOHelper.h.

{
    HWIODeviceUpdateEventTypeDeviceAdded = 0,               
    HWIODeviceUpdateEventTypeDeviceRemoved = 1,             
    HWIODeviceUpdateEventTypeDeviceChanged = 2,             
    HWIODeviceUpdateEventTypeDeviceActivityStatus = 3,      
    HWIODeviceUpdateEventTypeDeviceDetectedInputSignal = 4, 
};

HWIOVideoAssignmentType

enum HWIOVideoAssignmentType

HWIO video assignment type. Here are more detailed structural descriptions.

Enumerator
HWIOVideoAssignmentTypeUnassigned	HWIO video assignment type is unspecified.
HWIOVideoAssignmentTypeOutputFromUser	HWIO video assignment type is output from user.
HWIOVideoAssignmentTypeInputToVirtualInput	HWIO video assignment type is input to virtual input.
HWIOVideoAssignmentTypeOutputTestSignal	HWIO video assignment type is output test signal.
HWIOVideoAssignmentTypeOutputScreenShare	HWIO video assignment type is output screen share.
HWIOVideoAssignmentTypeOutputActiveSpeaker	HWIO video assignment type is output active speaker.
HWIOVideoAssignmentTypeOutputPinGroup	HWIO video assignment type is output pin group.
HWIOVideoAssignmentTypeOutputSpotlightGroup	HWIO video assignment type is output spotlight group.
HWIOVideoAssignmentTypeOutputGalleryView	HWIO video assignment type is output gallery view.

Definition at line 125 of file IHWIOHelper.h.

{
    HWIOVideoAssignmentTypeUnassigned = 0,          
    HWIOVideoAssignmentTypeOutputFromUser,          
    HWIOVideoAssignmentTypeInputToVirtualInput,     
    HWIOVideoAssignmentTypeOutputTestSignal,        
    HWIOVideoAssignmentTypeOutputScreenShare,       
    HWIOVideoAssignmentTypeOutputActiveSpeaker,     
    HWIOVideoAssignmentTypeOutputPinGroup,          
    HWIOVideoAssignmentTypeOutputSpotlightGroup,    
    HWIOVideoAssignmentTypeOutputGalleryView        
};

HWIOVideoConvertPreferenceType

enum HWIOVideoConvertPreferenceType

HWIO video convert preference type Here are more detailed structural descriptions.

Enumerator
HWIOVideoConvertPreferenceTypeUnknown	Unknown.
HWIOVideoConvertPreferenceTypeZoom	Prefer Zoom software for video conversion.
HWIOVideoConvertPreferenceTypeDevice	Prefer device hardware for video conversion.

Definition at line 210 of file IHWIOHelper.h.

{
    HWIOVideoConvertPreferenceTypeUnknown = -1,     
    HWIOVideoConvertPreferenceTypeZoom = 0,         
    HWIOVideoConvertPreferenceTypeDevice = 1        
};

HWIOVideoFormat

enum HWIOVideoFormat

HWIO video format. Here are more detailed structural descriptions.

Enumerator
HWIOVideoFormatUnspecified	HWIO video format is unspecified.
HWIOVideoFormatYUV420Limited	HWIO video format is YUV420 limited.
HWIOVideoFormatYUV422UYVYLimited	HWIO video format is 422UYVY limited.

Definition at line 79 of file IHWIOHelper.h.

{
    HWIOVideoFormatUnspecified = 0,     
    HWIOVideoFormatYUV420Limited,       
    HWIOVideoFormatYUV422UYVYLimited    
};

HWIOVideoFrameRate

enum HWIOVideoFrameRate

HWIO video frame rate. Here are more detailed structural descriptions.

Enumerator
HWIOVideoFrameRateUnspecified	HWIO video frame rate is unspecified.
HWIOVideoFrameRate25fps	HWIO video frame rate is 25fps.
HWIOVideoFrameRate29_97fps	HWIO video frame rate is 29_97fps.
HWIOVideoFrameRate30fps	HWIO video frame rate is 30fps.
HWIOVideoFrameRate60fps	HWIO video frame rate is 60fps.
HWIOVideoFrameRate50fps	HWIO video frame rate is 50fps.
HWIOVideoFrameRate59_94fps	HWIO video frame rate is 59_94fps.

Definition at line 64 of file IHWIOHelper.h.

{
    HWIOVideoFrameRateUnspecified = 0,  
    HWIOVideoFrameRate25fps,            
    HWIOVideoFrameRate29_97fps,         
    HWIOVideoFrameRate30fps,            
    HWIOVideoFrameRate60fps,            
    HWIOVideoFrameRate50fps,            
    HWIOVideoFrameRate59_94fps,         
};

HWIOVideoResolution

enum HWIOVideoResolution

HWIO video resolution. Here are more detailed structural descriptions.

Enumerator
HWIOVideoResolutionUnspecified	HWIO video resolution is unspecified.
HWIOVideoResolution720p	HWIO video resolution is 720p.
HWIOVideoResolution1080p	HWIO video resolution is 1080p.
HWIOVideoResolution2160p	HWIO video resolution is 2160p.

Definition at line 52 of file IHWIOHelper.h.

{
    HWIOVideoResolutionUnspecified = 0,  
    HWIOVideoResolution720p,             
    HWIOVideoResolution1080p,            
    HWIOVideoResolution2160p             
};