I interrogate and control an AJA video/audio capture/playout device. More...

#include <ntv2card.h>

Inheritance diagram for CNTV2Card:

Collaboration diagram for CNTV2Card:

Public Types
enum	ColorCorrectionColor { RED, GREEN, BLUE, NUM_COLORS }

Public Member Functions
virtual bool	SetVideoFormat (const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail=(!(0)), const bool inKeepVancSettings=(0), const NTV2Channel inChannel=NTV2_CHANNEL1)
	Configures the AJA device to handle a specific video format. More...

virtual bool	SetVideoFormat (const NTV2ChannelSet &inFrameStores, const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail=(!(0)))
	Sets the video format for one or more FrameStores. More...

virtual bool	SetFrameGeometry (NTV2FrameGeometry inGeometry, bool inIsRetail=(!(0)), NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the frame geometry of the given channel. More...

virtual bool	SetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat inNewFormat, bool inIsAJARetail=(!(0)), NTV2HDRXferChars inXferChars=NTV2_VPID_TC_SDR_TV, NTV2HDRColorimetry inColorimetry=NTV2_VPID_Color_Rec709, NTV2HDRLuminance inLuminance=NTV2_VPID_Luminance_YCbCr)
	Sets the frame buffer format for the given FrameStore on the AJA device. More...

virtual bool	SetFrameBufferFormat (const NTV2ChannelSet &inFrameStores, const NTV2FrameBufferFormat inNewFormat, const bool inIsAJARetail=(!(0)), const NTV2HDRXferChars inXferChars=NTV2_VPID_TC_SDR_TV, const NTV2HDRColorimetry inColorimetry=NTV2_VPID_Color_Rec709, const NTV2HDRLuminance inLuminance=NTV2_VPID_Luminance_YCbCr)
	Sets the frame buffer format for the given FrameStore(s) on the AJA device. More...

virtual bool	SetReference (const NTV2ReferenceSource inRefSource, const bool inKeepFramePulseSelect=(0))
	Sets the device's clock reference source. See Video Output Clocking & Synchronization for more information. More...

virtual bool	GetReference (NTV2ReferenceSource &outRefSource)
	Answers with the device's current clock reference source. More...

virtual bool	EnableFramePulseReference (const bool inEnable)
	Enables the device's frame pulse reference select. More...

virtual bool	GetEnableFramePulseReference (bool &outEnabled)
	Answers whether or not the device's current frame pulse reference source is enabled. See Video Output Clocking & Synchronization for more information. More...

virtual bool	SetFramePulseReference (const NTV2ReferenceSource inRefSource)
	Sets the device's frame pulse reference source. See Video Output Clocking & Synchronization for more information. More...

virtual bool	GetFramePulseReference (NTV2ReferenceSource &outRefSource)
	Answers with the device's current frame pulse reference source. More...

virtual bool	GetEveryFrameServices (NTV2EveryFrameTaskMode &outMode)
	Retrieves the device's current "retail service" task mode. More...

virtual bool	SetEveryFrameServices (const NTV2EveryFrameTaskMode inMode)
	Sets the device's task mode. More...

virtual bool	SetMode (const NTV2Channel inChannel, const NTV2Mode inNewValue, const bool inIsRetail=(!(0)))
	Determines if a given FrameStore on the AJA device will be used to capture or playout video. More...

virtual bool	SetMode (const NTV2ChannelSet &inChannels, const NTV2Mode inMode)
	Sets the capture or playout mode of a set of FrameStores on the AJA device. More...

virtual bool	GetMode (const NTV2Channel inChannel, NTV2Mode &outValue)
	Answers with the current NTV2Mode of the given FrameStore on the AJA device. More...

virtual bool	GetFrameGeometry (NTV2FrameGeometry &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat &outValue)
	Returns the current frame buffer format for the given FrameStore on the AJA device. More...

virtual bool	GetVideoFormat (NTV2VideoFormat &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetStandard (NTV2Standard inValue, NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetStandard (NTV2Standard &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	IsProgressiveStandard (bool &outIsProgressive, NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	IsSDStandard (bool &outIsStandardDef, NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetFrameRate (NTV2FrameRate inNewValue, NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the AJA device's frame rate. More...

virtual bool	GetFrameRate (NTV2FrameRate &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
	Returns the AJA device's currently configured frame rate via its "value" parameter. More...

virtual bool	SetSmpte372 (ULWord inValue, NTV2Channel inChannel=NTV2_CHANNEL1)
	Enables or disables the device's SMPTE-372 (dual-link) mode (used for older 3G-levelB-capable devices). More...

virtual bool	GetSmpte372 (ULWord &outValue, NTV2Channel inChannel=NTV2_CHANNEL1)
	Returns the device's current SMPTE-372 (dual-link) mode, whether it's enabled or not. More...

virtual bool	SetProgressivePicture (ULWord value)

virtual bool	GetProgressivePicture (ULWord &outValue)

virtual bool	SetQuadFrameEnable (const bool inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Enables or disables quad-frame mode on the device. More...

virtual bool	GetQuadFrameEnable (bool &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Returns the device's current quad-frame mode, whether it's enabled or not. More...

virtual bool	SetQuadQuadFrameEnable (const bool inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Enables or disables "quad-quad" 8K frame mode on the device. More...

virtual bool	GetQuadQuadFrameEnable (bool &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Returns the device's current "quad-quad" frame mode, whether it's enabled or not. More...

virtual bool	SetQuadQuadSquaresEnable (const bool inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Enables or disables quad-quad-frame (8K) squares mode on the device. More...

virtual bool	GetQuadQuadSquaresEnable (bool &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Returns the device's current "quad-quad-squares" frame mode, whether it's enabled or not. More...

virtual bool	Set4kSquaresEnable (const bool inIsEnabled, const NTV2Channel inChannel)
	Enables or disables SMPTE 425 "2K quadrants" mode for the given FrameStore bank on the device. Client applications should call this function when "4K Squares" mode (not two-sample-interleave) is needed. More...

virtual bool	Get4kSquaresEnable (bool &outIsEnabled, const NTV2Channel inChannel)
	Answers whether the FrameStore bank's current SMPTE 425 "4K squares" (i.e., "2K quadrants") mode is enabled or not. More...

virtual bool	SetTsiFrameEnable (const bool inIsEnabled, const NTV2Channel inChannel)
	Enables or disables SMPTE 425 two-sample interleave (Tsi) frame mode on the device. More...

virtual bool	GetTsiFrameEnable (bool &outIsEnabled, const NTV2Channel inChannel)
	Returns the current SMPTE 425 two-sample-interleave frame mode on the device, whether it's enabled or not. More...

virtual bool	GetTsiMuxSyncFail (bool &outSyncFailed, const NTV2Channel inWhichTsiMux)
	Answers if the SMPTE 425 two-sample-interleave mux/demux input sync has failed or not. More...

virtual bool	SetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode inValue)

virtual bool	GetFrameBufferQuarterSizeMode (NTV2Channel inChannel, NTV2QuarterSizeExpandMode &outValue)

virtual bool	SetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality inValue)

virtual bool	GetFrameBufferQuality (NTV2Channel inChannel, NTV2FrameBufferQuality &outValue)

virtual bool	SetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF inValue)

virtual bool	GetEncodeAsPSF (NTV2Channel inChannel, NTV2EncodeAsPSF &outValue)

virtual bool	SetFrameBufferOrientation (const NTV2Channel inChannel, const NTV2FBOrientation inValue)
	Sets the frame buffer orientation for the given NTV2Channel. More...

virtual bool	GetFrameBufferOrientation (const NTV2Channel inChannel, NTV2FBOrientation &outValue)
	Answers with the current frame buffer orientation for the given NTV2Channel. More...

virtual bool	SetAlphaFromInput2Bit (ULWord inValue)

virtual bool	GetAlphaFromInput2Bit (ULWord &outValue)

virtual bool	SetOutputFrame (const NTV2Channel inChannel, const ULWord inValue)
	Sets the output frame index number for the given FrameStore. This identifies which frame in device SDRAM will be used for playout after the next VBI. More...

virtual bool	GetOutputFrame (const NTV2Channel inChannel, ULWord &outValue)
	Answers with the current output frame number for the given FrameStore (expressed as an NTV2Channel). More...

virtual bool	SetInputFrame (const NTV2Channel inChannel, const ULWord inValue)
	Sets the input frame index number for the given FrameStore. This identifies which frame in device SDRAM will be written after the next VBI. More...

virtual bool	GetInputFrame (const NTV2Channel inChannel, ULWord &outValue)
	Answers with the current input frame index number for the given FrameStore. This identifies which particular frame in device SDRAM will be written after the next frame interrupt. More...

virtual bool	SetDualLinkOutputEnable (const bool inIsEnabled)

virtual bool	GetDualLinkOutputEnable (bool &outIsEnabled)

virtual bool	SetDualLinkInputEnable (const bool inIsEnabled)

virtual bool	GetDualLinkInputEnable (bool &outIsEnabled)

virtual bool	SetVideoLimiting (const NTV2VideoLimiting inValue)
	Sets the device's video range limiting mode. More...

virtual bool	GetVideoLimiting (NTV2VideoLimiting &outValue)
	Answers with the current video range limiting mode for the device. More...

virtual bool	SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC, const NTV2Standard inStandard, const NTV2FrameGeometry inGeometry, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetEnableVANCData (const bool inVANCenabled, const bool inTallerVANC=(0), const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the VANC mode for the given FrameStore. More...

virtual bool	SetVANCMode (const NTV2ChannelSet &inChannels, const NTV2VANCMode inVancMode)
	Sets the VANC mode for the given FrameStores. More...

virtual bool	GetVANCMode (NTV2VANCMode &outVancMode, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Retrieves the current VANC mode for the given FrameStore. More...

virtual bool	SetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode inMode)
	Enables or disables the "VANC Shift Mode" feature for the given channel. More...

virtual bool	SetVANCShiftMode (NTV2ChannelSet &inChannels, const NTV2VANCDataShiftMode inMode)
	Sets the "VANC Shift Mode" for the given channel(s). More...

virtual bool	GetVANCShiftMode (NTV2Channel inChannel, NTV2VANCDataShiftMode &outValue)
	Retrieves the current "VANC Shift Mode" feature for the given channel. More...

virtual bool	SetPulldownMode (NTV2Channel inChannel, bool inValue)

virtual bool	GetPulldownMode (NTV2Channel inChannel, bool &outValue)

virtual bool	ReadLineCount (ULWord &outValue)
	Answers with the line offset into the frame currently being read (NTV2_MODE_DISPLAY) or written (NTV2_MODE_CAPTURE) for FrameStore 1. More...

virtual bool	SetDefaultVideoOutMode (ULWord mode)

virtual bool	GetDefaultVideoOutMode (ULWord &outMode)

virtual bool	GetActiveFrameDimensions (NTV2FrameDimensions &outFrameDimensions, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual NTV2FrameDimensions	GetActiveFrameDimensions (const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetNumberActiveLines (ULWord &outNumActiveLines)

virtual bool	FlipFlopPage (const NTV2Channel inChannel)

virtual bool	SetPCIAccessFrame (const NTV2Channel inChannel, const ULWord inValue, const bool inWaitForVBI=(!(0)))

virtual bool	GetPCIAccessFrame (const NTV2Channel inChannel, ULWord &outValue)

virtual bool	SetEnableVANCData (const NTV2ChannelSet &inChannels, const bool inVANCenable, const bool inTallerVANC=(0))

virtual bool	SetVANCMode (const NTV2VANCMode inVancMode, const NTV2Standard st, const NTV2FrameGeometry fg, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetBaseAddress (NTV2Channel channel, ULWord **pBaseAddress)

virtual bool	GetBaseAddress (ULWord **pBaseAddress)

virtual bool	GetRegisterBaseAddress (ULWord regNumber, ULWord **pRegAddress)

virtual bool	GetXena2FlashBaseAddress (ULWord **pXena2FlashAddress)

virtual bool	SupportsP2PTransfer (void)

virtual bool	SupportsP2PTarget (void)

virtual bool	SetForce64 (ULWord force64)

virtual bool	GetForce64 (ULWord *force64)

virtual bool	Get64BitAutodetect (ULWord *autodetect64)

virtual bool	BankSelectReadRegister (const NTV2RegInfo &inBankSelect, NTV2RegInfo &inOutRegInfo)
	Reads the given set of registers from the bank specified in position 0. More...

virtual bool	WriteRegisters (const NTV2RegisterWrites &inRegWrites)
	Writes the given sequence of NTV2RegInfo's. More...

virtual bool	BankSelectWriteRegister (const NTV2RegInfo &inBankSelect, const NTV2RegInfo &inRegInfo)
	Writes the given set of registers to the bank specified at position 0. More...

virtual bool	WriteVirtualData (const ULWord inTag, const void *inVirtualData, const ULWord inVirtualDataSize)
	Writes the block of virtual data. More...

virtual bool	ReadVirtualData (const ULWord inTag, void *outVirtualData, const ULWord inVirtualDataSize)
	Reads the block of virtual data for a specific tag. More...

virtual bool	ReadSDIStatistics (NTV2SDIInStatistics &outStats)
	For devices that support it (see the NTV2DeviceCanDoSDIErrorChecks function in "ntv2devicefeatures.h"), this function fetches the SDI statistics for all SDI input spigots. More...

virtual bool	SetFrameBufferSize (const NTV2Framesize inSize)
	Sets the device's intrinsic frame buffer size. More...

virtual bool	SetFrameBufferSize (const NTV2Channel inChannel, const NTV2Framesize inValue)
	Sets the device's intrinsic frame buffer size. More...

virtual bool	GetFrameBufferSize (const NTV2Channel inChannel, NTV2Framesize &outValue)
	Answers with the frame size currently being used on the device. More...

virtual bool	IsBufferSizeSetBySW (void)

virtual bool	DisableChannel (const NTV2Channel inChannel)
	Disables the given FrameStore. More...

virtual bool	DisableChannels (const NTV2ChannelSet &inChannels)
	Disables the given FrameStore(s). More...

virtual bool	EnableChannel (const NTV2Channel inChannel)
	Enables the given FrameStore. More...

virtual bool	EnableChannels (const NTV2ChannelSet &inChannels, const bool inDisableOthers=(0))
	Enables the given FrameStore(s). More...

virtual bool	IsChannelEnabled (const NTV2Channel inChannel, bool &outEnabled)
	Answers whether or not the given FrameStore is enabled. More...

virtual bool	GetEnabledChannels (NTV2ChannelSet &outChannels)
	Answers with the set of channels that are currently enabled. More...

virtual bool	GetDisabledChannels (NTV2ChannelSet &outChannels)
	Answers with the set of channels that are currently disabled. More...

virtual bool	SetVideoDACMode (NTV2VideoDACMode inValue)

virtual bool	GetVideoDACMode (NTV2VideoDACMode &outValue)

virtual bool	SetSDIOutputStandard (const UWord inOutputSpigot, const NTV2Standard inValue)
	Sets the SDI output spigot's video standard. More...

virtual bool	SetSDIOutputStandard (const NTV2ChannelSet &inSDIOutputs, const NTV2Standard inValue)
	Sets the video standard for the given SDI output(s). More...

virtual bool	GetSDIOutputStandard (const UWord inOutputSpigot, NTV2Standard &outValue)
	Answers with the current video standard of the given SDI output spigot. More...

virtual bool	SetSecondaryVideoFormat (NTV2VideoFormat inFormat)

virtual bool	GetSecondaryVideoFormat (NTV2VideoFormat &outFormat)

virtual bool	SetInputVideoSelect (NTV2InputVideoSelect inInputSelect)

virtual bool	GetInputVideoSelect (NTV2InputVideoSelect &outInputSelect)

virtual NTV2VideoFormat	GetInputVideoFormat (const NTV2InputSource inVideoSource=NTV2_INPUTSOURCE_SDI1, const bool inIsProgressive=(0))
	Returns the video format of the signal that is present on the given input source. More...

virtual NTV2VideoFormat	GetSDIInputVideoFormat (NTV2Channel inChannel, bool inIsProgressive=(0))
	Returns the video format of the signal that is present on the given SDI input source. More...

virtual NTV2VideoFormat	GetHDMIInputVideoFormat (NTV2Channel inHDMIInput=NTV2_CHANNEL1)

virtual NTV2VideoFormat	GetAnalogInputVideoFormat (void)
	Returns the video format of the signal that is present on the device's analog video input. More...

virtual NTV2VideoFormat	GetAnalogCompositeInputVideoFormat (void)
	Returns the video format of the signal that is present on the device's composite video input. More...

virtual NTV2VideoFormat	GetReferenceVideoFormat (void)
	Returns the video format of the signal that is present on the device's reference input. More...

virtual NTV2FrameRate	GetSDIInputRate (const NTV2Channel channel)

virtual NTV2FrameGeometry	GetSDIInputGeometry (const NTV2Channel channel)

virtual bool	GetSDIInputIsProgressive (const NTV2Channel channel)

virtual bool	GetSDIInput3GPresent (bool &outValue, const NTV2Channel channel)

virtual bool	GetSDIInput3GbPresent (bool &outValue, const NTV2Channel channel)

virtual bool	GetSDIInput6GPresent (bool &outValue, const NTV2Channel channel)

virtual bool	GetSDIInput12GPresent (bool &outValue, const NTV2Channel channel)

virtual bool	SetLHIVideoDACStandard (const NTV2Standard inValue)

virtual bool	GetLHIVideoDACStandard (NTV2Standard &outValue)

virtual bool	SetLHIVideoDACMode (NTV2LHIVideoDACMode value)

virtual bool	GetLHIVideoDACMode (NTV2LHIVideoDACMode &outValue)

virtual bool	SetLHIVideoDACMode (const NTV2VideoDACMode inValue)

virtual bool	GetLHIVideoDACMode (NTV2VideoDACMode &outValue)

virtual bool	SetSDIOut2Kx1080Enable (const NTV2Channel inChannel, const bool inIsEnabled)

virtual bool	GetSDIOut2Kx1080Enable (const NTV2Channel inChannel, bool &outIsEnabled)

virtual bool	SetSDIOut3GEnable (const NTV2Channel inChannel, const bool inEnable)

virtual bool	GetSDIOut3GEnable (const NTV2Channel inChannel, bool &outIsEnabled)

virtual bool	SetSDIOut3GbEnable (const NTV2Channel inChannel, const bool inEnable)

virtual bool	GetSDIOut3GbEnable (const NTV2Channel inChannel, bool &outIsEnabled)

virtual bool	SetSDIOut6GEnable (const NTV2Channel inChannel, const bool inEnable)

virtual bool	GetSDIOut6GEnable (const NTV2Channel inChannel, bool &outIsEnabled)

virtual bool	SetSDIOut12GEnable (const NTV2Channel inChannel, const bool inEnable)

virtual bool	GetSDIOut12GEnable (const NTV2Channel inChannel, bool &outIsEnabled)

virtual bool	SetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem)
	Sets the device's NTV2AudioSystem that will provide audio for the given SDI output's audio embedder. For 3G-capable SDI outputs, this affects Data Stream 1 (or Link A). More...

virtual bool	SetSDIOutputAudioSystem (const NTV2ChannelSet &inSDIOutputs, const NTV2AudioSystem inAudioSystem, const bool inDS2=(0))
	Sets the device's NTV2AudioSystem that will provide audio for the given SDI outputs' audio embedders. For 3G-capable SDI outputs, this affects Data Stream 1 (or Link A). More...

virtual bool	GetSDIOutputAudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem &outAudioSystem)
	Answers with the device's NTV2AudioSystem that is currently providing audio for the given SDI output's audio embedder. (For 3G-capable SDI outputs, this is for Data Stream 1, or Link A.) More...

virtual bool	SetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, const NTV2AudioSystem inAudioSystem)
	Sets the Audio System that will supply audio for the given SDI output's audio embedder for Data Stream 2 (Link B) for dual-link playout. More...

virtual bool	GetSDIOutputDS2AudioSystem (const NTV2Channel inSDIOutputConnector, NTV2AudioSystem &outAudioSystem)
	Answers with the device's Audio System that is currently providing audio for the given SDI output's audio embedder for Data Stream 2 (Link B) for dual-link output. More...

virtual bool	SetSDIInLevelBtoLevelAConversion (const NTV2ChannelSet &inSDIInputs, const bool inEnable)
	Enables or disables 3G level B to 3G level A conversion at the SDI input(s). More...

virtual bool	SetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, const bool inEnable)
	Enables or disables 3G level B to 3G level A conversion at the SDI input widget (assuming the AJA device can do so). More...

virtual bool	GetSDIInLevelBtoLevelAConversion (const UWord inInputSpigot, bool &outIsEnabled)
	Answers with the device's current 3G level B to 3G level A conversion setting for the given SDI input spigot (assuming the device can do such a conversion). More...

virtual bool	SetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, const bool inEnable)
	Enables or disables 3G level A to 3G level B conversion at the SDI output widget (assuming the AJA device can do so). More...

virtual bool	SetSDIOutLevelAtoLevelBConversion (const NTV2ChannelSet &inSDIOutputs, const bool inEnable)
	Enables or disables 3G level A to 3G level B conversion at the given SDI output(s). More...

virtual bool	GetSDIOutLevelAtoLevelBConversion (const UWord inOutputSpigot, bool &outIsEnabled)
	Answers with the device's current 3G level A to 3G level B conversion setting for the given SDI output spigot (assuming the device can do such a conversion). More...

virtual bool	SetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, const bool inEnable)
	Enables or disables an RGB-over-3G-level-A conversion at the SDI output widget (assuming the AJA device can do so). More...

virtual bool	SetSDIOutRGBLevelAConversion (const NTV2ChannelSet &inSDIOutputs, const bool inEnable)
	Enables or disables an RGB-over-3G-level-A conversion at the given SDI output(s). More...

virtual bool	GetSDIOutRGBLevelAConversion (const UWord inOutputSpigot, bool &outIsEnabled)
	Answers with the device's current RGB-over-3G-level-A conversion at the given SDI output spigot (assuming the device can do such a conversion). More...

virtual bool	SetMultiFormatMode (const bool inEnable)
	Enables or disables multi-format (per channel) device operation. If enabled, each device channel can handle a different video format (subject to certain limitations). If disabled, all device channels have the same video format. More...

virtual bool	GetMultiFormatMode (bool &outIsEnabled)
	Answers if the device is operating in multiple-format per channel (independent channel) mode or not. If enabled, each device channel can accommodate a different video format (subject to certain limitations). If disabled, all device channels have the same video format. More...

virtual CNTV2DriverInterface &	driverInterface (void)

virtual std::string	GetFPGAVersionString (const NTV2XilinxFPGA inFPGA=eFPGAVideoProc)

virtual Word	GetPCIFPGAVersion (void)

virtual std::string	GetPCIFPGAVersionString (void)

virtual bool	GetInstalledBitfileInfo (ULWord &outNumBytes, std::string &outDateStr, std::string &outTimeStr)
	Returns the size and time/date stamp of the device's currently-installed firmware. More...

virtual std::string	GetBitfileInfoString (const BITFILE_INFO_STRUCT &inBitFileInfo)
	Generates and returns an info string with date, time and name for the given inBifFileInfo. More...

virtual bool	IsFailSafeBitfileLoaded (bool &outIsFailSafe)
	Answers whether or not the "fail-safe" (aka "safe-boot") bitfile is currently loaded and running in the FPGA. More...

virtual bool	CanWarmBootFPGA (bool &outCanWarmBoot)
	Answers whether or not the FPGA can be reloaded without powering off. More...

virtual bool	IsDynamicDevice (void)

virtual bool	IsDynamicFirmwareLoaded (void)

virtual NTV2DeviceID	GetBaseDeviceID ()

virtual NTV2DeviceIDList	GetDynamicDeviceList (void)

virtual NTV2DeviceIDSet	GetDynamicDeviceIDs (void)

virtual bool	CanLoadDynamicDevice (const NTV2DeviceID inDeviceID)

virtual bool	LoadDynamicDevice (const NTV2DeviceID inDeviceID)
	Quickly, dynamically loads the given device ID firmware. More...

virtual bool	AddDynamicBitfile (const std::string &inBitfilePath)
	Adds the given bitfile to the list of available dynamic bitfiles. More...

virtual bool	AddDynamicDirectory (const std::string &inDirectory)
	Adds all bitfiles found in the given host file directory to the list of available dynamic bitfiles. More...

virtual bool	IsBreakoutBoardConnected (void)

virtual ULWord	GetFrameBufferSize (void) const

Construction & Destruction
	CNTV2Card ()
	My default constructor. More...

	CNTV2Card (const UWord inDeviceIndex, const std::string &inHostName=std::string())
	Constructor that opens the device. More...

virtual	~CNTV2Card ()
	My destructor. More...

Inquiry
virtual std::string	GetDisplayName (void)
	Answers with this device's display name. More...

virtual std::string	GetModelName (void)
	Answers with this device's model name. More...

virtual Word	GetDeviceVersion (void)
	Answers with this device's version number. More...

virtual std::string	GetDeviceVersionString (void)
	Answers with this device's version number as a human-readable string. More...

virtual std::string	GetDriverVersionString (void)
	Answers with this device's driver's version as a human-readable string. More...

virtual std::string	GetDescription (void) const

virtual bool	GetDriverVersionComponents (UWord &outMajor, UWord &outMinor, UWord &outPoint, UWord &outBuild)
	Answers with the individual version components of this device's driver. More...

virtual uint64_t	GetSerialNumber (void)
	Answers with my serial number. More...

virtual bool	GetSerialNumberString (std::string &outSerialNumberString)
	Answers with a string that contains my human-readable serial number. More...

virtual bool	GetPCIDeviceID (ULWord &outPCIDeviceID)
	Answers with my PCI device ID. More...

virtual NTV2BreakoutType	GetBreakoutHardware (void)

virtual class DeviceCapabilities &	features (void)

virtual bool	DeviceCanDoFormat (const NTV2FrameRate inFR, const NTV2FrameGeometry inFG, const NTV2Standard inStd)

virtual ULWord	DeviceGetFrameBufferSize (void)

virtual ULWord	DeviceGetAudioFrameBuffer (void)

virtual ULWord	DeviceGetAudioFrameBuffer2 (void)

virtual ULWord	DeviceGetFrameBufferSize (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)

virtual ULWord	DeviceGetNumberFrameBuffers (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)

virtual ULWord	DeviceGetAudioFrameBuffer (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)

virtual ULWord	DeviceGetAudioFrameBuffer2 (const NTV2FrameGeometry inFrameGeometry, const NTV2FrameBufferFormat inFBFormat)

virtual bool	DeviceCanDoVideoFormat (const NTV2VideoFormat inVF)

virtual bool	DeviceCanDoFrameBufferFormat (const NTV2PixelFormat inPF)

virtual bool	DeviceCanDoWidget (const NTV2WidgetID inWgtID)

virtual bool	DeviceCanDoConversionMode (const NTV2ConversionMode inCM)

virtual bool	DeviceCanDoDSKMode (const NTV2DSKMode inDSKM)

virtual bool	DeviceCanDoInputSource (const NTV2InputSource inSrc)

virtual ULWord	DeviceGetNumberFrameBuffers (void)

DMA Transfer
virtual bool	DMARead (const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
	Transfers data from the AJA device to the host. More...

virtual bool	DMAWrite (const ULWord inFrameNumber, const ULWord *pFrameBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
	Transfers data from the host to the AJA device. More...

virtual bool	DMAReadFrame (const ULWord inFrameNumber, ULWord *pOutFrameBuffer, const ULWord inByteCount)
	Transfers a single frame from the AJA device to the host. More...

virtual bool	DMAReadFrame (const ULWord inFrameNumber, ULWord *pHostBuffer, const ULWord inByteCount, const NTV2Channel inChannel)
	Transfers a single frame from the AJA device to the host. This call is multi-format compatible. More...

virtual bool	DMAWriteFrame (const ULWord inFrameNumber, const ULWord *pInFrameBuffer, const ULWord inByteCount)
	Transfers a single frame from the host to the AJA device. More...

virtual bool	DMAWriteFrame (const ULWord inFrameNumber, const ULWord *pInFrameBuffer, const ULWord inByteCount, const NTV2Channel inChannel)
	Transfers a single frame from the host to the AJA device. This function is multi-format compatible. More...

virtual bool	DMAReadSegments (const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inSegmentByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch)
	Performs a segmented data transfer from the AJA device to the host. More...

virtual bool	DMAWriteSegments (const ULWord inFrameNumber, const ULWord *pFrameBuffer, const ULWord inOffsetBytes, const ULWord inSegmentByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch)
	Performs a segmented data transfer from the host to the AJA device. More...

virtual bool	DmaP2PTargetFrame (NTV2Channel channel, ULWord frameNumber, ULWord frameOffset, PCHANNEL_P2P_STRUCT pP2PData)
	DirectGMA p2p transfers (not GPUDirect: see DMABufferLock) More...

virtual bool	DmaP2PTransferFrame (NTV2DMAEngine DMAEngine, ULWord frameNumber, ULWord frameOffset, ULWord transferSize, ULWord numSegments, ULWord segmentTargetPitch, ULWord segmentCardPitch, PCHANNEL_P2P_STRUCT pP2PData)

virtual bool	DMAReadAudio (const NTV2AudioSystem inAudioSystem, ULWord *pOutAudioBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
	Synchronously transfers audio data from a given Audio System's buffer memory on the AJA device to the specified host buffer, blocking until the transfer has completed. More...

virtual bool	DMAWriteAudio (const NTV2AudioSystem inAudioSystem, const ULWord *pInAudioBuffer, const ULWord inOffsetBytes, const ULWord inByteCount)
	Synchronously transfers audio data from the specified host buffer to the given Audio System's buffer memory on the AJA device, blocking until the transfer has completed. More...

virtual bool	DMAReadAnc (const ULWord inFrameNumber, NTV2Buffer &outAncF1Buffer, NTV2Buffer &outAncF2Buffer=NULL_POINTER, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Transfers the contents of the ancillary data buffer(s) from a given frame on the AJA device to the host. More...

virtual bool	DMAWriteAnc (const ULWord inFrameNumber, NTV2Buffer &inAncF1Buffer, NTV2Buffer &inAncF2Buffer=NULL_POINTER, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Transfers the contents of the ancillary data buffer(s) from the host to a given frame on the AJA device. More...

virtual bool	DMAWriteLUTTable (const ULWord inFrameNumber, const ULWord *pInLUTBuffer, const ULWord inLUTIndex, const ULWord inByteCount=LUTTablePartitionSize)
	Synchronously transfers LUT data from the specified host buffer to the given buffer memory on the AJA device, blocking until the transfer has completed. More...

virtual bool	DMABufferLock (const NTV2Buffer &inBuffer, bool inMap=(0), bool inRDMA=(0))
	Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers. More...

virtual bool	DMABufferLock (const ULWord *pInBuffer, const ULWord inByteCount, bool inMap=(0), bool inRDMA=(0))
	Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers. More...

virtual bool	DMABufferUnlock (const NTV2Buffer &inBuffer)
	Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock. More...

virtual bool	DMABufferUnlock (const ULWord *pInBuffer, const ULWord inByteCount)
	Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock. More...

virtual bool	DMABufferUnlockAll ()
	Unlocks all previously-locked buffers used for DMA transfers. More...

virtual bool	DMABufferAutoLock (const bool inEnable, const bool inMap=(0), const ULWord64 inMaxLockSize=0)
	Enables or disables automatic buffer locking. More...

virtual bool	DMAClearAncRegion (const UWord inStartFrameNumber, const UWord inEndFrameNumber, const NTV2AncillaryDataRegion inAncRegion=NTV2_AncRgn_All, const NTV2Channel=NTV2_CHANNEL1)
	Clears the ancillary data region in the device frame buffer for the specified frames. More...

virtual bool	GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel, uint64_t &outAddress, uint64_t &outLength)
	Answers with the address and size of the given frame. More...

virtual bool	GetDeviceFrameInfo (const UWord inFrameNumber, const NTV2Channel inChannel, ULWord &outIntrinsicSize, bool &outMultiFmt, bool &outQuad, bool &outQuadQuad, bool &outSquares, bool &outTSI, uint64_t &outAddress, uint64_t &outLength)

virtual bool	DeviceAddressToFrameNumber (const uint64_t inAddress, UWord &outFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the frame number that contains the given address. More...

virtual bool	GetAncRegionOffsetAndSize (ULWord &outByteOffset, ULWord &outByteCount, const NTV2AncillaryDataRegion inAncRegion=NTV2_AncRgn_All)
	Answers with the offset and size of an ancillary data region within a device frame buffer. More...

virtual bool	GetAncRegionOffsetFromBottom (ULWord &outByteOffsetFromBottom, const NTV2AncillaryDataRegion inAncRegion=NTV2_AncRgn_All)
	Answers with the byte offset to the start of an ancillary data region within a device frame buffer, as measured from the bottom of the frame buffer. More...

Mixer/Keyer & Video Processing
virtual bool	SetMixerVancOutputFromForeground (const UWord inWhichMixer, const bool inFromForegroundSource=(!(0)))
	Sets the VANC source for the given mixer/keyer to the foreground video (or not). See the SDI Ancillary Data discussion for more information. More...

virtual bool	GetMixerVancOutputFromForeground (const UWord inWhichMixer, bool &outIsFromForegroundSource)
	Answers whether or not the VANC source for the given mixer/keyer is currently the foreground video. See the SDI Ancillary Data discussion for more information. More...

virtual bool	SetMixerFGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl)
	Sets the foreground input control value for the given mixer/keyer. More...

virtual bool	GetMixerFGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl &outInputControl)
	Returns the current foreground input control value for the given mixer/keyer. More...

virtual bool	SetMixerBGInputControl (const UWord inWhichMixer, const NTV2MixerKeyerInputControl inInputControl)
	Sets the background input control value for the given mixer/keyer. More...

virtual bool	GetMixerBGInputControl (const UWord inWhichMixer, NTV2MixerKeyerInputControl &outInputControl)
	Returns the current background input control value for the given mixer/keyer. More...

virtual bool	SetMixerMode (const UWord inWhichMixer, const NTV2MixerKeyerMode inMode)
	Sets the mode for the given mixer/keyer. More...

virtual bool	GetMixerMode (const UWord inWhichMixer, NTV2MixerKeyerMode &outMode)
	Returns the current operating mode of the given mixer/keyer. More...

virtual bool	SetMixerCoefficient (const UWord inWhichMixer, const ULWord inMixCoefficient)
	Sets the current mix coefficient of the given mixer/keyer. More...

virtual bool	GetMixerCoefficient (const UWord inWhichMixer, ULWord &outMixCoefficient)
	Returns the current mix coefficient the given mixer/keyer. More...

virtual bool	GetMixerSyncStatus (const UWord inWhichMixer, bool &outIsSyncOK)
	Returns the current sync state of the given mixer/keyer. More...

virtual bool	GetMixerFGMatteEnabled (const UWord inWhichMixer, bool &outIsEnabled)
	Answers if the given mixer/keyer's foreground matte is enabled or not. More...

virtual bool	SetMixerFGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled)
	Answers if the given mixer/keyer's foreground matte is enabled or not. More...

virtual bool	GetMixerBGMatteEnabled (const UWord inWhichMixer, bool &outIsEnabled)
	Answers if the given mixer/keyer's background matte is enabled or not. More...

virtual bool	SetMixerBGMatteEnabled (const UWord inWhichMixer, const bool inIsEnabled)
	Answers if the given mixer/keyer's background matte is enabled or not. More...

virtual bool	GetMixerMatteColor (const UWord inWhichMixer, YCbCr10BitPixel &outYCbCrValue)
	Answers with the given mixer/keyer's current matte color value being used. More...

virtual bool	SetMixerMatteColor (const UWord inWhichMixer, const YCbCr10BitPixel inYCbCrValue)
	Sets the matte color to use for the given mixer/keyer. More...

virtual bool	MixerHasRGBModeSupport (const UWord inWhichMixer, bool &outIsSupported)
	Answers if the given mixer/keyer's has RGB mode support. More...

virtual bool	SetMixerRGBRange (const UWord inWhichMixer, const NTV2MixerRGBRange inRGBRange)
	Sets the RGB range for the given mixer/keyer. More...

virtual bool	GetMixerRGBRange (const UWord inWhichMixer, NTV2MixerRGBRange &outRGBRange)
	Answers with the given mixer/keyer's current RGB Range. More...

Audio
virtual bool	SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Sets the number of audio channels to be concurrently captured or played for a given Audio System on the AJA device. More...

virtual bool	SetNumberAudioChannels (const ULWord inNumChannels, const NTV2AudioSystemSet &inAudioSystems)
	Sets the number of audio channels to be concurrently captured or played for the given Audio System(s). More...

virtual bool	GetNumberAudioChannels (ULWord &outNumChannels, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Returns the current number of audio channels being captured or played by a given Audio System on the AJA device. More...

virtual bool	SetAudioRate (const NTV2AudioRate inRate, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Sets the NTV2AudioRate for the given Audio System. More...

virtual bool	GetAudioRate (NTV2AudioRate &outRate, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Returns the current NTV2AudioRate for the given Audio System. More...

virtual bool	SetAudioBufferSize (const NTV2AudioBufferSize inValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Changes the size of the audio buffer that is used for a given Audio System in the AJA device. More...

virtual bool	SetAudioBufferSize (const NTV2AudioBufferSize inMode, const NTV2AudioSystemSet &inAudioSystems)
	Changes the size of the audio buffer used for the given Audio System(s). More...

virtual bool	GetAudioBufferSize (NTV2AudioBufferSize &outSize, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Retrieves the size of the input or output audio buffer being used for a given Audio System on the AJA device. More...

virtual bool	SetAudio20BitMode (const NTV2AudioSystem inAudioSystem, const bool inEnable)
	Enables or disables 20-bit mode for the NTV2AudioSystem. More...

virtual bool	GetAudio20BitMode (const NTV2AudioSystem inAudioSystem, bool &outEnable)
	Answers whether or not the device's NTV2AudioSystem is currently operating in 20-bit mode. Normally the NTV2AudioSystem operates in 24-bit mode. More...

virtual bool	SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Enables or disables NTV2AudioLoopBack mode for the given NTV2AudioSystem. More...

virtual bool	SetAudioLoopBack (const NTV2AudioLoopBack inMode, const NTV2AudioSystemSet &inAudioSystems)
	Enables or disables NTV2AudioLoopBack mode for the given Audio Systems. More...

virtual bool	GetAudioLoopBack (NTV2AudioLoopBack &outMode, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Answers if NTV2AudioLoopBack mode is currently on or off for the given NTV2AudioSystem. More...

virtual bool	SetAudioAnalogLevel (const NTV2AudioLevel value, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)

virtual bool	GetAudioAnalogLevel (NTV2AudioLevel &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)

virtual bool	SetEncodedAudioMode (const NTV2EncodedAudioMode value, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)

virtual bool	GetEncodedAudioMode (NTV2EncodedAudioMode &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)

virtual bool	SetEmbeddedAudioClock (const NTV2EmbeddedAudioClock inValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Sets the NTV2EmbeddedAudioClock setting for the given NTV2AudioSystem. More...

virtual bool	GetEmbeddedAudioClock (NTV2EmbeddedAudioClock &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	For the given NTV2AudioSystem, answers with the current NTV2EmbeddedAudioClock setting. More...

virtual bool	GetAudioWrapAddress (ULWord &outWrapAddress, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	For the given Audio System, answers with the wrap address, the threshold at which input/record or output/play transfers will likely need to account for "wrapping" around the end of the buffer back to the start of the buffer to continue recording/playing. More...

virtual bool	GetAudioReadOffset (ULWord &outReadOffset, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	For the given Audio System, answers with the byte offset from the start of the audio buffer to the first byte of the input/capture buffer. (The capture buffer immediately follows the playout buffer in increasing memory address order.) More...

virtual bool	GetAudioMemoryOffset (const ULWord inOffsetBytes, ULWord &outAbsByteOffset, const NTV2AudioSystem inAudioSystem, const bool inCaptureBuffer=(0))
	Answers with the byte offset in device SDRAM into the specified Audio System's audio buffer. More...

virtual bool	ReadAudioLastOut (ULWord &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	For the given Audio System, answers with the byte offset of the tail end of the last chunk of audio samples read by the device's output audio embedder. This is essentially the position of the "Play Head" during audio output. More...

virtual bool	ReadAudioLastIn (ULWord &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	For the given Audio System, answers with the byte offset to the last byte of the latest chunk of 4-byte audio samples written into the device's input audio buffer by its input audio de-embedder. This is essentially the position of the "Write Head" during audio capture. More...

virtual bool	StartAudioOutput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI=(0))
	Starts the playout side of the given NTV2AudioSystem, reading outgoing audio samples from the Audio System's playout buffer. More...

virtual bool	StopAudioOutput (const NTV2AudioSystem inAudioSystem)
	Stops the playout side of the given NTV2AudioSystem, parking the "Read Head" at the start of the playout buffer. More...

virtual bool	IsAudioOutputRunning (const NTV2AudioSystem inAudioSystem, bool &outIsRunning)
	Answers whether or not the playout side of the given NTV2AudioSystem is currently running. More...

virtual bool	SetAudioOutputPause (const NTV2AudioSystem inAudioSystem, const bool inPausePlayout)
	Pauses or resumes output of audio samples and advancement of the audio buffer pointer ("play head") of the given Audio System. More...

virtual bool	GetAudioOutputPause (const NTV2AudioSystem inAudioSystem, bool &outIsPaused)
	Answers if the device's Audio System is currently paused or not. More...

virtual bool	StartAudioInput (const NTV2AudioSystem inAudioSystem, const bool inWaitForVBI=(0))
	Starts the capture side of the given NTV2AudioSystem, writing incoming audio samples into the Audio System's capture buffer. More...

virtual bool	StopAudioInput (const NTV2AudioSystem inAudioSystem)
	Stops the capture side of the given NTV2AudioSystem, and resets the capture position (i.e. "Write Head") back to the start of the Audio System's capture buffer (offset zero). This can be useful for resynchronizing audio and video. More...

virtual bool	IsAudioInputRunning (const NTV2AudioSystem inAudioSystem, bool &outIsRunning)
	Answers whether or not the capture side of the given NTV2AudioSystem is currently running. More...

virtual bool	SetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable)
	Enables or disables the writing of incoming audio into the given Audio System's capture buffer. More...

virtual bool	GetAudioCaptureEnable (const NTV2AudioSystem inAudioSystem, bool &outEnable)
	Answers whether or not the Audio System is configured to write captured audio samples into device audio buffer memory. More...

virtual bool	SetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, const bool inEnable)
	Enables or disables a special mode for the given Audio System whereby its embedder and deembedder both start from the audio base address, instead of operating independently. More...

virtual bool	GetAudioPlayCaptureModeEnable (const NTV2AudioSystem inAudioSystem, bool &outEnable)
	Answers whether or not the device's Audio System is currently operating in a special mode in which its embedder and deembedder both start from the audio base address, instead of operating independently. More...

virtual bool	SetAudioInputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay)
	Sets the audio input delay for the given Audio System on the device. More...

virtual bool	GetAudioInputDelay (const NTV2AudioSystem inAudioSystem, ULWord &outDelay)
	Answers with the audio input delay for the given Audio System on the device. More...

virtual bool	SetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, const ULWord inDelay)
	Sets the audio output delay for the given Audio System on the device. More...

virtual bool	GetAudioOutputDelay (const NTV2AudioSystem inAudioSystem, ULWord &outDelay)
	Answers with the audio output delay for the given Audio System on the device. More...

virtual bool	SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const bool inIsNonPCM)
	Determines whether or not all outgoing audio channel pairs are to be flagged as non-PCM for the given Audio System on the device. More...

virtual bool	GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, bool &outIsNonPCM)
	Answers whether or not all outgoing audio channel pairs are currently being flagged as non-PCM for the given Audio System on the device. More...

virtual bool	SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, const bool inIsNonPCM)
	Determines whether the given audio channel pair being transmitted by the given Audio System is to be flagged as non-PCM or not. More...

virtual bool	SetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPairs &inNonPCMChannelPairs)
	Sets the non-PCM indicator in the AES header of the given channel pairs for the given Audio System on the device. More...

virtual bool	GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool &outIsNonPCM)
	Answers whether or not the given audio channel pair in the given Audio System on the device is being treated as normal PCM audio. More...

virtual bool	GetAudioPCMControl (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs &outNonPCMChannelPairs)
	Answers which NTV2AudioChannelPairs being transmitted by the given NTV2AudioSystem are currently being flagged as non-PCM. More...

virtual bool	IsAudioChannelPairPresent (const NTV2AudioSystem inAudioSystem, const NTV2AudioChannelPair inChannelPair, bool &outIsPresent)
	Answers whether or not the given NTV2AudioChannelPair in the given NTV2AudioSystem on the device is present in the input signal. More...

virtual bool	GetDetectedAudioChannelPairs (const NTV2AudioSystem inAudioSystem, NTV2AudioChannelPairs &outDetectedChannelPairs)
	Answers which audio channel pairs are present in the given Audio System's input stream. More...

virtual bool	GetDetectedAESChannelPairs (NTV2AudioChannelPairs &outDetectedChannelPairs)
	Answers which AES/EBU audio channel pairs are present on the device. More...

virtual bool	SetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, const NTV2AudioSource inAudioSource, const NTV2EmbeddedAudioInput inEmbeddedInput)
	Sets the audio source for the given NTV2AudioSystem on the device. More...

virtual bool	GetAudioSystemInputSource (const NTV2AudioSystem inAudioSystem, NTV2AudioSource &outAudioSource, NTV2EmbeddedAudioInput &outEmbeddedSource)
	Answers with the device's current NTV2AudioSource (and also possibly its NTV2EmbeddedAudioInput) for the given NTV2AudioSystem. More...

virtual bool	SetEmbeddedAudioInput (const NTV2EmbeddedAudioInput inEmbeddedSource, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Sets the embedded (SDI) audio source for the given NTV2AudioSystem on the device. More...

virtual bool	GetEmbeddedAudioInput (NTV2EmbeddedAudioInput &outEmbeddedSource, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Answers with the device's current embedded (SDI) audio source for the given NTV2AudioSystem. More...

virtual bool	InputAudioChannelPairHasPCM (const NTV2Channel inSDIInputConnector, const NTV2AudioChannelPair inAudioChannelPair, bool &outIsPCM)
	For the given SDI input (specified as a channel number), answers if the specified audio channel pair is currently PCM-encoded or not. More...

virtual bool	GetInputAudioChannelPairsWithPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs &outChannelPairs)
	For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently PCM-encoded. More...

virtual bool	GetInputAudioChannelPairsWithoutPCM (const NTV2Channel inSDIInputConnector, NTV2AudioChannelPairs &outChannelPairs)
	For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently not PCM-encoded. More...

virtual bool	GetSuspendHostAudio (bool &outIsSuspended)
	Answers as to whether or not the host OS audio services for the AJA device (e.g. CoreAudio on MacOS) are currently suspended or not. More...

virtual bool	SetSuspendHostAudio (const bool inSuspend)
	Suspends or resumes host OS audio (e.g. CoreAudio on MacOS) for the AJA device. More...

virtual bool	GetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, NTV2AudioSystem &outSrcAudioSystem, NTV2Audio4ChannelSelect &outSrcAudioChannels)
	Answers with the current audio source for a given quad of AES audio output channels. By default, at power-up, for AJA devices that support AES audio output, the content of AES audio output channels 1/2/3/4 reflect what's being output from audio channels 1/2/3/4 from NTV2_AUDIOSYSTEM_1, likewise with audio channels 5/6/7/8, etc. More...

virtual bool	SetAESOutputSource (const NTV2Audio4ChannelSelect inAESAudioChannels, const NTV2AudioSystem inSrcAudioSystem, const NTV2Audio4ChannelSelect inSrcAudioChannels)
	Changes the audio source for the given quad of AES audio output channels. By default, at power-up, for AJA devices that support AES audio output, the content of AES audio output channels 1/2/3/4 reflect what's being output from audio channels 1/2/3/4 from NTV2_AUDIOSYSTEM_1, likewise with audio channels 5/6/7/8, etc. More...

virtual bool	SetAudioOutputMonitorSource (const NTV2AudioChannelPair inChannelPair, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Sets the audio monitor output source to a specified audio system and channel pair. The audio output monitor is typically a pair of RCA jacks (white + red) and/or a headphone jack. More...

virtual bool	GetAudioOutputMonitorSource (NTV2AudioChannelPair &outChannelPair, NTV2AudioSystem &outAudioSystem)
	Answers with the current audio monitor source. The audio output monitor is typically a pair of RCA jacks (white + red) and/or a headphone jack. More...

virtual bool	GetAudioOutputEmbedderState (const NTV2Channel inSDIOutputConnector, bool &outIsEnabled)
	Answers with the current state of the audio output embedder for the given SDI output connector (specified as a channel number). When the embedder is disabled, the device will not embed any SMPTE 299M (HD) or SMPTE 272M (SD) packets in the HANC in the SDI output stream. More...

virtual bool	SetAudioOutputEmbedderState (const NTV2Channel inSDIOutputConnector, const bool &inEnable)
	Enables or disables the audio output embedder for the given SDI output connector (specified as a channel number). When the embedder is disabled, the device will not embed any SMPTE 299M (HD) or SMPTE 272M (SD) packets in the HANC in the SDI output stream. More...

virtual bool	GetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, bool &outEraseModeEnabled)
	Answers with the current state of the audio output erase mode for the given Audio System. If enabled, the Audio System automatically writes zeroes into the audio output buffer behind the output read head during playout. More...

virtual bool	SetAudioOutputEraseMode (const NTV2AudioSystem inAudioSystem, const bool &inEraseModeEnabled)
	Enables or disables output erase mode for the given Audio System, which, when enabled, automatically writes zeroes into the audio output buffer behind the output read head. More...

virtual bool	GetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, bool &outAESSyncModeBitSet)
	Answers with the current state of the AES Sync Mode bit for the given Audio System's output. More...

virtual bool	SetAudioOutputAESSyncModeBit (const NTV2AudioSystem inAudioSystem, const bool &inAESSyncModeBitSet)
	Sets or clears the AES Sync Mode bit for the given Audio System's output. More...

virtual bool	SetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, const bool inEnable)
	Sets the specified bidirectional XLR audio connectors to collectively act as inputs or outputs. More...

virtual bool	GetAnalogAudioTransmitEnable (const NTV2Audio4ChannelSelect inChannelQuad, bool &outEnabled)
	Answers whether or not the specified bidirectional XLR audio connectors are collectively acting as inputs or outputs. More...

virtual bool	GetRawAudioTimer (ULWord &outValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Answers with the current value of the 48kHz audio clock counter. More...

virtual bool	EnableBOBAnalogAudioIn (bool inEnable)
	Enables breakout board analog audio XLR inputs. More...

virtual bool	SetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, const bool inEnable)
	Sets the multi-link audio mode for the given audio system. More...

virtual bool	GetMultiLinkAudioMode (const NTV2AudioSystem inAudioSystem, bool &outEnabled)
	Answers with the current multi-link audio mode for the given audio system. More...

virtual bool	WriteAudioSource (const ULWord inValue, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	ReadAudioSource (ULWord &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetAnalogAudioIOConfiguration (const NTV2AnalogAudioIO inConfig)

virtual bool	GetAnalogAudioIOConfiguration (NTV2AnalogAudioIO &outConfig)

Audio Mixer
virtual bool	GetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, NTV2AudioSystem &outAudioSystem)
	Answers with the Audio System that's currently driving the given input of the Audio Mixer. More...

virtual bool	SetAudioMixerInputAudioSystem (const NTV2AudioMixerInput inMixerInput, const NTV2AudioSystem inAudioSystem)
	Sets the Audio System that will drive the given input of the Audio Mixer. More...

virtual bool	GetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelPair &outChannelPair)
	Answers with the Audio Channel Pair that's currently driving the given input of the Audio Mixer. More...

virtual bool	SetAudioMixerInputChannelSelect (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPair inChannelPair)
	Specifies the Audio Channel Pair that will drive the given input of the Audio Mixer. More...

virtual bool	GetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, ULWord &outGainValue)
	Answers with the current gain setting for the Audio Mixer's given input. More...

virtual bool	SetAudioMixerInputGain (const NTV2AudioMixerInput inMixerInput, const NTV2AudioMixerChannel inChannel, const ULWord inGainValue)
	Sets the gain for the given input of the Audio Mixer. More...

virtual bool	GetAudioMixerOutputGain (ULWord &outGainValue)
	Answers with the current gain setting for the Audio Mixer's output. More...

virtual bool	SetAudioMixerOutputGain (const ULWord inGainValue)
	Sets the gain for the output of the Audio Mixer. More...

virtual bool	GetAudioMixerOutputLevels (const NTV2AudioChannelPairs &inChannelPairs, std::vector< uint32_t > &outLevels)
	Answers with the Audio Mixer's current audio output levels. More...

virtual bool	GetHeadphoneOutputGain (ULWord &outGainValue)
	Answers with the current gain setting for the headphone out. More...

virtual bool	SetHeadphoneOutputGain (const ULWord inGainValue)
	Sets the gain for the headphone out. More...

virtual bool	GetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, NTV2AudioChannelsMuted16 &outMutes)
	Answers with a std::bitset that indicates which input audio channels of the given Audio Mixer input are currently muted. More...

virtual bool	SetAudioMixerInputChannelsMute (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelsMuted16 inMutes)
	Mutes (or enables) the given output audio channel of the Audio Mixer. More...

virtual bool	GetAudioMixerInputLevels (const NTV2AudioMixerInput inMixerInput, const NTV2AudioChannelPairs &inChannelPairs, std::vector< uint32_t > &outLevels)
	Answers with the Audio Mixer's current audio input levels. More...

virtual bool	GetAudioMixerLevelsSampleCount (ULWord &outSampleCount)
	Answers with the Audio Mixer's current sample count used for measuring audio levels. More...

virtual bool	SetAudioMixerLevelsSampleCount (const ULWord inSampleCount)
	Sets the Audio Mixer's sample count it uses for measuring audio levels. More...

virtual bool	GetAudioMixerOutputChannelsMute (NTV2AudioChannelsMuted16 &outMutes)
	Answers with a std::bitset that indicates which output audio channels of the Audio Mixer are currently muted. More...

virtual bool	SetAudioMixerOutputChannelsMute (const NTV2AudioChannelsMuted16 inMutes)
	Mutes or enables the individual output audio channels of the Audio Mixer. More...

Programming
virtual bool	ReadFlashProgramControl (ULWord &outValue)

virtual bool	IsXilinxProgrammed ()

virtual bool	ProgramMainFlash (const std::string &inFileName, const bool bInForceUpdate=(0), const bool bInQuiet=(0))

virtual bool	GetProgramStatus (SSC_GET_FIRMWARE_PROGRESS_STRUCT *statusStruct)

virtual bool	GetRunningFirmwarePackageRevision (ULWord &outRevision)
	Reports the revision number of the currently-running firmware package. KonaIP style boards have a package. More...

virtual bool	GetRunningFirmwareRevision (UWord &outRevision)
	Reports the revision number of the currently-running firmware. More...

virtual bool	GetRunningFirmwareDate (UWord &outYear, UWord &outMonth, UWord &outDay)
	Reports the (local Pacific) build date of the currently-running firmware. More...

virtual bool	GetRunningFirmwareTime (UWord &outHours, UWord &outMinutes, UWord &outSeconds)
	Reports the (local Pacific) build time of the currently-running firmware. More...

virtual bool	GetRunningFirmwareDate (std::string &outDate, std::string &outTime)
	Reports the (local Pacific) build date and time of the currently-running firmware. More...

virtual bool	GetRunningFirmwareUserID (ULWord &outUserID)
	Reports the UserID number of the currently-running firmware. More...

On-Device LEDs
virtual bool	SetLEDState (ULWord inValue)
	The four on-board LEDs can be set by writing 0-15. More...

virtual bool	GetLEDState (ULWord &outValue)
	Answers with the current state of the four on-board LEDs. More...

RP-188
virtual bool	SetRP188Mode (const NTV2Channel inChannel, const NTV2_RP188Mode inMode)
	Sets the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel. More...

virtual bool	GetRP188Mode (const NTV2Channel inChannel, NTV2_RP188Mode &outMode)
	Returns the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel. More...

virtual bool	SetRP188Data (const NTV2Channel inSDIOutput, const NTV2_RP188 &inRP188Data)
	Writes the raw RP188 data into the DBB/Low/Hi registers for the given SDI output. These values are latched and sent at the next VBI. More...

virtual bool	GetRP188Data (const NTV2Channel inSDIInput, NTV2_RP188 &outRP188Data)
	Reads the raw RP188 data from the DBB/Low/Hi registers for the given SDI input. On newer devices with bi-directional SDI connectors – see Timecode (RP-188, SMPTE-12M) for details – if the device is configured for... More...

virtual bool	SetRP188SourceFilter (const NTV2Channel inSDIInput, const UWord inFilterValue)
	Sets the RP188 DBB filter for the given SDI input. More...

virtual bool	GetRP188SourceFilter (const NTV2Channel inSDIInput, UWord &outFilterValue)
	Returns the current RP188 filter setting for the given SDI input. More...

virtual bool	IsRP188BypassEnabled (const NTV2Channel inSDIOutput, bool &outIsBypassEnabled)
	Answers if the SDI output's RP-188 bypass mode is enabled or not. More...

virtual bool	DisableRP188Bypass (const NTV2Channel inSDIOutput)
	Configures the SDI output's embedder to embed SMPTE 12M timecode specified in calls to CNTV2Card::SetRP188Data. More...

virtual bool	EnableRP188Bypass (const NTV2Channel inSDIOutput)
	Configures the SDI output's embedder to embed SMPTE 12M timecode obtained from an SDI input, which is often useful in E-E mode. More...

virtual bool	SetRP188BypassSource (const NTV2Channel inSDIOutput, const UWord inSDIInput)
	For the given SDI output that's in RP188 bypass mode (E-E), specifies the SDI input to be used as a timecode source. More...

virtual bool	GetRP188BypassSource (const NTV2Channel inSDIOutput, UWord &outSDIInput)
	For the given SDI output that's in RP188 bypass mode (E-E), answers with the SDI input that's currently being used as a timecode source. More...

Interrupts & Events
virtual bool	EnableInterrupt (const INTERRUPT_ENUMS inEventCode)

virtual bool	EnableOutputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
	Allows the CNTV2Card instance to wait for and respond to output vertical blanking interrupts originating from the given frameStore on the receiver's AJA device. More...

virtual bool	EnableInputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
	Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given input channel on the receiver's AJA device. More...

virtual bool	EnableInputInterrupt (const NTV2ChannelSet &inFrameStores)
	Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given FrameStore(s). More...

virtual bool	DisableInterrupt (const INTERRUPT_ENUMS inEventCode)

virtual bool	DisableOutputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
	Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given output channel on the device. More...

virtual bool	DisableInputInterrupt (const NTV2Channel channel=NTV2_CHANNEL1)
	Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given input channel on the device. More...

virtual bool	DisableInputInterrupt (const NTV2ChannelSet &inFrameStores)
	Prevents the CNTV2Card instance from waiting for and responding to input vertical blanking interrupts originating from the given frameStore(s) on the device. More...

virtual bool	GetCurrentInterruptMasks (NTV2InterruptMask &outIntMask1, NTV2Interrupt2Mask &outIntMask2)

virtual bool	SubscribeEvent (const INTERRUPT_ENUMS inEventCode)
	Causes me to be notified when the given event/interrupt is triggered for the AJA device. More...

virtual bool	SubscribeOutputVerticalEvent (const NTV2Channel inChannel)
	Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel. More...

virtual bool	SubscribeOutputVerticalEvent (const NTV2ChannelSet &inChannels)
	Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel(s). More...

virtual bool	SubscribeInputVerticalEvent (const NTV2Channel inChannel=NTV2_CHANNEL1)
	Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel. More...

virtual bool	SubscribeInputVerticalEvent (const NTV2ChannelSet &inChannels)
	Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel(s). More...

virtual bool	UnsubscribeEvent (const INTERRUPT_ENUMS inEventCode)
	Unregisters me so I'm no longer notified when the given event/interrupt is triggered on the AJA device. More...

virtual bool	UnsubscribeOutputVerticalEvent (const NTV2Channel inChannel)
	Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel. More...

virtual bool	UnsubscribeOutputVerticalEvent (const NTV2ChannelSet &inChannels)
	Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel(s). More...

virtual bool	UnsubscribeInputVerticalEvent (const NTV2Channel inChannel=NTV2_CHANNEL1)
	Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel. More...

virtual bool	UnsubscribeInputVerticalEvent (const NTV2ChannelSet &inChannels)
	Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel(s). More...

virtual bool	GetOutputVerticalInterruptCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the number of output vertical interrupts handled by the driver for the given output channel. More...

virtual bool	GetInputVerticalInterruptCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the number of input vertical interrupts handled by the driver for the given input channel. More...

virtual bool	GetOutputVerticalEventCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the number of output interrupt events that I successfully waited for on the given channel. More...

virtual bool	GetInputVerticalEventCount (ULWord &outCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the number of input interrupt events that I successfully waited for on the given channel. More...

virtual bool	SetOutputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Resets my output interrupt event tally for the given channel. More...

virtual bool	SetInputVerticalEventCount (const ULWord inCount, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Resets my input interrupt event tally for the given channel. More...

virtual bool	GetOutputFieldID (const NTV2Channel channel, NTV2FieldID &outFieldID)
	Returns the current field ID of the specified output channel. More...

virtual bool	GetInputFieldID (const NTV2Channel channel, NTV2FieldID &outFieldID)
	Returns the current field ID of the specified input channel. More...

virtual bool	WaitForOutputVerticalInterrupt (const NTV2Channel inChannel=NTV2_CHANNEL1, UWord inRepeatCount=1)
	Efficiently sleeps the calling thread/process until the next one or more field (interlaced video) or frame (progressive or interlaced video) VBIs occur for the specified output channel. More...

virtual bool	WaitForOutputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Efficiently sleeps the calling thread/process until the next output VBI for the given field and output channel. More...

virtual bool	WaitForInputVerticalInterrupt (const NTV2Channel inChannel=NTV2_CHANNEL1, UWord inRepeatCount=1)
	Efficiently sleeps the calling thread/process until the next one or more field (interlaced video) or frame (progressive or interlaced video) VBIs occur for the specified input channel. More...

virtual bool	WaitForInputFieldID (const NTV2FieldID inFieldID, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Efficiently sleeps the calling thread/process until the next input VBI for the given field and input channel. More...

virtual bool	SetRegisterWriteMode (const NTV2RegisterWriteMode inValue, const NTV2Channel inFrameStore=NTV2_CHANNEL1)
	Sets the FrameStore's NTV2RegisterWriteMode, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect. More...

virtual bool	GetRegisterWriteMode (NTV2RegisterWriteMode &outValue, const NTV2Channel inFrameStore=NTV2_CHANNEL1)
	Answers with the FrameStore's current NTV2RegisterWriteMode setting, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect. More...

AutoCirculate
virtual bool	GetFrameStamp (NTV2Crosspoint channelSpec, ULWord frameNum, FRAME_STAMP_STRUCT *pFrameStamp)

virtual bool	GetAutoCirculate (NTV2Crosspoint channelSpec, AUTOCIRCULATE_STATUS_STRUCT *autoCirculateStatus)

virtual bool	AutoCirculateInitForInput (const NTV2Channel inChannel, const UWord inFrameCount=7, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_INVALID, const ULWord inOptionFlags=0, const UByte inNumChannels=1, const UWord inStartFrameNumber=0, const UWord inEndFrameNumber=0)
	Prepares for subsequent AutoCirculate ingest, designating a contiguous block of frame buffers on the device for use by the FrameStore/channel, and specifies other optional behaviors. Upon successful return, the channel's NTV2AutoCirculateState is set to NTV2_AUTOCIRCULATE_INIT where it will remain until a subsequent call is made to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop. More...

virtual bool	AutoCirculateInitForOutput (const NTV2Channel inChannel, const UWord inFrameCount=7, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_INVALID, const ULWord inOptionFlags=0, const UByte inNumChannels=1, const UWord inStartFrameNumber=0, const UWord inEndFrameNumber=0)
	Prepares for subsequent AutoCirculate playout, designating a contiguous block of frame buffers on the device for use by the FrameStore/channel, and specifies other optional behaviors. Upon successful return, the channel's NTV2AutoCirculateState is set to NTV2_AUTOCIRCULATE_INIT where it will remain until a subsequent call is made to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop. More...

virtual bool	AutoCirculateStart (const NTV2Channel inChannel, const ULWord64 inStartTime=0)
	Starts AutoCirculating the specified channel that was previously initialized by CNTV2Card::AutoCirculateInitForInput or CNTV2Card::AutoCirculateInitForOutput. More...

virtual bool	AutoCirculateStop (const NTV2Channel inChannel, const bool inAbort=(0))
	Stops AutoCirculate for the given channel, and releases the on-device frame buffers that were allocated to it. More...

virtual bool	AutoCirculateStop (const NTV2ChannelSet &inChannels, const bool inAbort=(0))
	Stops any number of AutoCirculate channels. See the other AutoCirculateStop function overload for full details on what happens to each channel. More...

virtual bool	AutoCirculatePause (const NTV2Channel inChannel, const UWord inAtFrameNum=0xFFFF)
	Pauses AutoCirculate for the given channel. Once paused, AutoCirculate can be resumed later by calling CNTV2Card::AutoCirculateResume, picking up at the next frame without any loss of audio synchronization. More...

virtual bool	AutoCirculateResume (const NTV2Channel inChannel, const bool inClearDropCount=(0))
	Resumes AutoCirculate for the given channel, picking up at the next frame without loss of audio synchronization. More...

virtual bool	AutoCirculateFlush (const NTV2Channel inChannel, const bool inClearDropCount=(0))
	Flushes AutoCirculate for the given channel. More...

virtual bool	AutoCirculatePreRoll (const NTV2Channel inChannel, const ULWord inPreRollFrames)
	Tells AutoCirculate how many frames to skip before playout starts for the given channel. More...

virtual bool	AutoCirculateGetStatus (const NTV2Channel inChannel, AUTOCIRCULATE_STATUS &outStatus)
	Returns the current AutoCirculate status for the given channel. More...

virtual bool	AutoCirculateGetFrameStamp (const NTV2Channel inChannel, const ULWord inFrameNumber, FRAME_STAMP &outFrameInfo)
	Returns precise timing information for the given frame and channel that's currently AutoCirculating. More...

virtual bool	AutoCirculateSetActiveFrame (const NTV2Channel inChannel, const ULWord inNewActiveFrame)
	Immediately changes the Active Frame for the given channel. More...

virtual bool	AutoCirculateTransfer (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER &transferInfo)
	Transfers all or part of a frame as specified in the given AUTOCIRCULATE_TRANSFER object to/from the host. More...

virtual bool	FindUnallocatedFrames (const UWord inFrameCount, LWord &outStartFrame, LWord &outEndFrame, const NTV2Channel inFrameStore=NTV2_CHANNEL_INVALID)
	Returns the device frame buffer numbers of the first unallocated contiguous band of frame buffers having the given size that are available for use. This function is called by CNTV2Card::AutoCirculateInitForInput and CNTV2Card::AutoCirculateInitForOutput whenever a frame count is specified in lieu of explicit frame ranges. More...

Streaming API
virtual ULWord	StreamChannelInitialize (const NTV2Channel inChannel)
	Initialize a stream. Put the stream queue and hardware in a known good state ready for use. Releases all buffers remaining in the queue. At least one new buffer must be queued before starting the stream. More...

virtual ULWord	StreamChannelRelease (const NTV2Channel inChannel)
	Release a stream. Releases all buffers remaining in the queue. More...

virtual ULWord	StreamChannelStart (const NTV2Channel inChannel, NTV2StreamChannel &status)
	Start a stream. Put the stream is the active state to start processing queued buffers. For frame based video, the stream will start with the current buffer on the next frame sync. More...

virtual ULWord	StreamChannelStop (const NTV2Channel inChannel, NTV2StreamChannel &status)
	Stop a stream. Put the stream is the idle state. For frame based video, the stream will idle on the buffer on air after the next frame sync. More...

virtual ULWord	StreamChannelFlush (const NTV2Channel inChannel, NTV2StreamChannel &status)
	Flush a stream. Remove all the buffers from the stream except a currently active idle buffer. The stream must be in the initialize or idle state. More...

virtual ULWord	StreamChannelStatus (const NTV2Channel inChannel, NTV2StreamChannel &status)
	Get the current stream status. More...

virtual ULWord	StreamChannelWait (const NTV2Channel inChannel, NTV2StreamChannel &status)
	Wait for any stream event. Returns for any state or buffer change. More...

virtual ULWord	StreamBufferQueue (const NTV2Channel inChannel, NTV2Buffer &inBuffer, ULWord64 bufferCookie, NTV2StreamBuffer &status)
	Queue a buffer to the stream. The bufferCookie is a user defined identifier of the buffer used by the stream methods. More...

virtual ULWord	StreamBufferRelease (const NTV2Channel inChannel, NTV2StreamBuffer &status)
	Remove the oldest buffer released by the streaming engine from the buffer queue. More...

virtual ULWord	StreamBufferStatus (const NTV2Channel inChannel, ULWord64 bufferCookie, NTV2StreamBuffer &status)
	Get the status of the buffer identified by the bufferCookie. More...

Timing/Offset Control
virtual bool	GetNominalMinMaxHV (int &outNominalH, int &outMinH, int &outMaxH, int &outNominalV, int &outMinV, int &outMaxV)

virtual bool	SetVideoHOffset (const int inHOffset, const UWord inOutputSpigot=0)
	Adjusts the horizontal timing offset, in pixels, for the given SDI output connector. More...

virtual bool	GetVideoHOffset (int &outHOffset, const UWord inOutputSpigot=0)
	Answers with the current horizontal timing offset, in pixels, for the given SDI output connector. More...

virtual bool	SetVideoVOffset (const int inVOffset, const UWord inOutputSpigot=0)
	Adjusts the vertical timing offset, in lines, for the given SDI output connector. More...

virtual bool	GetVideoVOffset (int &outVOffset, const UWord inOutputSpigot=0)
	Answers with the current vertical timing offset, in lines, for the given SDI output connector. More...

virtual bool	SetAnalogOutHTiming (ULWord inValue)

virtual bool	GetAnalogOutHTiming (ULWord &outValue)

virtual bool	WriteOutputTimingControl (const ULWord inValue, const UWord inOutputSpigot=0)
	Adjusts the output timing for the given SDI output connector. More...

virtual bool	ReadOutputTimingControl (ULWord &outValue, const UWord inOutputSpigot=0)
	Returns the current output timing control value for the given SDI output connector. More...

virtual bool	SetSDI1OutHTiming (ULWord value)

virtual bool	GetSDI1OutHTiming (ULWord *value)

virtual bool	SetSDI2OutHTiming (ULWord value)

virtual bool	GetSDI2OutHTiming (ULWord *value)

VPID
virtual bool	SetSDIOutVPID (const ULWord inValueA, const ULWord inValueB, const UWord inOutputSpigot=NTV2_CHANNEL1)

virtual bool	GetSDIOutVPID (ULWord &outValueA, ULWord &outValueB, const UWord inOutputSpigot=NTV2_CHANNEL1)

virtual bool	ReadSDIInVPID (const NTV2Channel inSDIInput, ULWord &outValueA, ULWord &outValueB)

virtual bool	GetVPIDValidA (const NTV2Channel inChannel)

virtual bool	GetVPIDValidB (const NTV2Channel inChannel)

Up/Down Conversion
virtual bool	SetUpConvertMode (const NTV2UpConvertMode inValue)

virtual bool	GetUpConvertMode (NTV2UpConvertMode &outValue)

virtual bool	SetConverterOutStandard (const NTV2Standard inValue)

virtual bool	GetConverterOutStandard (NTV2Standard &outValue)

virtual bool	SetConverterOutRate (const NTV2FrameRate inValue)

virtual bool	GetConverterOutRate (NTV2FrameRate &outValue)

virtual bool	SetConverterInStandard (const NTV2Standard inValue)

virtual bool	GetConverterInStandard (NTV2Standard &outValue)

virtual bool	SetConverterInRate (const NTV2FrameRate inValue)

virtual bool	GetConverterInRate (NTV2FrameRate &outValue)

virtual bool	SetConverterPulldown (const ULWord inValue)

virtual bool	GetConverterPulldown (ULWord &outValue)

virtual bool	SetUCPassLine21 (const ULWord inValue)

virtual bool	GetUCPassLine21 (ULWord &outValue)

virtual bool	SetUCAutoLine21 (const ULWord inValue)

virtual bool	GetUCAutoLine21 (ULWord &outValue)

virtual bool	SetDownConvertMode (const NTV2DownConvertMode inValue)

virtual bool	GetDownConvertMode (NTV2DownConvertMode &outValue)

virtual bool	SetIsoConvertMode (const NTV2IsoConvertMode inValue)

virtual bool	GetIsoConvertMode (NTV2IsoConvertMode &outValue)

virtual bool	SetEnableConverter (const bool inValue)

virtual bool	GetEnableConverter (bool &outValue)

virtual bool	SetDeinterlaceMode (const ULWord inValue)

virtual bool	GetDeinterlaceMode (ULWord &outValue)

virtual bool	SetConversionMode (const NTV2ConversionMode inConversionMode)

virtual bool	GetConversionMode (NTV2ConversionMode &outConversionMode)

Signal Routing
virtual bool	GetConnectedOutput (const NTV2InputCrosspointID inInputXpt, NTV2OutputCrosspointID &outOutputXpt)
	Answers with the currently connected NTV2OutputCrosspointID for the given NTV2InputCrosspointID. More...

virtual bool	GetConnectedInput (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointID &outInputXpt)
	Answers with a connected NTV2InputCrosspointID for the given NTV2OutputCrosspointID. More...

virtual bool	GetConnectedInputs (const NTV2OutputCrosspointID inOutputXpt, NTV2InputCrosspointIDSet &outInputXpts)
	Answers with all of the NTV2InputCrosspointIDs that are connected to the given NTV2OutputCrosspointID. More...

virtual bool	Connect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, const bool inValidate=(0))
	Connects the given widget signal input (sink) to the given widget signal output (source). More...

virtual bool	Disconnect (const NTV2InputCrosspointID inInputXpt)
	Disconnects the given widget signal input (sink) from whatever output (source) it may be connected. More...

virtual bool	IsConnected (const NTV2InputCrosspointID inInputXpt, bool &outIsConnected)
	Answers whether or not the given widget signal input (sink) is connected to another output (source). More...

virtual bool	IsConnectedTo (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool &outIsConnected)
	Answers whether or not the given widget signal input (sink) is connected to another output (source). More...

virtual bool	CanConnect (const NTV2InputCrosspointID inInputXpt, const NTV2OutputCrosspointID inOutputXpt, bool &outCanConnect)
	Answers whether or not the given widget signal input (sink) can legally be connected to the given signal output (source). More...

virtual bool	ApplySignalRoute (const CNTV2SignalRouter &inRouter, const bool inReplace=(0))
	Applies the given routing table to the AJA device. More...

virtual bool	ApplySignalRoute (const NTV2XptConnections &inConnections, const bool inReplace=(0))
	Applies the given widget routing connections to the AJA device. More...

virtual bool	RemoveConnections (const NTV2XptConnections &inConnections)
	Removes the given widget routing connections from the AJA device. More...

virtual bool	ClearRouting (void)
	Removes all existing signal path connections between any and all widgets on the AJA device. More...

virtual bool	GetRouting (CNTV2SignalRouter &outRouting)
	Answers with the current signal routing between any and all widgets on the AJA device. More...

virtual bool	GetConnections (NTV2XptConnections &outConnections)
	Answers with the device's current widget routing connections. More...

virtual bool	GetRoutingForChannel (const NTV2Channel inChannel, CNTV2SignalRouter &outRouting)
	Answers with the current signal routing for the given channel. More...

virtual bool	GetPossibleConnections (NTV2PossibleConnections &outConnections)
	Answers with the implemented crosspoint connections (if known). More...

Analog
These functions only work on devices with analog inputs.
virtual bool	WriteSDProcAmpControlsInitialized (const ULWord inNewValue=1)

virtual bool	WriteSDBrightnessAdjustment (const ULWord inNewValue)

virtual bool	WriteSDContrastAdjustment (const ULWord inNewValue)

virtual bool	WriteSDSaturationAdjustment (const ULWord inNewValue)

virtual bool	WriteSDHueAdjustment (const ULWord inNewValue)

virtual bool	WriteSDCbOffsetAdjustment (const ULWord inNewValue)

virtual bool	WriteSDCrOffsetAdjustment (const ULWord inNewValue)

virtual bool	WriteHDProcAmpControlsInitialized (const ULWord inNewValue=1)

virtual bool	WriteHDBrightnessAdjustment (const ULWord inNewValue)

virtual bool	WriteHDContrastAdjustment (const ULWord inNewValue)

virtual bool	WriteHDSaturationAdjustmentCb (const ULWord inNewValue)

virtual bool	WriteHDSaturationAdjustmentCr (const ULWord inNewValue)

virtual bool	WriteHDCbOffsetAdjustment (const ULWord inNewValue)

virtual bool	WriteHDCrOffsetAdjustment (const ULWord inNewValue)

virtual bool	ReadSDProcAmpControlsInitialized (ULWord &outValue)

virtual bool	ReadSDBrightnessAdjustment (ULWord &outValue)

virtual bool	ReadSDContrastAdjustment (ULWord &outValue)

virtual bool	ReadSDSaturationAdjustment (ULWord &outValue)

virtual bool	ReadSDHueAdjustment (ULWord &outValue)

virtual bool	ReadSDCbOffsetAdjustment (ULWord &outValue)

virtual bool	ReadSDCrOffsetAdjustment (ULWord &outValue)

virtual bool	ReadHDProcAmpControlsInitialized (ULWord &outValue)

virtual bool	ReadHDBrightnessAdjustment (ULWord &outValue)

virtual bool	ReadHDContrastAdjustment (ULWord &outValue)

virtual bool	ReadHDSaturationAdjustmentCb (ULWord &outValue)

virtual bool	ReadHDSaturationAdjustmentCr (ULWord &outValue)

virtual bool	ReadHDCbOffsetAdjustment (ULWord &outValue)

virtual bool	ReadHDCrOffsetAdjustment (ULWord &outValue)

virtual bool	WriteProcAmpC1YAdjustment (const ULWord inNewValue)

virtual bool	WriteProcAmpC1CBAdjustment (const ULWord inNewValue)

virtual bool	WriteProcAmpC1CRAdjustment (const ULWord inNewValue)

virtual bool	WriteProcAmpC2CBAdjustment (const ULWord inNewValue)

virtual bool	WriteProcAmpC2CRAdjustment (const ULWord inNewValue)

virtual bool	WriteProcAmpOffsetYAdjustment (const ULWord inNewValue)

virtual bool	ReadProcAmpC1YAdjustment (ULWord &outValue)

virtual bool	ReadProcAmpC1CBAdjustment (ULWord &outValue)

virtual bool	ReadProcAmpC1CRAdjustment (ULWord &outValue)

virtual bool	ReadProcAmpC2CBAdjustment (ULWord &outValue)

virtual bool	ReadProcAmpC2CRAdjustment (ULWord &outValue)

virtual bool	ReadProcAmpOffsetYAdjustment (ULWord &outValue)

virtual bool	SetAnalogInputADCMode (const NTV2LSVideoADCMode inValue)

virtual bool	GetAnalogInputADCMode (NTV2LSVideoADCMode &outValue)

Analog LTC
virtual bool	SetLTCInputEnable (const bool inEnable)
	Enables or disables the ability for the device to read analog LTC on the reference input connector. More...

virtual bool	GetLTCInputEnable (bool &outIsEnabled)
	Answers true if the device is currently configured to read analog LTC from the reference input connector (instead of reference). More...

virtual bool	GetLTCInputPresent (bool &outIsPresent, const UWord inLTCInputNdx=0)
	Answers whether or not a valid analog LTC signal is being applied to the device's analog LTC input connector. More...

virtual bool	ReadAnalogLTCInput (const UWord inLTCInput, RP188_STRUCT &outRP188Data)
	Reads the current contents of the device's analog LTC input registers. More...

virtual bool	ReadAnalogLTCInput (const UWord inLTCInput, NTV2_RP188 &outRP188Data)
	Reads the current contents of the device's analog LTC input registers. More...

virtual bool	GetAnalogLTCInClockChannel (const UWord inLTCInput, NTV2Channel &outChannel)
	Answers with the (SDI) input channel that's providing the clock reference being used by the given device's analog LTC input. More...

virtual bool	SetAnalogLTCInClockChannel (const UWord inLTCInput, const NTV2Channel inChannel)
	Sets the (SDI) input channel that is to provide the clock reference to be used by the given analog LTC input. More...

virtual bool	WriteAnalogLTCOutput (const UWord inLTCOutput, const RP188_STRUCT &inRP188Data)
	Writes the given timecode to the specified analog LTC output register. More...

virtual bool	WriteAnalogLTCOutput (const UWord inLTCOutput, const NTV2_RP188 &inRP188Data)
	Writes the given timecode to the specified analog LTC output register. More...

virtual bool	GetAnalogLTCOutClockChannel (const UWord inLTCOutput, NTV2Channel &outChannel)
	Answers with the (SDI) output channel that's providing the clock reference being used by the given device's analog LTC output. More...

virtual bool	SetAnalogLTCOutClockChannel (const UWord inLTCOutput, const NTV2Channel inChannel)
	Sets the (SDI) output channel that is to provide the clock reference to be used by the given analog LTC output. More...

virtual bool	SetLTCEmbeddedOutEnable (const bool inNewValue)

virtual bool	GetLTCEmbeddedOutEnable (bool &outValue)

Stereo Compression
virtual bool	SetStereoCompressorOutputMode (const NTV2StereoCompressorOutputMode inNewValue)

virtual bool	GetStereoCompressorOutputMode (NTV2StereoCompressorOutputMode &outValue)

virtual bool	SetStereoCompressorFlipMode (const ULWord inNewValue)

virtual bool	GetStereoCompressorFlipMode (ULWord &outValue)

virtual bool	SetStereoCompressorFlipLeftHorz (const ULWord inNewValue)

virtual bool	GetStereoCompressorFlipLeftHorz (ULWord &outValue)

virtual bool	SetStereoCompressorFlipLeftVert (const ULWord inNewValue)

virtual bool	GetStereoCompressorFlipLeftVert (ULWord &outValue)

virtual bool	SetStereoCompressorFlipRightHorz (const ULWord inNewValue)

virtual bool	GetStereoCompressorFlipRightHorz (ULWord &outValue)

virtual bool	SetStereoCompressorFlipRightVert (const ULWord inNewValue)

virtual bool	GetStereoCompressorFlipRightVert (ULWord &outValue)

virtual bool	SetStereoCompressorStandard (const NTV2Standard inNewValue)

virtual bool	GetStereoCompressorStandard (NTV2Standard &outValue)

virtual bool	SetStereoCompressorLeftSource (const NTV2OutputCrosspointID inNewValue)

virtual bool	GetStereoCompressorLeftSource (NTV2OutputCrosspointID &outValue)

virtual bool	SetStereoCompressorRightSource (const NTV2OutputCrosspointID inNewValue)

virtual bool	GetStereoCompressorRightSource (NTV2OutputCrosspointID &outValue)

SDI Connectors
virtual bool	SetSDITransmitEnable (const NTV2Channel inChannel, const bool inEnable)
	Sets the specified bidirectional SDI connector to act as an input or an output. More...

virtual bool	SetSDITransmitEnable (const NTV2ChannelSet &inSDIConnectors, const bool inEnable)
	Sets the specified SDI connector(s) to act as an input or an output. More...

virtual bool	GetSDITransmitEnable (const NTV2Channel inChannel, bool &outEnabled)
	Answers whether or not the specified SDI connector is currently acting as a transmitter (i.e. an output). More...

virtual bool	GetTransmitSDIs (NTV2ChannelSet &outXmitSDIs)
	Answers with the transmitting/output SDI connectors. More...

SDI Bypass Relays
virtual bool	GetSDIRelayPosition (NTV2RelayState &outValue, const UWord inIndex0)
	Answers if the bypass relays between connectors 1/2 or 3/4 are currently in bypass or routing the signals through the device. More...

virtual bool	GetSDIRelayManualControl (NTV2RelayState &outValue, const UWord inIndex0)
	Answers if the bypass relays between connectors 1 and 2 would be in bypass or would route signals through the device, if under manual control. More...

virtual bool	SetSDIRelayManualControl (const NTV2RelayState inValue, const UWord inIndex0)
	Sets the state of the given connector pair relays to NTV2_DEVICE_BYPASSED (or NTV2_THROUGH_DEVICE if under manual control). More...

virtual bool	GetSDIWatchdogEnable (bool &outIsEnabled, const UWord inIndex0)
	Answers true if the given connector pair relays are under watchdog timer control, or false if they're under manual control. More...

virtual bool	SetSDIWatchdogEnable (const bool inEnable, const UWord inIndex0)
	Sets the connector pair relays to be under watchdog timer control or manual control. More...

virtual bool	GetSDIWatchdogStatus (NTV2RelayState &outValue)
	Answers if the watchdog timer would put the SDI relays into NTV2_DEVICE_BYPASSED or NTV2_THROUGH_DEVICE. More...

virtual bool	GetSDIWatchdogTimeout (ULWord &outValue)
	Answers with the amount of time that must elapse before the watchdog timer times out. More...

virtual bool	SetSDIWatchdogTimeout (const ULWord inValue)
	Specifies the amount of time that must elapse before the watchdog timer times out. More...

virtual bool	KickSDIWatchdog (void)
	Restarts the countdown timer to prevent the watchdog timer from timing out. More...

4K Conversion
virtual bool	Enable4KDCRGBMode (bool inEnable)
	Sets 4K Down Convert RGB mode. More...

virtual bool	GetEnable4KDCRGBMode (bool &outIsEnabled)

virtual bool	Enable4KDCYCC444Mode (bool inEnable)
	Sets 4K Down Convert YCC 444 mode. More...

virtual bool	GetEnable4KDCYCC444Mode (bool &outIsEnabled)

virtual bool	Enable4KDCPSFInMode (bool inEnable)
	Sets 4K Down Convert PSF in mode. More...

virtual bool	GetEnable4KDCPSFInMode (bool &outIsEnabled)

virtual bool	Enable4KPSFOutMode (bool inEnable)
	Sets 4K Down Convert PSF out Mode. More...

virtual bool	GetEnable4KPSFOutMode (bool &outIsEnabled)

SDI Input Error Detection
virtual bool	GetSDITRSError (const NTV2Channel inChannel)

virtual bool	GetSDILock (const NTV2Channel inChannel)

virtual ULWord	GetSDIUnlockCount (const NTV2Channel inChannel)

virtual ULWord	GetCRCErrorCountA (const NTV2Channel inChannel)

virtual ULWord	GetCRCErrorCountB (const NTV2Channel inChannel)

RS-422
virtual bool	SetRS422Parity (const NTV2Channel inSerialPort, const NTV2_RS422_PARITY inParity)
	Sets the parity control on the specified RS422 serial port. More...

virtual bool	GetRS422Parity (const NTV2Channel inSerialPort, NTV2_RS422_PARITY &outParity)
	Answers with the current parity control for the specified RS422 serial port. More...

virtual bool	SetRS422BaudRate (const NTV2Channel inSerialPort, const NTV2_RS422_BAUD_RATE inBaudRate)
	Sets the baud rate of the specified RS422 serial port. More...

virtual bool	GetRS422BaudRate (const NTV2Channel inSerialPort, NTV2_RS422_BAUD_RATE &outBaudRate)
	Answers with the current baud rate of the specified RS422 serial port. More...

TCP/IP
virtual bool	AcquireMailBoxLock (void)

virtual bool	ReleaseMailBoxLock (void)

virtual bool	AbortMailBoxLock (void)

Misc
virtual bool	GetDieTemperature (double &outTemp, const NTV2DieTempScale inTempScale=NTV2DieTempScale_Celsius)
	Reads the current die temperature of the device. More...

virtual bool	GetDieVoltage (double &outVoltage)
	Reads the current "Vcc" voltage of the device. More...

HEVC-Specific Functions
virtual bool	HevcGetDeviceInfo (HevcDeviceInfo *pInfo)
	Returns the driver version and time/date stamp of the hevc device's currently-installed firmware. More...

virtual bool	HevcWriteRegister (ULWord address, ULWord value, ULWord mask=0xffffffff, ULWord shift=0)
	Write an hevc register. More...

virtual bool	HevcReadRegister (ULWord address, ULWord *pValue, ULWord mask=0xffffffff, ULWord shift=0)
	Read an hevc register. More...

virtual bool	HevcSendCommand (HevcDeviceCommand *pCommand)
	Send a command to the hevc device. See the hevc codec documentation for details on commands. More...

virtual bool	HevcVideoTransfer (HevcDeviceTransfer *pTransfer)
	Transfer video to/from the hevc device. More...

virtual bool	HevcGetStatus (HevcDeviceStatus *pStatus)
	Get the status of the hevc device. More...

virtual bool	HevcDebugInfo (HevcDeviceDebug *pDebug)
	Get debug data from the hevc device. More...

HDMI HDR Support
virtual bool	EnableHDMIHDR (const bool inEnableHDMIHDR)
	Enables or disables HDMI HDR. More...

virtual bool	GetHDMIHDREnabled (void)

virtual bool	EnableHDMIHDRDolbyVision (const bool inEnable)
	Enables or disables HDMI HDR Dolby Vision. More...

virtual bool	GetHDMIHDRDolbyVisionEnabled (void)

virtual bool	SetHDMIHDRConstantLuminance (const bool inEnableConstantLuminance)
	Enables or disables BT.2020 Y'cC'bcC'rc versus BT.2020 Y'C'bC'r or R'G'B'. More...

virtual bool	GetHDMIHDRConstantLuminance (void)

virtual bool	SetHDMIHDRGreenPrimaryX (const uint16_t inGreenPrimaryX)
	Sets the Display Mastering data for Green Primary X as defined in SMPTE ST 2086. This is Byte 3 and 4 of SMDT Type 1. More...

virtual bool	GetHDMIHDRGreenPrimaryX (uint16_t &outGreenPrimaryX)
	Answers with the Display Mastering data for Green Primary X as defined in SMPTE ST 2086. This is Byte 3 and 4 of SMDT Type 1. More...

virtual bool	SetHDMIHDRGreenPrimaryY (const uint16_t inGreenPrimaryY)
	Sets the Display Mastering data for Green Primary Y as defined in SMPTE ST 2086. This is Byte 5 and 6 of SMDT Type 1. More...

virtual bool	GetHDMIHDRGreenPrimaryY (uint16_t &outGreenPrimaryY)
	Answers with the Display Mastering data for Green Primary Y as defined in SMPTE ST 2086. This is Byte 5 and 6 of SMDT Type 1. More...

virtual bool	SetHDMIHDRBluePrimaryX (const uint16_t inBluePrimaryX)
	Sets the Display Mastering data for Blue Primary X as defined in SMPTE ST 2086. This is Byte 7 and 8 of SMDT Type 1. More...

virtual bool	GetHDMIHDRBluePrimaryX (uint16_t &outBluePrimaryX)
	Answers with the Display Mastering data for Blue Primary X as defined in SMPTE ST 2086. This is Byte 7 and 8 of SMDT Type 1. More...

virtual bool	SetHDMIHDRBluePrimaryY (const uint16_t inBluePrimaryY)
	Sets the Display Mastering data for Blue Primary Y as defined in SMPTE ST 2086. This is Byte 9 and 10 of SMDT Type 1. More...

virtual bool	GetHDMIHDRBluePrimaryY (uint16_t &outBluePrimaryY)
	Answers with the Display Mastering data for Blue Primary Y as defined in SMPTE ST 2086. This is Byte 9 and 10 of SMDT Type 1. More...

virtual bool	SetHDMIHDRRedPrimaryX (const uint16_t inRedPrimaryX)
	Sets the Display Mastering data for Red Primary X as defined in SMPTE ST 2086. This is Byte 11 and 12 of SMDT Type 1. More...

virtual bool	GetHDMIHDRRedPrimaryX (uint16_t &outRedPrimaryX)
	Answers with the Display Mastering data for Red Primary X as defined in SMPTE ST 2086. This is Byte 11 and 12 of SMDT Type 1. More...

virtual bool	SetHDMIHDRRedPrimaryY (const uint16_t inRedPrimaryY)
	Sets the Display Mastering data for Red Primary Y as defined in SMPTE ST 2086. This is Byte 13 and 14 of SMDT Type 1. More...

virtual bool	GetHDMIHDRRedPrimaryY (uint16_t &outRedPrimaryY)
	Answers with the Display Mastering data for Red Primary Y as defined in SMPTE ST 2086. This is Byte 13 and 14 of SMDT Type 1. More...

virtual bool	SetHDMIHDRWhitePointX (const uint16_t inWhitePointX)
	Sets the Display Mastering data for White Point X as defined in SMPTE ST 2086. This is Byte 15 and 16 of SMDT Type 1. More...

virtual bool	GetHDMIHDRWhitePointX (uint16_t &outWhitePointX)
	Answers with the Display Mastering data for White Point X as defined in SMPTE ST 2086. This is Byte 15 and 16 of SMDT Type 1. More...

virtual bool	SetHDMIHDRWhitePointY (const uint16_t inWhitePointY)
	Sets the Display Mastering data for White Point Y as defined in SMPTE ST 2086. This is Byte 17 and 18 of SMDT Type 1. More...

virtual bool	GetHDMIHDRWhitePointY (uint16_t &outWhitePointY)
	Answers with the Display Mastering data for White Point Y as defined in SMPTE ST 2086. This is Byte 17 and 18 of SMDT Type 1. More...

virtual bool	SetHDMIHDRMaxMasteringLuminance (const uint16_t inMaxMasteringLuminance)
	Sets the Display Mastering data for the Max Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 19 and 20 of SMDT Type 1. More...

virtual bool	GetHDMIHDRMaxMasteringLuminance (uint16_t &outMaxMasteringLuminance)
	Answers with the Display Mastering data for the Max Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 19 and 20 of SMDT Type 1. More...

virtual bool	SetHDMIHDRMinMasteringLuminance (const uint16_t inMinMasteringLuminance)
	Sets the Display Mastering data for the Min Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 21 and 22 of SMDT Type 1. More...

virtual bool	GetHDMIHDRMinMasteringLuminance (uint16_t &outMinMasteringLuminance)
	Answers with the Display Mastering data for the Min Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 21 and 22 of SMDT Type 1. More...

virtual bool	SetHDMIHDRMaxContentLightLevel (const uint16_t inMaxContentLightLevel)
	Sets the Display Mastering data for the Max Content Light Level(Max CLL) value. This is Byte 23 and 24 of SMDT Type 1. More...

virtual bool	GetHDMIHDRMaxContentLightLevel (uint16_t &outMaxContentLightLevel)
	Answers with the Display Mastering data for the Max Content Light Level(Max CLL) value. This is Byte 23 and 24 of SMDT Type 1. More...

virtual bool	SetHDMIHDRMaxFrameAverageLightLevel (const uint16_t inMaxFrameAverageLightLevel)
	Sets the Display Mastering data for the Max Frame Average Light Level(Max FALL) value. This is Byte 25 and 26 of SMDT Type 1. More...

virtual bool	GetHDMIHDRMaxFrameAverageLightLevel (uint16_t &outMaxFrameAverageLightLevel)
	Answers with the Display Mastering data for the Max Frame Average Light Level(Max FALL) value. This is Byte 25 and 26 of SMDT Type 1. More...

virtual bool	SetHDMIHDRElectroOpticalTransferFunction (const uint8_t inEOTFByte)

virtual bool	GetHDMIHDRElectroOpticalTransferFunction (uint8_t &outEOTFByte)

virtual bool	SetHDMIHDRStaticMetadataDescriptorID (const uint8_t inSMDId)

virtual bool	GetHDMIHDRStaticMetadataDescriptorID (uint8_t &outSMDId)

virtual bool	SetHDRData (const HDRFloatValues &inFloatValues)

virtual bool	SetHDRData (const HDRRegValues &inRegisterValues)

virtual bool	GetHDRData (HDRFloatValues &outFloatValues)

virtual bool	GetHDRData (HDRRegValues &outRegisterValues)

virtual bool	SetHDMIHDRBT2020 (void)

virtual bool	SetHDMIHDRDCIP3 (void)

virtual bool	SetVPIDTransferCharacteristics (const NTV2VPIDTransferCharacteristics inValue, const NTV2Channel inChannel)

virtual bool	GetVPIDTransferCharacteristics (NTV2VPIDTransferCharacteristics &outValue, const NTV2Channel inChannel)

virtual bool	SetVPIDColorimetry (const NTV2VPIDColorimetry inValue, const NTV2Channel inChannel)

virtual bool	GetVPIDColorimetry (NTV2VPIDColorimetry &outValue, const NTV2Channel inChannel)

virtual bool	SetVPIDLuminance (const NTV2VPIDLuminance inValue, const NTV2Channel inChannel)

virtual bool	GetVPIDLuminance (NTV2VPIDLuminance &outValue, const NTV2Channel inChannel)

virtual bool	SetVPIDRGBRange (const NTV2VPIDRGBRange inValue, const NTV2Channel inChannel)

virtual bool	GetVPIDRGBRange (NTV2VPIDRGBRange &outValue, const NTV2Channel inChannel)

virtual bool	Set3DLUTTableLocation (const ULWord inFrameNumber, ULWord inLUTIndex=0)

virtual bool	Load3DLUTTable (void)

virtual bool	Set1DLUTTableLocation (const NTV2Channel inChannel, const ULWord inFrameNumber, ULWord inLUTIndex=0)

virtual bool	Load1DLUTTable (const NTV2Channel inChannel)

virtual bool	HasMultiRasterWidget (void)

virtual bool	SetMultiRasterBypassEnable (const bool inEnable)

virtual bool	GetMultiRasterBypassEnable (bool &outEnabled)

virtual bool	IsMultiRasterWidgetChannel (const NTV2Channel inChannel)

Public Member Functions inherited from CNTV2MacDriverInterface
virtual bool	SystemControl (void *dataPtr, SystemControlCode systemControlCode)

virtual bool	MapFrameBuffers (void)

virtual bool	UnmapFrameBuffers (void)

virtual bool	MapRegisters (void)

virtual bool	UnmapRegisters (void)

virtual bool	MapXena2Flash (void)

virtual bool	UnmapXena2Flash (void)

virtual ULWord	GetPCISlotNumber (void) const

virtual bool	MapMemory (const MemoryType memType, void **memPtr)

virtual bool	SetAudioOutputMode (NTV2_GlobalAudioPlaybackMode mode)

virtual bool	GetAudioOutputMode (NTV2_GlobalAudioPlaybackMode *mode)

virtual bool	SystemStatus (void *dataPtr, SystemStatusCode systemStatusCode)

virtual bool	KernelLog (void *dataPtr, UInt32 dataSize)

virtual bool	ConfigureInterrupt (bool, INTERRUPT_ENUMS)

virtual std::string	GetConnectionType (void) const

	CNTV2MacDriverInterface ()
	My default constructor. More...

virtual	~CNTV2MacDriverInterface ()
	My destructor. More...

virtual bool	WriteRegister (const ULWord inRegNum, const ULWord inValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
	Updates or replaces all or part of the 32-bit contents of a specific register (real or virtual) on the AJA device. Using the optional mask and shift parameters, it's possible to set or clear any number of specific bits in a real register without altering any of the register's other bits. More...

virtual bool	ReadRegister (const ULWord inRegNum, ULWord &outValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
	Reads all or part of the 32-bit contents of a specific register (real or virtual) on the AJA device. Using the optional mask and shift parameters, it's possible to read any number of specific bits in a register while ignoring the register's other bits. More...

virtual bool	AcquireStreamForApplication (ULWord inApplicationType, int32_t inProcessID)
	Reserves exclusive use of the AJA device for a given process, preventing other processes on the host from acquiring it until subsequently released. More...

virtual bool	ReleaseStreamForApplication (ULWord inApplicationType, int32_t inProcessID)
	Releases exclusive use of the AJA device for the given process, permitting other processes to acquire it. More...

virtual bool	AcquireStreamForApplicationWithReference (ULWord inApplicationType, int32_t inProcessID)
	A reference-counted version of CNTV2DriverInterface::AcquireStreamForApplication useful for process groups. More...

virtual bool	ReleaseStreamForApplicationWithReference (ULWord inApplicationType, int32_t inProcessID)
	A reference-counted version of CNTV2DriverInterface::ReleaseStreamForApplication useful for process groups. More...

virtual bool	SetStreamingApplication (const ULWord appType, const int32_t pid)
	Sets the four-CC type and process ID of the application that should "own" the AJA device (i.e. reserve it for exclusive use). More...

virtual bool	GetStreamingApplication (ULWord &outAppType, int32_t &outProcessID)
	Answers with the four-CC type and process ID of the application that currently "owns" the AJA device (i.e. reserved it for exclusive use). More...

virtual bool	WaitForInterrupt (const INTERRUPT_ENUMS type, const ULWord timeout=50)

virtual bool	GetInterruptCount (const INTERRUPT_ENUMS eInterrupt, ULWord &outCount)
	Answers with the number of interrupts of the given type processed by the driver. More...

virtual bool	WaitForChangeEvent (UInt32 timeout=0)

virtual bool	DmaTransfer (const NTV2DMAEngine inDMAEngine, const bool inIsRead, const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inByteCount, const bool inSynchronous=(!(0)))
	Transfers data between the AJA device and the host. This function will block and not return to the caller until the transfer has finished or failed. More...

virtual bool	DmaTransfer (const NTV2DMAEngine inDMAEngine, const bool inIsRead, const ULWord inFrameNumber, ULWord *pFrameBuffer, const ULWord inCardOffsetBytes, const ULWord inByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch, const bool inSynchronous=(!(0)))
	Transfers data in segments between the AJA device and the host. This function will block and not return to the caller until the transfer has finished or failed. More...

virtual bool	DmaTransfer (const NTV2DMAEngine inDMAEngine, const NTV2Channel inDMAChannel, const bool inIsTarget, const ULWord inFrameNumber, const ULWord inCardOffsetBytes, const ULWord inByteCount, const ULWord inNumSegments, const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch, const PCHANNEL_P2P_STRUCT &inP2PData)

virtual bool	AutoCirculate (AUTOCIRCULATE_DATA &autoCircData)
	Sends an AutoCirculate command to the NTV2 driver. More...

virtual bool	NTV2Message (NTV2_HEADER *pInMessage)
	Sends a message to the NTV2 driver (the new, improved, preferred way). More...

virtual bool	ControlDriverDebugMessages (NTV2_DriverDebugMessageSet, bool)

virtual bool	RestoreHardwareProcampRegisters (void)

Public Member Functions inherited from CNTV2DriverInterface
virtual ULWord	GetNumFrameBuffers (void) const

virtual ULWord	GetFrameBufferSize (void) const

virtual bool	DriverGetBitFileInformation (BITFILE_INFO_STRUCT &outBitFileInfo, const NTV2BitFileType inBitFileType=NTV2_VideoProcBitFile)
	Answers with the currently-installed bitfile information. More...

virtual bool	DriverGetBuildInformation (BUILD_INFO_STRUCT &outBuildInfo)
	Answers with the driver's build information. More...

virtual bool	GetPackageInformation (PACKAGE_INFO_STRUCT &outPkgInfo)
	Answers with the IP device's package information. More...

virtual bool	BitstreamWrite (const NTV2Buffer &inBuffer, const bool inFragment, const bool inSwap)

virtual bool	BitstreamReset (const bool inConfiguration, const bool inInterface)

virtual bool	BitstreamStatus (NTV2ULWordVector &outRegValues)

virtual bool	BitstreamLoad (const bool inSuspend, const bool inResume)

virtual bool	StreamChannelOps (const NTV2Channel inChannel, ULWord flags, NTV2StreamChannel &status)

virtual bool	StreamBufferOps (const NTV2Channel inChannel, NTV2Buffer &inBuffer, ULWord64 bufferCookie, ULWord flags, NTV2StreamBuffer &status)

virtual bool	ReadRP188Registers (const NTV2Channel inChannel, RP188_STRUCT *pRP188Data)

virtual NTV2Dictionary	ConnectParams (void) const

virtual bool	SuspendAudio (void)

virtual bool	ResumeAudio (const ULWord inFBSize)

virtual bool	ReadRegisterMulti (const ULWord numRegs, ULWord *pOutWhichRegFailed, NTV2RegInfo aRegs[])

virtual Word	SleepMs (const LWord msec)

virtual NTV2DeviceID	GetDeviceID (void)

virtual bool	IsDeviceReady (const bool inCheckValid=(0))

virtual bool	IsMBSystemValid (void)

virtual bool	IsMBSystemReady (void)

virtual bool	Open (const UWord inDeviceIndex)
	Opens a local/physical AJA device so it can be monitored/controlled. More...

virtual bool	Open (const std::string &inURLSpec)
	Opens the specified local, remote or software device. More...

virtual bool	Close (void)
	Closes me, releasing host resources that may have been allocated in a previous Open call. More...

template<typename T >
bool	ReadRegister (const ULWord inRegNum, T &outValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0)
	This template function reads all or part of the 32-bit contents of a specific register (real or virtual) from the AJA device, and if successful, returns its value automatically casted to the scalar type of the "outValue" parameter. More...

virtual bool	ReadRegisters (NTV2RegisterReads &inOutValues)
	Reads the register(s) specified by the given NTV2RegInfo sequence. More...

virtual bool	ConfigureSubscription (const bool bSubscribe, const INTERRUPT_ENUMS inInterruptType, PULWord &outSubcriptionHdl)

virtual HANDLE	GetInterruptEvent (const INTERRUPT_ENUMS eInterruptType)

virtual bool	GetInterruptEventCount (const INTERRUPT_ENUMS inEventCode, ULWord &outCount)
	Answers with the number of interrupt events that I successfully waited for. More...

virtual bool	SetInterruptEventCount (const INTERRUPT_ENUMS inEventCode, const ULWord inCount)
	Resets my interrupt event tally for the given interrupt type. (This is my count of the number of successful event waits.) More...

virtual bool	HevcSendMessage (HevcMessageHeader *pMessage)
	Sends an HEVC message to the NTV2 driver. More...

virtual bool	IsSupported (const NTV2BoolParamID inParamID)

virtual ULWord	GetNumSupported (const NTV2NumericParamID inParamID)

virtual ULWordSet	GetSupportedItems (const NTV2EnumsID inEnumsID)

virtual bool	GetRecordedRegisterWrites (NTV2RegisterWrites &outRegWrites) const
	Answers with the recorded register writes. More...

virtual bool	StartRecordRegisterWrites (const bool inSkipActualWrites=(0))
	Starts recording all WriteRegister calls. More...

virtual bool	IsRecordingRegisterWrites (void) const

virtual bool	StopRecordRegisterWrites (void)
	Stops recording all WriteRegister calls. More...

virtual bool	PauseRecordRegisterWrites (void)
	Pauses recording WriteRegister calls. More...

virtual bool	ResumeRecordRegisterWrites (void)
	Resumes recording WriteRegister calls (after a prior call to PauseRecordRegisterWrites). More...

virtual ULWord	GetNumRecordedRegisterWrites (void) const

	CNTV2DriverInterface ()
	My default constructor. More...

virtual	~CNTV2DriverInterface ()
	My destructor. More...

Static Public Member Functions
static NTV2VideoFormat	GetNTV2VideoFormat (NTV2FrameRate frameRate, UByte inputGeometry, bool progressiveTransport, bool isThreeG, bool progressivePicture=(0))

static NTV2VideoFormat	GetNTV2VideoFormat (NTV2FrameRate frameRate, NTV2Standard standard, bool isThreeG, UByte inputGeometry=0, bool progressivePicture=(0), bool isSquareDivision=(!(0)))

static std::string	SerialNum64ToString (const uint64_t inSerialNumber)
	Returns a string containing the decoded, human-readable device serial number. More...

Static Public Member Functions inherited from CNTV2DriverInterface
static NTV2StringList	GetLegalSchemeNames (void)

static void	SetShareMode (const bool inSharedMode)
	Specifies if subsequent Open calls should open the device in shared mode or not. More...

static bool	GetShareMode (void)

static void	SetOverlappedMode (const bool inOverlapMode)
	Specifies if the next Open call should try to open the device in overlapped mode or not. More...

static bool	GetOverlappedMode (void)

Protected Member Functions
virtual ULWord	GetSerialNumberLow (void)

virtual ULWord	GetSerialNumberHigh (void)

virtual bool	IS_CHANNEL_VALID (const NTV2Channel inChannel) const

virtual bool	IS_CHANNEL_INVALID (const NTV2Channel inChannel) const

virtual bool	IS_OUTPUT_SPIGOT_INVALID (const UWord inOutputSpigot)

virtual bool	IS_INPUT_SPIGOT_INVALID (const UWord inInputSpigot)

virtual bool	IS_HDMI_INPUT_SPIGOT_INVALID (const UWord inInputHDMIPort)

virtual bool	SetWarmBootFirmwareReload (bool enable)

virtual bool	S2110DeviceAncToXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER &inOutXferInfo)

virtual bool	S2110DeviceAncToBuffers (const NTV2Channel inChannel, NTV2Buffer &ancF1, NTV2Buffer &ancF2)

virtual bool	S2110DeviceAncFromXferBuffers (const NTV2Channel inChannel, AUTOCIRCULATE_TRANSFER &inOutXferInfo)

virtual bool	S2110DeviceAncFromBuffers (const NTV2Channel inChannel, NTV2Buffer &ancF1, NTV2Buffer &ancF2)

virtual bool	WriteSDIInVPID (const NTV2Channel inChannel, const ULWord inValA, const ULWord inValB)

Protected Member Functions inherited from CNTV2MacDriverInterface
virtual bool	OpenLocalPhysical (const UWord inDeviceIndex)
	Opens the local/physical device connection. More...

virtual bool	CloseLocalPhysical (void)
	Releases host resources associated with the local/physical device connection. More...

Protected Member Functions inherited from CNTV2DriverInterface
virtual bool	OpenRemote (const std::string &inURLSpec)
	Peforms the housekeeping details of opening the specified local, remote or software device. More...

virtual bool	CloseRemote (void)
	Releases host resources associated with the remote/special device connection. More...

virtual bool	ParseFlashHeader (BITFILE_INFO_STRUCT &outBitfileInfo)

virtual bool	GetBoolParam (const ULWord inParamID, ULWord &outValue)

virtual bool	GetNumericParam (const ULWord inParamID, ULWord &outValue)

virtual bool	GetRegInfoForBoolParam (const NTV2BoolParamID inParamID, NTV2RegInfo &outRegInfo)
	Answers with the NTV2RegInfo of the register associated with the given boolean (i.e., "Can Do") device feature. More...

virtual bool	GetRegInfoForNumericParam (const NTV2NumericParamID inParamID, NTV2RegInfo &outRegInfo)
	Answers with the NTV2RegInfo of the register associated with the given numeric (i.e., "Get Num") device feature. More...

virtual void	BumpEventCount (const INTERRUPT_ENUMS eInterruptType)
	Atomically increments the event count tally for the given interrupt type. More...

virtual void	FinishOpen (void)
	Initializes my member variables after a successful Open. More...

virtual bool	ReadFlashULWord (const ULWord inAddress, ULWord &outValue, const ULWord inRetryCount=1000)

Static Protected Attributes
static NTV2Buffer	NULL_POINTER
	Used for default empty NTV2Buffer parameters – do not modify. More...

CSCs, LUTs & Color Correction
virtual bool	SetColorSpaceMethod (const NTV2ColorSpaceMethod inCSCMethod, const NTV2Channel inChannel)
	Selects the color space converter operation method. More...

virtual bool	GetColorSpaceMethod (NTV2ColorSpaceMethod &outMethod, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the current operating mode of the given color space converter. More...

virtual bool	SetColorSpaceMatrixSelect (const NTV2ColorSpaceMatrixType inType, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the matrix type to be used for the given CSC, typically NTV2_Rec601Matrix or NTV2_Rec709Matrix. More...

virtual bool	GetColorSpaceMatrixSelect (NTV2ColorSpaceMatrixType &outType, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the current matrix type being used for the given CSC. More...

virtual bool	DownloadLUTToHW (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT, const NTV2Channel inLUT, const int inBank)
	Sends the given color lookup tables (LUTs) to the given LUT and bank. More...

virtual bool	Download12BitLUTToHW (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT, const NTV2Channel inLUT, const int inBank)

virtual bool	DownloadLUTToHW (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT, const NTV2Channel inLUT, const int inBank)
	Writes the LUT tables to the given LUT and bank. More...

virtual bool	Download12BitLUTToHW (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT, const NTV2Channel inLUT, const int inBank)

virtual bool	SetLUTEnable (const bool inEnable, const NTV2Channel inLUT)
	Enables or disables the given LUT. More...

virtual bool	LoadLUTTables (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT)
	Writes the LUT tables. More...

virtual bool	Load12BitLUTTables (const NTV2DoubleArray &inRedLUT, const NTV2DoubleArray &inGreenLUT, const NTV2DoubleArray &inBlueLUT)

virtual bool	WriteLUTTables (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT)
	Writes the LUT tables. More...

virtual bool	Write12BitLUTTables (const UWordSequence &inRedLUT, const UWordSequence &inGreenLUT, const UWordSequence &inBlueLUT)

virtual bool	GetLUTTables (NTV2DoubleArray &outRedLUT, NTV2DoubleArray &outGreenLUT, NTV2DoubleArray &outBlueLUT)
	Reads the LUT tables (as double-precision floating point values). More...

virtual bool	Get12BitLUTTables (NTV2DoubleArray &outRedLUT, NTV2DoubleArray &outGreenLUT, NTV2DoubleArray &outBlueLUT)

virtual bool	ReadLUTTables (UWordSequence &outRedLUT, UWordSequence &outGreenLUT, UWordSequence &outBlueLUT)
	Reads the LUT tables (as raw, unsigned 10-bit integers). More...

virtual bool	Read12BitLUTTables (UWordSequence &outRedLUT, UWordSequence &outGreenLUT, UWordSequence &outBlueLUT)

virtual bool	SetLUTV2HostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue)

virtual bool	GetLUTV2HostAccessBank (NTV2ColorCorrectionHostAccessBank &outValue, const NTV2Channel inChannel)

virtual bool	SetLUTV2OutputBank (const NTV2Channel inLUTWidget, const ULWord inBank)

virtual bool	GetLUTV2OutputBank (const NTV2Channel inLUTWidget, ULWord &outBank)

virtual bool	Has12BitLUTSupport (void)

virtual bool	Set12BitLUTPlaneSelect (const NTV2LUTPlaneSelect inLUTPlane)
	Sets the LUT plane. More...

virtual bool	Get12BitLUTPlaneSelect (NTV2LUTPlaneSelect &outLUTPlane)
	Answers with the current LUT plane. More...

virtual bool	SetColorSpaceRGBBlackRange (const NTV2_CSC_RGB_Range inRange, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the RGB range for the given CSC. More...

virtual bool	GetColorSpaceRGBBlackRange (NTV2_CSC_RGB_Range &outRange, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the current RGB range being used by a given CSC. More...

virtual bool	SetColorSpaceUseCustomCoefficient (const ULWord inUseCustomCoefficient, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetColorSpaceUseCustomCoefficient (ULWord &outUseCustomCoefficient, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetColorSpaceMakeAlphaFromKey (const bool inMakeAlphaFromKey, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Specifies whether or not the given CSC will produce alpha channel data from its key input. More...

virtual bool	GetColorSpaceMakeAlphaFromKey (ULWord &outMakeAlphaFromKey, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers whether or not the given CSC is set to produce alpha channel data from its key input. More...

virtual bool	GetColorSpaceVideoKeySyncFail (bool &outVideoKeySyncFail, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers whether or not the video signal present at the CSC’s Key Input is in sync with the video signal present at its Video Input. More...

virtual bool	SetColorSpaceCustomCoefficients (const NTV2CSCCustomCoeffs &inCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetColorSpaceCustomCoefficients (NTV2CSCCustomCoeffs &outCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetColorSpaceCustomCoefficients12Bit (const NTV2CSCCustomCoeffs &inCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetColorSpaceCustomCoefficients12Bit (NTV2CSCCustomCoeffs &outCustomCoefficients, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetLUTControlSelect (const NTV2LUTControlSelect inLUTSelect)

virtual bool	GetLUTControlSelect (NTV2LUTControlSelect &outLUTSelect)

virtual bool	SetColorCorrectionMode (const NTV2Channel inChannel, const NTV2ColorCorrectionMode inMode)

virtual bool	GetColorCorrectionMode (const NTV2Channel inChannel, NTV2ColorCorrectionMode &outMode)

virtual bool	SetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, const ULWord inBank)
	Sets the LUT bank to be used for the given LUT. More...

virtual bool	GetColorCorrectionOutputBank (const NTV2Channel inLUTWidget, ULWord &outBank)
	Answers with the current LUT bank in use for the given LUT. More...

virtual bool	SetColorCorrectionHostAccessBank (const NTV2ColorCorrectionHostAccessBank inValue)

virtual bool	GetColorCorrectionHostAccessBank (NTV2ColorCorrectionHostAccessBank &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetColorCorrectionSaturation (const NTV2Channel inChannel, const ULWord inValue)

virtual bool	GetColorCorrectionSaturation (const NTV2Channel inChannel, ULWord &outValue)

virtual bool	SetDitherFor8BitInputs (const NTV2Channel inChannel, const ULWord inDither)

virtual bool	GetDitherFor8BitInputs (const NTV2Channel inChannel, ULWord &outDither)

virtual NTV2ColorSpaceMethod	GetColorSpaceMethod (const NTV2Channel inChannel)

virtual bool	DownloadLUTToHW (const double *pInTable, const NTV2Channel inChannel, const int inBank)

virtual bool	LoadLUTTable (const double *pInTable)

static bool	GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, NTV2DoubleArray &outTable, const NTV2LutBitDepth inBitDepth=NTV2_LUT10Bit)

static bool	GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, UWordSequence &outTable, const NTV2LutBitDepth inBitDepth=NTV2_LUT10Bit)

static bool	GenerateGammaTable (const NTV2LutType inLUTType, const int inBank, double *pOutTable)

HDMI
virtual bool	GetHDMIInputColor (NTV2LHIHDMIColorSpace &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the current colorspace for the given HDMI input. More...

virtual bool	SetHDMIInputRange (const NTV2HDMIRange inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the given HDMI input's input range. More...

virtual bool	GetHDMIInputRange (NTV2HDMIRange &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's current input range setting. More...

virtual bool	GetHDMIInputAudioChannels (NTV2HDMIAudioChannels &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the current number of audio channels being received on the given HDMI input. More...

virtual bool	SetHDMIInColorSpace (const NTV2HDMIColorSpace inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the given HDMI input's color space. More...

virtual bool	GetHDMIInColorSpace (NTV2HDMIColorSpace &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's current color space setting. More...

virtual bool	GetHDMIInProtocol (NTV2HDMIProtocol &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's protocol. More...

virtual bool	GetHDMIInIsLocked (bool &outIsLocked, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers if the given HDMI input is genlocked or not. More...

virtual bool	SetHDMIInAudioSampleRateConverterEnable (const bool inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	GetHDMIInAudioSampleRateConverterEnable (bool &outIsEnabled, const NTV2Channel inChannel=NTV2_CHANNEL1)

virtual bool	SetHDMIInBitDepth (const NTV2HDMIBitDepth inNewValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the given HDMI input's bit depth. More...

virtual bool	GetHDMIInBitDepth (NTV2HDMIBitDepth &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's current bit depth setting. More...

virtual bool	GetHDMIInAudioChannel34Swap (bool &outIsSwapped, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's current audio channel 3/4 swap setting. More...

virtual bool	SetHDMIInAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Sets the given HDMI input's audio channel 3/4 swap state. More...

virtual bool	GetHDMIInVideoRange (NTV2HDMIRange &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's video black/white range. More...

virtual bool	GetHDMIInDynamicRange (HDRRegValues &outRegValues, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's video dynamic range and mastering information. More...

virtual bool	GetHDMIInDynamicRange (HDRFloatValues &outFloatValues, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's video dynamic range and mastering information. More...

virtual bool	GetHDMIInColorimetry (NTV2HDMIColorimetry &outColorimetry, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's current colorimetry. More...

virtual bool	GetHDMIInDolbyVision (bool &outIsDolbyVision, const NTV2Channel inChannel=NTV2_CHANNEL1)
	Answers with the given HDMI input's Dolby Vision flag is set. More...

virtual bool	SetHDMIOut3DPresent (const bool inIs3DPresent)

virtual bool	GetHDMIOut3DPresent (bool &outIs3DPresent)

virtual bool	SetHDMIOut3DMode (const NTV2HDMIOut3DMode inValue)

virtual bool	GetHDMIOut3DMode (NTV2HDMIOut3DMode &outValue)

virtual bool	SetHDMIV2TxBypass (const bool inBypass)

virtual bool	SetHDMIOutVideoStandard (const NTV2Standard inNewValue)

virtual bool	GetHDMIOutVideoStandard (NTV2Standard &outValue)

virtual bool	SetHDMIOutSampleStructure (const NTV2HDMISampleStructure inNewValue)

virtual bool	GetHDMIOutSampleStructure (NTV2HDMISampleStructure &outValue)

virtual bool	SetHDMIOutVideoFPS (const NTV2FrameRate inNewValue)

virtual bool	GetHDMIOutVideoFPS (NTV2FrameRate &outValue)

virtual bool	SetHDMIOutRange (const NTV2HDMIRange inNewValue)

virtual bool	GetHDMIOutRange (NTV2HDMIRange &outValue)

virtual bool	SetHDMIOutAudioChannels (const NTV2HDMIAudioChannels inNewValue)

virtual bool	GetHDMIOutAudioChannels (NTV2HDMIAudioChannels &outValue)

virtual bool	SetHDMIOutColorSpace (const NTV2HDMIColorSpace inNewValue)

virtual bool	GetHDMIOutColorSpace (NTV2HDMIColorSpace &outValue)

virtual bool	SetLHIHDMIOutColorSpace (const NTV2LHIHDMIColorSpace inNewValue)

virtual bool	GetLHIHDMIOutColorSpace (NTV2LHIHDMIColorSpace &outValue)

virtual bool	SetHDMIOutBitDepth (const NTV2HDMIBitDepth inNewValue)

virtual bool	GetHDMIOutBitDepth (NTV2HDMIBitDepth &outValue)

virtual bool	SetHDMIOutProtocol (const NTV2HDMIProtocol inNewValue)

virtual bool	GetHDMIOutProtocol (NTV2HDMIProtocol &outValue)

virtual bool	SetHDMIOutForceConfig (const bool inNewValue)

virtual bool	GetHDMIOutForceConfig (bool &outValue)

virtual bool	SetHDMIOutPrefer420 (const bool inNewValue)

virtual bool	GetHDMIOutPrefer420 (bool &outValue)

virtual bool	GetHDMIOutDownstreamBitDepth (NTV2HDMIBitDepth &outValue)

virtual bool	GetHDMIOutDownstreamColorSpace (NTV2LHIHDMIColorSpace &outValue)

virtual bool	SetHDMIOutAudioSource2Channel (const NTV2AudioChannelPair inNewValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Sets the HDMI output's 2-channel audio source. More...

virtual bool	GetHDMIOutAudioSource2Channel (NTV2AudioChannelPair &outValue, NTV2AudioSystem &outAudioSystem)
	Answers with the HDMI output's current 2-channel audio source. More...

virtual bool	SetHDMIOutAudioSource8Channel (const NTV2Audio8ChannelSelect inNewValue, const NTV2AudioSystem inAudioSystem=NTV2_AUDIOSYSTEM_1)
	Changes the HDMI output's 8-channel audio source. More...

virtual bool	GetHDMIOutAudioSource8Channel (NTV2Audio8ChannelSelect &outValue, NTV2AudioSystem &outAudioSystem)
	Answers with the HDMI output's current 8-channel audio source. More...

virtual bool	GetHDMIOutAudioChannel34Swap (bool &outIsSwapped, const NTV2Channel inWhichHDMIOut=NTV2_CHANNEL1)
	Answers with the HDMI output's current audio channel 3/4 swap setting. More...

virtual bool	SetHDMIOutAudioChannel34Swap (const bool inIsSwapped, const NTV2Channel inWhichHDMIOut=NTV2_CHANNEL1)
	Sets the HDMI output's audio channel 3/4 swap state. More...

virtual bool	SetHDMIOutAudioRate (const NTV2AudioRate inNewValue)
	Sets the HDMI output's audio rate. More...

virtual bool	GetHDMIOutAudioRate (NTV2AudioRate &outValue)
	Answers with the HDMI output's current audio rate. More...

virtual bool	SetHDMIOutAudioFormat (const NTV2AudioFormat inNewValue)
	Sets the HDMI output's audio format. More...

virtual bool	GetHDMIOutAudioFormat (NTV2AudioFormat &outValue)
	Answers with the HDMI output's current audio format. More...

virtual bool	EnableHDMIOutUserOverride (const bool inEnable)
	Enables or disables override of HDMI parameters. More...

virtual bool	GetEnableHDMIOutUserOverride (bool &outIsEnabled)
	Answers if override of HDMI parameters is enabled or not. More...

virtual bool	EnableHDMIOutCenterCrop (const bool inEnable)
	Controls the 4k/2k -> UHD/HD HDMI center cropping feature. More...

virtual bool	GetEnableHDMIOutCenterCrop (bool &outIsEnabled)
	Answers if the HDMI 4k/2k -> UHD/HD center cropping is enabled or not. More...

virtual bool	SetHDMIOutDecimateMode (const bool inEnable)
	Enables or disables decimate mode on the device's HDMI rasterizer, which halves the output frame rate when enabled. This allows a 60 Hz video stream to be displayed on a 30 Hz HDMI monitor. More...

virtual bool	GetHDMIOutDecimateMode (bool &outIsEnabled)

virtual bool	SetHDMIOutTsiIO (const bool inTsiEnable)
	Enables or disables two sample interleave I/O mode on the device's HDMI rasterizer. More...

virtual bool	GetHDMIOutTsiIO (bool &tsiEnabled)

virtual bool	SetHDMIOutLevelBMode (const bool inEnable)
	Enables or disables level-B mode on the device's HDMI rasterizer. More...

virtual bool	GetHDMIOutLevelBMode (bool &outIsEnabled)

virtual bool	SetHDMIV2Mode (const NTV2HDMIV2Mode inMode)
	Sets HDMI V2 mode for the device. More...

virtual bool	GetHDMIV2Mode (NTV2HDMIV2Mode &outMode)
	Answers with the current HDMI V2 mode of the device. More...

virtual bool	GetHDMIOutStatus (NTV2HDMIOutputStatus &outStatus)
	Answers with the current HDMI output status. More...

virtual bool	GetHDMIInputStatus (ULWord &outValue, const NTV2Channel inChannel=NTV2_CHANNEL1, const bool in12BitDetection=(0))
	Answers with the contents of the HDMI Input status register for the given HDMI input. More...

virtual bool	GetHDMIInputStatusRegNum (ULWord &outRegNum, const NTV2Channel inChannel=NTV2_CHANNEL1, const bool in12BitDetection=(0))
	Answers with the HDMI Input status register number for the given HDMI input. More...

Ancillary Data
virtual bool	AncSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size)
	Sets the capacity of the SDI ANC or HDMI AUX buffers in device frame memory. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncInsertInit (const UWord inSDIOutput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
	Initializes the given SDI output's Anc inserter for custom Anc packet insertion. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncInsertSetComponents (const UWord inSDIOutput, const bool inVancY, const bool inVancC, const bool inHancY, const bool inHancC)
	Enables or disables individual Anc insertion components for the given SDI output. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncInsertSetEnable (const UWord inSDIOutput, const bool inIsEnabled)
	Enables or disables the given SDI output's Anc inserter frame buffer reads. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncInsertIsEnabled (const UWord inSDIOutput, bool &outIsEnabled)
	Answers with the run state of the given Anc inserter – i.e. if its "memory reader" is enabled or not. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncInsertSetReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF1Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
	Configures the Anc inserter for the next frame's F1 Anc data to embed/transmit. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncInsertSetField2ReadParams (const UWord inSDIOutput, const ULWord inFrameNumber, const ULWord inF2Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
	Configures the Anc inserter for the next frame's F2 Anc data to embed/transmit. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncInsertSetIPParams (const UWord inSDIOutput, const UWord ancChannel, const ULWord payloadID, const ULWord ssrc)
	Configures the Anc inserter IP specific params. More...

virtual bool	AncInsertGetReadInfo (const UWord inSDIOutput, uint64_t &outF1StartAddr, uint64_t &outF2StartAddr)
	Answers where, in device SDRAM, the given SDI connector's Anc inserter is currently reading Anc data for playout. More...

virtual bool	AncExtractInit (const UWord inSDIInput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
	Initializes the given SDI input's Anc extractor for custom Anc packet detection and de-embedding. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.) More...

virtual bool	AncExtractSetComponents (const UWord inSDIInput, const bool inVancY, const bool inVancC, const bool inHancY, const bool inHancC)
	Enables or disables the Anc extraction components for the given SDI input. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.) More...

virtual bool	AncExtractSetEnable (const UWord inSDIInput, const bool inIsEnabled)
	Enables or disables the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.) More...

virtual bool	AncExtractIsEnabled (const UWord inSDIInput, bool &outIsEnabled)
	Answers whether the given SDI input's Anc extractor is enabled/active or not. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncExtractSetWriteParams (const UWord inSDIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
	Configures the given SDI input's Anc extractor to receive the next frame's F1 Anc data. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncExtractSetField2WriteParams (const UWord inSDIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
	Configures the given SDI input's Anc extractor to receive the next frame's F2 Anc data. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncExtractGetWriteInfo (const UWord inSDIInput, uint64_t &outF1StartAddr, uint64_t &outF1EndAddr, uint64_t &outF2StartAddr, uint64_t &outF2EndAddr)
	Answers with the given SDI input's current Anc extractor info. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.) More...

virtual bool	AncExtractGetFilterDIDs (const UWord inSDIInput, NTV2DIDSet &outDIDs)
	Answers with the DIDs currently being excluded (filtered) by the SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncExtractSetFilterDIDs (const UWord inSDIInput, const NTV2DIDSet &inDIDs)
	Replaces the DIDs to be excluded (filtered) by the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncExtractGetField1Size (const UWord inSDIInput, ULWord &outF1Size)
	Answers with the number of bytes of field 1 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncExtractGetField2Size (const UWord inSDIInput, ULWord &outF2Size)
	Answers with the number of bytes of field 2 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncExtractGetBufferOverrun (const UWord inSDIInput, bool &outIsOverrun, const UWord inField=0)
	Answers whether or not the given SDI input's Anc extractor reached its buffer limits. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

virtual bool	AncExtractIsProgressive (const UWord inSDIInput, bool &outIsProgressive)
	Answers whether or not the given SDI input's Anc extractor was configured with a progressive video format. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.) More...

static UWord	AncExtractGetMaxNumFilterDIDs (void)

static NTV2DIDSet	AncExtractGetDefaultDIDs (const bool inHDAudio=(!(0)))

Auxillary Data
virtual bool	AuxSetFrameBufferSize (const ULWord inF1Size, const ULWord inF2Size)
	Sets the capacity of the HDMI AUX buffers in device frame memory. More...

virtual bool	AuxInsertInit (const UWord inHDMIOutput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
	Initializes the given HDMI output's Aux inserter for custom Aux packet insertion. More...

virtual bool	AuxInsertSetComponents (const UWord inHDMIOutput, const bool inVauxY, const bool inVauxC, const bool inHauxY, const bool inHauxC)
	Enables or disables individual Aux insertion components for the given HDMI output. More...

virtual bool	AuxInsertSetEnable (const UWord inHDMIOutput, const bool inIsEnabled)
	Enables or disables the given HDMI output's Aux inserter frame buffer reads. More...

virtual bool	AuxInsertIsEnabled (const UWord inHDMIOutput, bool &outIsEnabled)
	Answers with the run state of the given Aux inserter – i.e. if its "memory reader" is enabled or not. More...

virtual bool	AuxInsertSetReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF1Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
	Configures the Aux inserter for the next frame's F1 Aux data to embed/transmit. More...

virtual bool	AuxInsertSetField2ReadParams (const UWord inHDMIOutput, const ULWord inFrameNumber, const ULWord inF2Size, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)
	Configures the Aux inserter for the next frame's F2 Aux data to embed/transmit. More...

virtual bool	AuxInsertSetIPParams (const UWord inHDMIOutput, const UWord auxChannel, const ULWord payloadID, const ULWord ssrc)
	Configures the Aux inserter IP specific params. More...

virtual bool	AuxInsertGetReadInfo (const UWord inHDMIOutput, uint64_t &outF1StartAddr, uint64_t &outF2StartAddr)
	Answers where, in device SDRAM, the given HDMI connector's Aux inserter is currently reading Aux data for playout. More...

virtual bool	AuxExtractInit (const UWord inHDMIInput, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
	Initializes the given HDMI input's Aux extractor for custom Aux packet detection and de-embedding. More...

virtual bool	AuxExtractSetEnable (const UWord inHDMIInput, const bool inIsEnabled)
	Enables or disables the given HDMI input's Aux extractor. More...

virtual bool	AuxExtractIsEnabled (const UWord inHDMIInput, bool &outIsEnabled)
	Answers whether the given HDMI input's Aux extractor is enabled/active or not. More...

virtual bool	AuxExtractSetWriteParams (const UWord inHDMIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)

virtual bool	AuxExtractSetField2WriteParams (const UWord inHDMIInput, const ULWord inFrameNumber, const NTV2Channel inChannel=NTV2_CHANNEL_INVALID, const NTV2Framesize inFrameSize=NTV2_FRAMESIZE_INVALID)

virtual bool	AuxExtractGetWriteInfo (const UWord inHDMIInput, uint64_t &outF1StartAddr, uint64_t &outF1EndAddr, uint64_t &outF2StartAddr, uint64_t &outF2EndAddr)
	Answers with the given HDMI input's current Aux extractor info. More...

virtual bool	AuxExtractGetField1Size (const UWord inHDMIInput, ULWord &outF1Size)
	Answers with the number of bytes of field 1 ANC extracted. More...

virtual bool	AuxExtractGetField2Size (const UWord inHDMIInput, ULWord &outF2Size)
	Answers with the number of bytes of field 2 HDMI AUX data extracted. More...

virtual bool	AuxExtractGetPacketFilters (const UWord inHDMIInput, NTV2DIDSet &outDIDs)
	Answers with the HDMI packet types currently being excluded (filtered) by the HDMI input's Aux extractor. More...

virtual bool	AuxExtractSetPacketFilters (const UWord inHDMIInput, const NTV2DIDSet &inDIDs)
	Replaces the HDMI packet types to be excluded (filtered) by the given HDMI input's Aux extractor. More...

virtual bool	AuxExtractSetFilterInclusionMode (const UWord inHDMIInput, const bool inEnable)
	Enables or disables HDMI AUX packet filtering for the given HDMI input. More...

virtual bool	AuxExtractGetFilterInclusionMode (const UWord inHDMIInput, bool &outEnabled)
	Answers whether or not HDMI AUX packet filtering is enabled for the given HDMI input. More...

virtual bool	AuxExtractGetBufferOverrun (const UWord inHDMIInput, bool &outIsOverrun, const UWord inField=0)
	Answers whether or not the given HDMI input's Aux extractor reached its buffer limits. More...

virtual bool	AuxExtractIsProgressive (const UWord inHDMIInput, bool &outIsProgressive)
	Answers whether or not the given HDMI input's Aux extractor was configured with a progressive video format. More...

static UWord	AuxExtractGetMaxNumPacketFilters (void)

static NTV2DIDSet	AuxExtractGetDefaultPacketFilters (void)

Additional Inherited Members
Protected Types inherited from CNTV2DriverInterface
typedef std::vector< ULWord >	_EventCounts

typedef std::vector< PULWord >	_EventHandles

Protected Attributes inherited from CNTV2DriverInterface
UWord	_boardNumber
	My device index number. More...

NTV2DeviceID	_boardID
	My cached device ID. More...

bool	_boardOpened
	True if I'm open and connected to the device. More...

bool	mRecordRegWrites
	True if recording; otherwise false when not recording. More...

bool	mSkipRegWrites
	True if actual register writes are skipped while recording. More...

ULWord	_programStatus

NTV2RPCAPI *	_pRPCAPI
	Points to remote or software device interface; otherwise NULL for local physical device. More...

_EventHandles	mInterruptEventHandles
	For subscribing to each possible event, one for each interrupt type. More...

_EventCounts	mEventCounts
	My event tallies, one for each interrupt type. Note that these. More...

NTV2RegisterWrites	mRegWrites
	Stores WriteRegister data. More...

AJALock	mRegWritesLock
	Guard mutex for mRegWrites. More...

ULWord *	_pFrameBaseAddress

ULWord *	_pRegisterBaseAddress

ULWord	_pRegisterBaseAddressLength

ULWord *	_pXena2FlashBaseAddress

ULWord *	_pCh1FrameBaseAddress

ULWord *	_pCh2FrameBaseAddress

ULWord	_ulNumFrameBuffers

ULWord	_ulFrameBufferSize

ULWord	_pciSlot

Detailed Description

I interrogate and control an AJA video/audio capture/playout device.

Definition at line 28 of file ntv2card.h.

Member Enumeration Documentation

◆ ColorCorrectionColor

enum CNTV2Card::ColorCorrectionColor

Enumerator
RED
GREEN
BLUE
NUM_COLORS

Definition at line 6212 of file ntv2card.h.

Constructor & Destructor Documentation

◆ CNTV2Card() [1/2]

CNTV2Card::CNTV2Card ( )

My default constructor.

Definition at line 21 of file ntv2card.cpp.

◆ CNTV2Card() [2/2]

CNTV2Card::CNTV2Card	(	const UWord	inDeviceIndex,
		const std::string &	inHostName = `std::string()`
	)

explicit

Constructor that opens the device.

Parameters

[in]	inDeviceIndex	A zero-based index number that identifies which device to open, which should be the number received from the CNTV2DeviceScanner.
[in]	inHostName	If non-empty, must contain the name of a host that has one or more AJA devices. Defaults to empty string (the local host).

◆ ~CNTV2Card()

CNTV2Card::~CNTV2Card ( )

virtual

My destructor.

Definition at line 57 of file ntv2card.cpp.

Member Function Documentation

◆ AbortMailBoxLock()

bool CNTV2Card::AbortMailBoxLock ( void )

virtual

Definition at line 4502 of file ntv2register.cpp.

◆ AcquireMailBoxLock()

bool CNTV2Card::AcquireMailBoxLock ( void )

virtual

Definition at line 4488 of file ntv2register.cpp.

◆ AddDynamicBitfile()

bool CNTV2Card::AddDynamicBitfile ( const std::string & inBitfilePath )

virtual

Adds the given bitfile to the list of available dynamic bitfiles.

Parameters

[in] inBitfilePath A string containing the path to the bitfile.

Returns: True if added successfully; otherwise false.

Definition at line 215 of file ntv2dynamicdevice.cpp.

◆ AddDynamicDirectory()

bool CNTV2Card::AddDynamicDirectory ( const std::string & inDirectory )

virtual

Adds all bitfiles found in the given host file directory to the list of available dynamic bitfiles.

Parameters

[in] inDirectory A string containing the path to the directory.

Returns: True if successful; otherwise false.

Definition at line 220 of file ntv2dynamicdevice.cpp.

◆ AncExtractGetBufferOverrun()

bool CNTV2Card::AncExtractGetBufferOverrun	(	const UWord	inSDIInput,
		bool &	outIsOverrun,
		const UWord	inField = `0`
	)

virtual

Answers whether or not the given SDI input's Anc extractor reached its buffer limits. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[out]	outIsOverrun	Receives true if the extractor is reporting that it overran its buffer limits; otherwise false if it didn't.
[in]	inField	Optionally specifies the field of interest. Specify 0 for the "total" buffer overflow between the F1 and F2 buffers; specify 1 for Field 1; specify 2 for Field 2. Defaults to zero (the "total"). (Added in SDK 16.1)

Note: The extractor will not actually write any Anc bytes past its "stop" address, but it will report that it was about to via this "overrun" flag.

Definition at line 1016 of file ntv2anc.cpp.

◆ AncExtractGetDefaultDIDs()

NTV2DIDSet CNTV2Card::AncExtractGetDefaultDIDs ( const bool inHDAudio = (! (0) ) )

static

Returns: The default DIDs that the device Anc extractor filter is started with.

Parameters

[in] inHDAudio Optionally specifies the desired audio packet filtering. Specify true (the default) for the default HD audio packet DIDs; otherwise false for the default SD audio packet DIDs.

See also: CNTV2Card::AncExtractSetFilterDIDs, CNTV2Card::AncExtractGetMaxNumFilterDIDs, Ancillary Packet Filtering

Definition at line 1068 of file ntv2anc.cpp.

◆ AncExtractGetField1Size()

bool CNTV2Card::AncExtractGetField1Size	(	const UWord	inSDIInput,
		ULWord &	outF1Size
	)

virtual

Answers with the number of bytes of field 1 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[out]	outF1Size	Receives the number of bytes of field 1 ANC extracted;

Definition at line 974 of file ntv2anc.cpp.

◆ AncExtractGetField2Size()

bool CNTV2Card::AncExtractGetField2Size	(	const UWord	inSDIInput,
		ULWord &	outF2Size
	)

virtual

Answers with the number of bytes of field 2 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[out]	outF2Size	Receives the number of bytes of field 2 ANC extracted;

Definition at line 995 of file ntv2anc.cpp.

◆ AncExtractGetFilterDIDs()

bool CNTV2Card::AncExtractGetFilterDIDs	(	const UWord	inSDIInput,
		NTV2DIDSet &	outDIDs
	)

virtual

Answers with the DIDs currently being excluded (filtered) by the SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[out]	outDIDs	Receives the NTV2DIDSet that contain the DIDs that are currently being filtered (excluded).

See also: CNTV2Card::AncExtractSetFilterDIDs, Ancillary Packet Filtering

Definition at line 924 of file ntv2anc.cpp.

◆ AncExtractGetMaxNumFilterDIDs()

UWord CNTV2Card::AncExtractGetMaxNumFilterDIDs ( void )

static

Returns: The maximum number of distinct DIDs that the device Anc extractor filter can accommodate.

See also: CNTV2Card::AncExtractSetFilterDIDs, CNTV2Card::AncExtractGetDefaultDIDs, Ancillary Packet Filtering

Definition at line 1061 of file ntv2anc.cpp.

◆ AncExtractGetWriteInfo()

bool CNTV2Card::AncExtractGetWriteInfo	(	const UWord	inSDIInput,
		uint64_t &	outF1StartAddr,
		uint64_t &	outF1EndAddr,
		uint64_t &	outF2StartAddr,
		uint64_t &	outF2EndAddr
	)

virtual

Answers with the given SDI input's current Anc extractor info. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[out]	outF1StartAddr	Receives the device SDRAM offset where the extractor starts writing F1 anc data.
[out]	outF1EndAddr	Receives the device SDRAM offset where the extractor will stop writing F1 anc data.
[out]	outF2StartAddr	Receives the device SDRAM offset where the extractor starts writing F2 anc data.
[out]	outF2EndAddr	Receives the device SDRAM offset where the extractor will stop writing F2 anc data.

See also: SDI Anc Packet Capture

Definition at line 902 of file ntv2anc.cpp.

◆ AncExtractInit()

bool CNTV2Card::AncExtractInit	(	const UWord	inSDIInput,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Standard	inStandard = `NTV2_STANDARD_INVALID`
	)

virtual

Initializes the given SDI input's Anc extractor for custom Anc packet detection and de-embedding. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's fed from the SDI input, if different from the SDI input. The default is to use the same NTV2Channel that corresponds to the given SDI input (e.g., NTV2_CHANNEL1 == 0 == SDIIn1).
[in]	inStandard	Optionally overrides the NTV2Standard used to initialize the Anc extractor. Defaults to using the NTV2Standard of the NTV2Channel being used.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AncExtractSetEnable, CNTV2Card::AncExtractSetWriteParams, CNTV2Card::AncExtractSetFilterDIDs, SDI Anc Packet Capture

Definition at line 706 of file ntv2anc.cpp.

◆ AncExtractIsEnabled()

bool CNTV2Card::AncExtractIsEnabled	(	const UWord	inSDIInput,
		bool &	outIsEnabled
	)

virtual

Answers whether the given SDI input's Anc extractor is enabled/active or not. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest as a zero-based index value (e.g., 0 == SDIIn1).
[out]	outIsEnabled	Receives 'true' if the Anc extractor is enabled (running); otherwise false.

See also: CNTV2Card::AncExtractSetEnable, SDI Anc Packet Capture

Definition at line 793 of file ntv2anc.cpp.

◆ AncExtractIsProgressive()

bool CNTV2Card::AncExtractIsProgressive	(	const UWord	inSDIInput,
		bool &	outIsProgressive
	)

virtual

Answers whether or not the given SDI input's Anc extractor was configured with a progressive video format. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[out]	outIsProgressive	Receives true if the extractor was configured with a progressive format. Otherwise false.

Definition at line 1044 of file ntv2anc.cpp.

◆ AncExtractSetComponents()

bool CNTV2Card::AncExtractSetComponents	(	const UWord	inSDIInput,
		const bool	inVancY,
		const bool	inVancC,
		const bool	inHancY,
		const bool	inHancC
	)

virtual

Enables or disables the Anc extraction components for the given SDI input. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[in]	inVancY	Specify true to enable Vanc Y component extraction; otherwise false to disable it.
[in]	inVancC	Specify true to enable Vanc C component extraction; otherwise false to disable it.
[in]	inHancY	Specify true to enable Hanc Y component extraction; otherwise false to disable it.
[in]	inHancC	Specify true to enable Hanc C component extraction; otherwise false to disable it.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 760 of file ntv2anc.cpp.

◆ AncExtractSetEnable()

bool CNTV2Card::AncExtractSetEnable	(	const UWord	inSDIInput,
		const bool	inIsEnabled
	)

virtual

Enables or disables the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[in]	inIsEnabled	Specify true to enable the Anc extractor; otherwise false to disable it.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AncExtractIsEnabled, SDI Anc Packet Capture

Definition at line 772 of file ntv2anc.cpp.

◆ AncExtractSetField2WriteParams()

bool CNTV2Card::AncExtractSetField2WriteParams	(	const UWord	inSDIInput,
		const ULWord	inFrameNumber,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

Configures the given SDI input's Anc extractor to receive the next frame's F2 Anc data. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[in]	inFrameNumber	Tells the Anc extractor where to write the received Anc data, specified as a frame number.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the SDI input, if different from the SDI input. The default is to use the same NTV2Channel that corresponds to the SDI input (e.g., NTV2_CHANNEL1 == 0 == SDIIn1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Anc buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AncExtractSetWriteParams, SDI Anc Packet Capture

Definition at line 856 of file ntv2anc.cpp.

◆ AncExtractSetFilterDIDs()

bool CNTV2Card::AncExtractSetFilterDIDs	(	const UWord	inSDIInput,
		const NTV2DIDSet &	inDIDs
	)

virtual

Replaces the DIDs to be excluded (filtered) by the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[in]	inDIDs	Specifies the DIDs to be filtered (excluded). Specify an empty set to disable all packet filtering.

Note: DIDs having the value 0 (zero) are ignored.

See also: CNTV2Card::AncExtractGetFilterDIDs, Ancillary Packet Filtering

Definition at line 949 of file ntv2anc.cpp.

◆ AncExtractSetWriteParams()

bool CNTV2Card::AncExtractSetWriteParams	(	const UWord	inSDIInput,
		const ULWord	inFrameNumber,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

Configures the given SDI input's Anc extractor to receive the next frame's F1 Anc data. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest (e.g., 0=SDIIn1, 1=SDIIn2, etc.).
[in]	inFrameNumber	Tells the Anc extractor where to write the received Anc data, specified as a frame number.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the SDI input, if different from the SDI input. The default is to use the same NTV2Channel that corresponds to the SDI input (e.g., NTV2_CHANNEL1 == 0 == SDIIn1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Anc buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AncExtractSetField2WriteParams, SDI Anc Packet Capture

Definition at line 810 of file ntv2anc.cpp.

◆ AncInsertGetReadInfo()

bool CNTV2Card::AncInsertGetReadInfo	(	const UWord	inSDIOutput,
		uint64_t &	outF1StartAddr,
		uint64_t &	outF2StartAddr
	)

virtual

Answers where, in device SDRAM, the given SDI connector's Anc inserter is currently reading Anc data for playout.

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[out]	outF1StartAddr	Receives the Anc inserter's current F1 starting address.
[out]	outF2StartAddr	Receives the Anc inserter's current F2 starting address.

Definition at line 511 of file ntv2anc.cpp.

◆ AncInsertInit()

bool CNTV2Card::AncInsertInit	(	const UWord	inSDIOutput,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Standard	inStandard = `NTV2_STANDARD_INVALID`
	)

virtual

Initializes the given SDI output's Anc inserter for custom Anc packet insertion. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the SDI output, if different from the SDI output. The default is to use the same NTV2Channel that corresponds to the given SDI output (e.g., NTV2_CHANNEL1 == 0 == SDIOut1).
[in]	inStandard	Optionally overrides the NTV2Standard used to initialize the Anc inserter. Defaults to using the NTV2Standard of the NTV2Channel being used.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 303 of file ntv2anc.cpp.

◆ AncInsertIsEnabled()

bool CNTV2Card::AncInsertIsEnabled	(	const UWord	inSDIOutput,
		bool &	outIsEnabled
	)

virtual

Answers with the run state of the given Anc inserter – i.e. if its "memory reader" is enabled or not. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest as a zero-based index value (e.g., 0 == SDIOut1).
[out]	outIsEnabled	Receives 'true' if the Anc inserter is enabled (running); otherwise false.

Definition at line 397 of file ntv2anc.cpp.

◆ AncInsertSetComponents()

bool CNTV2Card::AncInsertSetComponents	(	const UWord	inSDIOutput,
		const bool	inVancY,
		const bool	inVancC,
		const bool	inHancY,
		const bool	inHancC
	)

virtual

Enables or disables individual Anc insertion components for the given SDI output. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[in]	inVancY	Specify true to enable Vanc Y component insertion; otherwise false to disable it.
[in]	inVancC	Specify true to enable Vanc C component insertion; otherwise false to disable it.
[in]	inHancY	Specify true to enable Hanc Y component insertion; otherwise false to disable it.
[in]	inHancC	Specify true to enable Hanc C component insertion; otherwise false to disable it.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 357 of file ntv2anc.cpp.

◆ AncInsertSetEnable()

bool CNTV2Card::AncInsertSetEnable	(	const UWord	inSDIOutput,
		const bool	inIsEnabled
	)

virtual

Enables or disables the given SDI output's Anc inserter frame buffer reads. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[in]	inIsEnabled	Specify true to enable the Anc inserter; otherwise false to disable it.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 374 of file ntv2anc.cpp.

◆ AncInsertSetField2ReadParams()

bool CNTV2Card::AncInsertSetField2ReadParams	(	const UWord	inSDIOutput,
		const ULWord	inFrameNumber,
		const ULWord	inF2Size,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

Configures the Anc inserter for the next frame's F2 Anc data to embed/transmit. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[in]	inFrameNumber	Tells the Anc inserter where to find the Anc data to transmit, specified as a zero-based frame number.
[in]	inF2Size	Specifies the maximum number of F2 bytes to process in the Anc data buffer in the frame.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the SDI output, if different from the SDI output. The default is to use the same NTV2Channel that corresponds to the given SDI output (e.g., NTV2_CHANNEL1 == 0 == SDIOut1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Anc buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 456 of file ntv2anc.cpp.

◆ AncInsertSetIPParams()

bool CNTV2Card::AncInsertSetIPParams	(	const UWord	inSDIOutput,
		const UWord	ancChannel,
		const ULWord	payloadID,
		const ULWord	ssrc
	)

virtual

Configures the Anc inserter IP specific params.

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[in]	ancChannel	Tells the IP packetizer which Anc inserter to use (4-7).
[in]	payloadID	Tells the IP packetizer what the RTP Payload Id is.
[in]	ssrc	Tells the IP packetizer what the RTP SSRC is.

Definition at line 498 of file ntv2anc.cpp.

◆ AncInsertSetReadParams()

bool CNTV2Card::AncInsertSetReadParams	(	const UWord	inSDIOutput,
		const ULWord	inFrameNumber,
		const ULWord	inF1Size,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

Configures the Anc inserter for the next frame's F1 Anc data to embed/transmit. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest (e.g., 0=SDIOut1, 1=SDIOut2, etc.).
[in]	inFrameNumber	Tells the Anc inserter where to find the Anc data to transmit, specified as a zero-based frame number.
[in]	inF1Size	Specifies the maximum number of F1 bytes to process in the Anc data buffer in the frame.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the SDI output, if different from the SDI output. The default is to use the same NTV2Channel that corresponds to the given SDI output (e.g., NTV2_CHANNEL1 == 0 == SDIOut1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Anc buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 414 of file ntv2anc.cpp.

◆ AncSetFrameBufferSize()

bool CNTV2Card::AncSetFrameBufferSize	(	const ULWord	inF1Size,
		const ULWord	inF2Size
	)

virtual

Sets the capacity of the SDI ANC or HDMI AUX buffers in device frame memory. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)

Returns: True if successful; otherwise false.

Parameters

[in]	inF1Size	Specifies the capacity of the Field 1 anc buffer, in bytes.
[in]	inF2Size	Specifies the capacity of the Field 2 anc buffer, in bytes.

Note: This function should be used before configuring the anc extractors/inserters.; Size changes apply to all SDI anc and HDMI aux extractors/inserters.

Warning: Setting these values too large will result in SDI anc or HDMI aux data occupying the bottom of the video raster.

See also: CNTV2Card::GetAncRegionOffsetAndSize, Ancillary Data Space Limitations

Definition at line 123 of file ntv2anc.cpp.

◆ ApplySignalRoute() [1/2]

bool CNTV2Card::ApplySignalRoute	(	const CNTV2SignalRouter &	inRouter,
		const bool	inReplace = `(0)`
	)

virtual

Applies the given routing table to the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in]	inRouter	Specifies the CNTV2SignalRouter that contains the routing to be applied to the device.
[in]	inReplace	If true, replaces the device's existing widget routing with the given one. If false, augments the device's existing widget routing. Defaults to false.

Most modern AJA devices do not have fixed interconnections between inputs, outputs, FrameStores and the various video processing widgets (e.g., colorspace converters, mixer/keyers, etc.). Instead, these routing configurations are designated by a set of registers, one for each input of each widget. The register's value determines which widget output node (crosspoint) the input is connected to. A zero value in the register means that the input is not connected to anything. To simplify this process of routing widgets on the device, a set of signal paths (i.e., interconnects) are built and then applied to the device in this function call. This function iterates over each connection that's specified in the given routing table and updates the appropriate register in the device.

See also: Widget Signal Routing, CNTV2SignalRouter

Definition at line 242 of file ntv2regroute.cpp.

◆ ApplySignalRoute() [2/2]

bool CNTV2Card::ApplySignalRoute	(	const NTV2XptConnections &	inConnections,
		const bool	inReplace = `(0)`
	)

virtual

Applies the given widget routing connections to the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in]	inConnections	Specifies the routing connections to be applied to the device.
[in]	inReplace	If true, replaces the device's existing widget routing with the given one. If false, augments the device's existing widget routing. Defaults to false.

Most modern AJA devices do not have fixed interconnections between inputs, outputs, FrameStores and the various video processing widgets (e.g., colorspace converters, mixer/keyers, etc.). Instead, these routing configurations are designated by a set of registers, one for each input of each widget. The register's value determines which widget output node (crosspoint) the input is connected to. A zero value in the register means that the input is not connected to anything. To simplify this process of routing widgets on the device, a set of signal paths (i.e., interconnects) are built and then applied to the device in this function call. This function iterates over each connection that's specified in the given routing table and updates the appropriate register in the device.

See also: Widget Signal Routing

Definition at line 255 of file ntv2regroute.cpp.

◆ AutoCirculateFlush()

bool CNTV2Card::AutoCirculateFlush	(	const NTV2Channel	inChannel,
		const bool	inClearDropCount = `(0)`
	)

virtual

Flushes AutoCirculate for the given channel.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inClearDropCount	Specify `true` to clear the AUTOCIRCULATE_STATUS::acFramesDropped counter; otherwise leaves it unchanged. Defaults to `false` (don't clear it).

On capture, flushes all recorded frames that haven't yet been transferred to the host. On playout, all queued frames that have already been transferred to the device (that haven't yet played) are discarded. In either mode, this function has no effect on the Active Frame (the frame currently being captured or played by the device hardware at the moment the function was called). The NTV2AutoCirculateState (NTV2_AUTOCIRCULATE_RUNNING, etc.) for the given channel will remain unchanged.

See also: See AutoCirculate

Definition at line 610 of file ntv2autocirculate.cpp.

◆ AutoCirculateGetFrameStamp()

bool CNTV2Card::AutoCirculateGetFrameStamp	(	const NTV2Channel	inChannel,
		const ULWord	inFrameNumber,
		FRAME_STAMP &	outFrameInfo
	)

virtual

Returns precise timing information for the given frame and channel that's currently AutoCirculating.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inFrameNumber	Specifies the zero-based frame number of interest. This value must be no less than AUTOCIRCULATE_STATUS::acStartFrame and no more than AUTOCIRCULATE_STATUS::acEndFrame for the given channel. For capture/ingest, it should be "behind the record head". For playout, it should be "behind the play head."
[out]	outFrameInfo	Receives the FRAME_STAMP information for the given frame number and channel.

When the given channel is AutoCirculating, the driver will continuously fill in a FRAME_STAMP record for the frame it's currently working on, which is intended to give enough information to determine if frames have been dropped either on input or output. Moreover, it allows for synchronization of audio and video by time-stamping the audio input address at the start and end of a video frame.

See also: See AutoCirculate

Definition at line 667 of file ntv2autocirculate.cpp.

◆ AutoCirculateGetStatus()

bool CNTV2Card::AutoCirculateGetStatus	(	const NTV2Channel	inChannel,
		AUTOCIRCULATE_STATUS &	outStatus
	)

virtual

Returns the current AutoCirculate status for the given channel.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[out]	outStatus	Receives the AUTOCIRCULATE_STATUS information for the channel.

Clients can use the AUTOCIRCULATE_STATUS information to determine if there are sufficient readable frames in the driver to safely support a DMA transfer to host memory (for capture); or to determine if any frames have been dropped.

See also: See AutoCirculate

Definition at line 646 of file ntv2autocirculate.cpp.

◆ AutoCirculateInitForInput()

bool CNTV2Card::AutoCirculateInitForInput	(	const NTV2Channel	inChannel,
		const UWord	inFrameCount = `7`,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_INVALID`,
		const ULWord	inOptionFlags = `0`,
		const UByte	inNumChannels = `1`,
		const UWord	inStartFrameNumber = `0`,
		const UWord	inEndFrameNumber = `0`
	)

virtual

Prepares for subsequent AutoCirculate ingest, designating a contiguous block of frame buffers on the device for use by the FrameStore/channel, and specifies other optional behaviors. Upon successful return, the channel's NTV2AutoCirculateState is set to NTV2_AUTOCIRCULATE_INIT where it will remain until a subsequent call is made to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop.

Returns: true if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inFrameCount	Optionally specifies the number of contiguous device frame buffers to be continuously cycled through if zero is specified for both `inStartFrameNumber` and `inEndFrameNumber`. Defaults to 7. This value is ignored if a legitimate frame range is specified in the `inStartFrameNumber` and `inEndFrameNumber` parameters (see below).
[in]	inAudioSystem	Specifies the Audio System to use, if any. Defaults to NTV2_AUDIOSYSTEM_INVALID (no audio).
[in]	inOptionFlags	A bit mask that specifies additional AutoCirculate options (e.g., AUTOCIRCULATE_WITH_RP188, AUTOCIRCULATE_WITH_LTC, AUTOCIRCULATE_WITH_ANC, etc.). Defaults to zero (no options).
[in]	inNumChannels	Optionally specifies the number of channels to operate on when CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop are called. Defaults to 1. Must be greater than zero.
[in]	inStartFrameNumber	Specifies the starting frame index number as a zero-based unsigned decimal integer. Defaults to zero. This parameter always overrides `inFrameCount` if, when specified with `inEndFrameNumber`, are both non-zero. If specified, must be less than `inEndFrameNumber` – see Frame Buffer Indexing for more information.
[in]	inEndFrameNumber	Specifies the ending frame number as a zero-based unsigned decimal integer. Defaults to zero. This parameter always overrides `inFrameCount` if, when specified with `inEndFrameNumber`, are both non-zero. If specified, must be larger than `inStartFrameNumber` – see Frame Buffer Indexing for more information.

Note: For Multi-Channel or 4K/8K applications (i.e. where more than one channel is used for streaming video), AJA recommends specifying zero for inFrameCount, and explicitly specifying a frame range using inStartFrameNumber and inEndFrameNumber parameters.; Fewer frames reduces latency, but increases the likelihood of frame drops. See Frame Count Considerations (Capture).; All Widget Signal Routing should be completed prior to calling this function.; This function logs AutoCirculate Diagnostic Messages to “AJA Logger” or the ‘logreader’ Command-Line Utility. Be sure the AutoCirculate_39 message group is enabled, and the client application has called AJADebug::Open.

If this function succeeds, the driver will have designated a contiguous set of device frame buffers to be written by the FrameStore, and placed the channel into the NTV2_AUTOCIRCULATE_INIT state. The channel will then be ready for a subsequent call to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateTransfer. If the device's NTV2EveryFrameTaskMode (see CNTV2Card::GetEveryFrameServices ) is NTV2_OEM_TASKS, the driver will perform most of the device setup, including configuring the FrameStore, etc.; otherwise (if NTV2_DISABLE_TASKS ), the caller must manage all aspects of the FrameStore ( NTV2Mode, NTV2VideoFormat, etc.) before calling this function.

See also: CNTV2Card::AutoCirculateStop, CNTV2Card::AutoCirculateInitForOutput, AutoCirculate Capture

Definition at line 221 of file ntv2autocirculate.cpp.

◆ AutoCirculateInitForOutput()

bool CNTV2Card::AutoCirculateInitForOutput	(	const NTV2Channel	inChannel,
		const UWord	inFrameCount = `7`,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_INVALID`,
		const ULWord	inOptionFlags = `0`,
		const UByte	inNumChannels = `1`,
		const UWord	inStartFrameNumber = `0`,
		const UWord	inEndFrameNumber = `0`
	)

virtual

Prepares for subsequent AutoCirculate playout, designating a contiguous block of frame buffers on the device for use by the FrameStore/channel, and specifies other optional behaviors. Upon successful return, the channel's NTV2AutoCirculateState is set to NTV2_AUTOCIRCULATE_INIT where it will remain until a subsequent call is made to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop.

Returns: true if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inFrameCount	Optionally specifies the number of contiguous device frame buffers to be continuously cycled through if zero is specified for both `inStartFrameNumber` and `inEndFrameNumber`. Defaults to 7. This value is ignored if a legitimate frame range is specified in the `inStartFrameNumber` and `inEndFrameNumber` parameters (see below).
[in]	inAudioSystem	Specifies the Audio System to use, if any. Defaults to NTV2_AUDIOSYSTEM_INVALID (no audio).
[in]	inOptionFlags	A bit mask that specifies additional AutoCirculate options (e.g., AUTOCIRCULATE_WITH_RP188, AUTOCIRCULATE_WITH_LTC, AUTOCIRCULATE_WITH_ANC, etc.). Defaults to zero (no options).
[in]	inNumChannels	Optionally specifies the number of channels to operate on when CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateStop are called. Defaults to 7. Must be greater than zero.
[in]	inStartFrameNumber	Specifies the starting frame index number as a zero-based unsigned decimal integer. Defaults to zero. This parameter always overrides `inFrameCount` if, when specified with `inEndFrameNumber`, are both non-zero. If specified, must be less than `inEndFrameNumber` – see Frame Buffer Indexing for more information.
[in]	inEndFrameNumber	Specifies the ending frame index number as a zero-based unsigned decimal integer. Defaults to zero. This parameter always overrides `inFrameCount` if, when specified with `inEndFrameNumber`, are both non-zero. If specified, must be larger than `inStartFrameNumber` – see Frame Buffer Indexing for more information.

Note: For Multi-Channel or 4K/8K applications (i.e. where more than one channel is used for streaming video), AJA recommends specifying zero for inFrameCount, and explicitly specifying a frame range using inStartFrameNumber and inEndFrameNumber parameters.; Fewer frames reduces latency, but increases the likelihood of frame drops. See Latency Considerations.; All Widget Signal Routing should be completed prior to calling this function.; This function logs AutoCirculate Diagnostic Messages to “AJA Logger” or the ‘logreader’ Command-Line Utility. Be sure the AutoCirculate_39 message group is enabled, and the client application has called AJADebug::Open.

If this function succeeds, the driver will have designated a contiguous set of device frame buffers to be read by the FrameStore, and placed the channel into the NTV2_AUTOCIRCULATE_INIT state. The channel will then be ready for a subsequent call to CNTV2Card::AutoCirculateStart or CNTV2Card::AutoCirculateTransfer. If the device's NTV2EveryFrameTaskMode (see CNTV2Card::GetEveryFrameServices ) is NTV2_OEM_TASKS, the driver will perform most of the device setup, including configuring the FrameStore, setting the output standard, etc.; otherwise (if NTV2_DISABLE_TASKS ), the caller must manage all aspects of the FrameStore ( NTV2Mode, NTV2VideoFormat, etc.) before calling this function.

See also: CNTV2Card::AutoCirculateStop, CNTV2Card::AutoCirculateInitForInput, AutoCirculate Playout

Definition at line 353 of file ntv2autocirculate.cpp.

◆ AutoCirculatePause()

bool CNTV2Card::AutoCirculatePause	(	const NTV2Channel	inChannel,
		const UWord	inAtFrameNum = `0xFFFF`
	)

virtual

Pauses AutoCirculate for the given channel. Once paused, AutoCirculate can be resumed later by calling CNTV2Card::AutoCirculateResume, picking up at the next frame without any loss of audio synchronization.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inAtFrameNum	Reserved for future use. (Added to API in SDK 16.2)

When pausing, if the channel is in the NTV2_AUTOCIRCULATE_RUNNING state, it will be set to NTV2_AUTOCIRCULATE_PAUSED, and at the next VBI, the driver will explicitly stop audio circulating.

See also: CNTV2Card::AutoCirculateResume, AutoCirculate

Definition at line 570 of file ntv2autocirculate.cpp.

◆ AutoCirculatePreRoll()

bool CNTV2Card::AutoCirculatePreRoll	(	const NTV2Channel	inChannel,
		const ULWord	inPreRollFrames
	)

virtual

Tells AutoCirculate how many frames to skip before playout starts for the given channel.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inPreRollFrames	Specifies the number of frames to skip (ignore) before starting AutoCirculate.

Normally used for playout, this method instructs the driver to mark the given number of frames as valid. It's useful only in the rare case when, after CNTV2Card::AutoCirculateInitForOutput was called, several frames have already been transferred to the device (perhaps using CNTV2Card::DMAWrite), and calling CNTV2Card::AutoCirculateStart will ignore those pre-rolled frames without an intervening CNTV2Card::AutoCirculateTransfer call.

Note: This method does nothing if the channel's state is not currently NTV2_AUTOCIRCULATE_STARTING, NTV2_AUTOCIRCULATE_RUNNING or NTV2_AUTOCIRCULATE_PAUSED, or if the channel was initialized by CNTV2Card::AutoCirculateInitForInput.

See also: See AutoCirculate Playout

Definition at line 628 of file ntv2autocirculate.cpp.

◆ AutoCirculateResume()

bool CNTV2Card::AutoCirculateResume	(	const NTV2Channel	inChannel,
		const bool	inClearDropCount = `(0)`
	)

virtual

Resumes AutoCirculate for the given channel, picking up at the next frame without loss of audio synchronization.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inClearDropCount	Specify `true` to clear the AUTOCIRCULATE_STATUS::acFramesDropped counter; otherwise leaves it unchanged. Defaults to `false` (don't clear it).

When resuming, if the channel is in the NTV2_AUTOCIRCULATE_PAUSED state, it will be changed to NTV2_AUTOCIRCULATE_RUNNING, and at the next VBI, the driver will restart audio AutoCirculate.

See also: CNTV2Card::AutoCirculatePause, AutoCirculate

Definition at line 591 of file ntv2autocirculate.cpp.

◆ AutoCirculateSetActiveFrame()

bool CNTV2Card::AutoCirculateSetActiveFrame	(	const NTV2Channel	inChannel,
		const ULWord	inNewActiveFrame
	)

virtual

Immediately changes the Active Frame for the given channel.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inNewActiveFrame	Specifies the zero-based frame number to use. This value must be no less than acStartFrame and no more than acEndFrame for the given channel (see AUTOCIRCULATE_STATUS).

This method, assuming it succeeds, changes the Active Frame for the given channel by having the driver change the FrameStore's InputFrame register (input) or OutputFrame register (output). When one of these registers change on the device, it won't take effect until the next VBI, which ensures, for example, that an outgoing frame won't suddenly change mid-frame.

Note: This method does nothing if the channel's AutoCirculate state is not currently NTV2_AUTOCIRCULATE_STARTING, NTV2_AUTOCIRCULATE_RUNNING or NTV2_AUTOCIRCULATE_PAUSED.

See also: See AutoCirculate, Video System Operation

Definition at line 677 of file ntv2autocirculate.cpp.

◆ AutoCirculateStart()

bool CNTV2Card::AutoCirculateStart	(	const NTV2Channel	inChannel,
		const ULWord64	inStartTime = `0`
	)

virtual

Starts AutoCirculating the specified channel that was previously initialized by CNTV2Card::AutoCirculateInitForInput or CNTV2Card::AutoCirculateInitForOutput.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inStartTime	Optionally specifies a future start time as an unsigned 64-bit host-OS-dependent time value. If zero, the default, AutoCirculate will switch to the NTV2_AUTOCIRCULATE_RUNNING state at the next VBI received by the given channel. If non-zero, AutoCirculate will remain in the NTV2_AUTOCIRCULATE_STARTING_AT_TIME state until the system tick clock exceeds this value, at which point it will switch to the NTV2_AUTOCIRCULATE_RUNNING state. This value is denominated in the same time units as the finest-grained time counter available on the host's operating system.

This function performs the following tasks:

It sets the state of the channel in the driver from NTV2_AUTOCIRCULATE_INIT to NTV2_AUTOCIRCULATE_STARTING.
At the next VBI, the driver's interrupt service routine (ISR) will check the OS tick clock, and if it exceeds inStartTime value, it will continue starting AutoCirculate – otherwise the channel will remain in the NTV2_AUTOCIRCULATE_STARTING phase, with the driver re-checking the clock at every subsequent VBI.
The driver will change the channel's state to NTV2_AUTOCIRCULATE_RUNNING.
The driver will start tracking which memory frames are available and which are empty. Capture/Input Mode – The next frame to be recorded is determined, and the current last input audio sample is written into the next frame's FRAME_STAMP's acAudioInStartAddress field. Finally, the channel's active frame is set to the next frame number. Playout/Output Mode – The next frame to go out the jack is determined, and the current last output audio sample is written into the next frame's FRAME_STAMP::acAudioOutStartAddress field. Finally, the channel's active frame is set to the next frame number.
Finally, the driver will AutoCirculate frames at every VBI on a per-channel basis.
Note
This method will fail if the specified channel's AutoCirculate state is not NTV2_AUTOCIRCULATE_INIT.

Calling CNTV2Card::AutoCirculateStart while in the NTV2_AUTOCIRCULATE_PAUSED state won't un-pause AutoCirculate. (Instead, it will restart it.)

See also
CNTV2Card::AutoCirculateStop, CNTV2Card::AutoCirculatePause, AutoCirculate

Definition at line 503 of file ntv2autocirculate.cpp.

◆ AutoCirculateStop() [1/2]

bool CNTV2Card::AutoCirculateStop	(	const NTV2Channel	inChannel,
		const bool	inAbort = `(0)`
	)

virtual

Stops AutoCirculate for the given channel, and releases the on-device frame buffers that were allocated to it.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the NTV2Channel to stop. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
[in]	inAbort	Specifies if AutoCirculate is to be immediately stopped, not gracefully. Defaults to false (graceful stop).

If asked to stop gracefully (the default), the channel's AutoCirculate state is set to NTV2_AUTOCIRCULATE_STOPPING, and at the next VBI, AutoCirculate is explicitly stopped, after which the channel's state is set to NTV2_AUTOCIRCULATE_DISABLED. Once this method has been called, the channel cannot be used until it gets reinitialized by a subsequent call to CNTV2Card::AutoCirculateInitForInput or CNTV2Card::AutoCirculateInitForOutput. When called with inAbort set to true, audio capture or playback is immediately stopped (if a valid NTV2AudioSystem was specified in the AutoCirculateInit call), and the AutoCirculate channel status is changed to NTV2_AUTOCIRCULATE_DISABLED.

See also: CNTV2Card::AutoCirculatePause, CNTV2Card::AutoCirculateResume, CNTV2Card::AutoCirculateStart, AutoCirculate

Definition at line 519 of file ntv2autocirculate.cpp.

◆ AutoCirculateStop() [2/2]

bool CNTV2Card::AutoCirculateStop	(	const NTV2ChannelSet &	inChannels,
		const bool	inAbort = `(0)`
	)

virtual

Stops any number of AutoCirculate channels. See the other AutoCirculateStop function overload for full details on what happens to each channel.

Returns: True if all specified channels were successfully stopped; otherwise false.

Parameters

[in]	inChannels	Specifies the channel(s) to stop.
[in]	inAbort	Specifies if each channel is to be stopped immediately (i.e. not gracefully). Defaults to false (graceful stop).

Definition at line 561 of file ntv2autocirculate.cpp.

◆ AutoCirculateTransfer()

bool CNTV2Card::AutoCirculateTransfer	(	const NTV2Channel	inChannel,
		AUTOCIRCULATE_TRANSFER &	transferInfo
	)

virtual

Transfers all or part of a frame as specified in the given AUTOCIRCULATE_TRANSFER object to/from the host.

Parameters

[in]	inChannel	Specifies the NTV2Channel to use. Call NTV2DeviceGetNumFrameStores to discover how many FrameStores (and therefore channels) are available on the device.
	transferInfo	On entry, specifies the AUTOCIRCULATE_TRANSFER details. Upon return, contains information about the (successful) transfer.

It is recommended that this method be called from inside a loop in a separate execution thread, with a way to gracefully exit the loop. Once outside of the loop, CNTV2Card::AutoCirculateStop can then be called.

Warning: It is the caller's responsibility to provide valid video, audio and ancillary data pointers (and byte counts) via the AUTOCIRCULATE_TRANSFER::SetBuffers function(s). Bad addresses and/or sizes can cause crashes.

Note

Do not call this method with an NTV2Channel that's in the NTV2_AUTOCIRCULATE_DISABLED state.

The calling thread will block until the transfer completes (or fails).

For capture, there should be an available frame buffer on the device waiting to be transferred to the host. Call CNTV2Card::AutoCirculateGetStatus, and check AUTOCIRCULATE_STATUS::HasAvailableInputFrame.

For playout, there should be a free frame buffer on the device to accommodate the new frame being transferred. Call CNTV2Card::AutoCirculateGetStatus, and check AUTOCIRCULATE_STATUS::CanAcceptMoreOutputFrames.

For playout to IP devices running S2110 firmware, this method will automatically insert VPID and RP188 timecode packets into the outgoing RTP Anc streams, even if CNTV2Card::AutoCirculateInitForOutput was called without AUTOCIRCULATE_WITH_ANC, or if Anc buffers weren't specified in the AUTOCIRCULATE_TRANSFER object. This default behavior can be overridden or disabled:

To disable the default insertion of VPID, call CNTV2Card::SetSDIOutVPID, passing zeroes for the VPID values.
To override the default VPID packets, call CNTV2Card::AutoCirculateInitForOutput with AUTOCIRCULATE_WITH_ANC, and insert your own VPID packet(s) into the AUTOCIRCULATE_TRANSFER object's Anc buffers.
To disable the default insertion of RP188, nullify (clear) the AUTOCIRCULATE_TRANSFER::acOutputTimeCodes array storage.
To override the default RP188 packet(s), be sure CNTV2Card::AutoCirculateInitForOutput was called with AUTOCIRCULATE_WITH_ANC, and insert your own RP188 packets into the AUTOCIRCULATE_TRANSFER object's Anc buffers.

For capture from IP devices running S2110 firmware, this method will automatically extract VPID and RP188 timecode packets from the incoming RTP Anc streams, even if not AUTOCIRCULATE_WITH_ANC, or without Anc buffers in the "transferInfo".

Bug:: For IP devices running S2110 firmware, this method performs many heap allocations in order to transparently support normal (VPID and RP188) and custom ancillary data. This feature should be re-implemented to use separate, per-channel, private, pre-allocated heaps for the STL objects and other buffers it uses.

See also: CNTV2Card::DMAReadFrame, CNTV2Card::DMAWriteFrame, AutoCirculate

Definition at line 695 of file ntv2autocirculate.cpp.

◆ AuxExtractGetBufferOverrun()

bool CNTV2Card::AuxExtractGetBufferOverrun	(	const UWord	inHDMIInput,
		bool &	outIsOverrun,
		const UWord	inField = `0`
	)

virtual

Answers whether or not the given HDMI input's Aux extractor reached its buffer limits.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outIsOverrun	Receives true if the extractor is reporting that it overran its buffer limits; otherwise false if it didn't.
[in]	inField	Optionally specifies the field of interest. Specify 0 for the "total" buffer overflow between the F1 and F2 buffers; specify 1 for Field 1; specify 2 for Field 2. Defaults to zero (the "total"). (Added in SDK 16.1)

Note: The extractor will not actually write any Aux bytes past its "stop" address, but it will report that it was about to via this "overrun" flag.

Definition at line 982 of file ntv2aux.cpp.

◆ AuxExtractGetDefaultPacketFilters()

NTV2DIDSet CNTV2Card::AuxExtractGetDefaultPacketFilters ( void )

static

Returns: The default packet filters that the device Aux extractor filter is started with.

See also: CNTV2Card::AuxExtractSetPacketFilters, CNTV2Card::AuxExtractGetMaxNumPacketFilters, Auxiliary Packet Filtering

Definition at line 1034 of file ntv2aux.cpp.

◆ AuxExtractGetField1Size()

bool CNTV2Card::AuxExtractGetField1Size	(	const UWord	inHDMIInput,
		ULWord &	outF1Size
	)

virtual

Answers with the number of bytes of field 1 ANC extracted.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outF1Size	Receives the number of bytes of field 1 HDMI AUX data extracted

See also: CNTV2Card::AuxExtractGetField2Size, Custom Aux Packet Capture

Definition at line 940 of file ntv2aux.cpp.

◆ AuxExtractGetField2Size()

bool CNTV2Card::AuxExtractGetField2Size	(	const UWord	inHDMIInput,
		ULWord &	outF2Size
	)

virtual

Answers with the number of bytes of field 2 HDMI AUX data extracted.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outF1Size	Receives the number of bytes of field 2 HDMI AUX data extracted

See also: CNTV2Card::AuxExtractGetField1Size, Custom Aux Packet Capture

Definition at line 961 of file ntv2aux.cpp.

◆ AuxExtractGetFilterInclusionMode()

bool CNTV2Card::AuxExtractGetFilterInclusionMode	(	const UWord	inHDMIInput,
		bool &	outEnabled
	)

virtual

Answers whether or not HDMI AUX packet filtering is enabled for the given HDMI input.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outEnabled	Receives `true` if HDMI AUX packet filtering is enabled; otherwise receives `false`.

See also: CNTV2Card::AuxExtractGetPacketFilters, CNTV2Card::AuxExtractSetFilterInclusionMode, Auxiliary Packet Filtering

Definition at line 926 of file ntv2aux.cpp.

◆ AuxExtractGetMaxNumPacketFilters()

UWord CNTV2Card::AuxExtractGetMaxNumPacketFilters ( void )

static

Returns: The maximum number of distinct packet filters that the device Aux extractor filter can accommodate.

See also: CNTV2Card::AuxExtractSetPacketFilters, CNTV2Card::AuxExtractGetDefaultPacketFilters, Auxiliary Packet Filtering

Definition at line 1028 of file ntv2aux.cpp.

◆ AuxExtractGetPacketFilters()

bool CNTV2Card::AuxExtractGetPacketFilters	(	const UWord	inHDMIInput,
		NTV2DIDSet &	outDIDs
	)

virtual

Answers with the HDMI packet types currently being excluded (filtered) by the HDMI input's Aux extractor.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outDIDs	Receives the NTV2DIDSet that contain the packet types that are currently being filtered (excluded).

See also: CNTV2Card::AuxExtractSetPacketFilters, Auxiliary Packet Filtering

Definition at line 860 of file ntv2aux.cpp.

◆ AuxExtractGetWriteInfo()

bool CNTV2Card::AuxExtractGetWriteInfo	(	const UWord	inHDMIInput,
		uint64_t &	outF1StartAddr,
		uint64_t &	outF1EndAddr,
		uint64_t &	outF2StartAddr,
		uint64_t &	outF2EndAddr
	)

virtual

Answers with the given HDMI input's current Aux extractor info.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outF1StartAddr	Receives the device SDRAM offset where the extractor starts writing F1 aux data.
[out]	outF1EndAddr	Receives the device SDRAM offset where the extractor will stop writing F1 aux data.
[out]	outF2StartAddr	Receives the device SDRAM offset where the extractor starts writing F2 aux data.
[out]	outF2EndAddr	Receives the device SDRAM offset where the extractor will stop writing F2 aux data.

See also: Custom Aux Packet Capture

Definition at line 836 of file ntv2aux.cpp.

◆ AuxExtractInit()

bool CNTV2Card::AuxExtractInit	(	const UWord	inHDMIInput,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Standard	inStandard = `NTV2_STANDARD_INVALID`
	)

virtual

Initializes the given HDMI input's Aux extractor for custom Aux packet detection and de-embedding.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's fed from the HDMI input, if different from the HDMI input. The default is to use the same NTV2Channel that corresponds to the given HDMI input (e.g., NTV2_CHANNEL1 == 0 == HDMIIn1).
[in]	inStandard	Optionally overrides the NTV2Standard used to initialize the Aux extractor. Defaults to using the NTV2Standard of the NTV2Channel being used.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AuxExtractSetEnable, CNTV2Card::AuxExtractSetWriteParams, CNTV2Card::AuxExtractSetPacketFilters, Custom Aux Packet Capture

Definition at line 670 of file ntv2aux.cpp.

◆ AuxExtractIsEnabled()

bool CNTV2Card::AuxExtractIsEnabled	(	const UWord	inHDMIInput,
		bool &	outIsEnabled
	)

virtual

Answers whether the given HDMI input's Aux extractor is enabled/active or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest as a zero-based index value (e.g., 0 == HDMIIn1).
[out]	outIsEnabled	Receives 'true' if the Aux extractor is enabled (running); otherwise false.

See also: CNTV2Card::AuxExtractSetEnable, Custom Aux Packet Capture

Definition at line 721 of file ntv2aux.cpp.

◆ AuxExtractIsProgressive()

bool CNTV2Card::AuxExtractIsProgressive	(	const UWord	inHDMIInput,
		bool &	outIsProgressive
	)

virtual

Answers whether or not the given HDMI input's Aux extractor was configured with a progressive video format.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[out]	outIsProgressive	Receives true if the extractor was configured with a progressive format. Otherwise false.

Definition at line 1010 of file ntv2aux.cpp.

◆ AuxExtractSetEnable()

bool CNTV2Card::AuxExtractSetEnable	(	const UWord	inHDMIInput,
		const bool	inIsEnabled
	)

virtual

Enables or disables the given HDMI input's Aux extractor.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[in]	inIsEnabled	Specify true to enable the Aux extractor; otherwise false to disable it.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AuxExtractIsEnabled, Custom Aux Packet Capture

Definition at line 707 of file ntv2aux.cpp.

◆ AuxExtractSetField2WriteParams()

bool CNTV2Card::AuxExtractSetField2WriteParams	(	const UWord	inHDMIInput,
		const ULWord	inFrameNumber,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

    @brief      Configures the given HDMI input's Aux extractor to receive the next frame's F2 Aux data.
    @return     True if successful; otherwise false.
    @param[in]  inHDMIInput     Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).

Question / TODO: Needs accurate description for extraction, apply to Anc also.

Parameters

[in]	inFrameNumber	Tells the Aux extractor where to write the received Aux data, specified as a frame number.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the HDMI input, if different from the HDMI input. The default is to use the same NTV2Channel that corresponds to the HDMI input (e.g., NTV2_CHANNEL1 == 0 == HDMIIn1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Aux buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AuxExtractSetWriteParams, Custom Aux Packet Capture

Definition at line 785 of file ntv2aux.cpp.

◆ AuxExtractSetFilterInclusionMode()

bool CNTV2Card::AuxExtractSetFilterInclusionMode	(	const UWord	inHDMIInput,
		const bool	inEnable
	)

virtual

Enables or disables HDMI AUX packet filtering for the given HDMI input.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[in]	inEnable	Specify `true` to include only those HDMI AUX packets that match the filter values. Specify `false` for the default behavior (no packet filtering).

See also: CNTV2Card::AuxExtractGetPacketFilters, CNTV2Card::AuxExtractSetPacketFilters, Auxiliary Packet Filtering

Definition at line 912 of file ntv2aux.cpp.

◆ AuxExtractSetPacketFilters()

bool CNTV2Card::AuxExtractSetPacketFilters	(	const UWord	inHDMIInput,
		const NTV2DIDSet &	inDIDs
	)

virtual

Replaces the HDMI packet types to be excluded (filtered) by the given HDMI input's Aux extractor.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIInput	Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).
[in]	inDIDs	Specifies the DIDs to be filtered (excluded). Specify an empty set to disable all packet filtering.

Note: DIDs having the value 0 (zero) are ignored.

See also: CNTV2Card::AuxExtractGetPacketFilters, Auxiliary Packet Filtering

Definition at line 886 of file ntv2aux.cpp.

◆ AuxExtractSetWriteParams()

bool CNTV2Card::AuxExtractSetWriteParams	(	const UWord	inHDMIInput,
		const ULWord	inFrameNumber,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

    @brief      Configures the given HDMI input's Aux extractor to receive the next frame's F1 Aux data.
    @return     True if successful; otherwise false.
    @param[in]  inHDMIInput     Specifies the HDMI input of interest (e.g., 0=HDMIIn1, 1=HDMIIn2, etc.).

Question / TODO: Needs accurate description for extraction, apply to Anc also.

Parameters

[in]	inFrameNumber	Tells the Aux extractor where to write the received Aux data, specified as a frame number.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the HDMI input, if different from the HDMI input. The default is to use the same NTV2Channel that corresponds to the HDMI input (e.g., NTV2_CHANNEL1 == 0 == HDMIIn1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Aux buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for capture methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

See also: CNTV2Card::AuxExtractSetField2WriteParams, Custom Aux Packet Capture

Definition at line 738 of file ntv2aux.cpp.

◆ AuxInsertGetReadInfo()

bool CNTV2Card::AuxInsertGetReadInfo	(	const UWord	inHDMIOutput,
		uint64_t &	outF1StartAddr,
		uint64_t &	outF2StartAddr
	)

virtual

Answers where, in device SDRAM, the given HDMI connector's Aux inserter is currently reading Aux data for playout.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[out]	outF1StartAddr	Receives the Aux inserter's current F1 starting address.
[out]	outF2StartAddr	Receives the Aux inserter's current F2 starting address.

Definition at line 552 of file ntv2aux.cpp.

◆ AuxInsertInit()

bool CNTV2Card::AuxInsertInit	(	const UWord	inHDMIOutput,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Standard	inStandard = `NTV2_STANDARD_INVALID`
	)

virtual

Initializes the given HDMI output's Aux inserter for custom Aux packet insertion.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the HDMI output, if different from the HDMI output. The default is to use the same NTV2Channel that corresponds to the given HDMI output (e.g., NTV2_CHANNEL1 == 0 == HDMIOut1).
[in]	inStandard	Optionally overrides the NTV2Standard used to initialize the Aux inserter. Defaults to using the NTV2Standard of the NTV2Channel being used.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 304 of file ntv2aux.cpp.

◆ AuxInsertIsEnabled()

bool CNTV2Card::AuxInsertIsEnabled	(	const UWord	inHDMIOutput,
		bool &	outIsEnabled
	)

virtual

Answers with the run state of the given Aux inserter – i.e. if its "memory reader" is enabled or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest as a zero-based index value (e.g., 0 == HDMIOut1).
[out]	outIsEnabled	Receives 'true' if the Aux inserter is enabled (running); otherwise false.

Definition at line 414 of file ntv2aux.cpp.

◆ AuxInsertSetComponents()

bool CNTV2Card::AuxInsertSetComponents	(	const UWord	inHDMIOutput,
		const bool	inVauxY,
		const bool	inVauxC,
		const bool	inHauxY,
		const bool	inHauxC
	)

virtual

Enables or disables individual Aux insertion components for the given HDMI output.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[in]	inVauxY	Specify true to enable Vaux Y component insertion; otherwise false to disable it.
[in]	inVauxC	Specify true to enable Vaux C component insertion; otherwise false to disable it.
[in]	inHauxY	Specify true to enable Haux Y component insertion; otherwise false to disable it.
[in]	inHauxC	Specify true to enable Haux C component insertion; otherwise false to disable it.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 363 of file ntv2aux.cpp.

◆ AuxInsertSetEnable()

bool CNTV2Card::AuxInsertSetEnable	(	const UWord	inHDMIOutput,
		const bool	inIsEnabled
	)

virtual

Enables or disables the given HDMI output's Aux inserter frame buffer reads.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[in]	inIsEnabled	Specify true to enable the Aux inserter; otherwise false to disable it.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 387 of file ntv2aux.cpp.

◆ AuxInsertSetField2ReadParams()

bool CNTV2Card::AuxInsertSetField2ReadParams	(	const UWord	inHDMIOutput,
		const ULWord	inFrameNumber,
		const ULWord	inF2Size,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

Configures the Aux inserter for the next frame's F2 Aux data to embed/transmit.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[in]	inFrameNumber	Tells the Aux inserter where to find the Aux data to transmit, specified as a zero-based frame number.
[in]	inF2Size	Specifies the maximum number of F2 bytes to process in the Aux data buffer in the frame.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the HDMI output, if different from the HDMI output. The default is to use the same NTV2Channel that corresponds to the given HDMI output (e.g., NTV2_CHANNEL1 == 0 == HDMIOut1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Aux buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 484 of file ntv2aux.cpp.

◆ AuxInsertSetIPParams()

bool CNTV2Card::AuxInsertSetIPParams	(	const UWord	inHDMIOutput,
		const UWord	auxChannel,
		const ULWord	payloadID,
		const ULWord	ssrc
	)

virtual

Configures the Aux inserter IP specific params.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[in]	auxChannel	Tells the IP packetizer which Aux inserter to use (4-7).
[in]	payloadID	Tells the IP packetizer what the RTP Payload Id is.
[in]	ssrc	Tells the IP packetizer what the RTP SSRC is.

Definition at line 533 of file ntv2aux.cpp.

◆ AuxInsertSetReadParams()

bool CNTV2Card::AuxInsertSetReadParams	(	const UWord	inHDMIOutput,
		const ULWord	inFrameNumber,
		const ULWord	inF1Size,
		const NTV2Channel	inChannel = `NTV2_CHANNEL_INVALID`,
		const NTV2Framesize	inFrameSize = `NTV2_FRAMESIZE_INVALID`
	)

virtual

Configures the Aux inserter for the next frame's F1 Aux data to embed/transmit.

Returns: True if successful; otherwise false.

Parameters

[in]	inHDMIOutput	Specifies the HDMI output of interest (e.g., 0=HDMIOut1, 1=HDMIOut2, etc.).
[in]	inFrameNumber	Tells the Aux inserter where to find the Aux data to transmit, specified as a zero-based frame number.
[in]	inF1Size	Specifies the maximum number of F1 bytes to process in the Aux data buffer in the frame.
[in]	inChannel	Optionally specifies the NTV2Channel (FrameStore) that's driving the HDMI output, if different from the HDMI output. The default is to use the same NTV2Channel that corresponds to the given HDMI output (e.g., NTV2_CHANNEL1 == 0 == HDMIOut1).
[in]	inFrameSize	Optionally overrides the NTV2Framesize used to calculate the Aux buffer location in device SDRAM. Defaults to using the NTV2Framesize of the NTV2Channel being used.

Note: This function is provided for playback methods that don't use AutoCirculate. AutoCirculate based applications should not call this function.

Definition at line 435 of file ntv2aux.cpp.

◆ AuxSetFrameBufferSize()

virtual bool CNTV2Card::AuxSetFrameBufferSize	(	const ULWord	inF1Size,
		const ULWord	inF2Size
	)

inlinevirtual

Sets the capacity of the HDMI AUX buffers in device frame memory.

Note: As of SDK & driver 17.1, Aux buffers use the same virtual registers that Anc uses: kVRegAncField1Offset & kVRegAncField2Offset. So for now, simply redirect to AncSetFrameBufferSize.

Returns: True if successful; otherwise false.

Parameters

[in]	inF1Size	Specifies the capacity of the Field 1 aux buffer, in bytes.
[in]	inF2Size	Specifies the capacity of the Field 2 aux buffer, in bytes.

See also: CNTV2Card::GetAuxRegionOffsetAndSize, Auxiliary Data Space Limitations

Definition at line 5795 of file ntv2card.h.

◆ BankSelectReadRegister()

bool CNTV2Card::BankSelectReadRegister	(	const NTV2RegInfo &	inBankSelect,
		NTV2RegInfo &	inOutRegInfo
	)

virtual

Reads the given set of registers from the bank specified in position 0.

Parameters

[in]	inBankSelect	Specifies the bank select register.
[in]	inOutRegInfo	Specifies the register to be read (plus mask/shift/value).

Returns: True if all requested registers were successfully read; otherwise false.

Note: This operation is not guaranteed to be performed atomically.

Definition at line 4621 of file ntv2register.cpp.

◆ BankSelectWriteRegister()

bool CNTV2Card::BankSelectWriteRegister	(	const NTV2RegInfo &	inBankSelect,
		const NTV2RegInfo &	inRegInfo
	)

virtual

Writes the given set of registers to the bank specified at position 0.

Parameters

[in]	inBankSelect	Specifies the bank select register.
[in]	inRegInfo	Specifies the register to be written, and its mask, shift and value.

Returns: True if all requested registers were successfully written; otherwise false.

Note: This operation is not guaranteed to be performed atomically.

Definition at line 4610 of file ntv2register.cpp.

◆ CanConnect()

bool CNTV2Card::CanConnect	(	const NTV2InputCrosspointID	inInputXpt,
		const NTV2OutputCrosspointID	inOutputXpt,
		bool &	outCanConnect
	)

virtual

Answers whether or not the given widget signal input (sink) can legally be connected to the given signal output (source).

Parameters

[in]	inInputXpt	Specifies the input (signal sink) of interest.
[in]	inOutputXpt	Specifies the output (signal source) of interest.
[out]	outCanConnect	Receives true if the input can be connected to the specified output; otherwise false.

Returns: True if successful; otherwise false.

Note: This function will return false (failure) if the device firmware doesn't support route validation.

See also: Widget Signal Routing, CNTV2Card::Connect

Definition at line 192 of file ntv2regroute.cpp.

◆ CanLoadDynamicDevice()

bool CNTV2Card::CanLoadDynamicDevice ( const NTV2DeviceID inDeviceID )

virtual

Parameters

[in] inDeviceID Specifies the device ID of interest.

Returns: True if the given NTV2DeviceID can be dynamically loaded; otherwise false.

Definition at line 139 of file ntv2dynamicdevice.cpp.

◆ CanWarmBootFPGA()

bool CNTV2Card::CanWarmBootFPGA ( bool & outCanWarmBoot )

virtual

Answers whether or not the FPGA can be reloaded without powering off.

Parameters

[out] outCanWarmBoot Receives true if the FPGA can be reloaded without powering off the device. Receives false if it can only be reloaded after power-cycling.

Returns: True if successful; otherwise false.

Note: The "outCanWarmBoot" answer can only be trusted if the function result is true.

Definition at line 349 of file ntv2card.cpp.

◆ ClearRouting()

bool CNTV2Card::ClearRouting ( void )

virtual

Removes all existing signal path connections between any and all widgets on the AJA device.

Returns: True if successful; otherwise false.

This function writes zeroes into all crosspoint selection registers, effectively clearing any existing routing configuration on the device.

See also: Widget Signal Routing

Definition at line 278 of file ntv2regroute.cpp.

◆ Connect()

bool CNTV2Card::Connect	(	const NTV2InputCrosspointID	inInputXpt,
		const NTV2OutputCrosspointID	inOutputXpt,
		const bool	inValidate = `(0)`
	)

virtual

Connects the given widget signal input (sink) to the given widget signal output (source).

Parameters

[in]	inInputXpt	Specifies the input (signal sink) to be connected to the given output.
[in]	inOutputXpt	Specifies the output (signal source) to be connected to the given input. Specifying NTV2_XptBlack effects a disconnect.
[in]	inValidate	If true, calls NTV2Card::CanConnect to verify that the connection exists in firmware before writing the crosspoint register; otherwise writes the crosspoint register regardless. Defaults to false.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2Card::Disconnect, CNTV2Card::IsConnected

Definition at line 87 of file ntv2regroute.cpp.

◆ DeviceAddressToFrameNumber()

bool CNTV2Card::DeviceAddressToFrameNumber	(	const uint64_t	inAddress,
		UWord &	outFrameNumber,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the frame number that contains the given address.

Parameters

[in]	inAddress	Specifies the device memory address of the first byte of the given frame.
[out]	outFrameNumber	Receives the zero-based frame number.
[in]	inChannel	Optionally specifies the channel of interest (for multi-format). Defaults to NTV2_CHANNEL1 for uni-format.

Returns: True if successful; otherwise false.

Definition at line 382 of file ntv2dma.cpp.

◆ DeviceCanDoConversionMode()

bool CNTV2Card::DeviceCanDoConversionMode ( const NTV2ConversionMode inCM )

virtual

Deprecated:: Use DeviceCapabilities::CanDoConversionMode instead.

Definition at line 479 of file ntv2card.cpp.

◆ DeviceCanDoDSKMode()

bool CNTV2Card::DeviceCanDoDSKMode ( const NTV2DSKMode inDSKM )

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 484 of file ntv2card.cpp.

◆ DeviceCanDoFormat()

bool CNTV2Card::DeviceCanDoFormat	(	const NTV2FrameRate	inFR,
		const NTV2FrameGeometry	inFG,
		const NTV2Standard	inStd
	)

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 421 of file ntv2card.cpp.

◆ DeviceCanDoFrameBufferFormat()

bool CNTV2Card::DeviceCanDoFrameBufferFormat ( const NTV2PixelFormat inPF )

virtual

Deprecated:: Use DeviceCapabilities::CanDoFrameBufferFormat instead.

Definition at line 468 of file ntv2card.cpp.

◆ DeviceCanDoInputSource()

bool CNTV2Card::DeviceCanDoInputSource ( const NTV2InputSource inSrc )

virtual

Deprecated:: Use DeviceCapabilities::CanDoInputSource instead.

Definition at line 489 of file ntv2card.cpp.

◆ DeviceCanDoVideoFormat()

bool CNTV2Card::DeviceCanDoVideoFormat ( const NTV2VideoFormat inVF )

virtual

Deprecated:: Use DeviceCapabilities::CanDoVideoFormat instead.

Definition at line 463 of file ntv2card.cpp.

◆ DeviceCanDoWidget()

bool CNTV2Card::DeviceCanDoWidget ( const NTV2WidgetID inWgtID )

virtual

Deprecated:: Use DeviceCapabilities::CanDoWidget instead.

Definition at line 473 of file ntv2card.cpp.

◆ DeviceGetAudioFrameBuffer() [1/2]

ULWord CNTV2Card::DeviceGetAudioFrameBuffer	(	const NTV2FrameGeometry	inFrameGeometry,
		const NTV2FrameBufferFormat	inFBFormat
	)

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 453 of file ntv2card.cpp.

◆ DeviceGetAudioFrameBuffer() [2/2]

ULWord CNTV2Card::DeviceGetAudioFrameBuffer ( void )

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 433 of file ntv2card.cpp.

◆ DeviceGetAudioFrameBuffer2() [1/2]

ULWord CNTV2Card::DeviceGetAudioFrameBuffer2	(	const NTV2FrameGeometry	inFrameGeometry,
		const NTV2FrameBufferFormat	inFBFormat
	)

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 458 of file ntv2card.cpp.

◆ DeviceGetAudioFrameBuffer2() [2/2]

ULWord CNTV2Card::DeviceGetAudioFrameBuffer2 ( void )

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 438 of file ntv2card.cpp.

◆ DeviceGetFrameBufferSize() [1/2]

ULWord CNTV2Card::DeviceGetFrameBufferSize	(	const NTV2FrameGeometry	inFrameGeometry,
		const NTV2FrameBufferFormat	inFBFormat
	)

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 443 of file ntv2card.cpp.

◆ DeviceGetFrameBufferSize() [2/2]

ULWord CNTV2Card::DeviceGetFrameBufferSize ( void )

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 428 of file ntv2card.cpp.

◆ DeviceGetNumberFrameBuffers() [1/2]

ULWord CNTV2Card::DeviceGetNumberFrameBuffers	(	const NTV2FrameGeometry	inFrameGeometry,
		const NTV2FrameBufferFormat	inFBFormat
	)

virtual

Deprecated:: This function is obsolete. Do not use it.

Definition at line 448 of file ntv2card.cpp.

◆ DeviceGetNumberFrameBuffers() [2/2]

ULWord CNTV2Card::DeviceGetNumberFrameBuffers ( void )

virtual

Definition at line 291 of file ntv2card.cpp.

◆ DisableChannel()

bool CNTV2Card::DisableChannel ( const NTV2Channel inChannel )

virtual

Disables the given FrameStore.

Parameters

[in] inChannel Specifies the FrameStore as an NTV2Channel value.

Returns: True if successful; otherwise false.

Note: It is not an error to disable a FrameStore that is already disabled.

See also: CNTV2Card::EnableChannel, CNTV2Card::DisableChannels, FrameStore Operation

Definition at line 2077 of file ntv2register.cpp.

◆ DisableChannels()

bool CNTV2Card::DisableChannels ( const NTV2ChannelSet & inChannels )

virtual

Disables the given FrameStore(s).

Parameters

[in] inChannels Specifies the FrameStore(s) to be disabled.

Returns: True if successful; otherwise false.

Note: It is not an error to disable a FrameStore that is already disabled.

See also: CNTV2Card::EnableChannels, CNTV2Card::DisableChannel, FrameStore Operation

Definition at line 2087 of file ntv2register.cpp.

◆ DisableInputInterrupt() [1/2]

bool CNTV2Card::DisableInputInterrupt ( const NTV2Channel channel = NTV2_CHANNEL1 )

virtual

Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given input channel on the device.

Parameters

[in] channel Specifies the input channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 40 of file ntv2interrupts.cpp.

◆ DisableInputInterrupt() [2/2]

bool CNTV2Card::DisableInputInterrupt ( const NTV2ChannelSet & inFrameStores )

virtual

Prevents the CNTV2Card instance from waiting for and responding to input vertical blanking interrupts originating from the given frameStore(s) on the device.

Parameters

[in] inFrameStores Specifies the frameStore(s) of interest.

Returns: True if successful; otherwise false.

Definition at line 41 of file ntv2interrupts.cpp.

◆ DisableInterrupt()

bool CNTV2Card::DisableInterrupt ( const INTERRUPT_ENUMS inEventCode )

virtual

Definition at line 33 of file ntv2interrupts.cpp.

◆ DisableOutputInterrupt()

bool CNTV2Card::DisableOutputInterrupt ( const NTV2Channel channel = NTV2_CHANNEL1 )

virtual

Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given output channel on the device.

Parameters

[in] channel Specifies the output channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 39 of file ntv2interrupts.cpp.

◆ DisableRP188Bypass()

bool CNTV2Card::DisableRP188Bypass ( const NTV2Channel inSDIOutput )

virtual

Configures the SDI output's embedder to embed SMPTE 12M timecode specified in calls to CNTV2Card::SetRP188Data.

Parameters

[in] inSDIOutput Specifies the SDI output of interest, expressed as an NTV2Channel.

Returns: True if successful; otherwise false.

Note: The SDI output's NTV2_RP188Mode must be set to NTV2_RP188_OUTPUT.

See also: CNTV2Card::EnableRP188Bypass, CNTV2Card::SetRP188Data, CNTV2Card::SetRP188Mode, Timecode (RP-188, SMPTE-12M)

Definition at line 2562 of file ntv2register.cpp.

◆ Disconnect()

bool CNTV2Card::Disconnect ( const NTV2InputCrosspointID inInputXpt )

virtual

Disconnects the given widget signal input (sink) from whatever output (source) it may be connected.

Parameters

[in] inInputXpt Specifies the input (signal sink) to be disconnected.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2Card::Connect

Definition at line 134 of file ntv2regroute.cpp.

◆ DMABufferAutoLock()

bool CNTV2Card::DMABufferAutoLock	(	const bool	inEnable,
		const bool	inMap = `(0)`,
		const ULWord64	inMaxLockSize = `0`
	)

virtual

Enables or disables automatic buffer locking.

Parameters

[in]	inEnable	Specify true to enable automatic buffer locking; otherwise false to disable it.
[in]	inMap	If enabling automatic locking, also try to lock the segment map.
[in]	inMaxLockSize	Specify the maximum number of locked bytes.

Returns: True if successful; otherwise false.

See also: CNTV2Card::DMABufferLock, CNTV2Card::DMABufferUnlock, CNTV2Card::DMABufferUnlockAll, Host Buffer Locking

Definition at line 466 of file ntv2dma.cpp.

◆ DMABufferLock() [1/2]

bool CNTV2Card::DMABufferLock	(	const NTV2Buffer &	inBuffer,
		bool	inMap = `(0)`,
		bool	inRDMA = `(0)`
	)

virtual

Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers.

Parameters

[in]	inBuffer	Specifies the host buffer to lock.
[in]	inMap	Also lock the segment map.
[in]	inRDMA	Lock a GPUDirect buffer for p2p DMA.

Returns: True if successful; otherwise false.

See also: CNTV2Card::DMABufferUnlock, CNTV2Card::DMABufferAutoLock, CNTV2Card::DMABufferUnlockAll, Host Buffer Locking

Definition at line 429 of file ntv2dma.cpp.

◆ DMABufferLock() [2/2]

virtual bool CNTV2Card::DMABufferLock	(	const ULWord *	pInBuffer,
		const ULWord	inByteCount,
		bool	inMap = `(0)`,
		bool	inRDMA = `(0)`
	)

inlinevirtual

Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers.

Parameters

[in]	pInBuffer	Specifies the starting address of the host buffer to lock.
[in]	inByteCount	Specifies the total length of the host buffer.
[in]	inMap	Also lock the segment map.
[in]	inRDMA	Lock a GPUDirect buffer for p2p DMA.

Returns: True if successful; otherwise false.

Note: On the Windows platform, buffers allocated using GlobalAlloc or VirtualAlloc often won't map properly because these functions allocate the virtual address space but not the memory pages, which only get allocated and committed when the memory gets written (touched). Instead, we recommend using _aligned_malloc for mapped host memory.

See also: CNTV2Card::DMABufferUnlock, CNTV2Card::DMABufferAutoLock, CNTV2Card::DMABufferUnlockAll, Host Buffer Locking

Definition at line 466 of file ntv2card.h.

◆ DMABufferUnlock() [1/2]

bool CNTV2Card::DMABufferUnlock ( const NTV2Buffer & inBuffer )

virtual

Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock.

Parameters

[in] inBuffer Specifies the host buffer to unlock.

Returns: True if successful; otherwise false.

See also: CNTV2Card::DMABufferLock, CNTV2Card::DMABufferUnlockAll, Host Buffer Locking

Definition at line 444 of file ntv2dma.cpp.

◆ DMABufferUnlock() [2/2]

virtual bool CNTV2Card::DMABufferUnlock	(	const ULWord *	pInBuffer,
		const ULWord	inByteCount
	)

inlinevirtual

Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock.

Parameters

[in]	pInBuffer	Specifies the starting address of the previously locked host buffer.
[in]	inByteCount	Specifies the total length of the previously locked host buffer.

Returns: True if successful; otherwise false.

See also: CNTV2Card::DMABufferLock, CNTV2Card::DMABufferUnlockAll, Host Buffer Locking

Definition at line 487 of file ntv2card.h.

◆ DMABufferUnlockAll()

bool CNTV2Card::DMABufferUnlockAll ( )

virtual

Unlocks all previously-locked buffers used for DMA transfers.

Returns: True if successful; otherwise false.

See also: CNTV2Card::DMABufferLock, CNTV2Card::DMABufferUnlock, Host Buffer Locking

Definition at line 457 of file ntv2dma.cpp.

◆ DMAClearAncRegion()

bool CNTV2Card::DMAClearAncRegion	(	const UWord	inStartFrameNumber,
		const UWord	inEndFrameNumber,
		const NTV2AncillaryDataRegion	inAncRegion = `NTV2_AncRgn_All`,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Clears the ancillary data region in the device frame buffer for the specified frames.

Parameters

[in]	inStartFrameNumber	Specifies the starting device frame number.
[in]	inEndFrameNumber	Specifies the ending device frame number.
[in]	inAncRegion	Optionally specifies the ancillary data region to clear (e.g. NTV2_AncRgn_Field1, NTV2_AncRgn_Field2, etc.). Defaults to all regions.
[in]	inChannel	Optionally specifies the channel associated with the frame numbers. Defaults to NTV2_CHANNEL1. (New in SDK 16.1)

Returns: True if successful; otherwise false.

Definition at line 495 of file ntv2dma.cpp.

◆ DmaP2PTargetFrame()

bool CNTV2Card::DmaP2PTargetFrame	(	NTV2Channel	channel,
		ULWord	frameNumber,
		ULWord	frameOffset,
		PCHANNEL_P2P_STRUCT	pP2PData
	)

virtual

DirectGMA p2p transfers (not GPUDirect: see DMABufferLock)

Definition at line 116 of file ntv2dma.cpp.

◆ DmaP2PTransferFrame()

bool CNTV2Card::DmaP2PTransferFrame	(	NTV2DMAEngine	DMAEngine,
		ULWord	frameNumber,
		ULWord	frameOffset,
		ULWord	transferSize,
		ULWord	numSegments,
		ULWord	segmentTargetPitch,
		ULWord	segmentCardPitch,
		PCHANNEL_P2P_STRUCT	pP2PData
	)

virtual

Definition at line 122 of file ntv2dma.cpp.

◆ DMARead()

bool CNTV2Card::DMARead	(	const ULWord	inFrameNumber,
		ULWord *	pFrameBuffer,
		const ULWord	inOffsetBytes,
		const ULWord	inByteCount
	)

virtual

Transfers data from the AJA device to the host.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame index number of the starting frame to be read from the device. For Frame Buffer Indexing purposes, this function assumes the intrinsic frame size of the device.
[in]	pFrameBuffer	Specifies the non-NULL address of the host buffer that is to receive the frame data. The memory it points to must be writeable.
[in]	inOffsetBytes	Specifies the byte offset into the device frame buffer.
[in]	inByteCount	Specifies the total number of bytes to transfer.

Returns: True if successful; otherwise false.

Note: The host buffer should be at least inByteCount + inOffsetBytes in size, or host memory will be corrupted.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAWrite, CNTV2Card::DMAReadFrame, CNTV2Card::DMAReadSegments, Frame Buffer Access

Definition at line 29 of file ntv2dma.cpp.

◆ DMAReadAnc()

bool CNTV2Card::DMAReadAnc	(	const ULWord	inFrameNumber,
		NTV2Buffer &	outAncF1Buffer,
		NTV2Buffer &	outAncF2Buffer = `NULL_POINTER`,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Transfers the contents of the ancillary data buffer(s) from a given frame on the AJA device to the host.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame buffer to be read on the device. The actual starting device memory address is predicated on the device's current frame size, which doesn't take into account "quad" or "quad-quad 8K" frames. Callers must carefully calculate this number, taking into account other FrameStores or Channels that may be active, and if they're using "Quad" or "QuadQuad" geometries.
[out]	outAncF1Buffer	Specifies the host buffer that is to receive the device F1 ancillary data buffer contents.
[out]	outAncF2Buffer	Optionally specifies the host buffer that is to receive the device F2 ancillary data buffer contents.
[in]	inChannel	The FrameStore/Channel being used for ingest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Note

This function assumes the device Anc extractor has been properly configured by a prior calls to CNTV2Card::AncExtractInit, CNTV2Card::AncExtractSetWriteParams (and also possibly CNTV2Card::AncExtractSetField2WriteParams).

This function will block and not return until the transfer has finished or failed.

This function uses the values stored in the kVRegAncField1Offset and kVRegAncField2Offset virtual registers to determine the Anc data boundary locations within each frame buffer in device memory.

For capture from IP devices running S2110 firmware, this method will automatically extract VPID and RP188 timecode packets from the incoming RTP Anc streams, even if not AUTOCIRCULATE_WITH_ANC, or without Anc buffers in the "transferInfo".

To disable this behavior completely, use an invalid NTV2Channel value (e.g. NTV2_CHANNEL_INVALID).

Definition at line 172 of file ntv2dma.cpp.

◆ DMAReadAudio()

bool CNTV2Card::DMAReadAudio	(	const NTV2AudioSystem	inAudioSystem,
		ULWord *	pOutAudioBuffer,
		const ULWord	inOffsetBytes,
		const ULWord	inByteCount
	)

virtual

Synchronously transfers audio data from a given Audio System's buffer memory on the AJA device to the specified host buffer, blocking until the transfer has completed.

Parameters

[in]	inAudioSystem	Specifies the Audio System on the device that is to supply the audio data.
	pOutAudioBuffer	Specifies a valid, non-NULL pointer to the host buffer that is to receive the audio data. This buffer must be large enough to accommodate "inByteCount" bytes of data specified (below).
[in]	inOffsetBytes	Specifies the offset into the Audio System's buffer memory on the device from which to transfer audio data. Specify zero to start reading from the device audio output (playout) buffer. Specify the value returned from CNTV2Card::GetAudioReadOffset (0x00400000) to start reading from the audio input (capture) portion of the Audio System's audio buffer.
[in]	inByteCount	Specifies the number of audio bytes to transfer.

Returns: True if successful; otherwise false.

Note: This function can also be used to read audio samples from the output (playout) portion of the Audio System's buffer memory.

Definition at line 136 of file ntv2dma.cpp.

◆ DMAReadFrame() [1/2]

bool CNTV2Card::DMAReadFrame	(	const ULWord	inFrameNumber,
		ULWord *	pHostBuffer,
		const ULWord	inByteCount,
		const NTV2Channel	inChannel
	)

virtual

Transfers a single frame from the AJA device to the host. This call is multi-format compatible.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be read from the device. For Frame Buffer Indexing purposes, this function assumes frame offsets/sizes based on the FrameStore identified by the `inChannel` parameter (below).
[in]	pHostBuffer	Specifies the non-NULL address of the host buffer that is to receive the frame data. The memory it points to must be writeable.
[in]	inByteCount	Specifies the total number of bytes to transfer.
[in]	inChannel	Specifies the FrameStore to supply the Frame Buffer Indexing context to use with the `inFrameNumber` parameter. If the FrameStore, for example, is configured for UHD/4K, the intrinsic frame size (8MB or 16MB) will be quadrupled when calculating the starting source address in device SDRAM.

Returns: True if successful; otherwise false.

Note: The host buffer must be at least inByteCount in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAWriteFrame, CNTV2Card::DMARead, CNTV2Card::DMAReadSegments, Frame Buffer Access

Definition at line 46 of file ntv2dma.cpp.

◆ DMAReadFrame() [2/2]

bool CNTV2Card::DMAReadFrame	(	const ULWord	inFrameNumber,
		ULWord *	pOutFrameBuffer,
		const ULWord	inByteCount
	)

virtual

Transfers a single frame from the AJA device to the host.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be read from the device. For Frame Buffer Indexing purposes, this function assumes the intrinsic frame size of the device.
[in]	pOutFrameBuffer	Specifies the non-NULL address of the host buffer that is to receive the frame data. The memory it points to must be writeable.
[in]	inByteCount	Specifies the total number of bytes to transfer.

Returns: True if successful; otherwise false.

Note: The host buffer must be at least inByteCount in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAWriteFrame, CNTV2Card::DMARead, CNTV2Card::DMAReadSegments, Frame Buffer Access

Definition at line 41 of file ntv2dma.cpp.

◆ DMAReadSegments()

bool CNTV2Card::DMAReadSegments	(	const ULWord	inFrameNumber,
		ULWord *	pFrameBuffer,
		const ULWord	inCardOffsetBytes,
		const ULWord	inSegmentByteCount,
		const ULWord	inNumSegments,
		const ULWord	inSegmentHostPitch,
		const ULWord	inSegmentCardPitch
	)

virtual

Performs a segmented data transfer from the AJA device to the host.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be read from the device.
[in]	pFrameBuffer	Specifies the non-NULL address of the host buffer that is to supply the frame data. The memory it points to must be writeable.
[in]	inCardOffsetBytes	Specifies the initial on-device memory byte offset for the first bytes transferred.
[in]	inSegmentByteCount	Specifies the number of bytes to transfer per segment.
[in]	inNumSegments	Specifies the number of segments to transfer.
[in]	inSegmentHostPitch	Specifies the number of bytes to increment the host memory pointer after each segment is transferred.
[in]	inSegmentCardPitch	Specifies the number of bytes to increment the on-device memory pointer after each segment is transferred.

Returns: True if successful; otherwise false.

Note: The host buffer should be at least inSegmentByteCount*inNumSegments+inOffsetBytes in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAWriteSegments, CNTV2Card::DMARead, CNTV2Card::DMAReadFrame, Frame Buffer Access

Definition at line 90 of file ntv2dma.cpp.

◆ DMAWrite()

bool CNTV2Card::DMAWrite	(	const ULWord	inFrameNumber,
		const ULWord *	pFrameBuffer,
		const ULWord	inOffsetBytes,
		const ULWord	inByteCount
	)

virtual

Transfers data from the host to the AJA device.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be written on the device. For Frame Buffer Indexing purposes, this function assumes the intrinsic frame size of the device.
[in]	pFrameBuffer	Specifies the non-NULL address of the host buffer that is to supply the frame data. The memory it points to must be readable.
[in]	inOffsetBytes	Specifies the byte offset into the device frame buffer.
[in]	inByteCount	Specifies the total number of bytes to transfer.

Returns: True if successful; otherwise false.

Note: The host buffer should be at least inByteCount + inOffsetBytes in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMARead, CNTV2Card::DMAWriteFrame, CNTV2Card::DMAWriteSegments, Frame Buffer Access

Definition at line 35 of file ntv2dma.cpp.

◆ DMAWriteAnc()

bool CNTV2Card::DMAWriteAnc	(	const ULWord	inFrameNumber,
		NTV2Buffer &	inAncF1Buffer,
		NTV2Buffer &	inAncF2Buffer = `NULL_POINTER`,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Transfers the contents of the ancillary data buffer(s) from the host to a given frame on the AJA device.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be read from the device. The actual starting device memory address is predicated on the device's current frame size, which doesn't take into account "quad" or "quad-quad 8K" frames. Callers must carefully calculate this number, taking into account other FrameStores or Channels that may be active, and if they're using "Quad" or "QuadQuad" geometries.
[in]	inAncF1Buffer	Specifies the host buffer that is to supply the F1 ancillary data buffer content.
[in]	inAncF2Buffer	Optionally specifies the host buffer that is to supply the F2 ancillary data buffer content.
[in]	inChannel	The FrameStore/Channel being used for playout. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Note

This function assumes the device Anc inserter has been properly configured by prior calls to CNTV2Card::AncInsertInit, CNTV2Card::AncInsertSetReadParams (and also possibly CNTV2Card::AncInsertSetField2ReadParams).

This function will block and not return until the transfer has finished or failed.

This function uses the values stored in the kVRegAncField1Offset and kVRegAncField2Offset virtual registers to determine the Anc data boundary locations within each frame buffer in device memory.

For playout to IP devices running S2110 firmware, this method will automatically add VPID and RP188 timecode packets into the outgoing RTP Anc streams, even if such packets weren't placed into the given buffers. This default behavior can be overridden or disabled:

To disable this behavior completely, use an invalid NTV2Channel value (e.g. NTV2_CHANNEL_INVALID).
To disable the default VPID insertion, call CNTV2Card::SetSDIOutVPID, passing zeroes for the VPID values.
To override the default VPID values, insert your own VPID packet(s) into the F1 and/or F2 Anc buffers.
To override the default RP188 value(s), insert your own RP188 packets into the F1 and/or F2 Anc buffers.

Definition at line 228 of file ntv2dma.cpp.

◆ DMAWriteAudio()

bool CNTV2Card::DMAWriteAudio	(	const NTV2AudioSystem	inAudioSystem,
		const ULWord *	pInAudioBuffer,
		const ULWord	inOffsetBytes,
		const ULWord	inByteCount
	)

virtual

Synchronously transfers audio data from the specified host buffer to the given Audio System's buffer memory on the AJA device, blocking until the transfer has completed.

Parameters

[in]	inAudioSystem	Specifies the Audio System on the device that is to receive the audio data.
[in]	pInAudioBuffer	Specifies a valid, non-NULL pointer to the host buffer that is to supply the audio data.
[in]	inOffsetBytes	Specifies the offset into the Audio System's buffer memory on the device to which audio data will be transferred. Use zero for the start of the playout portion of the Audio System's buffer memory. Specifying 0 will start writing at the start of the device audio output (playout) buffer; specifying 0x00400000 will start writing at the start of the audio input (capture) buffer.
[in]	inByteCount	Specifies the number of audio bytes to transfer. Note that this value must not overrun the host buffer, nor the device's audio buffer.

Returns: True if successful; otherwise false.

Note: This function can also be used to write audio samples into the capture portion of the Audio System's buffer memory (which will quickly be overwritten if the capture audio system has been started).

Definition at line 154 of file ntv2dma.cpp.

◆ DMAWriteFrame() [1/2]

bool CNTV2Card::DMAWriteFrame	(	const ULWord	inFrameNumber,
		const ULWord *	pInFrameBuffer,
		const ULWord	inByteCount
	)

virtual

Transfers a single frame from the host to the AJA device.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be written to the device. For Frame Buffer Indexing purposes, this function assumes the intrinsic frame size of the device.
[in]	pInFrameBuffer	Specifies the non-NULL address of the host buffer that is to supply the frame data. The memory it points to must be readable.
[in]	inByteCount	Specifies the total number of bytes to transfer.

Returns: True if successful; otherwise false.

Note: The host buffer must be at least inByteCount in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAReadFrame, CNTV2Card::DMAWrite, CNTV2Card::DMAWriteSegments, Frame Buffer Access

Definition at line 65 of file ntv2dma.cpp.

◆ DMAWriteFrame() [2/2]

bool CNTV2Card::DMAWriteFrame	(	const ULWord	inFrameNumber,
		const ULWord *	pInFrameBuffer,
		const ULWord	inByteCount,
		const NTV2Channel	inChannel
	)

virtual

Transfers a single frame from the host to the AJA device. This function is multi-format compatible.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be written to the device. For Frame Buffer Indexing purposes, this function assumes frame offsets/sizes based on the FrameStore identified by the `inChannel` parameter (below).
[in]	pInFrameBuffer	Specifies the non-NULL address of the host buffer that is to supply the frame data. The memory it points to must be readable.
[in]	inByteCount	Specifies the total number of bytes to transfer.
[in]	inChannel	Specifies the FrameStore to supply the Frame Buffer Indexing context to use with the `inFrameNumber` parameter. If the FrameStore, for example, is configured for UHD/4K, the intrinsic frame size (8MB or 16MB) will be quadrupled when calculating the starting destination address in device SDRAM.

Returns: True if successful; otherwise false.

Note: The host buffer must be at least inByteCount in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAReadFrame, CNTV2Card::DMAWrite, CNTV2Card::DMAWriteSegments, Frame Buffer Access

Definition at line 70 of file ntv2dma.cpp.

◆ DMAWriteLUTTable()

bool CNTV2Card::DMAWriteLUTTable	(	const ULWord	inFrameNumber,
		const ULWord *	pInLUTBuffer,
		const ULWord	inLUTIndex,
		const ULWord	inByteCount = `LUTTablePartitionSize`
	)

virtual

Synchronously transfers LUT data from the specified host buffer to the given buffer memory on the AJA device, blocking until the transfer has completed.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame buffer to be read on the device.
[in]	pInLUTBuffer	Specifies a valid, non-NULL pointer to the host buffer that is to supply the LUT data.
[in]	inLUTIndex	Specifies the index of the LUT
[in]	inByteCount	Specifies the amount to DMA

Returns: True if successful; otherwise false.

Note: This function can also be used to write LUT Tables into memory

Definition at line 295 of file ntv2dma.cpp.

◆ DMAWriteSegments()

bool CNTV2Card::DMAWriteSegments	(	const ULWord	inFrameNumber,
		const ULWord *	pFrameBuffer,
		const ULWord	inOffsetBytes,
		const ULWord	inSegmentByteCount,
		const ULWord	inNumSegments,
		const ULWord	inSegmentHostPitch,
		const ULWord	inSegmentCardPitch
	)

virtual

Performs a segmented data transfer from the host to the AJA device.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame to be written on the device.
[in]	pFrameBuffer	Specifies the non-NULL address of the host buffer that is to supply the frame data. The memory it points to must be readable.
[in]	inOffsetBytes	Specifies the initial device memory byte offset for the first bytes transferred.
[in]	inSegmentByteCount	Specifies the number of bytes to transfer per segment.
[in]	inNumSegments	Specifies the number of segments to transfer.
[in]	inSegmentHostPitch	Specifies the number of bytes to increment the host memory pointer after each segment is transferred.
[in]	inSegmentCardPitch	Specifies the number of bytes to increment the on-device memory pointer after each segment is transferred.

Returns: True if successful; otherwise false.

Note: The host buffer should be at least inSegmentByteCount*inNumSegments+inOffsetBytes in size, or a host memory access violation may occur.; This function will block and not return until the transfer has finished or failed.

See also: CNTV2Card::DMAReadSegments, CNTV2Card::DMAWrite, CNTV2Card::DMAWriteFrame, Frame Buffer Access

Definition at line 103 of file ntv2dma.cpp.

◆ Download12BitLUTToHW() [1/2]

bool CNTV2Card::Download12BitLUTToHW	(	const NTV2DoubleArray &	inRedLUT,
		const NTV2DoubleArray &	inGreenLUT,
		const NTV2DoubleArray &	inBlueLUT,
		const NTV2Channel	inLUT,
		const int	inBank
	)

virtual

Definition at line 722 of file ntv2csclut.cpp.

◆ Download12BitLUTToHW() [2/2]

bool CNTV2Card::Download12BitLUTToHW	(	const UWordSequence &	inRedLUT,
		const UWordSequence &	inGreenLUT,
		const UWordSequence &	inBlueLUT,
		const NTV2Channel	inLUT,
		const int	inBank
	)

virtual

Definition at line 779 of file ntv2csclut.cpp.

◆ DownloadLUTToHW() [1/3]

bool CNTV2Card::DownloadLUTToHW	(	const double *	pInTable,
		const NTV2Channel	inChannel,
		const int	inBank
	)

virtual

Definition at line 1361 of file ntv2csclut.cpp.

◆ DownloadLUTToHW() [2/3]

bool CNTV2Card::DownloadLUTToHW	(	const NTV2DoubleArray &	inRedLUT,
		const NTV2DoubleArray &	inGreenLUT,
		const NTV2DoubleArray &	inBlueLUT,
		const NTV2Channel	inLUT,
		const int	inBank
	)

virtual

Sends the given color lookup tables (LUTs) to the given LUT and bank.

Parameters

[in]	inRedLUT	The Red LUT, a std::vector of double-precision floating-point values.
[in]	inGreenLUT	The Green LUT, a std::vector of double-precision floating-point values.
[in]	inBlueLUT	The Blue LUT, a std::vector of double-precision floating-point values.
[in]	inLUT	Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index number).
[in]	inBank	Specifies the LUT bank of interest (0 or 1).

Returns: True if successful; otherwise false.

Definition at line 695 of file ntv2csclut.cpp.

◆ DownloadLUTToHW() [3/3]

bool CNTV2Card::DownloadLUTToHW	(	const UWordSequence &	inRedLUT,
		const UWordSequence &	inGreenLUT,
		const UWordSequence &	inBlueLUT,
		const NTV2Channel	inLUT,
		const int	inBank
	)

virtual

Writes the LUT tables to the given LUT and bank.

Parameters

[in]	inRedLUT	The Red LUT, a std::vector of UWord values.
[in]	inGreenLUT	The Green LUT, a std::vector of UWord values.
[in]	inBlueLUT	The Blue LUT, a std::vector of UWord values.
[in]	inLUT	Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index number).
[in]	inBank	Specifies the LUT bank of interest (0 or 1).

Returns: True if successful; otherwise false.

Definition at line 752 of file ntv2csclut.cpp.

◆ driverInterface()

virtual CNTV2DriverInterface& CNTV2Card::driverInterface ( void )

inlinevirtual

Returns: Convenience method for accessing my CNTV2DriverInterface.

Definition at line 6121 of file ntv2card.h.

◆ Enable4KDCPSFInMode()

bool CNTV2Card::Enable4KDCPSFInMode ( bool inEnable )

virtual

Sets 4K Down Convert PSF in mode.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, specifies PSF in If false, specifies P in

Definition at line 4178 of file ntv2register.cpp.

◆ Enable4KDCRGBMode()

bool CNTV2Card::Enable4KDCRGBMode ( bool inEnable )

virtual

Sets 4K Down Convert RGB mode.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, specifies RGB mode If false, specifies YCC mode

Definition at line 4152 of file ntv2register.cpp.

◆ Enable4KDCYCC444Mode()

bool CNTV2Card::Enable4KDCYCC444Mode ( bool inEnable )

virtual

Sets 4K Down Convert YCC 444 mode.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, specifies YCC 444 If false, specifies YCC 422

Definition at line 4165 of file ntv2register.cpp.

◆ Enable4KPSFOutMode()

bool CNTV2Card::Enable4KPSFOutMode ( bool inEnable )

virtual

Sets 4K Down Convert PSF out Mode.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, specifies PSF out If false, specifies P out

Definition at line 4191 of file ntv2register.cpp.

◆ EnableBOBAnalogAudioIn()

bool CNTV2Card::EnableBOBAnalogAudioIn ( bool inEnable )

virtual

Enables breakout board analog audio XLR inputs.

Parameters

[in] inEnable If true, specifies that the XLR connectors are enabled. If false, breakout board audio reverts to digital AES inputs.

Returns: True if successful; otherwise false.

See also: kDeviceCanDoBreakoutBoard, kDeviceHasBreakoutBoard

Definition at line 1716 of file ntv2audio.cpp.

◆ EnableChannel()

bool CNTV2Card::EnableChannel ( const NTV2Channel inChannel )

virtual

Enables the given FrameStore.

Parameters

[in] inChannel Specifies the FrameStore as an NTV2Channel value.

Returns: True if successful; otherwise false.

Note: It is not an error to enable a FrameStore that is already enabled.

See also: CNTV2Card::DisableChannel, CNTV2Card::EnableChannels, FrameStore Operation

Definition at line 2097 of file ntv2register.cpp.

◆ EnableChannels()

bool CNTV2Card::EnableChannels	(	const NTV2ChannelSet &	inChannels,
		const bool	inDisableOthers = `(0)`
	)

virtual

Enables the given FrameStore(s).

Parameters

[in]	inChannels	Specifies the FrameStore(s) to be enabled.
[in]	inDisableOthers	If true, disables all other FrameStores on the device. Otherwise, leaves other FrameStores untouched. Defaults to false.

Returns: True if successful; otherwise false.

Note: It is not an error to enable a FrameStore that is already enabled.

See also: CNTV2Card::EnableChannel, CNTV2Card::DisableChannels, FrameStore Operation

Definition at line 2107 of file ntv2register.cpp.

◆ EnableFramePulseReference()

bool CNTV2Card::EnableFramePulseReference ( const bool inEnable )

virtual

Enables the device's frame pulse reference select.

Parameters

[in] inEnable Specify true to enable the frame pulse reference; otherwise specify false.

Returns: True if successful; otherwise false.

See also: GetEnableFramePulseReference, GetFramePulseReference, Video Output Clocking & Synchronization

Definition at line 1566 of file ntv2register.cpp.

◆ EnableHDMIHDR()

bool CNTV2Card::EnableHDMIHDR ( const bool inEnableHDMIHDR )

virtual

Enables or disables HDMI HDR.

Parameters

[in] inEnableHDMIHDR If true, sets the device to output HDMI HDR Metadata; otherwise sets the device to not output HDMI HDR Metadata.

Returns: True if successful; otherwise false.

Definition at line 923 of file ntv2hdmi.cpp.

◆ EnableHDMIHDRDolbyVision()

bool CNTV2Card::EnableHDMIHDRDolbyVision ( const bool inEnable )

virtual

Enables or disables HDMI HDR Dolby Vision.

Parameters

[in] inEnable If true, sets the device to output HDMI HDR Dolby Vision; otherwise sets the device to not output HDMI HDR Dolby Vision.

Note: This function only affects Dolby HDR signaling. The client application is responsible for transferring Dolby-encoded pixel data from the host to the device frame buffer(s) for HDMI transmission.

See also: CNTV2Card::GetHDMIHDRDolbyVisionEnabled

Returns: True if successful; otherwise false.

Definition at line 942 of file ntv2hdmi.cpp.

◆ EnableHDMIOutCenterCrop()

bool CNTV2Card::EnableHDMIOutCenterCrop ( const bool inEnable )

virtual

Controls the 4k/2k -> UHD/HD HDMI center cropping feature.

Parameters

[in] inEnable Specify true to enable center cropping; otherwise false to disable it.

Returns: True if successful; otherwise false.

Definition at line 1062 of file ntv2hdmi.cpp.

◆ EnableHDMIOutUserOverride()

bool CNTV2Card::EnableHDMIOutUserOverride ( const bool inEnable )

virtual

Enables or disables override of HDMI parameters.

Parameters

[in] inEnable Specify true to enable HDMI user-override; otherwise false to disable it.

Returns: True if successful; otherwise false.

Definition at line 1049 of file ntv2hdmi.cpp.

◆ EnableInputInterrupt() [1/2]

bool CNTV2Card::EnableInputInterrupt ( const NTV2Channel channel = NTV2_CHANNEL1 )

virtual

Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given input channel on the receiver's AJA device.

Parameters

[in] channel Specifies the input channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 23 of file ntv2interrupts.cpp.

◆ EnableInputInterrupt() [2/2]

bool CNTV2Card::EnableInputInterrupt ( const NTV2ChannelSet & inFrameStores )

virtual

Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given FrameStore(s).

Parameters

[in] inFrameStores The input frameStore(s) of interest.

Returns: True if successful; otherwise false.

Definition at line 24 of file ntv2interrupts.cpp.

◆ EnableInterrupt()

bool CNTV2Card::EnableInterrupt ( const INTERRUPT_ENUMS inEventCode )

virtual

Definition at line 21 of file ntv2interrupts.cpp.

◆ EnableOutputInterrupt()

bool CNTV2Card::EnableOutputInterrupt ( const NTV2Channel channel = NTV2_CHANNEL1 )

virtual

Allows the CNTV2Card instance to wait for and respond to output vertical blanking interrupts originating from the given frameStore on the receiver's AJA device.

Parameters

[in] channel Specifies the frameStore of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 22 of file ntv2interrupts.cpp.

◆ EnableRP188Bypass()

bool CNTV2Card::EnableRP188Bypass ( const NTV2Channel inSDIOutput )

virtual

Configures the SDI output's embedder to embed SMPTE 12M timecode obtained from an SDI input, which is often useful in E-E mode.

Parameters

[in] inSDIOutput Specifies the SDI output of interest, expressed as an NTV2Channel.

Returns: True if successful; otherwise false.

See also: CNTV2Card::DisableRP188Bypass, CNTV2Card::SetRP188SourceFilter, CNTV2Card::SetRP188BypassSource, Timecode (RP-188, SMPTE-12M)

Definition at line 2571 of file ntv2register.cpp.

◆ features()

virtual class DeviceCapabilities& CNTV2Card::features ( void )

inlinevirtual

Returns: A reference to my DeviceCapabilities API, for querying my capabilities.

Definition at line 141 of file ntv2card.h.

◆ FindUnallocatedFrames()

bool CNTV2Card::FindUnallocatedFrames	(	const UWord	inFrameCount,
		LWord &	outStartFrame,
		LWord &	outEndFrame,
		const NTV2Channel	inFrameStore = `NTV2_CHANNEL_INVALID`
	)

virtual

Returns the device frame buffer numbers of the first unallocated contiguous band of frame buffers having the given size that are available for use. This function is called by CNTV2Card::AutoCirculateInitForInput and CNTV2Card::AutoCirculateInitForOutput whenever a frame count is specified in lieu of explicit frame ranges.

Parameters

[in]	inFrameCount	Specifies the desired number of contiguous device frame buffers. Must exceed zero.
[out]	outStartFrame	Receives the starting device frame buffer number (or -1 upon failure).
[out]	outEndFrame	Receives the ending device frame buffer number (or -1 upon failure).
[in]	inFrameStore	Optionally specifies the FrameStore of interest for the desired frame count. Any memory being read or written by this FrameStore will be excluded when collecting unallocated regions of device SDRAM, and also its NTV2VideoFormat will determine if the frames are quad-sized or quad-quad-sized. Defaults to NTV2_CHANNEL_INVALID for backward compatibility.

Returns: True if successful; otherwise false.

Note: Prior to SDK 16.1, this function returned invalid frame numbers if any AutoCirculate channels were actively processing UHD/4K or UHD2/8K. In SDK 16.2, this function failed (returned false) if any AutoCirculate channels were actively processing UHD/4K or UHD2/8K. In SDK 16.3, the function was corrected to work with UHD/4K and UHD2/8K, but requires specifying a FrameStore of interest.

See also: See AutoCirculate

Definition at line 113 of file ntv2autocirculate.cpp.

◆ FlipFlopPage()

bool CNTV2Card::FlipFlopPage ( const NTV2Channel inChannel )

virtual

Deprecated:: Declared obsolete starting in SDK 16.2. Swapped the PCI access frame and output frame registers at the next output VBI.

Definition at line 2180 of file ntv2register.cpp.

◆ GenerateGammaTable() [1/3]

bool CNTV2Card::GenerateGammaTable	(	const NTV2LutType	inLUTType,
		const int	inBank,
		double *	pOutTable
	)

static

Definition at line 1349 of file ntv2csclut.cpp.

◆ GenerateGammaTable() [2/3]

bool CNTV2Card::GenerateGammaTable	(	const NTV2LutType	inLUTType,
		const int	inBank,
		NTV2DoubleArray &	outTable,
		const NTV2LutBitDepth	inBitDepth = `NTV2_LUT10Bit`
	)

static

Definition at line 469 of file ntv2csclut.cpp.

◆ GenerateGammaTable() [3/3]

bool CNTV2Card::GenerateGammaTable	(	const NTV2LutType	inLUTType,
		const int	inBank,
		UWordSequence &	outTable,
		const NTV2LutBitDepth	inBitDepth = `NTV2_LUT10Bit`
	)

static

Definition at line 661 of file ntv2csclut.cpp.

◆ Get12BitLUTPlaneSelect()

bool CNTV2Card::Get12BitLUTPlaneSelect ( NTV2LUTPlaneSelect & outLUTPlane )

virtual

Answers with the current LUT plane.

Parameters

[out] outLUTPlane Receives the current LUT plane.

Returns: True if successful; otherwise false.

Definition at line 353 of file ntv2csclut.cpp.

◆ Get12BitLUTTables()

bool CNTV2Card::Get12BitLUTTables	(	NTV2DoubleArray &	outRedLUT,
		NTV2DoubleArray &	outGreenLUT,
		NTV2DoubleArray &	outBlueLUT
	)

virtual

Definition at line 1010 of file ntv2csclut.cpp.

◆ Get4kSquaresEnable()

bool CNTV2Card::Get4kSquaresEnable	(	bool &	outIsEnabled,
		const NTV2Channel	inChannel
	)

virtual

Answers whether the FrameStore bank's current SMPTE 425 "4K squares" (i.e., "2K quadrants") mode is enabled or not.

Returns: True if successful; otherwise false.

Parameters

[out]	outIsEnabled	Receives true if the device's FrameStores are currently in "4K squares" (i.e., "2K quadrants") mode; otherwise false.
[in]	inChannel	Specifies the FrameStore bank of interest. Using anything ordinally less than NTV2_CHANNEL5 will report on FrameStores 1/2/3/4, while anything ordinally greater than NTV2_CHANNEL4 will report on FrameStores 5/6/7/8.

Definition at line 1289 of file ntv2register.cpp.

◆ Get64BitAutodetect()

bool CNTV2Card::Get64BitAutodetect ( ULWord * autodetect64 )

virtual

Definition at line 3189 of file ntv2register.cpp.

◆ GetActiveFrameDimensions() [1/2]

NTV2FrameDimensions CNTV2Card::GetActiveFrameDimensions ( const NTV2Channel inChannel = NTV2_CHANNEL1 )

virtual

Deprecated:: Obsolete starting in SDK 16.2.

Definition at line 794 of file ntv2register.cpp.

◆ GetActiveFrameDimensions() [2/2]

bool CNTV2Card::GetActiveFrameDimensions	(	NTV2FrameDimensions &	outFrameDimensions,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Deprecated:: Obsolete starting in SDK 16.2.

Definition at line 782 of file ntv2register.cpp.

◆ GetAESOutputSource()

bool CNTV2Card::GetAESOutputSource	(	const NTV2Audio4ChannelSelect	inAESAudioChannels,
		NTV2AudioSystem &	outSrcAudioSystem,
		NTV2Audio4ChannelSelect &	outSrcAudioChannels
	)

virtual

Answers with the current audio source for a given quad of AES audio output channels. By default, at power-up, for AJA devices that support AES audio output, the content of AES audio output channels 1/2/3/4 reflect what's being output from audio channels 1/2/3/4 from NTV2_AUDIOSYSTEM_1, likewise with audio channels 5/6/7/8, etc.

Parameters

[in]	inAESAudioChannels	Specifies the AES audio output channel quad of interest.
[out]	outSrcAudioSystem	Receives the NTV2AudioSystem that is currently driving the given AES audio output channel quad.
[out]	outSrcAudioChannels	Receives the audio channel quad from the Audio System that's sourcing the given AES audio output channel quad.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAESOutputSource, Audio Playout

Definition at line 1431 of file ntv2audio.cpp.

◆ GetAlphaFromInput2Bit()

bool CNTV2Card::GetAlphaFromInput2Bit ( ULWord & outValue )

virtual

Definition at line 2228 of file ntv2register.cpp.

◆ GetAnalogAudioIOConfiguration()

bool CNTV2Card::GetAnalogAudioIOConfiguration ( NTV2AnalogAudioIO & outConfig )

virtual

Deprecated:: Use CNTV2Card::GetAnalogAudioTransmitEnable instead.

Definition at line 1668 of file ntv2audio.cpp.

◆ GetAnalogAudioTransmitEnable()

bool CNTV2Card::GetAnalogAudioTransmitEnable	(	const NTV2Audio4ChannelSelect	inChannelQuad,
		bool &	outEnabled
	)

virtual

Answers whether or not the specified bidirectional XLR audio connectors are collectively acting as inputs or outputs.

Parameters

[in]	inChannelQuad	Specifies the XLR audio connectors of interest.
[out]	outEnabled	Receives true if the XLR connectors are currently transmitting (output), or false if they're receiving (input).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAnalogAudioTransmitEnable

Definition at line 1627 of file ntv2audio.cpp.

◆ GetAnalogCompositeInputVideoFormat()

NTV2VideoFormat CNTV2Card::GetAnalogCompositeInputVideoFormat ( void )

virtual

Returns the video format of the signal that is present on the device's composite video input.

Returns: A valid NTV2VideoFormat if successful; otherwise returns NTV2_FORMAT_UNKNOWN.

Definition at line 3513 of file ntv2register.cpp.

◆ GetAnalogInputADCMode()

bool CNTV2Card::GetAnalogInputADCMode ( NTV2LSVideoADCMode & outValue )

virtual

Definition at line 275 of file ntv2regconv.cpp.

◆ GetAnalogInputVideoFormat()

NTV2VideoFormat CNTV2Card::GetAnalogInputVideoFormat ( void )

virtual

Returns the video format of the signal that is present on the device's analog video input.

Returns: A valid NTV2VideoFormat if successful; otherwise returns NTV2_FORMAT_UNKNOWN.

Definition at line 3497 of file ntv2register.cpp.

◆ GetAnalogLTCInClockChannel()

bool CNTV2Card::GetAnalogLTCInClockChannel	(	const UWord	inLTCInput,
		NTV2Channel &	outChannel
	)

virtual

Answers with the (SDI) input channel that's providing the clock reference being used by the given device's analog LTC input.

Parameters

[in]	inLTCInput	Specifies the device's analog LTC input. Use 0 for LTC In 1, or 1 for LTC In 2. (Call NTV2DeviceGetNumLTCInputs to determine the number of analog LTC inputs.)
[out]	outChannel	Receives the NTV2Channel that is currently providing the clock reference for reading the given analog LTC input.

Returns: True if successful; otherwise false.

Note: This function is provided for devices that are capable of handling multiple, disparate video formats (see NTV2DeviceCanDoMultiFormat and CNTV2Card::GetMultiFormatMode functions). It doesn't make sense to call this function on a device that is running in "UniFormat" mode.

See also: SetAnalogLTCInClockChannel, NTV2DeviceGetNumLTCInputs, Analog LTC Input

Definition at line 3718 of file ntv2register.cpp.

◆ GetAnalogLTCOutClockChannel()

bool CNTV2Card::GetAnalogLTCOutClockChannel	(	const UWord	inLTCOutput,
		NTV2Channel &	outChannel
	)

virtual

Answers with the (SDI) output channel that's providing the clock reference being used by the given device's analog LTC output.

Parameters

[in]	inLTCOutput	Specifies the device's analog LTC output. Use 0 for LTC Out 1, or 1 for LTC Out 2. (Call NTV2DeviceGetNumLTCOutputs to determine the number of analog LTC outputs.)
[out]	outChannel	Receives the NTV2Channel that is currently providing the clock reference for writing the given analog LTC output.

Returns: True if successful; otherwise false.

Note: This function is provided for devices that are capable of handling multiple, disparate video formats (see NTV2DeviceCanDoMultiFormat and CNTV2Card::GetMultiFormatMode functions). It doesn't make sense to call this function on a device that is running in "UniFormat" mode.

See also: SetAnalogLTCOutClockChannel, NTV2DeviceGetNumLTCOutputs, Analog LTC Output

Definition at line 3758 of file ntv2register.cpp.

◆ GetAnalogOutHTiming()

bool CNTV2Card::GetAnalogOutHTiming ( ULWord & outValue )

virtual

Definition at line 3198 of file ntv2register.cpp.

◆ GetAncRegionOffsetAndSize()

bool CNTV2Card::GetAncRegionOffsetAndSize	(	ULWord &	outByteOffset,
		ULWord &	outByteCount,
		const NTV2AncillaryDataRegion	inAncRegion = `NTV2_AncRgn_All`
	)

virtual

Answers with the offset and size of an ancillary data region within a device frame buffer.

Parameters

[out]	outByteOffset	Receives the byte offset where the ancillary data region starts in the frame buffer, (measured from the start of the frame buffer). This is guaranteed to be non-zero if the function succeeds, and zero if it fails.
[out]	outByteCount	Receives the size of the ancillary data region, in bytes. This is guaranteed to be non-zero if the function succeeds, and zero if it fails.
[in]	inAncRegion	Optionally specifies the ancillary data region of interest (e.g. NTV2_AncRgn_Field1, NTV2_AncRgn_Field2, etc.). Defaults to all regions, for the maximum offset and size among all of them.

Returns: True if successful; otherwise false.

See also: CNTV2Card::AncSetFrameBufferSize, Ancillary Data Space Limitations

Definition at line 516 of file ntv2dma.cpp.

◆ GetAncRegionOffsetFromBottom()

bool CNTV2Card::GetAncRegionOffsetFromBottom	(	ULWord &	outByteOffsetFromBottom,
		const NTV2AncillaryDataRegion	inAncRegion = `NTV2_AncRgn_All`
	)

virtual

Answers with the byte offset to the start of an ancillary data region within a device frame buffer, as measured from the bottom of the frame buffer.

Parameters

[out]	outByteOffsetFromBottom	Receives the byte offset to the start of the ancillary data region, as measured from the bottom of the frame buffer.
[in]	inAncRegion	Optionally specifies the ancillary data region of interest (e.g. NTV2_AncRgn_Field1, NTV2_AncRgn_Field2, etc.). Defaults to all regions, for the largest offset among them all.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAncRegionOffsetAndSize, Ancillary Data Space Limitations

Definition at line 601 of file ntv2dma.cpp.

◆ GetAudio20BitMode()

bool CNTV2Card::GetAudio20BitMode	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outEnable
	)

virtual

Answers whether or not the device's NTV2AudioSystem is currently operating in 20-bit mode. Normally the NTV2AudioSystem operates in 24-bit mode.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[out]	outEnable	Receives 'true' if the Audio System is in 20 bit mode, or 'false' if audio is in 24 bit mode.

Note: This function is relevant only for the KONA IP or Io IP.

Definition at line 1086 of file ntv2audio.cpp.

◆ GetAudioAnalogLevel()

bool CNTV2Card::GetAudioAnalogLevel	(	NTV2AudioLevel &	outValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Definition at line 290 of file ntv2audio.cpp.

◆ GetAudioBufferSize()

bool CNTV2Card::GetAudioBufferSize	(	NTV2AudioBufferSize &	outSize,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Retrieves the size of the input or output audio buffer being used for a given Audio System on the AJA device.

Returns: True if successful; otherwise false.

Parameters

[out]	outSize	Receives the size of the capture/playout audio buffer for the given Audio System on the AJA device.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

See also: CNTV2Card::SetAudioBufferSize

Definition at line 268 of file ntv2audio.cpp.

◆ GetAudioCaptureEnable()

bool CNTV2Card::GetAudioCaptureEnable	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outEnable
	)

virtual

Answers whether or not the Audio System is configured to write captured audio samples into device audio buffer memory.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[out]	outEnable	Receives 'true' if the Audio System will write captured samples into device audio buffer memory when running; otherwise 'false' if the Audio System is prohibited from writing captured samples into device audio buffer memory.

See also: CNTV2Card::SetAudioCaptureEnable, Audio Capture

Definition at line 1176 of file ntv2audio.cpp.

◆ GetAudioInputDelay()

bool CNTV2Card::GetAudioInputDelay	(	const NTV2AudioSystem	inAudioSystem,
		ULWord &	outDelay
	)

virtual

Answers with the audio input delay for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System whose input delay is to be retrieved.
[out]	outDelay	A ULWord variable that is to receive the Audio System's current input delay value, expressed as an integral number of 512 byte chunks in the Audio System's audio buffer on the device. This can be translated into microseconds by multiplying the received value by 166.7.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioInputDelay, Audio Capture

Definition at line 1206 of file ntv2audio.cpp.

◆ GetAudioLoopBack()

bool CNTV2Card::GetAudioLoopBack	(	NTV2AudioLoopBack &	outMode,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Answers if NTV2AudioLoopBack mode is currently on or off for the given NTV2AudioSystem.

Returns: True if successful; otherwise false.

Parameters

[out]	outMode	Receives NTV2_AUDIO_LOOPBACK_ON if the Audio System's output embedder will pull audio samples from the Audio System's input de-embedder; otherwise receives NTV2_AUDIO_LOOPBACK_OFF if the output embedder emits silence (zeroes).
[in]	inAudioSystem	Optionally specifies the Audio System on the device to be affected. Defaults to NTV2_AUDIOSYSTEM_1.

See also: CNTV2Card::SetAudioLoopBack, Audio Playout

Definition at line 321 of file ntv2audio.cpp.

◆ GetAudioMemoryOffset()

bool CNTV2Card::GetAudioMemoryOffset	(	const ULWord	inOffsetBytes,
		ULWord &	outAbsByteOffset,
		const NTV2AudioSystem	inAudioSystem,
		const bool	inCaptureBuffer = `(0)`
	)

virtual

Answers with the byte offset in device SDRAM into the specified Audio System's audio buffer.

Returns: True if successful; otherwise false.

Parameters

[in]	inOffsetBytes	Specifies a byte offset as measured from the top of the Audio System's audio buffer memory. If "inCaptureBuffer" is set to 'true', this value represents the offset as measured from the top of the Audio System's capture buffer.
[out]	outAbsByteOffset	Receives the equivalent absolute byte offset in device SDRAM.
[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inCaptureBuffer	If true, "inOffsetBytes" is to be interpreted as relative to the start of the audio capture buffer. If false, the default, "inOffsetBytes" is relative to the start of the audio playout buffer.

Definition at line 1723 of file ntv2audio.cpp.

◆ GetAudioMixerInputAudioSystem()

bool CNTV2Card::GetAudioMixerInputAudioSystem	(	const NTV2AudioMixerInput	inMixerInput,
		NTV2AudioSystem &	outAudioSystem
	)

virtual

Answers with the Audio System that's currently driving the given input of the Audio Mixer.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[out]	outAudioSystem	Receives the NTV2AudioSystem that's currently driving the Audio Mixer's input.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioMixerInputAudioSystem, Audio Mixer

Definition at line 554 of file ntv2audio.cpp.

◆ GetAudioMixerInputChannelSelect()

bool CNTV2Card::GetAudioMixerInputChannelSelect	(	const NTV2AudioMixerInput	inMixerInput,
		NTV2AudioChannelPair &	outChannelPair
	)

virtual

Answers with the Audio Channel Pair that's currently driving the given input of the Audio Mixer.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[out]	outChannelPair	Receives the NTV2AudioChannelPair that's currently driving the audio mixer's input.

Returns: True if successful; otherwise false.

Note: Audio mixer inputs NTV2_AudioMixerInputAux1 and NTV2_AudioMixerInputAux2 currently return NTV2_AudioChannel1_2.

See also: CNTV2Card::SetAudioMixerInputChannelSelect, Audio Mixer

Definition at line 579 of file ntv2audio.cpp.

◆ GetAudioMixerInputChannelsMute()

bool CNTV2Card::GetAudioMixerInputChannelsMute	(	const NTV2AudioMixerInput	inMixerInput,
		NTV2AudioChannelsMuted16 &	outMutes
	)

virtual

Answers with a std::bitset that indicates which input audio channels of the given Audio Mixer input are currently muted.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[out]	outMutes	Receives the bitset. Call its "test" method, passing it a valid NTV2AudioMixerChannel to determine if that channel is muted (true) or not (false). Note that only audio channels NTV2_AudioMixerChannel1 and NTV2_AudioMixerChannel2 are relevant.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioMixerInputChannelsMute, Audio Mixer

Definition at line 739 of file ntv2audio.cpp.

◆ GetAudioMixerInputGain()

bool CNTV2Card::GetAudioMixerInputGain	(	const NTV2AudioMixerInput	inMixerInput,
		const NTV2AudioMixerChannel	inChannel,
		ULWord &	outGainValue
	)

virtual

Answers with the current gain setting for the Audio Mixer's given input.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[in]	inChannel	Specifies the audio channel of interest.
[out]	outGainValue	Receives the current main input gain level. This is a signed 18-bit value, where unity gain is 0x10000.

Returns: True if successful; otherwise false.

Note: Currently, the Audio Mixer's Main input gain control affects both audio channels 1 & 2 (L & R), while the Aux 1 & 2 inputs have separate gain settings for audio channels 1 & 2 (L & R).

See also: CNTV2Card::GetAudioMixerInputGain, Audio Mixer

Definition at line 609 of file ntv2audio.cpp.

◆ GetAudioMixerInputLevels()

bool CNTV2Card::GetAudioMixerInputLevels	(	const NTV2AudioMixerInput	inMixerInput,
		const NTV2AudioChannelPairs &	inChannelPairs,
		std::vector< uint32_t > &	outLevels
	)

virtual

Answers with the Audio Mixer's current audio input levels.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[in]	inChannelPairs	Specifies the audio channel pair(s) of interest. Use an empty list to retrieve all available audio channels.
[out]	outLevels	A std::vector of ULWord values, one per audio channel, in ascending audio channel order (per the NTV2AudioChannelPairs that were specified).

Returns: True if successful; otherwise false.

See also: See Audio Mixer

Definition at line 764 of file ntv2audio.cpp.

◆ GetAudioMixerLevelsSampleCount()

bool CNTV2Card::GetAudioMixerLevelsSampleCount ( ULWord & outSampleCount )

virtual

Answers with the Audio Mixer's current sample count used for measuring audio levels.

Parameters

[out] outSampleCount Receives the current sample count.

Returns: True if successful; otherwise false.

See also: See Audio Mixer

Definition at line 828 of file ntv2audio.cpp.

◆ GetAudioMixerOutputChannelsMute()

bool CNTV2Card::GetAudioMixerOutputChannelsMute ( NTV2AudioChannelsMuted16 & outMutes )

virtual

Answers with a std::bitset that indicates which output audio channels of the Audio Mixer are currently muted.

Parameters

[out] outMutes Receives the bitset. Call its "test" method, passing it a valid NTV2AudioMixerChannel to determine if that channel is muted (true) or not (false).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioMixerOutputChannelsMute, Audio Mixer

Definition at line 720 of file ntv2audio.cpp.

◆ GetAudioMixerOutputGain()

bool CNTV2Card::GetAudioMixerOutputGain ( ULWord & outGainValue )

virtual

Answers with the current gain setting for the Audio Mixer's output.

Parameters

[out] outGainValue Receives the current main input gain level. This is a signed 18-bit value, where unity gain is 0x10000.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioMixerOutputGain, Audio Mixer

Definition at line 636 of file ntv2audio.cpp.

◆ GetAudioMixerOutputLevels()

bool CNTV2Card::GetAudioMixerOutputLevels	(	const NTV2AudioChannelPairs &	inChannelPairs,
		std::vector< uint32_t > &	outLevels
	)

virtual

Answers with the Audio Mixer's current audio output levels.

Parameters

[in]	inChannelPairs	Specifies the audio channel pair(s) of interest. Use an empty list to retrieve all available audio channels.
[out]	outLevels	A std::vector of ULWord values, one per audio channel, in ascending audio channel order (per the NTV2AudioChannelPairs that were specified).

Returns: True if successful; otherwise false.

See also: See Audio Mixer

Definition at line 652 of file ntv2audio.cpp.

◆ GetAudioOutputAESSyncModeBit()

bool CNTV2Card::GetAudioOutputAESSyncModeBit	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outAESSyncModeBitSet
	)

virtual

Answers with the current state of the AES Sync Mode bit for the given Audio System's output.

Parameters

[in]	inAudioSystem	Specifies the audio system of interest.
[out]	outAESSyncModeBitSet	Receives 'true' if the bit is set; otherwise 'false' (normal operation).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioOutputAESSyncModeBit, Audio Playout

Definition at line 1687 of file ntv2audio.cpp.

◆ GetAudioOutputDelay()

bool CNTV2Card::GetAudioOutputDelay	(	const NTV2AudioSystem	inAudioSystem,
		ULWord &	outDelay
	)

virtual

Answers with the audio output delay for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System whose output delay is to be retrieved.
[out]	outDelay	A ULWord variable that is to receive the Audio System's current output delay value, expressed as an integral number of 512-byte chunks in the Audio System's audio buffer on the device. This can be translated into microseconds by multiplying the received value by 166.7.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioOutputDelay, Audio Playout

Definition at line 1222 of file ntv2audio.cpp.

◆ GetAudioOutputEmbedderState()

bool CNTV2Card::GetAudioOutputEmbedderState	(	const NTV2Channel	inSDIOutputConnector,
		bool &	outIsEnabled
	)

virtual

Answers with the current state of the audio output embedder for the given SDI output connector (specified as a channel number). When the embedder is disabled, the device will not embed any SMPTE 299M (HD) or SMPTE 272M (SD) packets in the HANC in the SDI output stream.

Parameters

[in]	inSDIOutputConnector	Specifies the SDI output of interest.
[out]	outIsEnabled	Receives 'true' if the audio output embedder is enabled; otherwise 'false' if disabled.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioOutputEmbedderState, Audio Playout

Definition at line 1561 of file ntv2audio.cpp.

◆ GetAudioOutputEraseMode()

bool CNTV2Card::GetAudioOutputEraseMode	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outEraseModeEnabled
	)

virtual

Answers with the current state of the audio output erase mode for the given Audio System. If enabled, the Audio System automatically writes zeroes into the audio output buffer behind the output read head during playout.

Parameters

[in]	inAudioSystem	Specifies the audio system of interest.
[out]	outEraseModeEnabled	Receives 'true' if enabled; otherwise 'false' if disabled (normal operation).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioOutputEraseMode, Audio Playout

Definition at line 1591 of file ntv2audio.cpp.

◆ GetAudioOutputMonitorSource()

bool CNTV2Card::GetAudioOutputMonitorSource	(	NTV2AudioChannelPair &	outChannelPair,
		NTV2AudioSystem &	outAudioSystem
	)

virtual

Answers with the current audio monitor source. The audio output monitor is typically a pair of RCA jacks (white + red) and/or a headphone jack.

Parameters

[out]	outAudioSystem	Receives the current audio system being used.
[out]	outChannelPair	Receives the current audio channel pair being used.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioOutputMonitorSource, Audio Playout

Definition at line 1007 of file ntv2audio.cpp.

◆ GetAudioOutputPause()

bool CNTV2Card::GetAudioOutputPause	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outIsPaused
	)

virtual

Answers if the device's Audio System is currently paused or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[out]	outIsPaused	Receives 'true' if audio output is paused, or 'false' if audio playout is running normally.

See also: CNTV2Card::SetAudioOutputPause, CNTV2Card::IsAudioOutputRunning, Audio Playout

Definition at line 1101 of file ntv2audio.cpp.

◆ GetAudioPCMControl() [1/3]

bool CNTV2Card::GetAudioPCMControl	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outIsNonPCM
	)

virtual

Answers whether or not all outgoing audio channel pairs are currently being flagged as non-PCM for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[out]	outIsNonPCM	Receives true if all outgoing audio channel pairs are currently flagged as non-PCM; otherwise receives false if the non-PCM indicator is set "Off".

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioPCMControl, Audio Playout

Definition at line 1237 of file ntv2audio.cpp.

◆ GetAudioPCMControl() [2/3]

bool CNTV2Card::GetAudioPCMControl	(	const NTV2AudioSystem	inAudioSystem,
		const NTV2AudioChannelPair	inChannelPair,
		bool &	outIsNonPCM
	)

virtual

Answers whether or not the given audio channel pair in the given Audio System on the device is being treated as normal PCM audio.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inChannelPair	Specifies the channel pair of interest.
[out]	outIsNonPCM	Receives true if the audio channel pair is currently being flagged as non-PCM; otherwise false.

Returns: True if successful; otherwise false.

Note: Call NTV2DeviceCanDoPCMControl to determine if this device supports per-audio-channel-pair PCM control.; This function's answer is irrelevant if the Audio-System-wide non-PCM control setting is set to non-PCM. (See the two-parameter overloaded version of this function.)

See also: CNTV2Card::SetAudioPCMControl, Audio Playout

Definition at line 1278 of file ntv2audio.cpp.

◆ GetAudioPCMControl() [3/3]

bool CNTV2Card::GetAudioPCMControl	(	const NTV2AudioSystem	inAudioSystem,
		NTV2AudioChannelPairs &	outNonPCMChannelPairs
	)

virtual

Answers which NTV2AudioChannelPairs being transmitted by the given NTV2AudioSystem are currently being flagged as non-PCM.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[out]	outNonPCMChannelPairs	Receives the NTV2AudioChannelPairs that are currently being flagged as non-PCM.

Returns: True if successful; otherwise false.

Note: Call NTV2DeviceCanDoPCMControl to determine if this device supports per-audio-channel-pair PCM control.

See also: CNTV2Card::SetAudioPCMControl, Audio Playout

Definition at line 1290 of file ntv2audio.cpp.

◆ GetAudioPlayCaptureModeEnable()

bool CNTV2Card::GetAudioPlayCaptureModeEnable	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outEnable
	)

virtual

Answers whether or not the device's Audio System is currently operating in a special mode in which its embedder and deembedder both start from the audio base address, instead of operating independently.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[out]	outEnable	A boolean variable that is to receive 'true' if the Audio System's de-embedder and embedder both start from the audio base address, or 'false' if the Audio System is operating normally.

Definition at line 1190 of file ntv2audio.cpp.

◆ GetAudioRate()

bool CNTV2Card::GetAudioRate	(	NTV2AudioRate &	outRate,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Returns the current NTV2AudioRate for the given Audio System.

Returns: True if successful; otherwise false.

Parameters

[out]	outRate	Receives the current NTV2AudioRate.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

Note: Current generation NTV2 devices only support a fixed 48 kHz sample rate.

Definition at line 226 of file ntv2audio.cpp.

◆ GetAudioReadOffset()

bool CNTV2Card::GetAudioReadOffset	(	ULWord &	outReadOffset,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

For the given Audio System, answers with the byte offset from the start of the audio buffer to the first byte of the input/capture buffer. (The capture buffer immediately follows the playout buffer in increasing memory address order.)

Returns: True if successful; otherwise false.

Parameters

[out]	outReadOffset	Receives the offset to the audio capture buffer from the start of the audio buffer. This will typically be 4MB.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

Definition at line 449 of file ntv2audio.cpp.

◆ GetAudioSystemInputSource()

bool CNTV2Card::GetAudioSystemInputSource	(	const NTV2AudioSystem	inAudioSystem,
		NTV2AudioSource &	outAudioSource,
		NTV2EmbeddedAudioInput &	outEmbeddedSource
	)

virtual

Answers with the device's current NTV2AudioSource (and also possibly its NTV2EmbeddedAudioInput) for the given NTV2AudioSystem.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[out]	outAudioSource	Receives the NTV2AudioSource that's currently being used for the given NTV2AudioSystem (e.g., NTV2_AUDIO_EMBEDDED, NTV2_AUDIO_AES, NTV2_AUDIO_ANALOG, etc.).
[out]	outEmbeddedSource	Receives the NTV2EmbeddedAudioInput. Ignore this result if the audio source is not NTV2_AUDIO_EMBEDDED.

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.

See also: CNTV2Card::SetAudioSystemInputSource, Audio Capture

Definition at line 520 of file ntv2audio.cpp.

◆ GetAudioWrapAddress()

bool CNTV2Card::GetAudioWrapAddress	(	ULWord &	outWrapAddress,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

For the given Audio System, answers with the wrap address, the threshold at which input/record or output/play transfers will likely need to account for "wrapping" around the end of the buffer back to the start of the buffer to continue recording/playing.

Note: Since input/record wrap detection is simple – i.e., the value returned from CNTV2Card::ReadAudioLastIn has decreased – this function is provided to detect when an output wrap will occur.

Returns: True if successful; otherwise false.

Parameters

[out]	outWrapAddress	Receives the byte offset in the audio output buffer at which a "wrap" will occur. This is typically 16KB from the end of the buffer. If the current offset plus the audio bytes to be written will go past this position, the caller should split the DMA transfer into two separate ones: one to fill to the end of the buffer, and the remainder from the start of the buffer.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

Definition at line 433 of file ntv2audio.cpp.

◆ GetAutoCirculate()

bool CNTV2Card::GetAutoCirculate	(	NTV2Crosspoint	channelSpec,
		AUTOCIRCULATE_STATUS_STRUCT *	autoCirculateStatus
	)

virtual

Deprecated:: Use CNTV2Card::AutoCirculateGetStatus instead.

Definition at line 96 of file ntv2autocirculate.cpp.

◆ GetBaseAddress() [1/2]

bool CNTV2Card::GetBaseAddress	(	NTV2Channel	channel,
		ULWord **	pBaseAddress
	)

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 3077 of file ntv2register.cpp.

◆ GetBaseAddress() [2/2]

bool CNTV2Card::GetBaseAddress ( ULWord ** pBaseAddress )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 3107 of file ntv2register.cpp.

◆ GetBaseDeviceID()

NTV2DeviceID CNTV2Card::GetBaseDeviceID ( )

virtual

Returns: Return base device id for IsDynamicDevice, otherwise DEVICE_ID_INVALID

Definition at line 57 of file ntv2dynamicdevice.cpp.

◆ GetBitfileInfoString()

string CNTV2Card::GetBitfileInfoString ( const BITFILE_INFO_STRUCT & inBitFileInfo )

virtual

Generates and returns an info string with date, time and name for the given inBifFileInfo.

Parameters

[in] inBitFileInfo BitFile Info structure to get information from, no validity checks are made on the structure before use.

Returns: A string containing the bitfile information.

Definition at line 328 of file ntv2card.cpp.

◆ GetBreakoutHardware()

NTV2BreakoutType CNTV2Card::GetBreakoutHardware ( void )

virtual

Returns: My current breakout box hardware type, if any is attached.

Definition at line 364 of file ntv2card.cpp.

◆ GetColorCorrectionHostAccessBank()

bool CNTV2Card::GetColorCorrectionHostAccessBank	(	NTV2ColorCorrectionHostAccessBank &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 227 of file ntv2csclut.cpp.

◆ GetColorCorrectionMode()

bool CNTV2Card::GetColorCorrectionMode	(	const NTV2Channel	inChannel,
		NTV2ColorCorrectionMode &	outMode
	)

virtual

Definition at line 77 of file ntv2csclut.cpp.

◆ GetColorCorrectionOutputBank()

bool CNTV2Card::GetColorCorrectionOutputBank	(	const NTV2Channel	inLUTWidget,
		ULWord &	outBank
	)

virtual

Answers with the current LUT bank in use for the given LUT.

Parameters

[in]	inLUTWidget	Specifies the LUT widget of interest as an NTV2Channel, a zero-based index number.
[out]	outBank	Receives the bank number that's currently in use (0 or 1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetColorCorrectionOutputBank, LUT Operation

Definition at line 120 of file ntv2csclut.cpp.

◆ GetColorCorrectionSaturation()

bool CNTV2Card::GetColorCorrectionSaturation	(	const NTV2Channel	inChannel,
		ULWord &	outValue
	)

virtual

Definition at line 320 of file ntv2csclut.cpp.

◆ GetColorSpaceCustomCoefficients()

bool CNTV2Card::GetColorSpaceCustomCoefficients	(	NTV2CSCCustomCoeffs &	outCustomCoefficients,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 1228 of file ntv2csclut.cpp.

◆ GetColorSpaceCustomCoefficients12Bit()

bool CNTV2Card::GetColorSpaceCustomCoefficients12Bit	(	NTV2CSCCustomCoeffs &	outCustomCoefficients,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 1294 of file ntv2csclut.cpp.

◆ GetColorSpaceMakeAlphaFromKey()

bool CNTV2Card::GetColorSpaceMakeAlphaFromKey	(	ULWord &	outMakeAlphaFromKey,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers whether or not the given CSC is set to produce alpha channel data from its key input.

Parameters

[out]	outMakeAlphaFromKey	Receives true if the CSC is generating alpha channel data from the YCbCr video signal being applied to its Key Input; otherwise receives false.
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Call NTV2DeviceGetNumCSCs to determine the number of available CSCs on the device. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetColorSpaceMakeAlphaFromKey, Color Space Converter Operation and widget_csc

Definition at line 1205 of file ntv2csclut.cpp.

◆ GetColorSpaceMatrixSelect()

bool CNTV2Card::GetColorSpaceMatrixSelect	(	NTV2ColorSpaceMatrixType &	outType,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the current matrix type being used for the given CSC.

Parameters

[out]	outType	Receives the matrix type being used, typically NTV2_Rec601Matrix or NTV2_Rec709Matrix.
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetColorSpaceMatrixSelect, Color Space Converter Operation and widget_csc

Definition at line 460 of file ntv2csclut.cpp.

◆ GetColorSpaceMethod() [1/2]

NTV2ColorSpaceMethod CNTV2Card::GetColorSpaceMethod ( const NTV2Channel inChannel )

virtual

Definition at line 444 of file ntv2csclut.cpp.

◆ GetColorSpaceMethod() [2/2]

bool CNTV2Card::GetColorSpaceMethod	(	NTV2ColorSpaceMethod &	outMethod,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the current operating mode of the given color space converter.

Parameters

[out]	outMethod	Receives the CSC's current operating method.
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetColorSpaceMethod, Color Space Converter Operation and widget_csc

Definition at line 410 of file ntv2csclut.cpp.

◆ GetColorSpaceRGBBlackRange()

bool CNTV2Card::GetColorSpaceRGBBlackRange	(	NTV2_CSC_RGB_Range &	outRange,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the current RGB range being used by a given CSC.

Parameters

[out]	outRange	Receives the RGB range (NTV2_CSC_RGB_RANGE_FULL, NTV2_CSC_RGB_RANGE_SMPTE, or NTV2_CSC_RGB_RANGE_INVALID upon failure).
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Call NTV2DeviceGetNumCSCs to determine the number of available CSCs on the device. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetColorSpaceRGBBlackRange, Color Space Converter Operation and widget_csc

Definition at line 1174 of file ntv2csclut.cpp.

◆ GetColorSpaceUseCustomCoefficient()

bool CNTV2Card::GetColorSpaceUseCustomCoefficient	(	ULWord &	outUseCustomCoefficient,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 1193 of file ntv2csclut.cpp.

◆ GetColorSpaceVideoKeySyncFail()

bool CNTV2Card::GetColorSpaceVideoKeySyncFail	(	bool &	outVideoKeySyncFail,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers whether or not the video signal present at the CSC’s Key Input is in sync with the video signal present at its Video Input.

Parameters

[out]	outVideoKeySyncFail	Receives true if the video signal present at the CSC’s Key Input is NOT sync'd to the video signal present at its Video Input; otherwise receives false.
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Call NTV2DeviceGetNumCSCs to determine the number of available CSCs on the device. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetColorSpaceMakeAlphaFromKey, CNTV2Card::SetColorSpaceMakeAlphaFromKey, Color Space Converter Operation and widget_csc

Note

The "outVideoKeySyncFail" result is valid and trustworthy when all of the following are true:

the Video Input is connected to a YCbCr signal source crosspoint;
the CSC's "Make Alpha From Key" setting is enabled;
the Key Input is connected to a YCbCr signal source crosspoint.

Definition at line 1338 of file ntv2csclut.cpp.

◆ GetConnectedInput()

bool CNTV2Card::GetConnectedInput	(	const NTV2OutputCrosspointID	inOutputXpt,
		NTV2InputCrosspointID &	outInputXpt
	)

virtual

Answers with a connected NTV2InputCrosspointID for the given NTV2OutputCrosspointID.

Parameters

[in]	inOutputXpt	Specifies the output (signal source) of interest.
[out]	outInputXpt	Receives one of the input (signal sink) the given output is connected to (if connected), or NTV2_XptBlack if not connected.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2Card::GetConnectedOutput, CNTV2Card::IsConnected

Bug:: If the output is connected to more than one widget input, this function only returns the first one found.

Definition at line 51 of file ntv2regroute.cpp.

◆ GetConnectedInputs()

bool CNTV2Card::GetConnectedInputs	(	const NTV2OutputCrosspointID	inOutputXpt,
		NTV2InputCrosspointIDSet &	outInputXpts
	)

virtual

Answers with all of the NTV2InputCrosspointIDs that are connected to the given NTV2OutputCrosspointID.

Parameters

[in]	inOutputXpt	Specifies the output (signal source) of interest.
[out]	outInputXpts	Receives the NTV2InputCrosspointIDSet of the inputs (signal sinks) the given output is connected to (if connected). If none are connected, the set will be empty.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2Card::GetConnectedOutput, CNTV2Card::IsConnected

Definition at line 67 of file ntv2regroute.cpp.

◆ GetConnectedOutput()

bool CNTV2Card::GetConnectedOutput	(	const NTV2InputCrosspointID	inInputXpt,
		NTV2OutputCrosspointID &	outOutputXpt
	)

virtual

Answers with the currently connected NTV2OutputCrosspointID for the given NTV2InputCrosspointID.

Parameters

[in]	inInputXpt	Specifies the input (signal sink) of interest.
[out]	outOutputXpt	Receives the output (signal source) the given input is connected to (if connected), or NTV2_XptBlack if not connected.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2Card::GetConnectedInput, CNTV2Card::IsConnected

Definition at line 29 of file ntv2regroute.cpp.

◆ GetConnections()

bool CNTV2Card::GetConnections ( NTV2XptConnections & outConnections )

virtual

Answers with the device's current widget routing connections.

Returns: True if successful; otherwise false.

Parameters

[out] outConnections Receives the current routing connections.

See also: Widget Signal Routing

Definition at line 345 of file ntv2regroute.cpp.

◆ GetConversionMode()

bool CNTV2Card::GetConversionMode ( NTV2ConversionMode & outConversionMode )

virtual

Definition at line 218 of file ntv2regconv.cpp.

◆ GetConverterInRate()

bool CNTV2Card::GetConverterInRate ( NTV2FrameRate & outValue )

virtual

Definition at line 21 of file ntv2regconv.cpp.

◆ GetConverterInStandard()

bool CNTV2Card::GetConverterInStandard ( NTV2Standard & outValue )

virtual

Definition at line 19 of file ntv2regconv.cpp.

◆ GetConverterOutRate()

bool CNTV2Card::GetConverterOutRate ( NTV2FrameRate & outValue )

virtual

Definition at line 17 of file ntv2regconv.cpp.

◆ GetConverterOutStandard()

bool CNTV2Card::GetConverterOutStandard ( NTV2Standard & outValue )

virtual

Definition at line 15 of file ntv2regconv.cpp.

◆ GetConverterPulldown()

bool CNTV2Card::GetConverterPulldown ( ULWord & outValue )

virtual

Definition at line 39 of file ntv2regconv.cpp.

◆ GetCRCErrorCountA()

ULWord CNTV2Card::GetCRCErrorCountA ( const NTV2Channel inChannel )

virtual

Returns: The current Link A error count for the given SDI input.

Parameters

[in] inChannel Specifies the channel (SDI input) of interest.

Note: This function returns valid information only for devices for which NTV2DeviceCanDoSDIErrorChecks returns 'true'.

Definition at line 4238 of file ntv2register.cpp.

◆ GetCRCErrorCountB()

ULWord CNTV2Card::GetCRCErrorCountB ( const NTV2Channel inChannel )

virtual

Returns: The current Link B error count for the given SDI input.

Parameters

[in] inChannel Specifies the channel (SDI input) of interest.

Note: This function returns valid information only for devices for which NTV2DeviceCanDoSDIErrorChecks returns 'true'.

Definition at line 4249 of file ntv2register.cpp.

◆ GetCurrentInterruptMasks()

bool CNTV2Card::GetCurrentInterruptMasks	(	NTV2InterruptMask &	outIntMask1,
		NTV2Interrupt2Mask &	outIntMask2
	)

virtual

Definition at line 15 of file ntv2interrupts.cpp.

◆ GetDefaultVideoOutMode()

bool CNTV2Card::GetDefaultVideoOutMode ( ULWord & outMode )

virtual

Deprecated:: Obsolete starting in SDK 16.3.

Definition at line 195 of file ntv2register.cpp.

◆ GetDeinterlaceMode()

bool CNTV2Card::GetDeinterlaceMode ( ULWord & outValue )

virtual

Definition at line 37 of file ntv2regconv.cpp.

◆ GetDescription()

string CNTV2Card::GetDescription ( void ) const

virtual

Returns: String containing device description

Reimplemented from CNTV2DriverInterface.

Definition at line 124 of file ntv2card.cpp.

◆ GetDetectedAESChannelPairs()

bool CNTV2Card::GetDetectedAESChannelPairs ( NTV2AudioChannelPairs & outDetectedChannelPairs )

virtual

Answers which AES/EBU audio channel pairs are present on the device.

Parameters

[out] outDetectedChannelPairs Receives the set of unique audio channel pairs that are present in any of the device's AES/EBU inputs.

Returns: True if successful; otherwise false.

See also: CNTV2Card::IsAudioChannelPairPresent, Audio Capture

Definition at line 1365 of file ntv2audio.cpp.

◆ GetDetectedAudioChannelPairs()

bool CNTV2Card::GetDetectedAudioChannelPairs	(	const NTV2AudioSystem	inAudioSystem,
		NTV2AudioChannelPairs &	outDetectedChannelPairs
	)

virtual

Answers which audio channel pairs are present in the given Audio System's input stream.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[out]	outDetectedChannelPairs	Receives the NTV2AudioChannelPairs that are present in the Audio System's input stream.

Returns: True if successful; otherwise false.

Note: NTV2 device firmware performs this detection using a simple method of detecting the presence of the Audio Group's data packet. It does not perform detailed inspection of the packet – i.e., checking bits b1/b2 of the AES sub-frame per SMPTE 272, nor checking the V/U/C/P bits per SMPTE 299.

See also: CNTV2Card::IsAudioChannelPairPresent, Audio Capture

Definition at line 1347 of file ntv2audio.cpp.

◆ GetDeviceFrameInfo() [1/2]

bool CNTV2Card::GetDeviceFrameInfo	(	const UWord	inFrameNumber,
		const NTV2Channel	inChannel,
		uint64_t &	outAddress,
		uint64_t &	outLength
	)

virtual

Answers with the address and size of the given frame.

Parameters

[in]	inFrameNumber	Specifies the zero-based frame number of the frame of interest.
[in]	inChannel	Specifies the NTV2Channel of interest (for multi-format mode). Ignored and assumes NTV2_CHANNEL1 if device is not in multi-format mode.
[out]	outAddress	Receives the device memory address of the first byte of the given frame.
[out]	outLength	Receives the frame size, in bytes.

Note: The NTV2Channel parameter must not refer to a FrameStore that is slaved to a quad or quad-quad master.

Returns: True if successful; otherwise false.

Definition at line 375 of file ntv2dma.cpp.

◆ GetDeviceFrameInfo() [2/2]

bool CNTV2Card::GetDeviceFrameInfo	(	const UWord	inFrameNumber,
		const NTV2Channel	inChannel,
		ULWord &	outIntrinsicSize,
		bool &	outMultiFmt,
		bool &	outQuad,
		bool &	outQuadQuad,
		bool &	outSquares,
		bool &	outTSI,
		uint64_t &	outAddress,
		uint64_t &	outLength
	)

virtual

Definition at line 317 of file ntv2dma.cpp.

◆ GetDeviceVersion()

Word CNTV2Card::GetDeviceVersion ( void )

virtual

Answers with this device's version number.

Returns: This device's version number.

Definition at line 65 of file ntv2card.cpp.

◆ GetDeviceVersionString()

string CNTV2Card::GetDeviceVersionString ( void )

virtual

Answers with this device's version number as a human-readable string.

Returns: A string containing this device's version number as a human-readable string.

Definition at line 72 of file ntv2card.cpp.

◆ GetDieTemperature()

bool CNTV2Card::GetDieTemperature	(	double &	outTemp,
		const NTV2DieTempScale	inTempScale = `NTV2DieTempScale_Celsius`
	)

virtual

Reads the current die temperature of the device.

Parameters

[out]	outTemp	Receives the temperature value that was read from the device.
[in]	inTempScale	Specifies the temperature unit scale to use. Defaults to Celsius.

Returns: True if successful; otherwise false.

Definition at line 4509 of file ntv2register.cpp.

◆ GetDieVoltage()

bool CNTV2Card::GetDieVoltage ( double & outVoltage )

virtual

Reads the current "Vcc" voltage of the device.

Parameters

[out] outVoltage Receives the "Vcc" voltage that was read from the device.

Returns: True if successful; otherwise false.

Definition at line 4531 of file ntv2register.cpp.

◆ GetDisabledChannels()

bool CNTV2Card::GetDisabledChannels ( NTV2ChannelSet & outChannels )

virtual

Answers with the set of channels that are currently disabled.

Parameters

[out] outChannels Receives the set of enabled channels.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetEnabledChannels, CNTV2Card::EnableChannels, CNTV2Card::DisableChannels, FrameStore Operation

Definition at line 2150 of file ntv2register.cpp.

◆ GetDisplayName()

string CNTV2Card::GetDisplayName ( void )

virtual

Answers with this device's display name.

Returns: A string containing this device's display name.

Definition at line 86 of file ntv2card.cpp.

◆ GetDitherFor8BitInputs()

bool CNTV2Card::GetDitherFor8BitInputs	(	const NTV2Channel	inChannel,
		ULWord &	outDither
	)

virtual

Definition at line 3178 of file ntv2register.cpp.

◆ GetDownConvertMode()

bool CNTV2Card::GetDownConvertMode ( NTV2DownConvertMode & outValue )

virtual

Definition at line 23 of file ntv2regconv.cpp.

◆ GetDriverVersionComponents()

bool CNTV2Card::GetDriverVersionComponents	(	UWord &	outMajor,
		UWord &	outMinor,
		UWord &	outPoint,
		UWord &	outBuild
	)

virtual

Answers with the individual version components of this device's driver.

Parameters

[out]	outMajor	Receives the driver's major version number.
[out]	outMinor	Receives the driver's minor version number.
[out]	outPoint	Receives the driver's point release number.
[out]	outBuild	Receives the driver's build number.

Returns: True if successful; otherwise false.

Definition at line 169 of file ntv2card.cpp.

◆ GetDriverVersionString()

string CNTV2Card::GetDriverVersionString ( void )

virtual

Answers with this device's driver's version as a human-readable string.

Returns: A string containing this device's driver's version as a human-readable string.

Definition at line 147 of file ntv2card.cpp.

◆ GetDualLinkInputEnable()

bool CNTV2Card::GetDualLinkInputEnable ( bool & outIsEnabled )

virtual

Definition at line 3162 of file ntv2register.cpp.

◆ GetDualLinkOutputEnable()

bool CNTV2Card::GetDualLinkOutputEnable ( bool & outIsEnabled )

virtual

Definition at line 3149 of file ntv2register.cpp.

◆ GetDynamicDeviceIDs()

NTV2DeviceIDSet CNTV2Card::GetDynamicDeviceIDs ( void )

virtual

Returns: A set of supported/available dynamic device IDs.

Definition at line 77 of file ntv2dynamicdevice.cpp.

◆ GetDynamicDeviceList()

NTV2DeviceIDList CNTV2Card::GetDynamicDeviceList ( void )

virtual

Returns: A list of supported/available dynamic device IDs.

Definition at line 68 of file ntv2dynamicdevice.cpp.

◆ GetEmbeddedAudioClock()

bool CNTV2Card::GetEmbeddedAudioClock	(	NTV2EmbeddedAudioClock &	outValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

For the given NTV2AudioSystem, answers with the current NTV2EmbeddedAudioClock setting.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives the current NTV2EmbeddedAudioClock setting.
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest. Defaults to NTV2_AUDIOSYSTEM_1.

See also: CNTV2Card::SetEmbeddedAudioClock, NTV2DeviceCanChangeEmbeddedAudioClock, Audio Capture

Definition at line 425 of file ntv2audio.cpp.

◆ GetEmbeddedAudioInput()

bool CNTV2Card::GetEmbeddedAudioInput	(	NTV2EmbeddedAudioInput &	outEmbeddedSource,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Answers with the device's current embedded (SDI) audio source for the given NTV2AudioSystem.

Parameters

[out]	outEmbeddedSource	Receives the NTV2EmbeddedAudioInput (SDI audio source).
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; This function assumes the device's current NTV2AudioSource is NTV2_AUDIO_EMBEDDED. Usually it's best to call CNTV2Card::GetAudioSystemInputSource instead of this function.

See also: CNTV2Card::SetEmbeddedAudioInput, CNTV2Card::GetAudioSystemInputSource, Audio Capture

Definition at line 377 of file ntv2audio.cpp.

◆ GetEnable4KDCPSFInMode()

bool CNTV2Card::GetEnable4KDCPSFInMode ( bool & outIsEnabled )

virtual

Definition at line 4183 of file ntv2register.cpp.

◆ GetEnable4KDCRGBMode()

bool CNTV2Card::GetEnable4KDCRGBMode ( bool & outIsEnabled )

virtual

Definition at line 4157 of file ntv2register.cpp.

◆ GetEnable4KDCYCC444Mode()

bool CNTV2Card::GetEnable4KDCYCC444Mode ( bool & outIsEnabled )

virtual

Definition at line 4170 of file ntv2register.cpp.

◆ GetEnable4KPSFOutMode()

bool CNTV2Card::GetEnable4KPSFOutMode ( bool & outIsEnabled )

virtual

Definition at line 4196 of file ntv2register.cpp.

◆ GetEnableConverter()

bool CNTV2Card::GetEnableConverter ( bool & outValue )

virtual

Definition at line 27 of file ntv2regconv.cpp.

◆ GetEnabledChannels()

bool CNTV2Card::GetEnabledChannels ( NTV2ChannelSet & outChannels )

virtual

Answers with the set of channels that are currently enabled.

Parameters

[out] outChannels Receives the set of enabled channels.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetDisabledChannels, CNTV2Card::EnableChannels, CNTV2Card::DisableChannels, FrameStore Operation

Definition at line 2136 of file ntv2register.cpp.

◆ GetEnableFramePulseReference()

bool CNTV2Card::GetEnableFramePulseReference ( bool & outEnabled )

virtual

Answers whether or not the device's current frame pulse reference source is enabled. See Video Output Clocking & Synchronization for more information.

Parameters

[out] outEnabled Receives true if the frame pulse reference is enabled; otherwise false.

Returns: True if successful; otherwise false.

See also: EnableFramePulseReference, GetFramePulseReference, Video Output Clocking & Synchronization

Definition at line 1575 of file ntv2register.cpp.

◆ GetEnableHDMIOutCenterCrop()

bool CNTV2Card::GetEnableHDMIOutCenterCrop ( bool & outIsEnabled )

virtual

Answers if the HDMI 4k/2k -> UHD/HD center cropping is enabled or not.

Parameters

[out] outIsEnabled Receives true if center cropping is enabled; otherwise false.

Returns: True if successful; otherwise false.

Definition at line 1067 of file ntv2hdmi.cpp.

◆ GetEnableHDMIOutUserOverride()

bool CNTV2Card::GetEnableHDMIOutUserOverride ( bool & outIsEnabled )

virtual

Answers if override of HDMI parameters is enabled or not.

Parameters

[out] outIsEnabled Receives true if enabled; otherwise false.

Returns: True if successful; otherwise false.

Definition at line 1054 of file ntv2hdmi.cpp.

◆ GetEncodeAsPSF()

bool CNTV2Card::GetEncodeAsPSF	(	NTV2Channel	inChannel,
		NTV2EncodeAsPSF &	outValue
	)

virtual

Definition at line 1957 of file ntv2register.cpp.

◆ GetEncodedAudioMode()

bool CNTV2Card::GetEncodedAudioMode	(	NTV2EncodedAudioMode &	outValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Definition at line 338 of file ntv2audio.cpp.

◆ GetEveryFrameServices()

bool CNTV2Card::GetEveryFrameServices ( NTV2EveryFrameTaskMode & outMode )

virtual

Retrieves the device's current "retail service" task mode.

Parameters

[out] outMode Receives the device's current "every frame task mode" setting. If successful, the variable will contain NTV2_DISABLE_TASKS, NTV2_STANDARD_TASKS, or NTV2_OEM_TASKS.

Returns: True if successful; otherwise false.

See also: CNTV2DriverInterface::GetStreamingApplication, Sharing AJA Devices With Other Applications

Definition at line 184 of file ntv2register.cpp.

◆ GetForce64()

bool CNTV2Card::GetForce64 ( ULWord * force64 )

virtual

Definition at line 3188 of file ntv2register.cpp.

◆ GetFPGAVersionString()

string CNTV2Card::GetFPGAVersionString ( const NTV2XilinxFPGA inFPGA = eFPGAVideoProc )

virtual

Definition at line 94 of file ntv2card.cpp.

◆ GetFrameBufferFormat()

bool CNTV2Card::GetFrameBufferFormat	(	NTV2Channel	inChannel,
		NTV2FrameBufferFormat &	outValue
	)

virtual

Returns the current frame buffer format for the given FrameStore on the AJA device.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number).
[out]	outValue	Receives the FrameStore's current pixel format. If the function result is true, the variable will contain a valid NTV2FrameBufferFormat value.

Returns: True if successful; otherwise false.

This function allows client applications to inquire about the current format of frame data stored in an AJA device's FrameStore. This is important because when frames are transferred between the host and the AJA device, the frame data format is presumed to be identical.

Definition at line 1875 of file ntv2register.cpp.

◆ GetFrameBufferOrientation()

bool CNTV2Card::GetFrameBufferOrientation	(	const NTV2Channel	inChannel,
		NTV2FBOrientation &	outValue
	)

virtual

Answers with the current frame buffer orientation for the given NTV2Channel.

Parameters

[in]	inChannel	Specifies the channel (aka FrameStore) of interest.
[out]	outValue	Receives the NTV2VideoFrameBufferOrientation value.

Returns: True if successful; otherwise false.

Note: Normal operation is NTV2_FRAMEBUFFER_ORIENTATION_TOPDOWN. For capture, the input de-embedder writes incoming pixel data in top-to-bottom order in the frame buffer, and the output embedder also reads outgoing pixel data in top-to-bottom order from frame buffer memory. In NTV2_FRAMEBUFFER_ORIENTATION_BOTTOMUP operation, this is reversed. The input de-embedder writes incoming pixel data in bottom-to-top order during capture, while for playout, the output embedder reads pixel data in bottom-to-top order.

Definition at line 1979 of file ntv2register.cpp.

◆ GetFrameBufferQuality()

bool CNTV2Card::GetFrameBufferQuality	(	NTV2Channel	inChannel,
		NTV2FrameBufferQuality &	outValue
	)

virtual

Definition at line 1927 of file ntv2register.cpp.

◆ GetFrameBufferQuarterSizeMode()

bool CNTV2Card::GetFrameBufferQuarterSizeMode	(	NTV2Channel	inChannel,
		NTV2QuarterSizeExpandMode &	outValue
	)

virtual

Definition at line 1903 of file ntv2register.cpp.

◆ GetFrameBufferSize() [1/2]

bool CNTV2Card::GetFrameBufferSize	(	const NTV2Channel	inChannel,
		NTV2Framesize &	outValue
	)

virtual

Answers with the frame size currently being used on the device.

Parameters

[in]	inChannel	Currently ignored. Use NTV2_CHANNEL1.
[out]	outValue	Receives the device's current frame size.

Returns: True if successful; otherwise false.

See also: Frame Buffer Indexing, CNTV2Card::SetFrameBufferSize

Definition at line 2034 of file ntv2register.cpp.

◆ GetFrameBufferSize() [2/2]

virtual ULWord CNTV2DriverInterface::GetFrameBufferSize

inline

Definition at line 384 of file ntv2driverinterface.h.

◆ GetFrameGeometry()

bool CNTV2Card::GetFrameGeometry	(	NTV2FrameGeometry &	outValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 970 of file ntv2register.cpp.

◆ GetFramePulseReference()

bool CNTV2Card::GetFramePulseReference ( NTV2ReferenceSource & outRefSource )

virtual

Answers with the device's current frame pulse reference source.

Parameters

[out] outRefSource Receives the NTV2ReferenceSource value.

Returns: True if successful; otherwise false.

See also: SetFramePulseReference, GetEnableFramePulseReference, Video Output Clocking & Synchronization

Definition at line 1593 of file ntv2register.cpp.

◆ GetFrameRate()

bool CNTV2Card::GetFrameRate	(	NTV2FrameRate &	outValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Returns the AJA device's currently configured frame rate via its "value" parameter.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives the device's current NTV2FrameRate value.
[in]	inChannel	Specifies the NTV2Channel of interest.

Note: The frame rate setting for NTV2_CHANNEL1 dictates the device reference clock for both single and multi-format mode (see Video Output Clocking & Synchronization).

Definition at line 1022 of file ntv2register.cpp.

◆ GetFrameStamp()

bool CNTV2Card::GetFrameStamp	(	NTV2Crosspoint	channelSpec,
		ULWord	frameNum,
		FRAME_STAMP_STRUCT *	pFrameStamp
	)

virtual

Deprecated:: Use CNTV2Card::AutoCirculateGetFrame instead.

Definition at line 68 of file ntv2autocirculate.cpp.

◆ GetHDMIHDRBluePrimaryX()

bool CNTV2Card::GetHDMIHDRBluePrimaryX ( uint16_t & outBluePrimaryX )

virtual

Answers with the Display Mastering data for Blue Primary X as defined in SMPTE ST 2086. This is Byte 7 and 8 of SMDT Type 1.

Parameters

[out] outBluePrimaryX Receives the Blue Primary X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 674 of file ntv2hdmi.cpp.

◆ GetHDMIHDRBluePrimaryY()

bool CNTV2Card::GetHDMIHDRBluePrimaryY ( uint16_t & outBluePrimaryY )

virtual

Answers with the Display Mastering data for Blue Primary Y as defined in SMPTE ST 2086. This is Byte 9 and 10 of SMDT Type 1.

Parameters

[out] outBluePrimaryY Receives the Blue Primary Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 694 of file ntv2hdmi.cpp.

◆ GetHDMIHDRConstantLuminance()

bool CNTV2Card::GetHDMIHDRConstantLuminance ( void )

virtual

Returns: True if BT.2020 Y'cC'bcC'rc is enabled; otherwise false for BT.2020 Y'C'bC'r or R'G'B'.

Definition at line 874 of file ntv2hdmi.cpp.

◆ GetHDMIHDRDolbyVisionEnabled()

bool CNTV2Card::GetHDMIHDRDolbyVisionEnabled ( void )

virtual

Returns: True if HDMI HDR Dolby Vision output is enabled for the device; otherwise false.

Definition at line 952 of file ntv2hdmi.cpp.

◆ GetHDMIHDRElectroOpticalTransferFunction()

bool CNTV2Card::GetHDMIHDRElectroOpticalTransferFunction ( uint8_t & outEOTFByte )

virtual

Definition at line 897 of file ntv2hdmi.cpp.

◆ GetHDMIHDREnabled()

bool CNTV2Card::GetHDMIHDREnabled ( void )

virtual

Returns: True if HDMI HDR metadata output is enabled for the device; otherwise false.

Definition at line 933 of file ntv2hdmi.cpp.

◆ GetHDMIHDRGreenPrimaryX()

bool CNTV2Card::GetHDMIHDRGreenPrimaryX ( uint16_t & outGreenPrimaryX )

virtual

Answers with the Display Mastering data for Green Primary X as defined in SMPTE ST 2086. This is Byte 3 and 4 of SMDT Type 1.

Parameters

[out] outGreenPrimaryX Receives the Green Primary X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 634 of file ntv2hdmi.cpp.

◆ GetHDMIHDRGreenPrimaryY()

bool CNTV2Card::GetHDMIHDRGreenPrimaryY ( uint16_t & outGreenPrimaryY )

virtual

Answers with the Display Mastering data for Green Primary Y as defined in SMPTE ST 2086. This is Byte 5 and 6 of SMDT Type 1.

Parameters

[out] outGreenPrimaryY Receives the Green Primary Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 654 of file ntv2hdmi.cpp.

◆ GetHDMIHDRMaxContentLightLevel()

bool CNTV2Card::GetHDMIHDRMaxContentLightLevel ( uint16_t & outMaxContentLightLevel )

virtual

Answers with the Display Mastering data for the Max Content Light Level(Max CLL) value. This is Byte 23 and 24 of SMDT Type 1.

Parameters

[out] outMaxContentLightLevel Receives the Max Content Light Level value.

Returns: True if successful; otherwise false.

Definition at line 834 of file ntv2hdmi.cpp.

◆ GetHDMIHDRMaxFrameAverageLightLevel()

bool CNTV2Card::GetHDMIHDRMaxFrameAverageLightLevel ( uint16_t & outMaxFrameAverageLightLevel )

virtual

Answers with the Display Mastering data for the Max Frame Average Light Level(Max FALL) value. This is Byte 25 and 26 of SMDT Type 1.

Parameters

[out] outMaxFrameAverageLightLevel Receives the Max Frame Average Light Level value.

Returns: True if successful; otherwise false.

Definition at line 854 of file ntv2hdmi.cpp.

◆ GetHDMIHDRMaxMasteringLuminance()

bool CNTV2Card::GetHDMIHDRMaxMasteringLuminance ( uint16_t & outMaxMasteringLuminance )

virtual

Answers with the Display Mastering data for the Max Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 19 and 20 of SMDT Type 1.

Parameters

[out] outMaxMasteringLuminance Receives the Max Mastering Luminance value.

Returns: True if successful; otherwise false.

Definition at line 794 of file ntv2hdmi.cpp.

◆ GetHDMIHDRMinMasteringLuminance()

bool CNTV2Card::GetHDMIHDRMinMasteringLuminance ( uint16_t & outMinMasteringLuminance )

virtual

Answers with the Display Mastering data for the Min Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 21 and 22 of SMDT Type 1.

Parameters

[out] outMinMasteringLuminance Receives the Min Mastering Luminance value.

Returns: True if successful; otherwise false.

Definition at line 814 of file ntv2hdmi.cpp.

◆ GetHDMIHDRRedPrimaryX()

bool CNTV2Card::GetHDMIHDRRedPrimaryX ( uint16_t & outRedPrimaryX )

virtual

Answers with the Display Mastering data for Red Primary X as defined in SMPTE ST 2086. This is Byte 11 and 12 of SMDT Type 1.

Parameters

[out] outRedPrimaryX Receives the Red Primary X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 714 of file ntv2hdmi.cpp.

◆ GetHDMIHDRRedPrimaryY()

bool CNTV2Card::GetHDMIHDRRedPrimaryY ( uint16_t & outRedPrimaryY )

virtual

Answers with the Display Mastering data for Red Primary Y as defined in SMPTE ST 2086. This is Byte 13 and 14 of SMDT Type 1.

Parameters

[out] outRedPrimaryY Receives the Red Primary Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 734 of file ntv2hdmi.cpp.

◆ GetHDMIHDRStaticMetadataDescriptorID()

bool CNTV2Card::GetHDMIHDRStaticMetadataDescriptorID ( uint8_t & outSMDId )

virtual

Definition at line 917 of file ntv2hdmi.cpp.

◆ GetHDMIHDRWhitePointX()

bool CNTV2Card::GetHDMIHDRWhitePointX ( uint16_t & outWhitePointX )

virtual

Answers with the Display Mastering data for White Point X as defined in SMPTE ST 2086. This is Byte 15 and 16 of SMDT Type 1.

Parameters

[out] outWhitePointX Receives the White Point X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 754 of file ntv2hdmi.cpp.

◆ GetHDMIHDRWhitePointY()

bool CNTV2Card::GetHDMIHDRWhitePointY ( uint16_t & outWhitePointY )

virtual

Answers with the Display Mastering data for White Point Y as defined in SMPTE ST 2086. This is Byte 17 and 18 of SMDT Type 1.

Parameters

[out] outWhitePointY Receives the White Point Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 774 of file ntv2hdmi.cpp.

◆ GetHDMIInAudioChannel34Swap()

bool CNTV2Card::GetHDMIInAudioChannel34Swap	(	bool &	outIsSwapped,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's current audio channel 3/4 swap setting.

Parameters

[out]	outIsSwapped	Receives true if channels 3 & 4 are currently being swapped; otherwise false.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetHDMIInAudioChannel34Swap

Definition at line 286 of file ntv2hdmi.cpp.

◆ GetHDMIInAudioSampleRateConverterEnable()

bool CNTV2Card::GetHDMIInAudioSampleRateConverterEnable	(	bool &	outIsEnabled,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 260 of file ntv2hdmi.cpp.

◆ GetHDMIInBitDepth()

bool CNTV2Card::GetHDMIInBitDepth	(	NTV2HDMIBitDepth &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's current bit depth setting.

Parameters

[out]	outValue	Receives the HDMI input's current NTV2HDMIBitDepth value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 216 of file ntv2hdmi.cpp.

◆ GetHDMIInColorimetry()

bool CNTV2Card::GetHDMIInColorimetry	(	NTV2HDMIColorimetry &	outColorimetry,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's current colorimetry.

Parameters

[out]	outColorimetry	Receives the input channels colorimetry.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetHDMIInAudioChannel34Swap

Definition at line 148 of file ntv2hdmi.cpp.

◆ GetHDMIInColorSpace()

bool CNTV2Card::GetHDMIInColorSpace	(	NTV2HDMIColorSpace &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's current color space setting.

Parameters

[out]	outValue	Receives the HDMI input's current NTV2HDMIColorSpace value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 194 of file ntv2hdmi.cpp.

◆ GetHDMIInDolbyVision()

bool CNTV2Card::GetHDMIInDolbyVision	(	bool &	outIsDolbyVision,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's Dolby Vision flag is set.

Parameters

[out]	outIsDolbyVision	Receives true if Dolby Vision input detected; otherwise false.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetHDMIInAudioChannel34Swap

Definition at line 157 of file ntv2hdmi.cpp.

◆ GetHDMIInDynamicRange() [1/2]

bool CNTV2Card::GetHDMIInDynamicRange	(	HDRFloatValues &	outFloatValues,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's video dynamic range and mastering information.

Parameters

[out]	outFloatValue	Receives the HDMI input's current HDRFloatValues data.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; false if no information present.

Definition at line 136 of file ntv2hdmi.cpp.

◆ GetHDMIInDynamicRange() [2/2]

bool CNTV2Card::GetHDMIInDynamicRange	(	HDRRegValues &	outRegValues,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's video dynamic range and mastering information.

Parameters

[out]	outRegValue	Receives the HDMI input's current HDRRegValues data.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; false if no information present.

Definition at line 76 of file ntv2hdmi.cpp.

◆ GetHDMIInIsLocked()

bool CNTV2Card::GetHDMIInIsLocked	(	bool &	outIsLocked,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers if the given HDMI input is genlocked or not.

Parameters

[out]	outIsLocked	Receives `true` if the HDMI input is locked; otherwise `false`.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 239 of file ntv2hdmi.cpp.

◆ GetHDMIInProtocol()

bool CNTV2Card::GetHDMIInProtocol	(	NTV2HDMIProtocol &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's protocol.

Parameters

[out]	outValue	Receives the HDMI input's current NTV2HDMIProtocol value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 229 of file ntv2hdmi.cpp.

◆ GetHDMIInputAudioChannels()

bool CNTV2Card::GetHDMIInputAudioChannels	(	NTV2HDMIAudioChannels &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the current number of audio channels being received on the given HDMI input.

Parameters

[out]	outValue	Receives the current NTV2HDMIAudioChannels value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 272 of file ntv2hdmi.cpp.

◆ GetHDMIInputColor()

bool CNTV2Card::GetHDMIInputColor	(	NTV2LHIHDMIColorSpace &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the current colorspace for the given HDMI input.

Parameters

[out]	outValue	Receives the HDMI input's current NTV2LHIHDMIColorSpace value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 52 of file ntv2hdmi.cpp.

◆ GetHDMIInputRange()

bool CNTV2Card::GetHDMIInputRange	(	NTV2HDMIRange &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's current input range setting.

Parameters

[out]	outValue	Receives the HDMI input's current NTV2HDMIRange value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 176 of file ntv2hdmi.cpp.

◆ GetHDMIInputStatus()

bool CNTV2Card::GetHDMIInputStatus	(	ULWord &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`,
		const bool	in12BitDetection = `(0)`
	)

virtual

Answers with the contents of the HDMI Input status register for the given HDMI input.

Definition at line 44 of file ntv2hdmi.cpp.

◆ GetHDMIInputStatusRegNum()

bool CNTV2Card::GetHDMIInputStatusRegNum	(	ULWord &	outRegNum,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`,
		const bool	in12BitDetection = `(0)`
	)

protectedvirtual

Answers with the HDMI Input status register number for the given HDMI input.

Definition at line 28 of file ntv2hdmi.cpp.

◆ GetHDMIInputVideoFormat()

NTV2VideoFormat CNTV2Card::GetHDMIInputVideoFormat ( NTV2Channel inHDMIInput = NTV2_CHANNEL1 )

virtual

Returns: A valid NTV2VideoFormat if successful; otherwise returns NTV2_FORMAT_UNKNOWN.

Parameters

[in] inHDMIInput Specifies the HDMI input of interest as an NTV2Channel, a zero-based index value. Defaults to NTV2_CHANNEL1 (the first HDMI input).

Definition at line 3456 of file ntv2register.cpp.

◆ GetHDMIInVideoRange()

bool CNTV2Card::GetHDMIInVideoRange	(	NTV2HDMIRange &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the given HDMI input's video black/white range.

Parameters

[out]	outValue	Receives the HDMI input's current NTV2HDMIRange value.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 64 of file ntv2hdmi.cpp.

◆ GetHDMIOut3DMode()

bool CNTV2Card::GetHDMIOut3DMode ( NTV2HDMIOut3DMode & outValue )

virtual

Definition at line 324 of file ntv2hdmi.cpp.

◆ GetHDMIOut3DPresent()

bool CNTV2Card::GetHDMIOut3DPresent ( bool & outIs3DPresent )

virtual

Definition at line 312 of file ntv2hdmi.cpp.

◆ GetHDMIOutAudioChannel34Swap()

bool CNTV2Card::GetHDMIOutAudioChannel34Swap	(	bool &	outIsSwapped,
		const NTV2Channel	inWhichHDMIOut = `NTV2_CHANNEL1`
	)

virtual

Answers with the HDMI output's current audio channel 3/4 swap setting.

Parameters

[out]	outIsSwapped	Receives true if channels 3 & 4 are currently being swapped; otherwise false.
[in]	inWhichHDMIOut	Optionally specifies the HDMI output of interest as an NTV2Channel, a zero-based index value. Defaults to the first HDMI output.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetHDMIOutAudioChannel34Swap

Definition at line 1034 of file ntv2hdmi.cpp.

◆ GetHDMIOutAudioChannels()

bool CNTV2Card::GetHDMIOutAudioChannels ( NTV2HDMIAudioChannels & outValue )

virtual

Definition at line 857 of file ntv2audio.cpp.

◆ GetHDMIOutAudioFormat()

bool CNTV2Card::GetHDMIOutAudioFormat ( NTV2AudioFormat & outValue )

virtual

Answers with the HDMI output's current audio format.

Parameters

[out] outValue Receives the HDMI output's current audio format.

Returns: True if successful; otherwise false.

Definition at line 990 of file ntv2audio.cpp.

◆ GetHDMIOutAudioRate()

bool CNTV2Card::GetHDMIOutAudioRate ( NTV2AudioRate & outValue )

virtual

Answers with the HDMI output's current audio rate.

Parameters

[out] outValue Receives the HDMI output's current audio rate.

Returns: True if successful; otherwise false.

Definition at line 978 of file ntv2audio.cpp.

◆ GetHDMIOutAudioSource2Channel()

bool CNTV2Card::GetHDMIOutAudioSource2Channel	(	NTV2AudioChannelPair &	outValue,
		NTV2AudioSystem &	outAudioSystem
	)

virtual

Answers with the HDMI output's current 2-channel audio source.

Parameters

[out]	outValue	Receives the audio channels that are currently being used.
[out]	outAudioSystem	Receives the Audio System that is currently supplying audio samples to the HDMI output.

Returns: True if successful; otherwise false.

Definition at line 885 of file ntv2audio.cpp.

◆ GetHDMIOutAudioSource8Channel()

bool CNTV2Card::GetHDMIOutAudioSource8Channel	(	NTV2Audio8ChannelSelect &	outValue,
		NTV2AudioSystem &	outAudioSystem
	)

virtual

Answers with the HDMI output's current 8-channel audio source.

Parameters

[out]	outValue	Receives the audio channels that are currently being used.
[out]	outAudioSystem	Receives the Audio System that is currently supplying audio samples to the HDMI output.

Returns: True if successful; otherwise false.

Definition at line 940 of file ntv2audio.cpp.

◆ GetHDMIOutBitDepth()

bool CNTV2Card::GetHDMIOutBitDepth ( NTV2HDMIBitDepth & outValue )

virtual

Definition at line 492 of file ntv2hdmi.cpp.

◆ GetHDMIOutColorSpace()

bool CNTV2Card::GetHDMIOutColorSpace ( NTV2HDMIColorSpace & outValue )

virtual

Definition at line 414 of file ntv2hdmi.cpp.

◆ GetHDMIOutDecimateMode()

bool CNTV2Card::GetHDMIOutDecimateMode ( bool & outIsEnabled )

virtual

Definition at line 557 of file ntv2hdmi.cpp.

◆ GetHDMIOutDownstreamBitDepth()

bool CNTV2Card::GetHDMIOutDownstreamBitDepth ( NTV2HDMIBitDepth & outValue )

virtual

Definition at line 450 of file ntv2hdmi.cpp.

◆ GetHDMIOutDownstreamColorSpace()

bool CNTV2Card::GetHDMIOutDownstreamColorSpace ( NTV2LHIHDMIColorSpace & outValue )

virtual

Definition at line 456 of file ntv2hdmi.cpp.

◆ GetHDMIOutForceConfig()

bool CNTV2Card::GetHDMIOutForceConfig ( bool & outValue )

virtual

Definition at line 531 of file ntv2hdmi.cpp.

◆ GetHDMIOutLevelBMode()

bool CNTV2Card::GetHDMIOutLevelBMode ( bool & outIsEnabled )

virtual

Definition at line 585 of file ntv2hdmi.cpp.

◆ GetHDMIOutPrefer420()

bool CNTV2Card::GetHDMIOutPrefer420 ( bool & outValue )

virtual

Definition at line 543 of file ntv2hdmi.cpp.

◆ GetHDMIOutProtocol()

bool CNTV2Card::GetHDMIOutProtocol ( NTV2HDMIProtocol & outValue )

virtual

Definition at line 519 of file ntv2hdmi.cpp.

◆ GetHDMIOutRange()

bool CNTV2Card::GetHDMIOutRange ( NTV2HDMIRange & outValue )

virtual

Definition at line 390 of file ntv2hdmi.cpp.

◆ GetHDMIOutSampleStructure()

bool CNTV2Card::GetHDMIOutSampleStructure ( NTV2HDMISampleStructure & outValue )

virtual

Definition at line 363 of file ntv2hdmi.cpp.

◆ GetHDMIOutStatus()

bool CNTV2Card::GetHDMIOutStatus ( NTV2HDMIOutputStatus & outStatus )

virtual

Answers with the current HDMI output status.

Returns: True if successful; otherwise false.

Parameters

[out] outStatus Receives the current status of the HDMI output.

Definition at line 606 of file ntv2hdmi.cpp.

◆ GetHDMIOutTsiIO()

bool CNTV2Card::GetHDMIOutTsiIO ( bool & tsiEnabled )

virtual

Definition at line 571 of file ntv2hdmi.cpp.

◆ GetHDMIOutVideoFPS()

bool CNTV2Card::GetHDMIOutVideoFPS ( NTV2FrameRate & outValue )

virtual

Definition at line 377 of file ntv2hdmi.cpp.

◆ GetHDMIOutVideoStandard()

bool CNTV2Card::GetHDMIOutVideoStandard ( NTV2Standard & outValue )

virtual

Definition at line 339 of file ntv2hdmi.cpp.

◆ GetHDMIV2Mode()

bool CNTV2Card::GetHDMIV2Mode ( NTV2HDMIV2Mode & outMode )

virtual

Answers with the current HDMI V2 mode of the device.

Returns: True if successful; otherwise false.

Parameters

[out] outMode Receives the current HDMI V2 operation mode for the device.

Definition at line 599 of file ntv2hdmi.cpp.

◆ GetHDRData() [1/2]

bool CNTV2Card::GetHDRData ( HDRFloatValues & outFloatValues )

virtual

Definition at line 988 of file ntv2hdmi.cpp.

◆ GetHDRData() [2/2]

bool CNTV2Card::GetHDRData ( HDRRegValues & outRegisterValues )

virtual

Definition at line 995 of file ntv2hdmi.cpp.

◆ GetHeadphoneOutputGain()

bool CNTV2Card::GetHeadphoneOutputGain ( ULWord & outGainValue )

virtual

Answers with the current gain setting for the headphone out.

Parameters

[out] outGainValue Receives the current headphone gain level. This is a signed 18-bit value, where unity gain is 0x10000.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetHeadphoneOutputGain, Audio Mixer

Definition at line 702 of file ntv2audio.cpp.

◆ GetInputAudioChannelPairsWithoutPCM()

bool CNTV2Card::GetInputAudioChannelPairsWithoutPCM	(	const NTV2Channel	inSDIInputConnector,
		NTV2AudioChannelPairs &	outChannelPairs
	)

virtual

For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently not PCM-encoded.

Parameters

[in]	inSDIInputConnector	Specifies the SDI input connector of interest as an NTV2Channel (a zero-based index number).
[out]	outChannelPairs	Receives the channel pairs that are not currently PCM-encoded.

Returns: True if successful; otherwise false.

Definition at line 1530 of file ntv2audio.cpp.

◆ GetInputAudioChannelPairsWithPCM()

bool CNTV2Card::GetInputAudioChannelPairsWithPCM	(	const NTV2Channel	inSDIInputConnector,
		NTV2AudioChannelPairs &	outChannelPairs
	)

virtual

For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently PCM-encoded.

Parameters

[in]	inSDIInputConnector	Specifies the SDI input connector of interest as an NTV2Channel (a zero-based index number).
[out]	outChannelPairs	Receives the channel pairs that are currently PCM-encoded.

Returns: True if successful; otherwise false.

Note: The audio de-embedder firmware sets non-PCM-detect bits in registers independently of its channel-pair-detection registers. Non-PCM-detect bits representing missing channel pairs are always clear. Therefore, callers of this function may wish to also call CNTV2Card::GetDetectedAudioChannelPairs (or CNTV2Card::GetDetectedAESChannelPairs), and then use std::set_intersection to produce a more realistic set of PCM channel pairs.

Definition at line 1502 of file ntv2audio.cpp.

◆ GetInputFieldID()

bool CNTV2Card::GetInputFieldID	(	const NTV2Channel	channel,
		NTV2FieldID &	outFieldID
	)

virtual

Returns the current field ID of the specified input channel.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number).
[out]	outFieldID	The current field ID of the specified input channel.

Returns: True if successful; otherwise false.

Definition at line 198 of file ntv2subscriptions.cpp.

◆ GetInputFrame()

bool CNTV2Card::GetInputFrame	(	const NTV2Channel	inChannel,
		ULWord &	outValue
	)

virtual

Answers with the current input frame index number for the given FrameStore. This identifies which particular frame in device SDRAM will be written after the next frame interrupt.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number. (The FrameStore should be enabled and set for capture mode.)
[out]	outValue	Receives the current input frame index number of the frame in device memory being written. See Frame Buffer Indexing for more information.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetInputFrame, FrameStore Operation

Definition at line 2218 of file ntv2register.cpp.

◆ GetInputVerticalEventCount()

bool CNTV2Card::GetInputVerticalEventCount	(	ULWord &	outCount,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the number of input interrupt events that I successfully waited for on the given channel.

Parameters

[out]	outCount	Receives the number of input interrupt events that were successfully waited for.
[in]	inChannel	Specifies the NTV2Channel of interest.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetInputVerticalEventCount, CNTV2Card::GetInterruptEventCount, Field/Frame Interrupts

Definition at line 114 of file ntv2subscriptions.cpp.

◆ GetInputVerticalInterruptCount()

bool CNTV2Card::GetInputVerticalInterruptCount	(	ULWord &	outCount,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the number of input vertical interrupts handled by the driver for the given input channel.

Parameters

[out]	outCount	Receives the number of input VBIs handled by the driver since it was loaded.
[in]	inChannel	Specifies the input channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetInputVerticalEventCount, CNTV2DriverInterface::GetInterruptEventCount, Field/Frame Interrupts

Definition at line 98 of file ntv2subscriptions.cpp.

◆ GetInputVideoFormat()

NTV2VideoFormat CNTV2Card::GetInputVideoFormat	(	const NTV2InputSource	inVideoSource = `NTV2_INPUTSOURCE_SDI1`,
		const bool	inIsProgressive = `(0)`
	)

virtual

Returns the video format of the signal that is present on the given input source.

Parameters

[in]	inVideoSource	Specifies the video input source as an NTV2InputSource.
[in]	inIsProgressive	Optionally specifies if the video format is expected to be progressive or not. Defaults to false (presumed to be interlaced).

Returns: A valid NTV2VideoFormat if successful; otherwise returns NTV2_FORMAT_UNKNOWN.

This function allows client applications to determine the kind of video signal, if any, is being presented to a given input source of the device. Because the hardware has no way of knowing if the incoming signal is progressive or interlaced (e.g., 525/29.97fps progressive versus 525/59.94fps interlaced), the function assumes interlaced, but the caller can override the function's "interlace" assumption.

Definition at line 3365 of file ntv2register.cpp.

◆ GetInputVideoSelect()

bool CNTV2Card::GetInputVideoSelect ( NTV2InputVideoSelect & outInputSelect )

virtual

Definition at line 3357 of file ntv2register.cpp.

◆ GetInstalledBitfileInfo()

bool CNTV2Card::GetInstalledBitfileInfo	(	ULWord &	outNumBytes,
		std::string &	outDateStr,
		std::string &	outTimeStr
	)

virtual

Returns the size and time/date stamp of the device's currently-installed firmware.

Parameters

[out]	outNumBytes	Receives the size of the installed firmware image, in bytes.
[out]	outDateStr	Receives a human-readable string containing the date the currently-installed firmware was built. The string has the format "YYYY/MM/DD", where "YYYY" is the year, "MM" is the month ("00" thru "12"), and "DD" is the day of the month ("00" thru "31").
[out]	outTimeStr	Receives a human-readable string containing the time the currently-installed firmware was built (in local Pacific time). The string has the format "HH:MM:SS", where HH is "00" thru "23", and both MM and SS are "00" thru "59".

Returns: True if successful; otherwise false.

Note: This function has nothing to do with the firmware bitfiles that are currently installed on the local host's file system.

Definition at line 304 of file ntv2card.cpp.

◆ GetIsoConvertMode()

bool CNTV2Card::GetIsoConvertMode ( NTV2IsoConvertMode & outValue )

virtual

Definition at line 35 of file ntv2regconv.cpp.

◆ GetLEDState()

bool CNTV2Card::GetLEDState ( ULWord & outValue )

virtual

Answers with the current state of the four on-board LEDs.

Parameters

[out] outValue Receives the current state of the four on-board LEDs. Only the least significant four bits of the ULWord have any meaning.

Returns: True if successful; otherwise, false.

Definition at line 2484 of file ntv2register.cpp.

◆ GetLHIHDMIOutColorSpace()

bool CNTV2Card::GetLHIHDMIOutColorSpace ( NTV2LHIHDMIColorSpace & outValue )

virtual

Definition at line 440 of file ntv2hdmi.cpp.

◆ GetLHIVideoDACMode() [1/2]

bool CNTV2Card::GetLHIVideoDACMode ( NTV2LHIVideoDACMode & outValue )

virtual

Definition at line 283 of file ntv2regconv.cpp.

◆ GetLHIVideoDACMode() [2/2]

bool CNTV2Card::GetLHIVideoDACMode ( NTV2VideoDACMode & outValue )

virtual

Definition at line 323 of file ntv2regconv.cpp.

◆ GetLHIVideoDACStandard()

bool CNTV2Card::GetLHIVideoDACStandard ( NTV2Standard & outValue )

virtual

Definition at line 281 of file ntv2regconv.cpp.

◆ GetLTCEmbeddedOutEnable()

bool CNTV2Card::GetLTCEmbeddedOutEnable ( bool & outValue )

virtual

Deprecated:: Obsolete, do not use. First deprecated in SDK 16.3.

Definition at line 3689 of file ntv2register.cpp.

◆ GetLTCInputEnable()

bool CNTV2Card::GetLTCInputEnable ( bool & outIsEnabled )

virtual

Answers true if the device is currently configured to read analog LTC from the reference input connector (instead of reference).

Parameters

[out] outEnabled Receives true if the device is set to read analog LTC from its reference connector, or false if it's configured to read reference.

Returns: True if successful; otherwise false.

Note: Not all devices are able to read analog LTC from their reference input. Call NTV2DeviceCanDoLTCInOnRefPort to find out.

See also: SetLTCInputEnable, NTV2DeviceCanDoLTCInOnRefPort, Analog LTC Input

Definition at line 3659 of file ntv2register.cpp.

◆ GetLTCInputPresent()

bool CNTV2Card::GetLTCInputPresent	(	bool &	outIsPresent,
		const UWord	inLTCInputNdx = `0`
	)

virtual

Answers whether or not a valid analog LTC signal is being applied to the device's analog LTC input connector.

Parameters

[out]	outIsPresent	Receives 'true' if a valid analog LTC signal is present at the analog LTC input connector; otherwise 'false'.
[in]	inLTCInputNdx	Optionally specifies the LTC input connector. Defaults to 0 (LTCIn1).

Returns: True if successful; otherwise false.

Note: Some devices share analog LTC input and reference input on one connector. For these devices, this call should be preceded by a call to NTV2Card::SetLTCInputEnable(true).

See also: ReadAnalogLTCInput, NTV2DeviceGetNumLTCInputs, Analog LTC Input

Definition at line 3668 of file ntv2register.cpp.

◆ GetLUTControlSelect()

bool CNTV2Card::GetLUTControlSelect ( NTV2LUTControlSelect & outLUTSelect )

virtual

Definition at line 334 of file ntv2csclut.cpp.

◆ GetLUTTables()

bool CNTV2Card::GetLUTTables	(	NTV2DoubleArray &	outRedLUT,
		NTV2DoubleArray &	outGreenLUT,
		NTV2DoubleArray &	outBlueLUT
	)

virtual

Reads the LUT tables (as double-precision floating point values).

Parameters

[out]	outRedLUT	Receives the Red LUT, a std::vector of double-precision floating-point values.
[out]	outGreenLUT	Receives the Green LUT, a std::vector of double-precision floating-point values.
[out]	outBlueLUT	Receives the Blue LUT, a std::vector of double-precision floating-point values.

Returns: True if successful; otherwise false.

Note: Version 2 LUTs (see NTV2DeviceGetLUTVersion) require setup of kRegLUTV2Control (register 376) for this function to work properly.

Definition at line 984 of file ntv2csclut.cpp.

◆ GetLUTV2HostAccessBank()

bool CNTV2Card::GetLUTV2HostAccessBank	(	NTV2ColorCorrectionHostAccessBank &	outValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 258 of file ntv2csclut.cpp.

◆ GetLUTV2OutputBank()

bool CNTV2Card::GetLUTV2OutputBank	(	const NTV2Channel	inLUTWidget,
		ULWord &	outBank
	)

virtual

Definition at line 137 of file ntv2csclut.cpp.

◆ GetMixerBGInputControl()

bool CNTV2Card::GetMixerBGInputControl	(	const UWord	inWhichMixer,
		NTV2MixerKeyerInputControl &	outInputControl
	)

virtual

Returns the current background input control value for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outInputControl	Receives the mixer/keyer's background input control value; otherwise NTV2MIXERINPUTCONTROL_INVALID upon failure.

See also: CNTV2Card::SetMixerBGInputControl, Mixer/Keyer Operation, widget_mixkey

Definition at line 2906 of file ntv2register.cpp.

◆ GetMixerBGMatteEnabled()

bool CNTV2Card::GetMixerBGMatteEnabled	(	const UWord	inWhichMixer,
		bool &	outIsEnabled
	)

virtual

Answers if the given mixer/keyer's background matte is enabled or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outIsEnabled	Receives true if the mixer's background matte is currently enabled; otherwise false.

See also: CNTV2Card::SetMixerBGMatteEnabled, CNTV2Card::GetMixerFGMatteEnabled, Mixer/Keyer Operation, widget_mixkey

Definition at line 2989 of file ntv2register.cpp.

◆ GetMixerCoefficient()

bool CNTV2Card::GetMixerCoefficient	(	const UWord	inWhichMixer,
		ULWord &	outMixCoefficient
	)

virtual

Returns the current mix coefficient the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outMixCoefficient	Receives the current mix coefficient value, where `0x10000` is the maximum.

See also: CNTV2Card::SetMixerCoefficient, Mixer/Keyer Operation, widget_mixkey

Definition at line 2953 of file ntv2register.cpp.

◆ GetMixerFGInputControl()

bool CNTV2Card::GetMixerFGInputControl	(	const UWord	inWhichMixer,
		NTV2MixerKeyerInputControl &	outInputControl
	)

virtual

Returns the current foreground input control value for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outInputControl	Receives the mixer/keyer's foreground input control value; otherwise NTV2MIXERINPUTCONTROL_INVALID upon failure.

See also: CNTV2Card::SetMixerFGInputControl, Mixer/Keyer Operation, widget_mixkey

Definition at line 2883 of file ntv2register.cpp.

◆ GetMixerFGMatteEnabled()

bool CNTV2Card::GetMixerFGMatteEnabled	(	const UWord	inWhichMixer,
		bool &	outIsEnabled
	)

virtual

Answers if the given mixer/keyer's foreground matte is enabled or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outIsEnabled	Receives true if the mixer's foreground matte is currently enabled; otherwise false.

See also: CNTV2Card::SetMixerFGMatteEnabled, CNTV2Card::GetMixerBGMatteEnabled, Mixer/Keyer Operation, widget_mixkey

Definition at line 2974 of file ntv2register.cpp.

◆ GetMixerMatteColor()

bool CNTV2Card::GetMixerMatteColor	(	const UWord	inWhichMixer,
		YCbCr10BitPixel &	outYCbCrValue
	)

virtual

Answers with the given mixer/keyer's current matte color value being used.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outYCbCrValue	Receives the mixer's current matte color value.

See also: CNTV2Card::SetMixerMatteColor, Mixer/Keyer Operation, widget_mixkey

Definition at line 3006 of file ntv2register.cpp.

◆ GetMixerMode()

bool CNTV2Card::GetMixerMode	(	const UWord	inWhichMixer,
		NTV2MixerKeyerMode &	outMode
	)

virtual

Returns the current operating mode of the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outMode	Receives the mode value.

See also: CNTV2Card::SetMixerMode, Mixer/Keyer Operation, widget_mixkey

Definition at line 2929 of file ntv2register.cpp.

◆ GetMixerRGBRange()

bool CNTV2Card::GetMixerRGBRange	(	const UWord	inWhichMixer,
		NTV2MixerRGBRange &	outRGBRange
	)

virtual

Answers with the given mixer/keyer's current RGB Range.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outRGBRange	Receives the mixer's current matte color value.

Definition at line 3061 of file ntv2register.cpp.

◆ GetMixerSyncStatus()

bool CNTV2Card::GetMixerSyncStatus	(	const UWord	inWhichMixer,
		bool &	outIsSyncOK
	)

virtual

Returns the current sync state of the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outIsSyncOK	Receives the mixer's current sync state. If true, the mixer is synchronized to its inputs. If false, the mixer is not synchronized to its inputs.

See also: See Mixer/Keyer Operation for more information

Definition at line 2962 of file ntv2register.cpp.

◆ GetMixerVancOutputFromForeground()

bool CNTV2Card::GetMixerVancOutputFromForeground	(	const UWord	inWhichMixer,
		bool &	outIsFromForegroundSource
	)

virtual

Answers whether or not the VANC source for the given mixer/keyer is currently the foreground video. See the SDI Ancillary Data discussion for more information.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outIsFromForegroundSource	Receives True if the mixer/keyer's VANC source is its foreground video input; otherwise False if it's its background video input.

See also: CNTV2Card::SetMixerVancOutputFromForeground, Mixer/Keyer Operation, widget_mixkey

Definition at line 2862 of file ntv2register.cpp.

◆ GetMode()

bool CNTV2Card::GetMode	(	const NTV2Channel	inChannel,
		NTV2Mode &	outValue
	)

virtual

Answers with the current NTV2Mode of the given FrameStore on the AJA device.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel value (a zero-based index number).
[out]	outValue	Receives the FrameStore's current NTV2Mode (NTV2_MODE_DISPLAY or NTV2_MODE_CAPTURE).

Returns: True if successful; otherwise false.

In NTV2_MODE_CAPTURE mode, device frame memory is written; in NTV2_MODE_DISPLAY mode, it's read from.

See also: CNTV2Card::SetMode, FrameStore Operation

Definition at line 1625 of file ntv2register.cpp.

◆ GetModelName()

string CNTV2Card::GetModelName ( void )

virtual

Answers with this device's model name.

Returns: A string containing this device's model name.

Definition at line 80 of file ntv2card.cpp.

◆ GetMultiFormatMode()

bool CNTV2Card::GetMultiFormatMode ( bool & outIsEnabled )

virtual

Answers if the device is operating in multiple-format per channel (independent channel) mode or not. If enabled, each device channel can accommodate a different video format (subject to certain limitations). If disabled, all device channels have the same video format.

Returns: True if successful; otherwise false.

Parameters

[out] outIsEnabled Receives true if the device is currently in multi-format mode, or false if it's in uni-format mode.

Deprecated:: Uniformat mode is deprecated starting in SDK 17.0. Eventually this function will be removed from the class.

See also: NTV2DeviceCanDoMultiFormat, CNTV2Card::SetMultiFormatMode, Video Output Clocking & Synchronization

Definition at line 4387 of file ntv2register.cpp.

◆ GetMultiLinkAudioMode()

bool CNTV2Card::GetMultiLinkAudioMode	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outEnabled
	)

virtual

Answers with the current multi-link audio mode for the given audio system.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[out]	outEnable	Receives true if multi-link audio mode is currently enabled; otherwise false if disabled.

See also: CNTV2Card::SetMultiLinkAudioMode, NTV2DeviceCanDoMultiLinkAudio, Multi-Link Audio (32, 48, 64 Audio Channels)

Definition at line 1651 of file ntv2audio.cpp.

◆ GetMultiRasterBypassEnable()

bool CNTV2Card::GetMultiRasterBypassEnable ( bool & outEnabled )

virtual

Definition at line 4707 of file ntv2register.cpp.

◆ GetNominalMinMaxHV()

bool CNTV2Card::GetNominalMinMaxHV	(	int &	outNominalH,
		int &	outMinH,
		int &	outMaxH,
		int &	outNominalV,
		int &	outMinV,
		int &	outMaxV
	)

virtual

Definition at line 597 of file ntv2register.cpp.

◆ GetNTV2VideoFormat() [1/2]

NTV2VideoFormat CNTV2Card::GetNTV2VideoFormat	(	NTV2FrameRate	frameRate,
		NTV2Standard	standard,
		bool	isThreeG,
		UByte	inputGeometry = `0`,
		bool	progressivePicture = `(0)`,
		bool	isSquareDivision = `(! (0) )`
	)

static

Definition at line 377 of file ntv2register.cpp.

◆ GetNTV2VideoFormat() [2/2]

NTV2VideoFormat CNTV2Card::GetNTV2VideoFormat	(	NTV2FrameRate	frameRate,
		UByte	inputGeometry,
		bool	progressiveTransport,
		bool	isThreeG,
		bool	progressivePicture = `(0)`
	)

static

Definition at line 371 of file ntv2register.cpp.

◆ GetNumberActiveLines()

bool CNTV2Card::GetNumberActiveLines ( ULWord & outNumActiveLines )

virtual

Deprecated:: Obsolete starting in SDK 16.2.

Definition at line 772 of file ntv2register.cpp.

◆ GetNumberAudioChannels()

bool CNTV2Card::GetNumberAudioChannels	(	ULWord &	outNumChannels,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Returns the current number of audio channels being captured or played by a given Audio System on the AJA device.

Returns: True if successful; otherwise false.

Parameters

[out]	outNumChannels	Receives the number of audio channels that the AJA device hardware is currently capturing or playing for the given Audio System. If the function result is true, the variable's contents will be valid, and for most AJA devices will be 6, 8, or 16.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

This function allows client applications to determine how many audio channels the AJA hardware is currently capturing/playing into/from the given Audio System on the device.

Definition at line 180 of file ntv2audio.cpp.

◆ GetOutputFieldID()

bool CNTV2Card::GetOutputFieldID	(	const NTV2Channel	channel,
		NTV2FieldID &	outFieldID
	)

virtual

Returns the current field ID of the specified output channel.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number).
[out]	outFieldID	The current field ID of the specified output channel.

Returns: True if successful; otherwise false.

Definition at line 164 of file ntv2subscriptions.cpp.

◆ GetOutputFrame()

bool CNTV2Card::GetOutputFrame	(	const NTV2Channel	inChannel,
		ULWord &	outValue
	)

virtual

Answers with the current output frame number for the given FrameStore (expressed as an NTV2Channel).

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number.
[out]	outValue	Receives the current output frame number, a zero-based index into each 8/16/32 MB block of SDRAM on the device.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetOutputFrame, FrameStore Operation

Definition at line 2200 of file ntv2register.cpp.

◆ GetOutputVerticalEventCount()

bool CNTV2Card::GetOutputVerticalEventCount	(	ULWord &	outCount,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the number of output interrupt events that I successfully waited for on the given channel.

Parameters

[out]	outCount	Receives the number of output interrupt events that were successfully waited for.
[in]	inChannel	Specifies the NTV2Channel of interest.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetOutputVerticalEventCount, CNTV2DriverInterface::GetInterruptEventCount, Field/Frame Interrupts

Definition at line 107 of file ntv2subscriptions.cpp.

◆ GetOutputVerticalInterruptCount()

bool CNTV2Card::GetOutputVerticalInterruptCount	(	ULWord &	outCount,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Answers with the number of output vertical interrupts handled by the driver for the given output channel.

Parameters

[out]	outCount	Receives the number of output VBIs handled by the driver since it was loaded.
[in]	inChannel	Specifies the output channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetOutputVerticalEventCount, CNTV2DriverInterface::GetInterruptEventCount, Field/Frame Interrupts

Definition at line 91 of file ntv2subscriptions.cpp.

◆ GetPCIAccessFrame()

bool CNTV2Card::GetPCIAccessFrame	(	const NTV2Channel	inChannel,
		ULWord &	outValue
	)

virtual

Deprecated:: Declared obsolete starting in SDK 16.2. The "PCI Access Frame" register had no effect on the hardware, but was used to store the next/pending output frame.

Definition at line 2174 of file ntv2register.cpp.

◆ GetPCIDeviceID()

bool CNTV2Card::GetPCIDeviceID ( ULWord & outPCIDeviceID )

virtual

Answers with my PCI device ID.

Parameters

[out] outPCIDeviceID Receives my PCI device ID.

Returns: True if successful (and valid); otherwise false.

Definition at line 2403 of file ntv2register.cpp.

◆ GetPCIFPGAVersion()

Word CNTV2Card::GetPCIFPGAVersion ( void )

virtual

Definition at line 109 of file ntv2card.cpp.

◆ GetPCIFPGAVersionString()

string CNTV2Card::GetPCIFPGAVersionString ( void )

virtual

Definition at line 116 of file ntv2card.cpp.

◆ GetPossibleConnections()

bool CNTV2Card::GetPossibleConnections ( NTV2PossibleConnections & outConnections )

virtual

Answers with the implemented crosspoint connections (if known).

Parameters

[out] outConnections Receives the device's NTV2PossibleConnections.

Returns: True if successful; otherwise false.

Definition at line 1795 of file ntv2register.cpp.

◆ GetProgramStatus()

bool CNTV2Card::GetProgramStatus ( SSC_GET_FIRMWARE_PROGRESS_STRUCT * statusStruct )

virtual

Definition at line 2257 of file ntv2register.cpp.

◆ GetProgressivePicture()

bool CNTV2Card::GetProgressivePicture ( ULWord & outValue )

virtual

Definition at line 1081 of file ntv2register.cpp.

◆ GetPulldownMode()

bool CNTV2Card::GetPulldownMode	(	NTV2Channel	inChannel,
		bool &	outValue
	)

virtual

Definition at line 2839 of file ntv2register.cpp.

◆ GetQuadFrameEnable()

bool CNTV2Card::GetQuadFrameEnable	(	bool &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Returns the device's current quad-frame mode, whether it's enabled or not.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives 'true' if the device is currently in quad frame mode; otherwise 'false'.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1. Ignored if the device is incapable of 4K.

Definition at line 1209 of file ntv2register.cpp.

◆ GetQuadQuadFrameEnable()

bool CNTV2Card::GetQuadQuadFrameEnable	(	bool &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Returns the device's current "quad-quad" frame mode, whether it's enabled or not.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives 'true' if the device is currently in quad quad frame mode; otherwise 'false'.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1. Ignored if the device is incapable of 8K/UHD2.

Definition at line 1224 of file ntv2register.cpp.

◆ GetQuadQuadSquaresEnable()

bool CNTV2Card::GetQuadQuadSquaresEnable	(	bool &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Returns the device's current "quad-quad-squares" frame mode, whether it's enabled or not.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives 'true' if the device is currently in "quad quad squares" frame mode; otherwise 'false'.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1. Ignored if the device is incapable of multi-format mode, or is not currently in multi-format mode.

Definition at line 1197 of file ntv2register.cpp.

◆ GetRawAudioTimer()

bool CNTV2Card::GetRawAudioTimer	(	ULWord &	outValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Answers with the current value of the 48kHz audio clock counter.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives the number of 48kHz "ticks" that have transpired since the device was powered up.
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest. Currently ignored, but may be used if a future NTV2 device has more than one audio clock.

Note: This counter will overflow and wrap back to zero in 24:51:00 [hh:mm:ss].

Definition at line 1709 of file ntv2audio.cpp.

◆ GetReference()

bool CNTV2Card::GetReference ( NTV2ReferenceSource & outRefSource )

virtual

Answers with the device's current clock reference source.

Parameters

[out] outRefSource Receives the current NTV2ReferenceSource value.

Returns: True if successful; otherwise false.

See also: SetReference, GetReferenceVideoFormat, Video Output Clocking & Synchronization

Definition at line 1523 of file ntv2register.cpp.

◆ GetReferenceVideoFormat()

NTV2VideoFormat CNTV2Card::GetReferenceVideoFormat ( void )

virtual

Returns the video format of the signal that is present on the device's reference input.

Returns: A valid NTV2VideoFormat if successful; otherwise returns NTV2_FORMAT_UNKNOWN.

Note: The returned video format, if valid, will be an SD format for black burst and HD for tri-level.; If the device is capable of reading analog LTC from its reference input connector (i.e. if NTV2DeviceCanDoLTCInOnRefPort returns true), then CNTV2Card::GetLTCInputEnable should be called to confirm that the reference port is reading reference, and not LTC.

See also: GetReference, SetReference, Video Output Clocking & Synchronization

Definition at line 3546 of file ntv2register.cpp.

◆ GetRegisterBaseAddress()

bool CNTV2Card::GetRegisterBaseAddress	(	ULWord	regNumber,
		ULWord **	pRegAddress
	)

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 3119 of file ntv2register.cpp.

◆ GetRegisterWriteMode()

bool CNTV2Card::GetRegisterWriteMode	(	NTV2RegisterWriteMode &	outValue,
		const NTV2Channel	inFrameStore = `NTV2_CHANNEL1`
	)

virtual

Answers with the FrameStore's current NTV2RegisterWriteMode setting, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect.

Parameters

[out]	outValue	Receives the NTV2RegisterWriteMode that's currently being used by the FrameStore.
[in]	inFrameStore	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number. If omitted, defaults to NTV2_CHANNEL1.

See also: CNTV2Card::SetRegisterWriteMode, CNTV2Card::SetInputFrame, CNTV2Card::SetOutputFrame, Field/Frame Interrupts

Definition at line 2470 of file ntv2register.cpp.

◆ GetRouting()

bool CNTV2Card::GetRouting ( CNTV2SignalRouter & outRouting )

virtual

Answers with the current signal routing between any and all widgets on the AJA device.

Parameters

[out] outRouting Receives the current signal routing.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2SignalRouter, CNTV2Card::GetRoutingForChannel, CNTV2Card::ApplySignalRoute

Definition at line 305 of file ntv2regroute.cpp.

◆ GetRoutingForChannel()

bool CNTV2Card::GetRoutingForChannel	(	const NTV2Channel	inChannel,
		CNTV2SignalRouter &	outRouting
	)

virtual

Answers with the current signal routing for the given channel.

Parameters

[in]	inChannel	Specifies the NTV2Channel of interest.
[out]	outRouting	Receives the current signal routing for the given channel.

Returns: True if successful; otherwise false.

See also: Widget Signal Routing, CNTV2SignalRouter, CNTV2Card::GetRouting, CNTV2Card::ApplySignalRoute

Definition at line 362 of file ntv2regroute.cpp.

◆ GetRP188BypassSource()

bool CNTV2Card::GetRP188BypassSource	(	const NTV2Channel	inSDIOutput,
		UWord &	outSDIInput
	)

virtual

For the given SDI output that's in RP188 bypass mode (E-E), answers with the SDI input that's currently being used as a timecode source.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest, expressed as an NTV2Channel.
[out]	outSDIInput	Receives the SDI input being used as a timecode source, expressed as a zero-based index number.

Returns: True if successful; otherwise false.

Definition at line 2590 of file ntv2register.cpp.

◆ GetRP188Data()

bool CNTV2Card::GetRP188Data	(	const NTV2Channel	inSDIInput,
		NTV2_RP188 &	outRP188Data
	)

virtual

Reads the raw RP188 data from the DBB/Low/Hi registers for the given SDI input. On newer devices with bi-directional SDI connectors – see Timecode (RP-188, SMPTE-12M) for details – if the device is configured for...

input: answers with the last timecode received at the SDI input (subject to the SDI input's RP188 source filter – see CNTV2Card::GetRP188SourceFilter);

output: answers with the timecode that's to be embedded into the SDI output (usually the last timecode written via CNTV2Card::SetRP188Data).

Parameters

[in]	inSDIInput	Specifies the SDI input of interest, expressed as an NTV2Channel. For bi-directional SDI devices, specifies the SDI connector of interest, which can specify an SDI output.
[out]	outRP188Data	Receives the raw RP188 data values.

See also: CNTV2Card::SetRP188Data, CNTV2Card::GetRP188SourceFilter, Timecode (RP-188, SMPTE-12M)

Definition at line 2510 of file ntv2register.cpp.

◆ GetRP188Mode()

bool CNTV2Card::GetRP188Mode	(	const NTV2Channel	inChannel,
		NTV2_RP188Mode &	outMode
	)

virtual

Returns the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel.

Parameters

[in]	inChannel	Specifies the channel of interest.
[out]	outMode	Receives the RP-188 mode for the given channel.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetRP188Mode, Timecode (RP-188, SMPTE-12M)

Definition at line 2499 of file ntv2register.cpp.

◆ GetRP188SourceFilter()

bool CNTV2Card::GetRP188SourceFilter	(	const NTV2Channel	inSDIInput,
		UWord &	outFilterValue
	)

virtual

Returns the current RP188 filter setting for the given SDI input.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest, expressed as an NTV2Channel.
[out]	outFilterValue	Receives the given SDI input's current RP188 SDI input filter, an 8-bit value. 0x00 is LTC; 0x01 is VITC1; 0x02 is VITC2; 0xFF is unfiltered, which results in the timecode registers containing the last received timecode packet for the input frame.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetRP188SourceFilter, CNTV2Card::IsRP188BypassEnabled, CNTV2Card::GetRP188BypassSource, Timecode (RP-188, SMPTE-12M)

Definition at line 2541 of file ntv2register.cpp.

◆ GetRS422BaudRate()

bool CNTV2Card::GetRS422BaudRate	(	const NTV2Channel	inSerialPort,
		NTV2_RS422_BAUD_RATE &	outBaudRate
	)

virtual

Answers with the current baud rate of the specified RS422 serial port.

Returns: True if successful; otherwise false.

Parameters

[in]	inSerialPort	Specifies the RS422 serial port of interest, expressed as an NTV2Channel (a zero-based index number). Call NTV2DeviceGetNumSerialPorts to determine the number of available serial ports.
[out]	outBaudRate	Receives the NTV2_RS422_BAUD_RATE being used.

See also: CNTV2Card::GetRS422Parity, CNTV2Card::SetRS422BaudRate, NTV2DeviceGetNumSerialPorts, NTV2DeviceCanDoProgrammableRS422

Definition at line 4467 of file ntv2register.cpp.

◆ GetRS422Parity()

bool CNTV2Card::GetRS422Parity	(	const NTV2Channel	inSerialPort,
		NTV2_RS422_PARITY &	outParity
	)

virtual

Answers with the current parity control for the specified RS422 serial port.

Returns: True if successful; otherwise false.

Parameters

[in]	inSerialPort	Specifies the RS422 serial port of interest, expressed as an NTV2Channel (a zero-based index number). Call NTV2DeviceGetNumSerialPorts to determine the number of available serial ports.
[out]	outParity	Receives the serial port's current NTV2_RS422_PARITY setting.

See also: CNTV2Card::SetRS422Parity, CNTV2Card::GetRS422BaudRate, NTV2DeviceGetNumSerialPorts, NTV2DeviceCanDoProgrammableRS422

Definition at line 4424 of file ntv2register.cpp.

◆ GetRunningFirmwareDate() [1/2]

bool CNTV2Card::GetRunningFirmwareDate	(	std::string &	outDate,
		std::string &	outTime
	)

virtual

Reports the (local Pacific) build date and time of the currently-running firmware.

Parameters

[out]	outDate	Receives a string containing the human-readable running firmware build date, in the form 'YYYY/MM/DD', where YYYY, MM and DD are the numeric Gregorian year, month and day values, expressed as unsigned decimal values (with leading zeroes).
[out]	outTime	Receives a string containing the human-readable running firmware build time, in the form 'HH:MM:SS', where HH, MM and SS are the numeric hour, minute and second values, expressed as unsigned decimal values (with leading zeroes), and a 24-hour clock format.

Returns: True if successful; otherwise false.

Note: This date/time may differ from the build date/time of the installed firmware if, after erasing or reflashing, the device was never power-cycled to force its FPGA to reload.

See also: CNTV2Card::GetRunningFirmwareTime, CNTV2Card::GetRunningFirmwareRevision, Firmware.

Definition at line 2367 of file ntv2register.cpp.

◆ GetRunningFirmwareDate() [2/2]

bool CNTV2Card::GetRunningFirmwareDate	(	UWord &	outYear,
		UWord &	outMonth,
		UWord &	outDay
	)

virtual

Reports the (local Pacific) build date of the currently-running firmware.

Parameters

[out]	outYear	Receives the year portion of the build date, an unsigned integer representing a standard Gregorian calendar year (e.g., 2017).
[out]	outMonth	Receives the month portion of the build date, an unsigned integer representing a standard 1-based Gregorian calendar month (e.g., 1 == January).
[out]	outDay	Receives the day portion of the build date, an unsigned integer representing a standard 1-based Gregorian calendar day (i.e., 1 thru 31).

Returns: True if successful; otherwise false.

Note: This date may differ from the build date of the installed firmware if, after erasing or reflashing, the device was never power-cycled to force its FPGA to reload.

See also: CNTV2Card::GetRunningFirmwareTime, CNTV2Card::GetRunningFirmwareRevision, Firmware.

Definition at line 2314 of file ntv2register.cpp.

◆ GetRunningFirmwarePackageRevision()

bool CNTV2Card::GetRunningFirmwarePackageRevision ( ULWord & outRevision )

virtual

Reports the revision number of the currently-running firmware package. KonaIP style boards have a package.

Parameters

[out] outRevision Receives the revision number.

Returns: True if successful; otherwise false.

Note: This may differ from the revision number of the installed firmware package if, after erasing or reflashing, the device was not power-cycled to force its FPGA to reload.

Definition at line 2290 of file ntv2register.cpp.

◆ GetRunningFirmwareRevision()

bool CNTV2Card::GetRunningFirmwareRevision ( UWord & outRevision )

virtual

Reports the revision number of the currently-running firmware.

Parameters

[out] outRevision Receives the revision number.

Returns: True if successful; otherwise false.

Note: This may differ from the revision number of the installed firmware if, after erasing or reflashing, the device was not power-cycled to force its FPGA to reload.

See also: CNTV2Card::GetRunningFirmwareDate, CNTV2Card::GetRunningFirmwareTime, Firmware.

Definition at line 2300 of file ntv2register.cpp.

◆ GetRunningFirmwareTime()

bool CNTV2Card::GetRunningFirmwareTime	(	UWord &	outHours,
		UWord &	outMinutes,
		UWord &	outSeconds
	)

virtual

Reports the (local Pacific) build time of the currently-running firmware.

Parameters

[out]	outHours	Receives the hours portion of the build time, an unsigned integer representing the number of hours past the start of day (0 thru 23).
[out]	outMinutes	Receives the minutes portion of the build time, an unsigned integer representing the number of minutes past the hour (0 thru 59).
[out]	outSeconds	Receives the seconds portion of the build time, an unsigned integer representing the number of seconds past the minute (0 thru 59).

Returns: True if successful; otherwise false.

Note: This date may differ from the build date of the installed firmware if, after erasing or reflashing, the device was never power-cycled to force its FPGA to reload.

See also: CNTV2Card::GetRunningFirmwareDate, CNTV2Card::GetRunningFirmwareRevision, Firmware.

Definition at line 2343 of file ntv2register.cpp.

◆ GetRunningFirmwareUserID()

bool CNTV2Card::GetRunningFirmwareUserID ( ULWord & outUserID )

virtual

Reports the UserID number of the currently-running firmware.

Parameters

[out] outUserID Receives the UserID.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetRunningFirmwareDate, CNTV2Card::GetRunningFirmwareTime, Firmware.

Definition at line 2386 of file ntv2register.cpp.

◆ GetSDI1OutHTiming()

bool CNTV2Card::GetSDI1OutHTiming ( ULWord * value )

virtual

Definition at line 3333 of file ntv2register.cpp.

◆ GetSDI2OutHTiming()

bool CNTV2Card::GetSDI2OutHTiming ( ULWord * value )

virtual

Definition at line 3337 of file ntv2register.cpp.

◆ GetSDIInLevelBtoLevelAConversion()

bool CNTV2Card::GetSDIInLevelBtoLevelAConversion	(	const UWord	inInputSpigot,
		bool &	outIsEnabled
	)

virtual

Answers with the device's current 3G level B to 3G level A conversion setting for the given SDI input spigot (assuming the device can do such a conversion).

Returns: True if successful; otherwise false.

Parameters

[in]	inInputSpigot	Specifies the SDI input widget of interest (0 == SDIIn1, 1 == SDIIn2, etc.).
[out]	outIsEnabled	Receives true if enabled, or false if disabled (normal operation).

Definition at line 4292 of file ntv2register.cpp.

◆ GetSDIInput12GPresent()

bool CNTV2Card::GetSDIInput12GPresent	(	bool &	outValue,
		const NTV2Channel	channel
	)

virtual

Definition at line 3638 of file ntv2register.cpp.

◆ GetSDIInput3GbPresent()

bool CNTV2Card::GetSDIInput3GbPresent	(	bool &	outValue,
		const NTV2Channel	channel
	)

virtual

Definition at line 3614 of file ntv2register.cpp.

◆ GetSDIInput3GPresent()

bool CNTV2Card::GetSDIInput3GPresent	(	bool &	outValue,
		const NTV2Channel	channel
	)

virtual

Definition at line 3602 of file ntv2register.cpp.

◆ GetSDIInput6GPresent()

bool CNTV2Card::GetSDIInput6GPresent	(	bool &	outValue,
		const NTV2Channel	channel
	)

virtual

Definition at line 3626 of file ntv2register.cpp.

◆ GetSDIInputGeometry()

NTV2FrameGeometry CNTV2Card::GetSDIInputGeometry ( const NTV2Channel channel )

virtual

Definition at line 3575 of file ntv2register.cpp.

◆ GetSDIInputIsProgressive()

bool CNTV2Card::GetSDIInputIsProgressive ( const NTV2Channel channel )

virtual

Definition at line 3592 of file ntv2register.cpp.

◆ GetSDIInputRate()

NTV2FrameRate CNTV2Card::GetSDIInputRate ( const NTV2Channel channel )

virtual

Definition at line 3558 of file ntv2register.cpp.

◆ GetSDIInputVideoFormat()

NTV2VideoFormat CNTV2Card::GetSDIInputVideoFormat	(	NTV2Channel	inChannel,
		bool	inIsProgressive = `(0)`
	)

virtual

Returns the video format of the signal that is present on the given SDI input source.

Parameters

[in]	inChannel	Specifies the SDI input connector as an NTV2Channel value, a zero-based index number.
[in]	inIsProgressive	Optionally specifies if the video format is expected to be progressive or not. Defaults to false (presumed to be interlaced).

Returns: A valid NTV2VideoFormat if successful; otherwise returns NTV2_FORMAT_UNKNOWN.

This function allows client applications to determine the kind of video signal, if any, is being presented to a given input source of the device. Because the hardware has no way of knowing if the incoming signal is progressive or interlaced (e.g., 525/29.97fps progressive versus 525/59.94fps interlaced), the function assumes interlaced, but the caller can override this assumption.

Definition at line 3386 of file ntv2register.cpp.

◆ GetSDILock()

bool CNTV2Card::GetSDILock ( const NTV2Channel inChannel )

virtual

Returns: True if the given SDI input is currently locked to a valid signal; otherwise false.

Parameters

[in] inChannel Specifies the channel (SDI input) of interest.

Note: This function returns valid information only for devices for which NTV2DeviceCanDoSDIErrorChecks returns 'true'.

Definition at line 4216 of file ntv2register.cpp.

◆ GetSDIOut12GEnable()

bool CNTV2Card::GetSDIOut12GEnable	(	const NTV2Channel	inChannel,
		bool &	outIsEnabled
	)

virtual

Definition at line 3920 of file ntv2register.cpp.

◆ GetSDIOut2Kx1080Enable()

bool CNTV2Card::GetSDIOut2Kx1080Enable	(	const NTV2Channel	inChannel,
		bool &	outIsEnabled
	)

virtual

Definition at line 3849 of file ntv2register.cpp.

◆ GetSDIOut3GbEnable()

bool CNTV2Card::GetSDIOut3GbEnable	(	const NTV2Channel	inChannel,
		bool &	outIsEnabled
	)

virtual

Definition at line 3878 of file ntv2register.cpp.

◆ GetSDIOut3GEnable()

bool CNTV2Card::GetSDIOut3GEnable	(	const NTV2Channel	inChannel,
		bool &	outIsEnabled
	)

virtual

Definition at line 3863 of file ntv2register.cpp.

◆ GetSDIOut6GEnable()

bool CNTV2Card::GetSDIOut6GEnable	(	const NTV2Channel	inChannel,
		bool &	outIsEnabled
	)

virtual

Definition at line 3895 of file ntv2register.cpp.

◆ GetSDIOutLevelAtoLevelBConversion()

bool CNTV2Card::GetSDIOutLevelAtoLevelBConversion	(	const UWord	inOutputSpigot,
		bool &	outIsEnabled
	)

virtual

Answers with the device's current 3G level A to 3G level B conversion setting for the given SDI output spigot (assuming the device can do such a conversion).

Returns: True if successful; otherwise false.

Parameters

[in]	inOutputSpigot	Specifies the SDI output widget of interest (0 == SDIOut1, 1 == SDIOut2, etc.).
[out]	outIsEnabled	Receives true if enabled, or false if disabled (normal operation).

Definition at line 4334 of file ntv2register.cpp.

◆ GetSDIOutputAudioSystem()

bool CNTV2Card::GetSDIOutputAudioSystem	(	const NTV2Channel	inSDIOutputConnector,
		NTV2AudioSystem &	outAudioSystem
	)

virtual

Answers with the device's NTV2AudioSystem that is currently providing audio for the given SDI output's audio embedder. (For 3G-capable SDI outputs, this is for Data Stream 1, or Link A.)

Parameters

[in]	inSDIOutputConnector	Specifies the SDI output connector of interest as an NTV2Channel (a zero-based index number).
[out]	outAudioSystem	Receives the Audio System that's currently being used (e.g., NTV2_AUDIOSYSTEM_1).

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; Use the NTV2DeviceGetNumVideoOutputs function to determine the number of SDI output jacks the device has.

See also: CNTV2Card::SetSDIOutputAudioSystem, CNTV2Card::GetSDIOutputDS2AudioSystem, CNTV2Card::SetSDIOutputDS2AudioSystem, Audio Playout

Definition at line 3929 of file ntv2register.cpp.

◆ GetSDIOutputDS2AudioSystem()

bool CNTV2Card::GetSDIOutputDS2AudioSystem	(	const NTV2Channel	inSDIOutputConnector,
		NTV2AudioSystem &	outAudioSystem
	)

virtual

Answers with the device's Audio System that is currently providing audio for the given SDI output's audio embedder for Data Stream 2 (Link B) for dual-link output.

Parameters

[in]	inSDIOutputConnector	Specifies the SDI output connector of interest as an NTV2Channel (a zero-based index number).
[out]	outAudioSystem	Receives the Audio System that's currently being used (e.g., NTV2_AUDIOSYSTEM_1).

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; The Corvid 88 has a firmware limitation where audio systems 5/6/7/8 cannot playback embedded audio on SDIs 1/2/3/4, nor can audio systems 1/2/3/4 playback embedded audio on SDIs 5/6/7/8.

See also: CNTV2Card::SetSDIOutputAudioSystem, CNTV2Card::GetSDIOutputAudioSystem, CNTV2Card::SetSDIOutputDS2AudioSystem, Audio Playout

Definition at line 3986 of file ntv2register.cpp.

◆ GetSDIOutputStandard()

bool CNTV2Card::GetSDIOutputStandard	(	const UWord	inOutputSpigot,
		NTV2Standard &	outValue
	)

virtual

Answers with the current video standard of the given SDI output spigot.

Parameters

[in]	inOutputSpigot	Specifies the SDI output spigot of interest as a zero-based index number, where zero is "SDI Out 1".
[out]	outValue	Receives the video standard.

Returns: True if successful; otherwise false.

Definition at line 3258 of file ntv2register.cpp.

◆ GetSDIOutRGBLevelAConversion()

bool CNTV2Card::GetSDIOutRGBLevelAConversion	(	const UWord	inOutputSpigot,
		bool &	outIsEnabled
	)

virtual

Answers with the device's current RGB-over-3G-level-A conversion at the given SDI output spigot (assuming the device can do such a conversion).

Returns: True if successful; otherwise false.

Parameters

[in]	inOutputSpigot	Specifies the SDI output spigot of interest (where 0 is "SDI Out 1").
[out]	outIsEnabled	Receives true if the device's output spigot is currently performing the conversion; otherwise false (not converting).

Definition at line 4366 of file ntv2register.cpp.

◆ GetSDIOutVPID()

bool CNTV2Card::GetSDIOutVPID	(	ULWord &	outValueA,
		ULWord &	outValueB,
		const UWord	inOutputSpigot = `NTV2_CHANNEL1`
	)

virtual

Definition at line 163 of file ntv2regvpid.cpp.

◆ GetSDIRelayManualControl()

bool CNTV2Card::GetSDIRelayManualControl	(	NTV2RelayState &	outValue,
		const UWord	inIndex0
	)

virtual

Answers if the bypass relays between connectors 1 and 2 would be in bypass or would route signals through the device, if under manual control.

Parameters

[out]	outValue	Receives the relay state (NTV2_DEVICE_BYPASSED or NTV2_THROUGH_DEVICE).
[in]	inIndex0	Specifies the relay/connector pair of interest. Use 0 for SDI 1&2, or 1 for SDI 3&4.

Returns: True if successful; otherwise false.

Note: Manual control will not change the state of the relays if the watchdog timer for the relays is enabled.

Definition at line 4083 of file ntv2register.cpp.

◆ GetSDIRelayPosition()

bool CNTV2Card::GetSDIRelayPosition	(	NTV2RelayState &	outValue,
		const UWord	inIndex0
	)

virtual

Answers if the bypass relays between connectors 1/2 or 3/4 are currently in bypass or routing the signals through the device.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives the current state of the relays (NTV2_DEVICE_BYPASSED or NTV2_THROUGH_DEVICE).
[in]	inIndex0	Specifies the relay/connector pair of interest. Use 0 for SDI 1&2, or 1 for SDI 3&4.

Definition at line 4067 of file ntv2register.cpp.

◆ GetSDITransmitEnable()

bool CNTV2Card::GetSDITransmitEnable	(	const NTV2Channel	inChannel,
		bool &	outEnabled
	)

virtual

Answers whether or not the specified SDI connector is currently acting as a transmitter (i.e. an output).

Parameters

[in]	inChannel	Specifies the SDI connector as an NTV2Channel (a zero-based index number).
[out]	outEnabled	Receives true if the SDI channel connector is currently a transmitter (output), or false if it's acting as an input.

Returns: True if successful; otherwise false.

See also: NTV2DeviceHasBiDirectionalSDI, Signal Inputs & Outputs

Definition at line 3817 of file ntv2register.cpp.

◆ GetSDITRSError()

bool CNTV2Card::GetSDITRSError ( const NTV2Channel inChannel )

virtual

Returns: True if the given SDI input is currently reporting TRS errors; otherwise false.

Parameters

[in] inChannel Specifies the channel (SDI input) of interest.

Definition at line 4205 of file ntv2register.cpp.

◆ GetSDIUnlockCount()

ULWord CNTV2Card::GetSDIUnlockCount ( const NTV2Channel inChannel )

virtual

Returns: The number of transitions to the "unlocked" state for the given SDI input.

Parameters

[in] inChannel Specifies the channel (SDI input) of interest.

Note: This function returns valid information only for devices for which NTV2DeviceCanDoSDIErrorChecks returns 'true'.

Definition at line 4227 of file ntv2register.cpp.

◆ GetSDIWatchdogEnable()

bool CNTV2Card::GetSDIWatchdogEnable	(	bool &	outIsEnabled,
		const UWord	inIndex0
	)

virtual

Answers true if the given connector pair relays are under watchdog timer control, or false if they're under manual control.

Parameters

[out]	outIsEnabled	Receives 'true' if the watchdog timer is controlling the relays; receives 'false' if the relays are under manual control.
[in]	inIndex0	Specifies the relay/connector pair of interest. Use 0 for SDI 1&2, or 1 for SDI 3&4.

Returns: True if successful; otherwise false.

Definition at line 4111 of file ntv2register.cpp.

◆ GetSDIWatchdogStatus()

bool CNTV2Card::GetSDIWatchdogStatus ( NTV2RelayState & outValue )

virtual

Answers if the watchdog timer would put the SDI relays into NTV2_DEVICE_BYPASSED or NTV2_THROUGH_DEVICE.

Parameters

[out] outValue Receives the current state of the watchdog timer.

Returns: True if successful; otherwise false.

Note: The watchdog timer won't change the state of the relays if they're under manual control.

Definition at line 4055 of file ntv2register.cpp.

◆ GetSDIWatchdogTimeout()

bool CNTV2Card::GetSDIWatchdogTimeout ( ULWord & outValue )

virtual

Answers with the amount of time that must elapse before the watchdog timer times out.

Parameters

[out] outValue Receives the time value in units of 8 nanoseconds.

Returns: True if successful; otherwise false.

Note: The timeout interval begins or is reset when a kick sequence is received.

Definition at line 4139 of file ntv2register.cpp.

◆ GetSecondaryVideoFormat()

bool CNTV2Card::GetSecondaryVideoFormat ( NTV2VideoFormat & outFormat )

virtual

Definition at line 3344 of file ntv2register.cpp.

◆ GetSerialNumber()

uint64_t CNTV2Card::GetSerialNumber ( void )

virtual

Answers with my serial number.

Returns: My 64-bit serial number.

Note: To decode this into a human-readable form, use my SerialNum64ToString class method.

Definition at line 200 of file ntv2card.cpp.

◆ GetSerialNumberHigh()

ULWord CNTV2Card::GetSerialNumberHigh ( void )

protectedvirtual

Definition at line 194 of file ntv2card.cpp.

◆ GetSerialNumberLow()

ULWord CNTV2Card::GetSerialNumberLow ( void )

protectedvirtual

Definition at line 187 of file ntv2card.cpp.

◆ GetSerialNumberString()

bool CNTV2Card::GetSerialNumberString ( std::string & outSerialNumberString )

virtual

Answers with a string that contains my human-readable serial number.

Returns: True if successful (and valid); otherwise false.

Definition at line 214 of file ntv2card.cpp.

◆ GetSmpte372()

bool CNTV2Card::GetSmpte372	(	ULWord &	outValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Returns the device's current SMPTE-372 (dual-link) mode, whether it's enabled or not.

Note: The enable bits work on channel pairs, thus a parameter of NTV2_CHANNEL1 or NTV2_CHANNEL2 refers to the same control bit.

Returns: True if successful; otherwise false.

Parameters

[out]	outValue	Receives 1 if the device is currently in dual-link mode; otherwise receives 0.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1.

Todo:

Should use bool& parameter instead of a ULWord&.

Should be named GetSMPTE372Enable.

Definition at line 1056 of file ntv2register.cpp.

◆ GetStandard()

bool CNTV2Card::GetStandard	(	NTV2Standard &	outValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 828 of file ntv2register.cpp.

◆ GetStereoCompressorFlipLeftHorz()

bool CNTV2Card::GetStereoCompressorFlipLeftHorz ( ULWord & outValue )

virtual

Definition at line 447 of file ntv2regconv.cpp.

◆ GetStereoCompressorFlipLeftVert()

bool CNTV2Card::GetStereoCompressorFlipLeftVert ( ULWord & outValue )

virtual

Definition at line 449 of file ntv2regconv.cpp.

◆ GetStereoCompressorFlipMode()

bool CNTV2Card::GetStereoCompressorFlipMode ( ULWord & outValue )

virtual

Definition at line 445 of file ntv2regconv.cpp.

◆ GetStereoCompressorFlipRightHorz()

bool CNTV2Card::GetStereoCompressorFlipRightHorz ( ULWord & outValue )

virtual

Definition at line 451 of file ntv2regconv.cpp.

◆ GetStereoCompressorFlipRightVert()

bool CNTV2Card::GetStereoCompressorFlipRightVert ( ULWord & outValue )

virtual

Definition at line 453 of file ntv2regconv.cpp.

◆ GetStereoCompressorLeftSource()

bool CNTV2Card::GetStereoCompressorLeftSource ( NTV2OutputCrosspointID & outValue )

virtual

Definition at line 457 of file ntv2regconv.cpp.

◆ GetStereoCompressorOutputMode()

bool CNTV2Card::GetStereoCompressorOutputMode ( NTV2StereoCompressorOutputMode & outValue )

virtual

Definition at line 443 of file ntv2regconv.cpp.

◆ GetStereoCompressorRightSource()

bool CNTV2Card::GetStereoCompressorRightSource ( NTV2OutputCrosspointID & outValue )

virtual

Definition at line 459 of file ntv2regconv.cpp.

◆ GetStereoCompressorStandard()

bool CNTV2Card::GetStereoCompressorStandard ( NTV2Standard & outValue )

virtual

Definition at line 455 of file ntv2regconv.cpp.

◆ GetSuspendHostAudio()

bool CNTV2Card::GetSuspendHostAudio ( bool & outIsSuspended )

virtual

Answers as to whether or not the host OS audio services for the AJA device (e.g. CoreAudio on MacOS) are currently suspended or not.

Parameters

[out] outIsSuspended Receives 'true' if the host OS audio service is currently suspended for the AJA device; otherwise, receives 'false'.

Returns: True if successful; otherwise false.

Definition at line 1390 of file ntv2audio.cpp.

◆ GetTransmitSDIs()

bool CNTV2Card::GetTransmitSDIs ( NTV2ChannelSet & outXmitSDIs )

virtual

Answers with the transmitting/output SDI connectors.

Parameters

[out] outXmitSDIs Receives the set of transmitting SDI connectors.

Returns: True if successful; otherwise false.

Note: This function returns valid results for devices with or without bi-directional SDIs.; This function does not take into account an SDI output that's designated as a "monitor" (i.e. NTV2WidgetType_SDIMonOut or NTV2_WgtSDIMonOut1).

See also: NTV2DeviceHasBiDirectionalSDI, Signal Inputs & Outputs

Definition at line 3829 of file ntv2register.cpp.

◆ GetTsiFrameEnable()

bool CNTV2Card::GetTsiFrameEnable	(	bool &	outIsEnabled,
		const NTV2Channel	inChannel
	)

virtual

Returns the current SMPTE 425 two-sample-interleave frame mode on the device, whether it's enabled or not.

Returns: True if successful; otherwise false.

Parameters

[out]	outIsEnabled	Receives true if the device's FrameStores are currently in two-sample interleave (Tsi) mode; otherwise false.
[in]	inChannel	Specifies the FrameStore bank of interest. Using anything ordinally less than NTV2_CHANNEL5 will report on FrameStores 1/2/3/4, while anything ordinally greater than NTV2_CHANNEL4 will report on FrameStores 5/6/7/8.

Definition at line 1404 of file ntv2register.cpp.

◆ GetTsiMuxSyncFail()

bool CNTV2Card::GetTsiMuxSyncFail	(	bool &	outSyncFailed,
		const NTV2Channel	inWhichTsiMux
	)

virtual

Answers if the SMPTE 425 two-sample-interleave mux/demux input sync has failed or not.

Returns: True if successful; otherwise false.

Parameters

[out]	outSyncFailed	Receives true if the device's Tsi Mux input sync detect is indicating failure.
[in]	inWhichTsiMux	Specifies the Tsi Mux of interest. Use NTV2_CHANNEL1 for Tsi Mux 1, etc.

Definition at line 1439 of file ntv2register.cpp.

◆ GetUCAutoLine21()

bool CNTV2Card::GetUCAutoLine21 ( ULWord & outValue )

virtual

Definition at line 43 of file ntv2regconv.cpp.

◆ GetUCPassLine21()

bool CNTV2Card::GetUCPassLine21 ( ULWord & outValue )

virtual

Definition at line 41 of file ntv2regconv.cpp.

◆ GetUpConvertMode()

bool CNTV2Card::GetUpConvertMode ( NTV2UpConvertMode & outValue )

virtual

Definition at line 13 of file ntv2regconv.cpp.

◆ GetVANCMode()

bool CNTV2Card::GetVANCMode	(	NTV2VANCMode &	outVancMode,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Retrieves the current VANC mode for the given FrameStore.

Parameters

[out]	outVancMode	Receives the current NTV2VANCMode setting.
[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetVANCMode, VANC Frame Geometries

Definition at line 2728 of file ntv2register.cpp.

◆ GetVANCShiftMode()

bool CNTV2Card::GetVANCShiftMode	(	NTV2Channel	inChannel,
		NTV2VANCDataShiftMode &	outValue
	)

virtual

Retrieves the current "VANC Shift Mode" feature for the given channel.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number.
[out]	outValue	Receives the current NTV2VANCDataShiftMode setting. If NTV2_VANCDATA_NORMAL, then bit shifting is disabled. If NTV2_VANCDATA_8BITSHIFT_ENABLE, then it's enabled.

Returns: True if successful; otherwise false.

Note

The bit shift feature only affects VANC lines (not visible raster lines) and only when the device FrameStore is configured as follows:

video format is set for an HD format (see NTV2_IS_HD_VIDEO_FORMAT macro) – not SD or 4K/UHD;
pixel format is set for NTV2_FBF_8BIT_YCBCR;
VANC mode is set to NTV2_VANCMODE_TALL or NTV2_VANCMODE_TALLER (see CNTV2Card::SetVANCMode).

See also: CNTV2Card::SetVANCShiftMode, CNTV2Card::GetVANCMode, CNTV2Card::SetVANCMode, VANC Frame Geometries

Definition at line 2821 of file ntv2register.cpp.

◆ GetVideoDACMode()

bool CNTV2Card::GetVideoDACMode ( NTV2VideoDACMode & outValue )

virtual

Definition at line 3196 of file ntv2register.cpp.

◆ GetVideoFormat()

bool CNTV2Card::GetVideoFormat	(	NTV2VideoFormat &	outValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 335 of file ntv2register.cpp.

◆ GetVideoHOffset()

bool CNTV2Card::GetVideoHOffset	(	int &	outHOffset,
		const UWord	inOutputSpigot = `0`
	)

virtual

Answers with the current horizontal timing offset, in pixels, for the given SDI output connector.

Parameters

[out]	outHOffset	Receives the current horizontal output timing offset, a signed value, in pixels after or before the nominal value.
[in]	inOutputSpigot	(Added in SDK v16.1) Optionally specifies the SDI output connector of interest. Defaults to 0 (SDI Out 1).

Note: The "inOutputSpigot" parameter is respected only if the device is multi-format-capable (see NTV2DeviceCanDoMultiFormat) and the device is currently in multi-format mode (see CNTV2Card::GetMultiFormatMode and CNTV2Card::SetMultiFormatMode). Otherwise, this function only reports the horizontal timing offset for SDI Output 1 (i.e., the "global" output timing).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetVideoHOffset, CNTV2Card::GetVideoVOffset

Definition at line 702 of file ntv2register.cpp.

◆ GetVideoLimiting()

bool CNTV2Card::GetVideoLimiting ( NTV2VideoLimiting & outValue )

virtual

Answers with the current video range limiting mode for the device.

Parameters

[out] outValue Receives the device's current NTV2VideoLimiting setting.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetVideoLimiting

Definition at line 2617 of file ntv2register.cpp.

◆ GetVideoVOffset()

bool CNTV2Card::GetVideoVOffset	(	int &	outVOffset,
		const UWord	inOutputSpigot = `0`
	)

virtual

Answers with the current vertical timing offset, in lines, for the given SDI output connector.

Parameters

[out]	outVOffset	Receives the current vertical output timing offset, a signed value, in lines after or before the nominal value.
[in]	inOutputSpigot	(Added in SDK v16.1) Optionally specifies the SDI output spigot of interest. Defaults to 0 (SDI Out 1).

Note: The "inOutputSpigot" parameter is respected only if the device is multi-format-capable (see NTV2DeviceCanDoMultiFormat) and the device is currently in multi-format mode (see CNTV2Card::GetMultiFormatMode and CNTV2Card::SetMultiFormatMode). Otherwise, this function only reports the vertical timing offset for SDI Output 1 (i.e., the "global" output timing).

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetVideoVOffset, CNTV2Card::GetVideoHOffset

Definition at line 750 of file ntv2register.cpp.

◆ GetVPIDColorimetry()

bool CNTV2Card::GetVPIDColorimetry	(	NTV2VPIDColorimetry &	outValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 188 of file ntv2regvpid.cpp.

◆ GetVPIDLuminance()

bool CNTV2Card::GetVPIDLuminance	(	NTV2VPIDLuminance &	outValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 198 of file ntv2regvpid.cpp.

◆ GetVPIDRGBRange()

bool CNTV2Card::GetVPIDRGBRange	(	NTV2VPIDRGBRange &	outValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 208 of file ntv2regvpid.cpp.

◆ GetVPIDTransferCharacteristics()

bool CNTV2Card::GetVPIDTransferCharacteristics	(	NTV2VPIDTransferCharacteristics &	outValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 178 of file ntv2regvpid.cpp.

◆ GetVPIDValidA()

bool CNTV2Card::GetVPIDValidA ( const NTV2Channel inChannel )

virtual

Returns: True if the SDI VPID link A input status is valid; otherwise false.

Parameters

[in] inChannel Specifies the SDI input connector of interest, specified as an NTV2Channel, a zero-based index value.

Definition at line 50 of file ntv2regvpid.cpp.

◆ GetVPIDValidB()

bool CNTV2Card::GetVPIDValidB ( const NTV2Channel inChannel )

virtual

Returns: True if the SDI VPID link B input status is valid; otherwise false.

Parameters

[in] inChannel Specifies the SDI input connector of interest, specified as an NTV2Channel, a zero-based index value.

Definition at line 59 of file ntv2regvpid.cpp.

◆ GetXena2FlashBaseAddress()

bool CNTV2Card::GetXena2FlashBaseAddress ( ULWord ** pXena2FlashAddress )

virtual

Deprecated:: Obsolete starting in SDK 16.0.

Definition at line 3134 of file ntv2register.cpp.

◆ Has12BitLUTSupport()

bool CNTV2Card::Has12BitLUTSupport ( void )

virtual

Definition at line 339 of file ntv2csclut.cpp.

◆ HasMultiRasterWidget()

bool CNTV2Card::HasMultiRasterWidget ( void )

virtual

Definition at line 4694 of file ntv2register.cpp.

◆ HevcDebugInfo()

bool CNTV2Card::HevcDebugInfo ( HevcDeviceDebug * pDebug )

virtual

Get debug data from the hevc device.

Parameters

[in] pDebug HevcDeviceStatus structure to receive the information. This is an expanded version of the device status that contains performance information. This structure may change more often.

Returns: True if successful; otherwise false.

Definition at line 173 of file ntv2hevc.cpp.

◆ HevcGetDeviceInfo()

bool CNTV2Card::HevcGetDeviceInfo ( HevcDeviceInfo * pInfo )

virtual

Returns the driver version and time/date stamp of the hevc device's currently-installed firmware.

Parameters

[out] pInfo HevcDeviceInfo structure to receive the information.

Returns: True if successful; otherwise false.

Definition at line 11 of file ntv2hevc.cpp.

◆ HevcGetStatus()

bool CNTV2Card::HevcGetStatus ( HevcDeviceStatus * pStatus )

virtual

Get the status of the hevc device.

Parameters

[in] pStatus HevcDeviceDebug structure to receive the information.

Returns: True if successful; otherwise false.

Definition at line 152 of file ntv2hevc.cpp.

◆ HevcReadRegister()

bool CNTV2Card::HevcReadRegister	(	ULWord	address,
		ULWord *	pValue,
		ULWord	mask = `0xffffffff`,
		ULWord	shift = `0`
	)

virtual

Read an hevc register.

Parameters

[in]	address	Hevc register byte address
[out]	pValue	Hevc register data
[in]	mask	Read bit mask
[in]	shift	Read bit shift

Returns: True if successful; otherwise false.

Definition at line 54 of file ntv2hevc.cpp.

◆ HevcSendCommand()

bool CNTV2Card::HevcSendCommand ( HevcDeviceCommand * pCommand )

virtual

Send a command to the hevc device. See the hevc codec documentation for details on commands.

Parameters

[in] pCommand HevcDeviceCommand structure with the command parameters.

Returns: True if successful; otherwise false.

Definition at line 82 of file ntv2hevc.cpp.

◆ HevcVideoTransfer()

bool CNTV2Card::HevcVideoTransfer ( HevcDeviceTransfer * pTransfer )

virtual

Transfer video to/from the hevc device.

Parameters

[in] pTransfer HevcDeviceTransfer structure with the transfer parameters.

Returns: True if successful; otherwise false.

Definition at line 103 of file ntv2hevc.cpp.

◆ HevcWriteRegister()

bool CNTV2Card::HevcWriteRegister	(	ULWord	address,
		ULWord	value,
		ULWord	mask = `0xffffffff`,
		ULWord	shift = `0`
	)

virtual

Write an hevc register.

Parameters

[in]	address	Hevc register byte address
[in]	value	Hevc register data
[in]	mask	Read bit mask
[in]	shift	Read bit shift

Returns: True if successful; otherwise false.

Definition at line 32 of file ntv2hevc.cpp.

◆ InputAudioChannelPairHasPCM()

bool CNTV2Card::InputAudioChannelPairHasPCM	(	const NTV2Channel	inSDIInputConnector,
		const NTV2AudioChannelPair	inAudioChannelPair,
		bool &	outIsPCM
	)

virtual

For the given SDI input (specified as a channel number), answers if the specified audio channel pair is currently PCM-encoded or not.

Parameters

[in]	inSDIInputConnector	Specifies the SDI input connector of interest as an NTV2Channel (a zero-based index number).
[in]	inAudioChannelPair	Specifies the audio channel pair of interest.
[out]	outIsPCM	Receives true if the channel pair is currently PCM-encoded; otherwise false.

Returns: True if successful; otherwise false.

Definition at line 1489 of file ntv2audio.cpp.

◆ IS_CHANNEL_INVALID()

bool CNTV2Card::IS_CHANNEL_INVALID ( const NTV2Channel inChannel ) const

protectedvirtual

Definition at line 256 of file ntv2card.cpp.

◆ IS_CHANNEL_VALID()

virtual bool CNTV2Card::IS_CHANNEL_VALID ( const NTV2Channel inChannel ) const

inlineprotectedvirtual

Definition at line 6518 of file ntv2card.h.

◆ IS_HDMI_INPUT_SPIGOT_INVALID()

bool CNTV2Card::IS_HDMI_INPUT_SPIGOT_INVALID ( const UWord inInputHDMIPort )

protectedvirtual

Definition at line 284 of file ntv2card.cpp.

◆ IS_INPUT_SPIGOT_INVALID()

bool CNTV2Card::IS_INPUT_SPIGOT_INVALID ( const UWord inInputSpigot )

protectedvirtual

Definition at line 277 of file ntv2card.cpp.

◆ IS_OUTPUT_SPIGOT_INVALID()

bool CNTV2Card::IS_OUTPUT_SPIGOT_INVALID ( const UWord inOutputSpigot )

protectedvirtual

Definition at line 264 of file ntv2card.cpp.

◆ IsAudioChannelPairPresent()

bool CNTV2Card::IsAudioChannelPairPresent	(	const NTV2AudioSystem	inAudioSystem,
		const NTV2AudioChannelPair	inChannelPair,
		bool &	outIsPresent
	)

virtual

Answers whether or not the given NTV2AudioChannelPair in the given NTV2AudioSystem on the device is present in the input signal.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[in]	inChannelPair	Specifies the NTV2AudioChannelPair of interest.
[out]	outIsPresent	Receives true if the NTV2AudioChannelPair is present; otherwise false if it's not present.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetDetectedAudioChannelPairs, Audio Capture

Definition at line 1335 of file ntv2audio.cpp.

◆ IsAudioInputRunning()

bool CNTV2Card::IsAudioInputRunning	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outIsRunning
	)

virtual

Answers whether or not the capture side of the given NTV2AudioSystem is currently running.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[out]	outIsRunning	Receives 'true' if the Audio System's capture side is currently running; otherwise receives 'false'.

See also: CNTV2Card::StartAudioInput, CNTV2Card::StopAudioInput, Audio Capture

Definition at line 1157 of file ntv2audio.cpp.

◆ IsAudioOutputRunning()

bool CNTV2Card::IsAudioOutputRunning	(	const NTV2AudioSystem	inAudioSystem,
		bool &	outIsRunning
	)

virtual

Answers whether or not the playout side of the given NTV2AudioSystem is currently running.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[out]	outIsRunning	Receives 'true' if the Audio System's playout side is currently running; otherwise receives 'false'.

See also: CNTV2Card::StartAudioOutput, CNTV2Card::StopAudioOutput, CNTV2Card::SetAudioOutputPause, CNTV2Card::GetAudioOutputPause, Audio Playout

Definition at line 1066 of file ntv2audio.cpp.

◆ IsBreakoutBoardConnected()

bool CNTV2Card::IsBreakoutBoardConnected ( void )

virtual

Definition at line 4731 of file ntv2register.cpp.

◆ IsBufferSizeSetBySW()

bool CNTV2Card::IsBufferSizeSetBySW ( void )

virtual

Returns: True if the device intrinsic frame buffer size is currently settable and set by software (overriding the firmware); otherwise false.

See also: Frame Buffer Indexing

Definition at line 1678 of file ntv2register.cpp.

◆ IsChannelEnabled()

bool CNTV2Card::IsChannelEnabled	(	const NTV2Channel	inChannel,
		bool &	outEnabled
	)

virtual

Answers whether or not the given FrameStore is enabled.

Parameters

[in]	inChannel	Specifies the FrameStore, as identified by an NTV2Channel value.
[out]	outEnabled	Receives "true" if the FrameStore is enabled, or "false" if disabled.

Returns: True if successful; otherwise false.

See also: See FrameStore Operation

Definition at line 2122 of file ntv2register.cpp.

◆ IsConnected()

bool CNTV2Card::IsConnected	(	const NTV2InputCrosspointID	inInputXpt,
		bool &	outIsConnected
	)

virtual

Answers whether or not the given widget signal input (sink) is connected to another output (source).

Parameters

[in]	inInputXpt	Specifies the input (signal sink) of interest.
[out]	outIsConnected	Receives true if the input is connected to any other output (other than NTV2_XptBlack).

Returns: True if successful; otherwise false.

Note: If the input is connected to NTV2_XptBlack, "outIsConnected" will be "false".

See also: Widget Signal Routing, CNTV2Card::IsConnectedTo

Definition at line 181 of file ntv2regroute.cpp.

◆ IsConnectedTo()

bool CNTV2Card::IsConnectedTo	(	const NTV2InputCrosspointID	inInputXpt,
		const NTV2OutputCrosspointID	inOutputXpt,
		bool &	outIsConnected
	)

virtual

Answers whether or not the given widget signal input (sink) is connected to another output (source).

Parameters

[in]	inInputXpt	Specifies the input (signal sink) of interest.
[in]	inOutputXpt	Specifies the output (signal source) of interest. It's okay to specify NTV2_XptBlack.
[out]	outIsConnected	Receives true if the input is connected to the specified output.

Returns: True if successful; otherwise false.

See also: CNTV2Card::IsConnected, Widget Signal Routing

Definition at line 168 of file ntv2regroute.cpp.

◆ IsDynamicDevice()

bool CNTV2Card::IsDynamicDevice ( void )

virtual

Returns: True if this device can quickly change bitfiles; otherwise false.

Definition at line 27 of file ntv2dynamicdevice.cpp.

◆ IsDynamicFirmwareLoaded()

bool CNTV2Card::IsDynamicFirmwareLoaded ( void )

virtual

Returns: True if the device has been dynamically reconfigured; otherwise false.

Definition at line 43 of file ntv2dynamicdevice.cpp.

◆ IsFailSafeBitfileLoaded()

bool CNTV2Card::IsFailSafeBitfileLoaded ( bool & outIsFailSafe )

virtual

Answers whether or not the "fail-safe" (aka "safe-boot") bitfile is currently loaded and running in the FPGA.

Parameters

[out] outIsFailSafe Receives true if the "fail-safe" bitfile is currently loaded and running in the FPGA; otherwise receives false. This return value cannot be trusted if the function result is false.

Returns: True if successful; otherwise false.

Note: The "outIsFailSafe" answer can only be trusted if the function result is true.

See also: NTV2DeviceCanReportFailSafeLoaded

Definition at line 340 of file ntv2card.cpp.

◆ IsMultiRasterWidgetChannel()

bool CNTV2Card::IsMultiRasterWidgetChannel ( const NTV2Channel inChannel )

virtual

Definition at line 4726 of file ntv2register.cpp.

◆ IsProgressiveStandard()

bool CNTV2Card::IsProgressiveStandard	(	bool &	outIsProgressive,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 855 of file ntv2register.cpp.

◆ IsRP188BypassEnabled()

bool CNTV2Card::IsRP188BypassEnabled	(	const NTV2Channel	inSDIOutput,
		bool &	outIsBypassEnabled
	)

virtual

Answers if the SDI output's RP-188 bypass mode is enabled or not.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest, expressed as an NTV2Channel.
[out]	outIsBypassEnabled	Receives true if the SDI output's RP188 timecode is currently sourced from its RP188 registers (see CNTV2Card::SetRP188Data). Receives false if its output timecode is currently sourced from an SDI input (see CNTV2Card::GetRP188BypassSource and CNTV2Card::GetRP188SourceFilter).

Returns: True if successful; otherwise false.

See also: CNTV2Card::EnableRP188Bypass, CNTV2Card::DisableRP188Bypass, CNTV2Card::GetRP188BypassSource, CNTV2Card::GetRP188SourceFilter

Definition at line 2549 of file ntv2register.cpp.

◆ IsSDStandard()

bool CNTV2Card::IsSDStandard	(	bool &	outIsStandardDef,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 876 of file ntv2register.cpp.

◆ IsXilinxProgrammed()

bool CNTV2Card::IsXilinxProgrammed ( )

virtual

Definition at line 2244 of file ntv2register.cpp.

◆ KickSDIWatchdog()

bool CNTV2Card::KickSDIWatchdog ( void )

virtual

Restarts the countdown timer to prevent the watchdog timer from timing out.

Returns: True if successful; otherwise false.

Definition at line 4045 of file ntv2register.cpp.

◆ Load12BitLUTTables()

bool CNTV2Card::Load12BitLUTTables	(	const NTV2DoubleArray &	inRedLUT,
		const NTV2DoubleArray &	inGreenLUT,
		const NTV2DoubleArray &	inBlueLUT
	)

virtual

Definition at line 827 of file ntv2csclut.cpp.

◆ Load1DLUTTable()

bool CNTV2Card::Load1DLUTTable ( const NTV2Channel inChannel )

virtual

Definition at line 1442 of file ntv2csclut.cpp.

◆ Load3DLUTTable()

bool CNTV2Card::Load3DLUTTable ( void )

virtual

Definition at line 1419 of file ntv2csclut.cpp.

◆ LoadDynamicDevice()

bool CNTV2Card::LoadDynamicDevice ( const NTV2DeviceID inDeviceID )

virtual

Quickly, dynamically loads the given device ID firmware.

Parameters

[in] inDeviceID Specifies the device ID of interest.

Returns: True if loaded successfully; otherwise false.

Note: If successful, calling CNTV2Card::GetDeviceID will return the same NTV2DeviceID as "inDeviceID". This CNTV2Card instance will be talking to the same hardware device, but it will have a different personality with different capabilities.

Definition at line 145 of file ntv2dynamicdevice.cpp.

◆ LoadLUTTable()

bool CNTV2Card::LoadLUTTable ( const double * pInTable )

virtual

Definition at line 1388 of file ntv2csclut.cpp.

◆ LoadLUTTables()

bool CNTV2Card::LoadLUTTables	(	const NTV2DoubleArray &	inRedLUT,
		const NTV2DoubleArray &	inGreenLUT,
		const NTV2DoubleArray &	inBlueLUT
	)

virtual

Writes the LUT tables.

Parameters

[in]	inRedLUT	The Red LUT, a std::vector of double-precision floating-point values.
[in]	inGreenLUT	The Green LUT, a std::vector of double-precision floating-point values.
[in]	inBlueLUT	The Blue LUT, a std::vector of double-precision floating-point values.

Returns: True if successful; otherwise false.

Note: Version 2 LUTs (see NTV2DeviceGetLUTVersion) require setup of kRegLUTV2Control (register 376) for this function to work properly.

Definition at line 809 of file ntv2csclut.cpp.

◆ MixerHasRGBModeSupport()

bool CNTV2Card::MixerHasRGBModeSupport	(	const UWord	inWhichMixer,
		bool &	outIsSupported
	)

virtual

Answers if the given mixer/keyer's has RGB mode support.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[out]	outIsSupported	Receives true if the mixer has RGB mode support.

Definition at line 3046 of file ntv2register.cpp.

◆ ProgramMainFlash()

bool CNTV2Card::ProgramMainFlash	(	const std::string &	inFileName,
		const bool	bInForceUpdate = `(0)`,
		const bool	bInQuiet = `(0)`
	)

virtual

Definition at line 2271 of file ntv2register.cpp.

◆ Read12BitLUTTables()

bool CNTV2Card::Read12BitLUTTables	(	UWordSequence &	outRedLUT,
		UWordSequence &	outGreenLUT,
		UWordSequence &	outBlueLUT
	)

virtual

Definition at line 1076 of file ntv2csclut.cpp.

◆ ReadAnalogLTCInput() [1/2]

bool CNTV2Card::ReadAnalogLTCInput	(	const UWord	inLTCInput,
		NTV2_RP188 &	outRP188Data
	)

virtual

Reads the current contents of the device's analog LTC input registers.

Parameters

[in]	inLTCInput	Specifies the device's analog LTC input to use. Use 0 for LTC In 1, or 1 for LTC In 2. (Call NTV2DeviceGetNumLTCInputs to determine the number of analog LTC inputs.)
[out]	outRP188Data	Receives the timecode read from the device registers.

Returns: True if successful; otherwise false.

Note: The registers are read immediately, and should contain stable data if called soon after the VBI.

See also: GetLTCInputPresent, NTV2DeviceGetNumLTCInputs, Analog LTC Input

Definition at line 3705 of file ntv2register.cpp.

◆ ReadAnalogLTCInput() [2/2]

bool CNTV2Card::ReadAnalogLTCInput	(	const UWord	inLTCInput,
		RP188_STRUCT &	outRP188Data
	)

virtual

Reads the current contents of the device's analog LTC input registers.

Parameters

[in]	inLTCInput	Specifies the device's analog LTC input to use. Use 0 for LTC In 1, or 1 for LTC In 2. (Call NTV2DeviceGetNumLTCInputs to determine the number of analog LTC inputs.)
[out]	outRP188Data	Receives the timecode read from the device registers.

Returns: True if successful; otherwise false.

Note: The registers are read immediately, and should contain stable data if called soon after the VBI.

See also: GetLTCInputPresent, NTV2DeviceGetNumLTCInputs, Analog LTC Input

Definition at line 3695 of file ntv2register.cpp.

◆ ReadAudioLastIn()

bool CNTV2Card::ReadAudioLastIn	(	ULWord &	outValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

For the given Audio System, answers with the byte offset to the last byte of the latest chunk of 4-byte audio samples written into the device's input audio buffer by its input audio de-embedder. This is essentially the position of the "Write Head" during audio capture.

Parameters

[out]	outValue	Receives the byte offset of the last byte of audio data written into the input audio buffer. This offset is measured from the start of the device capture buffer.
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.

Returns: True if successful; otherwise false.

See also: Audio Capture

Definition at line 465 of file ntv2audio.cpp.

◆ ReadAudioLastOut()

bool CNTV2Card::ReadAudioLastOut	(	ULWord &	outValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

For the given Audio System, answers with the byte offset of the tail end of the last chunk of audio samples read by the device's output audio embedder. This is essentially the position of the "Play Head" during audio output.

Parameters

[out]	outValue	Receives the byte offset of the tail end of the last chunk of audio samples read by the device's output audio embedder in its output audio buffer. This offset is measured from the start of the device playback buffer.
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.

Returns: True if successful; otherwise false.

See also: CNTV2Card::WriteAudioLastOut, Audio Playout

Definition at line 472 of file ntv2audio.cpp.

◆ ReadAudioSource()

bool CNTV2Card::ReadAudioSource	(	ULWord &	outValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Deprecated:: This function is obsolete.

Definition at line 480 of file ntv2audio.cpp.

◆ ReadFlashProgramControl()

bool CNTV2Card::ReadFlashProgramControl ( ULWord & outValue )

virtual

Definition at line 2235 of file ntv2register.cpp.

◆ ReadHDBrightnessAdjustment()

bool CNTV2Card::ReadHDBrightnessAdjustment ( ULWord & outValue )

virtual

Definition at line 415 of file ntv2regconv.cpp.

◆ ReadHDCbOffsetAdjustment()

bool CNTV2Card::ReadHDCbOffsetAdjustment ( ULWord & outValue )

virtual

Definition at line 419 of file ntv2regconv.cpp.

◆ ReadHDContrastAdjustment()

bool CNTV2Card::ReadHDContrastAdjustment ( ULWord & outValue )

virtual

Definition at line 416 of file ntv2regconv.cpp.

◆ ReadHDCrOffsetAdjustment()

bool CNTV2Card::ReadHDCrOffsetAdjustment ( ULWord & outValue )

virtual

Definition at line 420 of file ntv2regconv.cpp.

◆ ReadHDProcAmpControlsInitialized()

bool CNTV2Card::ReadHDProcAmpControlsInitialized ( ULWord & outValue )

virtual

Definition at line 414 of file ntv2regconv.cpp.

◆ ReadHDSaturationAdjustmentCb()

bool CNTV2Card::ReadHDSaturationAdjustmentCb ( ULWord & outValue )

virtual

Definition at line 417 of file ntv2regconv.cpp.

◆ ReadHDSaturationAdjustmentCr()

bool CNTV2Card::ReadHDSaturationAdjustmentCr ( ULWord & outValue )

virtual

Definition at line 418 of file ntv2regconv.cpp.

◆ ReadLineCount()

bool CNTV2Card::ReadLineCount ( ULWord & outValue )

virtual

Answers with the line offset into the frame currently being read (NTV2_MODE_DISPLAY) or written (NTV2_MODE_CAPTURE) for FrameStore 1.

Parameters

[out] outValue Receives the line number currently being read or written.

Returns: True if successful; otherwise false.

Definition at line 2230 of file ntv2register.cpp.

◆ ReadLUTTables()

bool CNTV2Card::ReadLUTTables	(	UWordSequence &	outRedLUT,
		UWordSequence &	outGreenLUT,
		UWordSequence &	outBlueLUT
	)

virtual

Reads the LUT tables (as raw, unsigned 10-bit integers).

Parameters

[out]	outRedLUT	Receives the Red LUT as a vector of unsigned 10-bit values (0-1023).
[out]	outGreenLUT	Receives the Green LUT as a vector of unsigned 10-bit values (0-1023).
[out]	outBlueLUT	Receives the Blue LUT as a vector of unsigned 10-bit values (0-1023).

Returns: True if successful; otherwise false.

Note: Version 2 LUTs (see NTV2DeviceGetLUTVersion) require setup of kRegLUTV2Control (register 376) for this function to work properly.

Definition at line 1039 of file ntv2csclut.cpp.

◆ ReadOutputTimingControl()

bool CNTV2Card::ReadOutputTimingControl	(	ULWord &	outValue,
		const UWord	inOutputSpigot = `0`
	)

virtual

Returns the current output timing control value for the given SDI output connector.

Parameters

[out]	outValue	Receives the current output timing control value.
[in]	inOutputSpigot	Optionally specifies the SDI output connector of interest. Defaults to 0 (SDI Out 1).

Note: The "inOutputSpigot" parameter is respected only if the device is multi-format-capable (see NTV2DeviceCanDoMultiFormat) and the device is currently in multi-format mode (see CNTV2Card::GetMultiFormatMode and CNTV2Card::SetMultiFormatMode). Otherwise, this function only reports the timing for SDI Output 1 (i.e., the "global" output timing).

Returns: True if successful; otherwise false.

See also: CNTV2Card::WriteOutputTimingControl, CNTV2Card::GetVideoVOffset, CNTV2Card::GetVideoHOffset

Definition at line 3324 of file ntv2register.cpp.

◆ ReadProcAmpC1CBAdjustment()

bool CNTV2Card::ReadProcAmpC1CBAdjustment ( ULWord & outValue )

virtual

Definition at line 432 of file ntv2regconv.cpp.

◆ ReadProcAmpC1CRAdjustment()

bool CNTV2Card::ReadProcAmpC1CRAdjustment ( ULWord & outValue )

virtual

Definition at line 433 of file ntv2regconv.cpp.

◆ ReadProcAmpC1YAdjustment()

bool CNTV2Card::ReadProcAmpC1YAdjustment ( ULWord & outValue )

virtual

Definition at line 431 of file ntv2regconv.cpp.

◆ ReadProcAmpC2CBAdjustment()

bool CNTV2Card::ReadProcAmpC2CBAdjustment ( ULWord & outValue )

virtual

Definition at line 434 of file ntv2regconv.cpp.

◆ ReadProcAmpC2CRAdjustment()

bool CNTV2Card::ReadProcAmpC2CRAdjustment ( ULWord & outValue )

virtual

Definition at line 435 of file ntv2regconv.cpp.

◆ ReadProcAmpOffsetYAdjustment()

bool CNTV2Card::ReadProcAmpOffsetYAdjustment ( ULWord & outValue )

virtual

Definition at line 436 of file ntv2regconv.cpp.

◆ ReadSDBrightnessAdjustment()

bool CNTV2Card::ReadSDBrightnessAdjustment ( ULWord & outValue )

virtual

Definition at line 408 of file ntv2regconv.cpp.

◆ ReadSDCbOffsetAdjustment()

bool CNTV2Card::ReadSDCbOffsetAdjustment ( ULWord & outValue )

virtual

Definition at line 412 of file ntv2regconv.cpp.

◆ ReadSDContrastAdjustment()

bool CNTV2Card::ReadSDContrastAdjustment ( ULWord & outValue )

virtual

Definition at line 409 of file ntv2regconv.cpp.

◆ ReadSDCrOffsetAdjustment()

bool CNTV2Card::ReadSDCrOffsetAdjustment ( ULWord & outValue )

virtual

Definition at line 413 of file ntv2regconv.cpp.

◆ ReadSDHueAdjustment()

bool CNTV2Card::ReadSDHueAdjustment ( ULWord & outValue )

virtual

Definition at line 411 of file ntv2regconv.cpp.

◆ ReadSDIInVPID()

bool CNTV2Card::ReadSDIInVPID	(	const NTV2Channel	inSDIInput,
		ULWord &	outValueA,
		ULWord &	outValueB
	)

virtual

Definition at line 68 of file ntv2regvpid.cpp.

◆ ReadSDIStatistics()

bool CNTV2Card::ReadSDIStatistics ( NTV2SDIInStatistics & outStats )

virtual

For devices that support it (see the NTV2DeviceCanDoSDIErrorChecks function in "ntv2devicefeatures.h"), this function fetches the SDI statistics for all SDI input spigots.

Parameters

[out] outStats Receives the SDI statistics for all SDI input spigots.

Returns: True if successful; otherwise false.

Definition at line 4648 of file ntv2register.cpp.

◆ ReadSDProcAmpControlsInitialized()

bool CNTV2Card::ReadSDProcAmpControlsInitialized ( ULWord & outValue )

virtual

Definition at line 407 of file ntv2regconv.cpp.

◆ ReadSDSaturationAdjustment()

bool CNTV2Card::ReadSDSaturationAdjustment ( ULWord & outValue )

virtual

Definition at line 410 of file ntv2regconv.cpp.

◆ ReadVirtualData()

bool CNTV2Card::ReadVirtualData	(	const ULWord	inTag,
		void *	outVirtualData,
		const ULWord	inVirtualDataSize
	)

virtual

Reads the block of virtual data for a specific tag.

Parameters

[in]	inTag	Tag for the virtual data.
[out]	outVirtualData	Virtual data buffer to be written
[in]	inVirtualDataSize	Virtual data size to read

Returns: True if all requested data was successfully read; otherwise false.

Note: This operation is not guaranteed to be performed atomically.

Definition at line 4641 of file ntv2register.cpp.

◆ ReleaseMailBoxLock()

bool CNTV2Card::ReleaseMailBoxLock ( void )

virtual

Definition at line 4495 of file ntv2register.cpp.

◆ RemoveConnections()

bool CNTV2Card::RemoveConnections ( const NTV2XptConnections & inConnections )

virtual

Removes the given widget routing connections from the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in] inConnections Specifies the routing connections to be removed from the device.

See also: Widget Signal Routing

Definition at line 268 of file ntv2regroute.cpp.

◆ S2110DeviceAncFromBuffers()

bool CNTV2Card::S2110DeviceAncFromBuffers	(	const NTV2Channel	inChannel,
		NTV2Buffer &	ancF1,
		NTV2Buffer &	ancF2
	)

protectedvirtual

Definition at line 1116 of file ntv2autocirculate.cpp.

◆ S2110DeviceAncFromXferBuffers()

bool CNTV2Card::S2110DeviceAncFromXferBuffers	(	const NTV2Channel	inChannel,
		AUTOCIRCULATE_TRANSFER &	inOutXferInfo
	)

protectedvirtual

Definition at line 987 of file ntv2autocirculate.cpp.

◆ S2110DeviceAncToBuffers()

bool CNTV2Card::S2110DeviceAncToBuffers	(	const NTV2Channel	inChannel,
		NTV2Buffer &	ancF1,
		NTV2Buffer &	ancF2
	)

protectedvirtual

Development

Definition at line 1387 of file ntv2autocirculate.cpp.

◆ S2110DeviceAncToXferBuffers()

bool CNTV2Card::S2110DeviceAncToXferBuffers	(	const NTV2Channel	inChannel,
		AUTOCIRCULATE_TRANSFER &	inOutXferInfo
	)

protectedvirtual

Development

Definition at line 1144 of file ntv2autocirculate.cpp.

◆ SerialNum64ToString()

string CNTV2Card::SerialNum64ToString ( const uint64_t inSerialNumber )

static

Returns a string containing the decoded, human-readable device serial number.

Parameters

[in] inSerialNumber Specifies the 64-bit device serial number.

Returns: A string containing the decoded, human-readable device serial number. If invalid, returns the string "INVALID?".

Definition at line 208 of file ntv2card.cpp.

◆ Set12BitLUTPlaneSelect()

bool CNTV2Card::Set12BitLUTPlaneSelect ( const NTV2LUTPlaneSelect inLUTPlane )

virtual

Sets the LUT plane.

Parameters

[in] inLUTPlane Specifies the LUT plane of interest.

Returns: True if successful; otherwise false.

Definition at line 345 of file ntv2csclut.cpp.

◆ Set1DLUTTableLocation()

bool CNTV2Card::Set1DLUTTableLocation	(	const NTV2Channel	inChannel,
		const ULWord	inFrameNumber,
		ULWord	inLUTIndex = `0`
	)

virtual

Definition at line 1425 of file ntv2csclut.cpp.

◆ Set3DLUTTableLocation()

bool CNTV2Card::Set3DLUTTableLocation	(	const ULWord	inFrameNumber,
		ULWord	inLUTIndex = `0`
	)

virtual

Definition at line 1402 of file ntv2csclut.cpp.

◆ Set4kSquaresEnable()

bool CNTV2Card::Set4kSquaresEnable	(	const bool	inIsEnabled,
		const NTV2Channel	inChannel
	)

virtual

Enables or disables SMPTE 425 "2K quadrants" mode for the given FrameStore bank on the device. Client applications should call this function when "4K Squares" mode (not two-sample-interleave) is needed.

Returns: True if successful; otherwise false.

Parameters

[in]	inIsEnabled	Specify true to put the device's FrameStores into "4K squares" (i.e., "2K quadrants") mode. Specify false to put the device's FrameStores into normal mode (if not currently running in quad frame mode), or the non-2K quadrants quad mode.
[in]	inChannel	Specifies the FrameStore bank of interest. Using anything ordinally less than NTV2_CHANNEL5 will affect FrameStores 1/2/3/4, while anything ordinally greater than NTV2_CHANNEL4 will affect FrameStores 5/6/7/8.

Note: Disabling 4K squares will implicitly set two-sample-interleave mode for the FrameStores.

Definition at line 1238 of file ntv2register.cpp.

◆ SetAESOutputSource()

bool CNTV2Card::SetAESOutputSource	(	const NTV2Audio4ChannelSelect	inAESAudioChannels,
		const NTV2AudioSystem	inSrcAudioSystem,
		const NTV2Audio4ChannelSelect	inSrcAudioChannels
	)

virtual

Changes the audio source for the given quad of AES audio output channels. By default, at power-up, for AJA devices that support AES audio output, the content of AES audio output channels 1/2/3/4 reflect what's being output from audio channels 1/2/3/4 from NTV2_AUDIOSYSTEM_1, likewise with audio channels 5/6/7/8, etc.

Parameters

[in]	inAESAudioChannels	Specifies the AES audio output channel quad of interest.
[in]	inSrcAudioSystem	Specifies the NTV2AudioSystem that should drive the given AES audio output channel quad.
[in]	inSrcAudioChannels	Specifies the audio channel quad from the given Audio System that should drive the given AES audio output channel quad.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAESOutputSource, Audio Playout

Definition at line 1458 of file ntv2audio.cpp.

◆ SetAlphaFromInput2Bit()

bool CNTV2Card::SetAlphaFromInput2Bit ( ULWord inValue )

virtual

Definition at line 2227 of file ntv2register.cpp.

◆ SetAnalogAudioIOConfiguration()

bool CNTV2Card::SetAnalogAudioIOConfiguration ( const NTV2AnalogAudioIO inConfig )

virtual

Deprecated:: Use CNTV2Card::SetAnalogAudioTransmitEnable instead.

Definition at line 1660 of file ntv2audio.cpp.

◆ SetAnalogAudioTransmitEnable()

bool CNTV2Card::SetAnalogAudioTransmitEnable	(	const NTV2Audio4ChannelSelect	inChannelQuad,
		const bool	inEnable
	)

virtual

Sets the specified bidirectional XLR audio connectors to collectively act as inputs or outputs.

Parameters

[in]	inChannelQuad	Specifies the XLR audio connectors of interest.
[in]	inEnable	If true, specifies that the connectors are to be used as outputs. If false, specifies they're to be used as inputs.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAnalogAudioTransmitEnable

Definition at line 1615 of file ntv2audio.cpp.

◆ SetAnalogInputADCMode()

bool CNTV2Card::SetAnalogInputADCMode ( const NTV2LSVideoADCMode inValue )

virtual

Definition at line 274 of file ntv2regconv.cpp.

◆ SetAnalogLTCInClockChannel()

bool CNTV2Card::SetAnalogLTCInClockChannel	(	const UWord	inLTCInput,
		const NTV2Channel	inChannel
	)

virtual

Sets the (SDI) input channel that is to provide the clock reference to be used by the given analog LTC input.

Parameters

[in]	inLTCInput	Specifies the device's analog LTC input. Use 0 for LTC In 1, or 1 for LTC In 2. (Call NTV2DeviceGetNumLTCInputs to determine the number of analog LTC inputs.)
[in]	inChannel	Specifies the NTV2Channel that should provide the clock reference for reading the given analog LTC input.

Returns: True if successful; otherwise false.

Note: This function is provided for devices that are capable of handling multiple, disparate video formats (see NTV2DeviceCanDoMultiFormat and CNTV2Card::GetMultiFormatMode functions). It doesn't make sense to call this function on a device that is running in "UniFormat" mode.

See also: GetAnalogLTCInClockChannel, NTV2DeviceGetNumLTCInputs, Analog LTC Input

Definition at line 3731 of file ntv2register.cpp.

◆ SetAnalogLTCOutClockChannel()

bool CNTV2Card::SetAnalogLTCOutClockChannel	(	const UWord	inLTCOutput,
		const NTV2Channel	inChannel
	)

virtual

Sets the (SDI) output channel that is to provide the clock reference to be used by the given analog LTC output.

Parameters

[in]	inLTCOutput	Specifies the device's analog LTC output. Use 0 for LTC Out 1, 1 for LTC Out 2, etc. (Call NTV2DeviceGetNumLTCOutputs to determine the number of analog LTC outputs.)
[in]	inChannel	Specifies the NTV2Channel that should provide the clock reference for writing the given analog LTC output.

Returns: True if successful; otherwise false.

Note: This function is provided for devices that are capable of handling multiple, disparate video formats (see NTV2DeviceCanDoMultiFormat and CNTV2Card::GetMultiFormatMode functions). It doesn't make sense to call this function on a device that is running in "UniFormat" mode.

See also: GetAnalogLTCOutClockChannel, NTV2DeviceGetNumLTCOutputs, Analog LTC Output

Definition at line 3776 of file ntv2register.cpp.

◆ SetAnalogOutHTiming()

bool CNTV2Card::SetAnalogOutHTiming ( ULWord inValue )

virtual

Definition at line 3197 of file ntv2register.cpp.

◆ SetAudio20BitMode()

bool CNTV2Card::SetAudio20BitMode	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inEnable
	)

virtual

Enables or disables 20-bit mode for the NTV2AudioSystem.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem on the device to be affected.
[in]	inEnable	Specify `true` to use 20-bit mode; specify `false` for normal (24-bit) mode.

Note: This function is relevant only for the KONA IP or Io IP.

Definition at line 1078 of file ntv2audio.cpp.

◆ SetAudioAnalogLevel()

bool CNTV2Card::SetAudioAnalogLevel	(	const NTV2AudioLevel	value,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Definition at line 280 of file ntv2audio.cpp.

◆ SetAudioBufferSize() [1/2]

bool CNTV2Card::SetAudioBufferSize	(	const NTV2AudioBufferSize	inMode,
		const NTV2AudioSystemSet &	inAudioSystems
	)

virtual

Changes the size of the audio buffer used for the given Audio System(s).

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specifies the desired size of the capture/playout audio buffer to be used on the AJA device. All modern AJA devices use NTV2_AUDIO_BUFFER_BIG (4 MB).
[in]	inAudioSystems	Specifies the Audio System(s) of interest.

See also: CNTV2Card::GetAudioBufferSize

Definition at line 258 of file ntv2audio.cpp.

◆ SetAudioBufferSize() [2/2]

bool CNTV2Card::SetAudioBufferSize	(	const NTV2AudioBufferSize	inValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Changes the size of the audio buffer that is used for a given Audio System in the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specifies the desired size of the capture/playout audio buffer to be used on the AJA device. All modern AJA devices use NTV2_AUDIO_BUFFER_BIG (4 MB).
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

See also: CNTV2Card::GetAudioBufferSize

Definition at line 249 of file ntv2audio.cpp.

◆ SetAudioCaptureEnable()

bool CNTV2Card::SetAudioCaptureEnable	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inEnable
	)

virtual

Enables or disables the writing of incoming audio into the given Audio System's capture buffer.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inEnable	If true, the Audio System will write captured samples into device audio buffer memory (if currently running). If false, the Audio System will not write captured samples into device audio buffer memory.

Note: Applications using AutoCirculate won't need to call this function, since AutoCirculate configures the Audio System automatically.

See also: CNTV2Card::GetAudioCaptureEnable, Audio Capture

Definition at line 1169 of file ntv2audio.cpp.

◆ SetAudioInputDelay()

bool CNTV2Card::SetAudioInputDelay	(	const NTV2AudioSystem	inAudioSystem,
		const ULWord	inDelay
	)

virtual

Sets the audio input delay for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System whose input delay is to be set.
[in]	inDelay	Specifies the new audio input delay value for the Audio System. Each increment of this value increases the delay by exactly 512 bytes in the Audio System's audio buffer, or about 166.7 microseconds. Values from 0 thru 8159 are valid, which gives a maximum delay of about 1.36 seconds.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioInputDelay, Audio Capture

Definition at line 1198 of file ntv2audio.cpp.

◆ SetAudioLoopBack() [1/2]

bool CNTV2Card::SetAudioLoopBack	(	const NTV2AudioLoopBack	inMode,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Enables or disables NTV2AudioLoopBack mode for the given NTV2AudioSystem.

Returns: True if successful; otherwise false.

Parameters

[in]	inMode	Specify NTV2_AUDIO_LOOPBACK_ON to force the Audio System's output embedder, to pull audio samples from the Audio System's input de-embedder. Specify NTV2_AUDIO_LOOPBACK_OFF to have the output embedder emit silence (zeroes).
[in]	inAudioSystem	Optionally specifies the Audio System on the device to be affected. Defaults to NTV2_AUDIOSYSTEM_1.

See also: CNTV2Card::GetAudioLoopBack, Audio Playout

Definition at line 300 of file ntv2audio.cpp.

◆ SetAudioLoopBack() [2/2]

bool CNTV2Card::SetAudioLoopBack	(	const NTV2AudioLoopBack	inMode,
		const NTV2AudioSystemSet &	inAudioSystems
	)

virtual

Enables or disables NTV2AudioLoopBack mode for the given Audio Systems.

Returns: True if successful; otherwise false.

Parameters

[in]	inMode	Specify NTV2_AUDIO_LOOPBACK_ON to force each Audio System's output embedder to pull audio samples from its corresponding SDI input de-embedder; otherwise specify NTV2_AUDIO_LOOPBACK_OFF.
[in]	inAudioSystems	Specifies the Audio System(s) on the device to be affected.

See also: CNTV2Card::GetAudioLoopBack, Audio Playout

Definition at line 311 of file ntv2audio.cpp.

◆ SetAudioMixerInputAudioSystem()

bool CNTV2Card::SetAudioMixerInputAudioSystem	(	const NTV2AudioMixerInput	inMixerInput,
		const NTV2AudioSystem	inAudioSystem
	)

virtual

Sets the Audio System that will drive the given input of the Audio Mixer.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[in]	inAudioSystem	Specifies the new NTV2AudioSystem that is to drive the Audio Mixer's input.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioMixerInputAudioSystem, Audio Mixer

Definition at line 566 of file ntv2audio.cpp.

◆ SetAudioMixerInputChannelSelect()

bool CNTV2Card::SetAudioMixerInputChannelSelect	(	const NTV2AudioMixerInput	inMixerInput,
		const NTV2AudioChannelPair	inChannelPair
	)

virtual

Specifies the Audio Channel Pair that will drive the given input of the Audio Mixer.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[in]	inChannelPair	Specifies the new NTV2AudioChannelPair that is to drive the audio mixer's input.

Returns: True if successful; otherwise false.

Note: Audio mixer inputs NTV2_AudioMixerInputAux1 and NTV2_AudioMixerInputAux2 are currently fixed to NTV2_AudioChannel1_2 and cannot be changed.

See also: CNTV2Card::SetAudioMixerInputChannelSelect, Audio Mixer

Definition at line 594 of file ntv2audio.cpp.

◆ SetAudioMixerInputChannelsMute()

bool CNTV2Card::SetAudioMixerInputChannelsMute	(	const NTV2AudioMixerInput	inMixerInput,
		const NTV2AudioChannelsMuted16	inMutes
	)

virtual

Mutes (or enables) the given output audio channel of the Audio Mixer.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[in]	inMutes	Specifies the mute state for each audio channel as a std::bitset. The index in the bitset directly correlates with the NTV2AudioMixerChannel. Set the bit to mute the channel; clear/reset the bit to unmute/enable the channel. Note that only audio channels NTV2_AudioMixerChannel1 and NTV2_AudioMixerChannel2 are relevant.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioMixerInputChannelsMute, Audio Mixer

Definition at line 753 of file ntv2audio.cpp.

◆ SetAudioMixerInputGain()

bool CNTV2Card::SetAudioMixerInputGain	(	const NTV2AudioMixerInput	inMixerInput,
		const NTV2AudioMixerChannel	inChannel,
		const ULWord	inGainValue
	)

virtual

Sets the gain for the given input of the Audio Mixer.

Parameters

[in]	inMixerInput	Specifies the Audio Mixer's input of interest.
[in]	inChannel	Specifies the audio channel of interest.
[in]	inGainValue	Specifies the new input gain level. This is a signed 18-bit value, where unity gain is 0x10000.

Returns: True if successful; otherwise false.

Note: Currently, the Audio Mixer's Main input gain control affects both audio channels 1 & 2 (L & R), while the Aux 1 & 2 inputs have separate gain settings for audio channels 1 & 2 (L & R).

See also: CNTV2Card::SetAudioMixerInputGain, Audio Mixer

Definition at line 623 of file ntv2audio.cpp.

◆ SetAudioMixerLevelsSampleCount()

bool CNTV2Card::SetAudioMixerLevelsSampleCount ( const ULWord inSampleCount )

virtual

Sets the Audio Mixer's sample count it uses for measuring audio levels.

Parameters

[in] inSampleCount Specifies the new sample count. Must be a power of two (e.g. 1, 2, 4, 8 ...) up to 0x8000 maximum.

Returns: True if successful; otherwise false.

See also: See Audio Mixer

Definition at line 837 of file ntv2audio.cpp.

◆ SetAudioMixerOutputChannelsMute()

bool CNTV2Card::SetAudioMixerOutputChannelsMute ( const NTV2AudioChannelsMuted16 inMutes )

virtual

Mutes or enables the individual output audio channels of the Audio Mixer.

Parameters

[in] inMutes Specifies the mute state for each audio channel as a std::bitset. The index in the bitset directly correlates with the NTV2AudioMixerChannel. Set the bit to mute the channel; clear/reset the bit to unmute/enable the channel.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioMixerOutputChannelsMute, Audio Mixer

Definition at line 732 of file ntv2audio.cpp.

◆ SetAudioMixerOutputGain()

bool CNTV2Card::SetAudioMixerOutputGain ( const ULWord inGainValue )

virtual

Sets the gain for the output of the Audio Mixer.

Parameters

[in] inGainValue Specifies the new input gain level. This is a signed 18-bit value, where unity gain is 0x10000.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetAudioMixerOutputGain, Audio Mixer

Definition at line 644 of file ntv2audio.cpp.

◆ SetAudioOutputAESSyncModeBit()

bool CNTV2Card::SetAudioOutputAESSyncModeBit	(	const NTV2AudioSystem	inAudioSystem,
		const bool &	inAESSyncModeBitSet
	)

virtual

Sets or clears the AES Sync Mode bit for the given Audio System's output.

Parameters

[in]	inAudioSystem	Specifies the audio system of interest.
[in]	inAESSyncModeBitSet	Specify 'true' to set the AES Sync Mode bit; otherwise 'false' for normal operation.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioOutputAESSyncModeBit, Audio Playout

Definition at line 1700 of file ntv2audio.cpp.

◆ SetAudioOutputDelay()

bool CNTV2Card::SetAudioOutputDelay	(	const NTV2AudioSystem	inAudioSystem,
		const ULWord	inDelay
	)

virtual

Sets the audio output delay for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System whose output delay is to be set.
[in]	inDelay	Specifies the new audio output delay value for the Audio System. Each increment of this value increases the delay by exactly 512 bytes in the Audio System's audio buffer, or about 166.7 microseconds (when configured for 16 audio channels). Values from 0 to 8159 are valid, which gives a maximum delay of about 1.36 seconds.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioOutputDelay, Audio Playout

Definition at line 1214 of file ntv2audio.cpp.

◆ SetAudioOutputEmbedderState()

bool CNTV2Card::SetAudioOutputEmbedderState	(	const NTV2Channel	inSDIOutputConnector,
		const bool &	inEnable
	)

virtual

Enables or disables the audio output embedder for the given SDI output connector (specified as a channel number). When the embedder is disabled, the device will not embed any SMPTE 299M (HD) or SMPTE 272M (SD) packets in the HANC in the SDI output stream.

Parameters

[in]	inSDIOutputConnector	Specifies the SDI output of interest.
[in]	inEnable	Specify 'true' to enable the audio output embedder (normal operation). Specify 'false' to disable the embedder.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioOutputEmbedderState, Audio Playout

Definition at line 1578 of file ntv2audio.cpp.

◆ SetAudioOutputEraseMode()

bool CNTV2Card::SetAudioOutputEraseMode	(	const NTV2AudioSystem	inAudioSystem,
		const bool &	inEraseModeEnabled
	)

virtual

Enables or disables output erase mode for the given Audio System, which, when enabled, automatically writes zeroes into the audio output buffer behind the output read head.

Parameters

[in]	inAudioSystem	Specifies the audio system of interest.
[in]	inEraseModeEnabled	Specify 'true' to enable output erase mode; otherwise 'false' for normal operation.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioOutputEraseMode, Audio Playout

Definition at line 1606 of file ntv2audio.cpp.

◆ SetAudioOutputMonitorSource()

bool CNTV2Card::SetAudioOutputMonitorSource	(	const NTV2AudioChannelPair	inChannelPair,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Sets the audio monitor output source to a specified audio system and channel pair. The audio output monitor is typically a pair of RCA jacks (white + red) and/or a headphone jack.

Parameters

[in]	inAudioSystem	Specifies the audio system to use.
[in]	inChannelPair	Specifies the audio channel pair to use.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetAudioOutputMonitorSource, Audio Playout

Definition at line 996 of file ntv2audio.cpp.

◆ SetAudioOutputPause()

bool CNTV2Card::SetAudioOutputPause	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inPausePlayout
	)

virtual

Pauses or resumes output of audio samples and advancement of the audio buffer pointer ("play head") of the given Audio System.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inPausePlayout	Specify 'true' to pause producing audio samples ("paused"). Specify 'false' to resume producing audio samples ("running").

Note: This function doesn't alter the Audio Output Buffer Pointer ("play head") position. To reset the "play head" back to the beginning of the buffer, use CNTV2Card::SetAudioOutputReset instead.

See also: CNTV2Card::GetAudioOutputPause, CNTV2Card::StartAudioOutput, CNTV2Card::StopAudioOutput, Audio Playout

Definition at line 1094 of file ntv2audio.cpp.

◆ SetAudioPCMControl() [1/3]

bool CNTV2Card::SetAudioPCMControl	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inIsNonPCM
	)

virtual

Determines whether or not all outgoing audio channel pairs are to be flagged as non-PCM for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inIsNonPCM	If true, the "non-PCM" indicator in the AES header of all outgoing audio channel pairs is set "On"; otherwise, the indicator is set "Off" (to indicate normal PCM audio).

Returns: True if successful; otherwise false.

Note: This setting, if non-PCM, overrides per-audio-channel-pair PCM control on those devices that support it (see NTV2DeviceCanDoPCMControl).

See also: CNTV2Card::GetAudioPCMControl, Audio Playout

Definition at line 1230 of file ntv2audio.cpp.

◆ SetAudioPCMControl() [2/3]

bool CNTV2Card::SetAudioPCMControl	(	const NTV2AudioSystem	inAudioSystem,
		const NTV2AudioChannelPair	inChannelPair,
		const bool	inIsNonPCM
	)

virtual

Determines whether the given audio channel pair being transmitted by the given Audio System is to be flagged as non-PCM or not.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inChannelPair	Specifies the audio channel pair of interest.
[in]	inIsNonPCM	If true, the "non-PCM" indicator in the AES header of the channel pair is set "On"; otherwise, the indicator is set "Off" (to indicate normal PCM audio).

Returns: True if successful; otherwise false.

Note: Call NTV2DeviceCanDoPCMControl to determine if per-audio-channel-pair PCM control capability is available on this device.; This function has no effect if the Audio-System-wide non-PCM control setting is set to non-PCM. (See the two-parameter overloaded version of this function.)

See also: CNTV2Card::GetAudioPCMControl, Audio Playout

Definition at line 1244 of file ntv2audio.cpp.

◆ SetAudioPCMControl() [3/3]

bool CNTV2Card::SetAudioPCMControl	(	const NTV2AudioSystem	inAudioSystem,
		const NTV2AudioChannelPairs &	inNonPCMChannelPairs
	)

virtual

Sets the non-PCM indicator in the AES header of the given channel pairs for the given Audio System on the device.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inNonPCMChannelPairs	Specifies the audio channel pairs whose non-PCM indicators will be set "On".

Returns: True if successful; otherwise false.

Note: Call NTV2DeviceCanDoPCMControl to determine if this device supports per-audio-channel-pair PCM control.

See also: CNTV2Card::GetAudioPCMControl, Audio Playout

Definition at line 1256 of file ntv2audio.cpp.

◆ SetAudioPlayCaptureModeEnable()

bool CNTV2Card::SetAudioPlayCaptureModeEnable	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inEnable
	)

virtual

Enables or disables a special mode for the given Audio System whereby its embedder and deembedder both start from the audio base address, instead of operating independently.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System on the device to be affected.
[in]	inEnable	If true, de-embedder and embedder both start from the audio base address. If false, the Audio System operates normally.

Definition at line 1183 of file ntv2audio.cpp.

◆ SetAudioRate()

bool CNTV2Card::SetAudioRate	(	const NTV2AudioRate	inRate,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Sets the NTV2AudioRate for the given Audio System.

Returns: True if successful; otherwise false.

Parameters

[in]	inRate	Specifies the new NTV2AudioRate.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

Note: Current generation NTV2 devices only support a fixed 48 kHz sample rate.

Definition at line 205 of file ntv2audio.cpp.

◆ SetAudioSystemInputSource()

bool CNTV2Card::SetAudioSystemInputSource	(	const NTV2AudioSystem	inAudioSystem,
		const NTV2AudioSource	inAudioSource,
		const NTV2EmbeddedAudioInput	inEmbeddedInput
	)

virtual

Sets the audio source for the given NTV2AudioSystem on the device.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[in]	inAudioSource	Specifies the NTV2AudioSource to use for the given NTV2AudioSystem e.g., NTV2_AUDIO_EMBEDDED, NTV2_AUDIO_AES, NTV2_AUDIO_ANALOG, etc.).
[in]	inEmbeddedInput	If the audio source is set to NTV2_AUDIO_EMBEDDED, and the device has multiple SDI inputs, use `inEmbeddedInput` to specify which NTV2EmbeddedAudioInput to use. This parameter is ignored if `inAudioSource` is not NTV2_AUDIO_EMBEDDED.

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; The Corvid 88 has a firmware limitation where audio systems 5/6/7/8 cannot record or playback embedded audio on SDIs 1/2/3/4, nor can audio systems 1/2/3/4 record or playback embedded audio on SDIs 5/6/7/8.

See also: CNTV2Card::GetAudioSystemInputSource, Audio Capture

Definition at line 485 of file ntv2audio.cpp.

◆ SetColorCorrectionHostAccessBank()

bool CNTV2Card::SetColorCorrectionHostAccessBank ( const NTV2ColorCorrectionHostAccessBank inValue )

virtual

Definition at line 155 of file ntv2csclut.cpp.

◆ SetColorCorrectionMode()

bool CNTV2Card::SetColorCorrectionMode	(	const NTV2Channel	inChannel,
		const NTV2ColorCorrectionMode	inMode
	)

virtual

Definition at line 68 of file ntv2csclut.cpp.

◆ SetColorCorrectionOutputBank()

bool CNTV2Card::SetColorCorrectionOutputBank	(	const NTV2Channel	inLUTWidget,
		const ULWord	inBank
	)

virtual

Sets the LUT bank to be used for the given LUT.

Parameters

[in]	inLUTWidget	Specifies the LUT widget of interest as an NTV2Channel, a zero-based index number.
[in]	inBank	Specifies the bank number to be used. Must be 0 or 1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetColorCorrectionOutputBank, LUT Operation

Definition at line 85 of file ntv2csclut.cpp.

◆ SetColorCorrectionSaturation()

bool CNTV2Card::SetColorCorrectionSaturation	(	const NTV2Channel	inChannel,
		const ULWord	inValue
	)

virtual

Definition at line 311 of file ntv2csclut.cpp.

◆ SetColorSpaceCustomCoefficients()

bool CNTV2Card::SetColorSpaceCustomCoefficients	(	const NTV2CSCCustomCoeffs &	inCustomCoefficients,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 1211 of file ntv2csclut.cpp.

◆ SetColorSpaceCustomCoefficients12Bit()

bool CNTV2Card::SetColorSpaceCustomCoefficients12Bit	(	const NTV2CSCCustomCoeffs &	inCustomCoefficients,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 1252 of file ntv2csclut.cpp.

◆ SetColorSpaceMakeAlphaFromKey()

bool CNTV2Card::SetColorSpaceMakeAlphaFromKey	(	const bool	inMakeAlphaFromKey,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Specifies whether or not the given CSC will produce alpha channel data from its key input.

Parameters

[in]	inMakeAlphaFromKey	Specify true to have the CSC generate alpha channel data from a YCbCr video signal applied to its Key Input; otherwise specify false to have it generate an "opaque" value.
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Call NTV2DeviceGetNumCSCs to determine the number of available CSCs on the device. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetColorSpaceMakeAlphaFromKey, Color Space Converter Operation and widget_csc

Definition at line 1199 of file ntv2csclut.cpp.

◆ SetColorSpaceMatrixSelect()

bool CNTV2Card::SetColorSpaceMatrixSelect	(	const NTV2ColorSpaceMatrixType	inType,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the matrix type to be used for the given CSC, typically NTV2_Rec601Matrix or NTV2_Rec709Matrix.

Parameters

[in]	inType	Specifies the matrix type to be used.
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetColorSpaceMatrixSelect, Color Space Converter Operation and widget_csc

Definition at line 452 of file ntv2csclut.cpp.

◆ SetColorSpaceMethod()

bool CNTV2Card::SetColorSpaceMethod	(	const NTV2ColorSpaceMethod	inCSCMethod,
		const NTV2Channel	inChannel
	)

virtual

Selects the color space converter operation method.

Parameters

[in]	inCSCMethod	Specifies the method by which the color space converter will transform its input into its output.
[in]	inChannel	Specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel.

Returns: True if the call was successful; otherwise false.

Note: When selecting NTV2_CSC_Method_Enhanced_4K as the method, the channel must be NTV2_CHANNEL1 or NTV2_CHANNEL5. This will group four CSCs together to process the 4K image. To leave 4K, take CSC 1 (or CSC 5) out of 4K mode.

See also: CNTV2Card::GetColorSpaceMethod, Color Space Converter Operation and widget_csc

Definition at line 364 of file ntv2csclut.cpp.

◆ SetColorSpaceRGBBlackRange()

bool CNTV2Card::SetColorSpaceRGBBlackRange	(	const NTV2_CSC_RGB_Range	inRange,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the RGB range for the given CSC.

Parameters

[in]	inRange	Specifies the new RGB range (NTV2_CSC_RGB_RANGE_FULL or NTV2_CSC_RGB_RANGE_SMPTE).
[in]	inChannel	Optionally specifies the CSC of interest, a zero-based index value expressed as an NTV2Channel. Call NTV2DeviceGetNumCSCs to determine the number of available CSCs on the device. Defaults to NTV2_CHANNEL1 (CSC1).

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetColorSpaceRGBBlackRange, Color Space Converter Operation and widget_csc

Definition at line 1165 of file ntv2csclut.cpp.

◆ SetColorSpaceUseCustomCoefficient()

bool CNTV2Card::SetColorSpaceUseCustomCoefficient	(	const ULWord	inUseCustomCoefficient,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 1186 of file ntv2csclut.cpp.

◆ SetConversionMode()

bool CNTV2Card::SetConversionMode ( const NTV2ConversionMode inConversionMode )

virtual

OK...shouldda been a table....started off as only 8 modes....

Definition at line 46 of file ntv2regconv.cpp.

◆ SetConverterInRate()

bool CNTV2Card::SetConverterInRate ( const NTV2FrameRate inValue )

virtual

Definition at line 20 of file ntv2regconv.cpp.

◆ SetConverterInStandard()

bool CNTV2Card::SetConverterInStandard ( const NTV2Standard inValue )

virtual

Definition at line 18 of file ntv2regconv.cpp.

◆ SetConverterOutRate()

bool CNTV2Card::SetConverterOutRate ( const NTV2FrameRate inValue )

virtual

Definition at line 16 of file ntv2regconv.cpp.

◆ SetConverterOutStandard()

bool CNTV2Card::SetConverterOutStandard ( const NTV2Standard inValue )

virtual

Definition at line 14 of file ntv2regconv.cpp.

◆ SetConverterPulldown()

bool CNTV2Card::SetConverterPulldown ( const ULWord inValue )

virtual

Definition at line 38 of file ntv2regconv.cpp.

◆ SetDefaultVideoOutMode()

bool CNTV2Card::SetDefaultVideoOutMode ( ULWord mode )

virtual

Deprecated:: Obsolete starting in SDK 16.3.

Definition at line 190 of file ntv2register.cpp.

◆ SetDeinterlaceMode()

bool CNTV2Card::SetDeinterlaceMode ( const ULWord inValue )

virtual

Definition at line 36 of file ntv2regconv.cpp.

◆ SetDitherFor8BitInputs()

bool CNTV2Card::SetDitherFor8BitInputs	(	const NTV2Channel	inChannel,
		const ULWord	inDither
	)

virtual

Definition at line 3171 of file ntv2register.cpp.

◆ SetDownConvertMode()

bool CNTV2Card::SetDownConvertMode ( const NTV2DownConvertMode inValue )

virtual

Definition at line 22 of file ntv2regconv.cpp.

◆ SetDualLinkInputEnable()

bool CNTV2Card::SetDualLinkInputEnable ( const bool inIsEnabled )

virtual

Definition at line 3156 of file ntv2register.cpp.

◆ SetDualLinkOutputEnable()

bool CNTV2Card::SetDualLinkOutputEnable ( const bool inIsEnabled )

virtual

Definition at line 3144 of file ntv2register.cpp.

◆ SetEmbeddedAudioClock()

bool CNTV2Card::SetEmbeddedAudioClock	(	const NTV2EmbeddedAudioClock	inValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Sets the NTV2EmbeddedAudioClock setting for the given NTV2AudioSystem.

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specifies the NTV2EmbeddedAudioClock setting to use.
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest. Defaults to NTV2_AUDIOSYSTEM_1.

See also: CNTV2Card::SetEmbeddedAudioClock, NTV2DeviceCanChangeEmbeddedAudioClock, Audio Capture

Definition at line 417 of file ntv2audio.cpp.

◆ SetEmbeddedAudioInput()

bool CNTV2Card::SetEmbeddedAudioInput	(	const NTV2EmbeddedAudioInput	inEmbeddedSource,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Sets the embedded (SDI) audio source for the given NTV2AudioSystem on the device.

Parameters

[in]	inEmbeddedSource	If the audio source is set to NTV2_AUDIO_EMBEDDED, and the device has multiple SDI inputs, use `inEmbeddedInput` to specify which NTV2EmbeddedAudioInput to use. This parameter is ignored if `inAudioSource` is not NTV2_AUDIO_EMBEDDED.
[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; This function will have no effect if the device's current NTV2AudioSource is something other than NTV2_AUDIO_EMBEDDED. Usually it's best to call CNTV2Card::SetAudioSystemInputSource instead of this function.; The Corvid 88 has a firmware limitation where audio systems 5/6/7/8 cannot record or playback embedded audio on SDIs 1/2/3/4, nor can audio systems 1/2/3/4 record or playback embedded audio on SDIs 5/6/7/8.

See also: CNTV2Card::GetEmbeddedAudioInput, CNTV2Card::SetAudioSystemInputSource, Audio Capture

Definition at line 346 of file ntv2audio.cpp.

◆ SetEnableConverter()

bool CNTV2Card::SetEnableConverter ( const bool inValue )

virtual

Definition at line 25 of file ntv2regconv.cpp.

◆ SetEnableVANCData() [1/3]

bool CNTV2Card::SetEnableVANCData	(	const bool	inVANCenabled,
		const bool	inTallerVANC,
		const NTV2Standard	inStandard,
		const NTV2FrameGeometry	inGeometry,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 2720 of file ntv2register.cpp.

◆ SetEnableVANCData() [2/3]

bool CNTV2Card::SetEnableVANCData	(	const bool	inVANCenabled,
		const bool	inTallerVANC = `(0)`,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 2625 of file ntv2register.cpp.

◆ SetEnableVANCData() [3/3]

virtual bool CNTV2Card::SetEnableVANCData	(	const NTV2ChannelSet &	inChannels,
		const bool	inVANCenable,
		const bool	inTallerVANC = `(0)`
	)

inlinevirtual

Definition at line 1201 of file ntv2card.h.

◆ SetEncodeAsPSF()

bool CNTV2Card::SetEncodeAsPSF	(	NTV2Channel	inChannel,
		NTV2EncodeAsPSF	inValue
	)

virtual

Definition at line 1947 of file ntv2register.cpp.

◆ SetEncodedAudioMode()

bool CNTV2Card::SetEncodedAudioMode	(	const NTV2EncodedAudioMode	value,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Definition at line 330 of file ntv2audio.cpp.

◆ SetEveryFrameServices()

bool CNTV2Card::SetEveryFrameServices ( const NTV2EveryFrameTaskMode inMode )

virtual

Sets the device's task mode.

Returns: True if successful; otherwise false.

Parameters

[in] inMode Specifies the task mode the device is to assume, and must be one of the following values: NTV2_DISABLE_TASKS, NTV2_STANDARD_TASKS, or NTV2_OEM_TASKS.

Warning: Do not use task mode NTV2_STANDARD_TASKS for OEM applications.

See also: CNTV2DriverInterface::GetStreamingApplication, Sharing AJA Devices With Other Applications

Definition at line 179 of file ntv2register.cpp.

◆ SetForce64()

bool CNTV2Card::SetForce64 ( ULWord force64 )

virtual

Definition at line 3187 of file ntv2register.cpp.

◆ SetFrameBufferFormat() [1/2]

bool CNTV2Card::SetFrameBufferFormat	(	const NTV2ChannelSet &	inFrameStores,
		const NTV2FrameBufferFormat	inNewFormat,
		const bool	inIsAJARetail = `(! (0) )`,
		const NTV2HDRXferChars	inXferChars = `NTV2_VPID_TC_SDR_TV`,
		const NTV2HDRColorimetry	inColorimetry = `NTV2_VPID_Color_Rec709`,
		const NTV2HDRLuminance	inLuminance = `NTV2_VPID_Luminance_YCbCr`
	)

virtual

Sets the frame buffer format for the given FrameStore(s) on the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in]	inFrameStores	Specifies the FrameStore(s) of interest as a channel-set (a set of zero-based index numbers).
[in]	inNewFormat	Specifies the desired frame buffer format. This must be a valid NTV2FrameBufferFormat value.
[in]	inIsAJARetail	Specifies if the AJA retail configuration settings are to be respected or not. Defaults to false on all platforms other than MacOS, which defaults to true.
[in]	inXferChars	Specifies the HDR tranfer characteristc description (affects output VPID).
[in]	inColorimetry	Specifies the HDR colorimetry description (affects output VPID).
[in]	inLuminance	Specifies the HDR luminance description (affects output VPID).

This function allows client applications to control the format of frame data read or written by the FrameStore(s) on an AJA device. This is important, because when frames are transferred between the host and the AJA device, the frame data format is presumed to be identical.

Definition at line 1858 of file ntv2register.cpp.

◆ SetFrameBufferFormat() [2/2]

bool CNTV2Card::SetFrameBufferFormat	(	NTV2Channel	inChannel,
		NTV2FrameBufferFormat	inNewFormat,
		bool	inIsAJARetail = `(! (0) )`,
		NTV2HDRXferChars	inXferChars = `NTV2_VPID_TC_SDR_TV`,
		NTV2HDRColorimetry	inColorimetry = `NTV2_VPID_Color_Rec709`,
		NTV2HDRLuminance	inLuminance = `NTV2_VPID_Luminance_YCbCr`
	)

virtual

Sets the frame buffer format for the given FrameStore on the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number).
[in]	inNewFormat	Specifies the desired frame buffer format. This must be a valid NTV2FrameBufferFormat value.
[in]	inIsAJARetail	Specifies if the AJA retail configuration settings are to be respected or not. Defaults to false on all platforms other than MacOS, which defaults to true.
[in]	inXferChars	Specifies the HDR tranfer characteristc description (affects output VPID).
[in]	inColorimetry	Specifies the HDR colorimetry description (affects output VPID).
[in]	inLuminance	Specifies the HDR luminance description (affects output VPID).

This function allows client applications to control the format of frame data stored in the FrameStores on an AJA device. This is important, because when frames are transferred between the host and the AJA device, the frame data format is presumed to be identical.

Definition at line 1812 of file ntv2register.cpp.

◆ SetFrameBufferOrientation()

bool CNTV2Card::SetFrameBufferOrientation	(	const NTV2Channel	inChannel,
		const NTV2FBOrientation	inValue
	)

virtual

Sets the frame buffer orientation for the given NTV2Channel.

Parameters

[in]	inChannel	Specifies the channel (aka FrameStore) of interest.
[in]	inValue	Specifies the new frame buffer orientation.

Returns: True if successful; otherwise false.

Note: For capture, NTV2_FRAMEBUFFER_ORIENTATION_TOPDOWN or NTV2_FRAMEBUFFER_ORIENTATION_NORMAL specifies that the input de-embedder writes incoming pixel data in top-to-bottom order in the frame buffer, whereas NTV2_FRAMEBUFFER_ORIENTATION_BOTTOMUP writes incoming pixel data in bottom-to-top order. For playout, NTV2_FRAMEBUFFER_ORIENTATION_TOPDOWN or NTV2_FRAMEBUFFER_ORIENTATION_NORMAL specifies that the output embedder reads outgoing pixel data in top-to-bottom order from frame buffer memory, whereas NTV2_FRAMEBUFFER_ORIENTATION_BOTTOMUP reads it in bottom-to-top order.

Definition at line 1967 of file ntv2register.cpp.

◆ SetFrameBufferQuality()

bool CNTV2Card::SetFrameBufferQuality	(	NTV2Channel	inChannel,
		NTV2FrameBufferQuality	inValue
	)

virtual

Definition at line 1913 of file ntv2register.cpp.

◆ SetFrameBufferQuarterSizeMode()

bool CNTV2Card::SetFrameBufferQuarterSizeMode	(	NTV2Channel	inChannel,
		NTV2QuarterSizeExpandMode	inValue
	)

virtual

Definition at line 1893 of file ntv2register.cpp.

◆ SetFrameBufferSize() [1/2]

bool CNTV2Card::SetFrameBufferSize	(	const NTV2Channel	inChannel,
		const NTV2Framesize	inValue
	)

virtual

Sets the device's intrinsic frame buffer size.

Parameters

[in]	inChannel	Specifies the FrameStore to be affected. (Currently ignored – see note below.)
[in]	inValue	Specifies the new frame size. Must be NTV2_FRAMESIZE_8MB or NTV2_FRAMESIZE_16MB.

Returns: True if successful; otherwise false.

See also: Frame Buffer Indexing, CNTV2Card::GetFrameBufferSize

Definition at line 1992 of file ntv2register.cpp.

◆ SetFrameBufferSize() [2/2]

bool CNTV2Card::SetFrameBufferSize ( const NTV2Framesize inSize )

virtual

Sets the device's intrinsic frame buffer size.

Parameters

[in] inSize Specifies the intrinsic frame size the hardware should use.

Returns: True if successful; otherwise false. Failure usually indicates the intrinsic frame size is not software-changeable.

See also: Frame Buffer Indexing, CNTV2Card::GetFrameBufferSize

Definition at line 1738 of file ntv2register.cpp.

◆ SetFrameGeometry()

bool CNTV2Card::SetFrameGeometry	(	NTV2FrameGeometry	inGeometry,
		bool	inIsRetail = `(! (0) )`,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the frame geometry of the given channel.

Parameters

[in]	inGeometry	Specifies the desired frame geometry. It must be a valid NTV2FrameGeometry value.
[in]	inIsRetail	This parameter is ignored.
[in]	inChannel	Specifies the NTV2Channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 897 of file ntv2register.cpp.

◆ SetFramePulseReference()

bool CNTV2Card::SetFramePulseReference ( const NTV2ReferenceSource inRefSource )

virtual

Sets the device's frame pulse reference source. See Video Output Clocking & Synchronization for more information.

Parameters

[in] inRefSource Specifies the NTV2ReferenceSource to use for the device's frame pulse reference.

Returns: True if successful; otherwise false.

See also: GetFramePulseReference, GetEnableFramePulseReference, Video Output Clocking & Synchronization

Definition at line 1586 of file ntv2register.cpp.

◆ SetFrameRate()

bool CNTV2Card::SetFrameRate	(	NTV2FrameRate	inNewValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the AJA device's frame rate.

Returns: True if successful; otherwise false.

Parameters

[in]	inNewValue	Specifies the new NTV2FrameRate value the AJA device is to be configured with.
[in]	inChannel	Specifies the NTV2Channel of interest.

Note: The frame rate setting for NTV2_CHANNEL1 dictates the device reference clock for both single and multi-format mode (see Video Output Clocking & Synchronization).

Definition at line 1005 of file ntv2register.cpp.

◆ SetHDMIHDRBluePrimaryX()

bool CNTV2Card::SetHDMIHDRBluePrimaryX ( const uint16_t inBluePrimaryX )

virtual

Sets the Display Mastering data for Blue Primary X as defined in SMPTE ST 2086. This is Byte 7 and 8 of SMDT Type 1.

Parameters

[in] inBluePrimaryX Specifies the Blue Primary X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 660 of file ntv2hdmi.cpp.

◆ SetHDMIHDRBluePrimaryY()

bool CNTV2Card::SetHDMIHDRBluePrimaryY ( const uint16_t inBluePrimaryY )

virtual

Sets the Display Mastering data for Blue Primary Y as defined in SMPTE ST 2086. This is Byte 9 and 10 of SMDT Type 1.

Parameters

[in] inBluePrimaryY Specifies the Blue Primary Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 680 of file ntv2hdmi.cpp.

◆ SetHDMIHDRBT2020()

bool CNTV2Card::SetHDMIHDRBT2020 ( void )

virtual

Definition at line 1014 of file ntv2hdmi.cpp.

◆ SetHDMIHDRConstantLuminance()

bool CNTV2Card::SetHDMIHDRConstantLuminance ( const bool inEnableConstantLuminance )

virtual

Enables or disables BT.2020 Y'cC'bcC'rc versus BT.2020 Y'C'bC'r or R'G'B'.

Parameters

[in] inEnableConstantLuminance If true, sets the device to BT.2020 Y'cC'bcC'rc; otherwise sets the device to BT.2020 Y'C'bC'r or R'G'B'.

Returns: True if successful; otherwise false.

Definition at line 860 of file ntv2hdmi.cpp.

◆ SetHDMIHDRDCIP3()

bool CNTV2Card::SetHDMIHDRDCIP3 ( void )

virtual

Definition at line 1024 of file ntv2hdmi.cpp.

◆ SetHDMIHDRElectroOpticalTransferFunction()

bool CNTV2Card::SetHDMIHDRElectroOpticalTransferFunction ( const uint8_t inEOTFByte )

virtual

Definition at line 883 of file ntv2hdmi.cpp.

◆ SetHDMIHDRGreenPrimaryX()

bool CNTV2Card::SetHDMIHDRGreenPrimaryX ( const uint16_t inGreenPrimaryX )

virtual

Sets the Display Mastering data for Green Primary X as defined in SMPTE ST 2086. This is Byte 3 and 4 of SMDT Type 1.

Parameters

[in] inGreenPrimaryX Specifies the Green Primary X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 620 of file ntv2hdmi.cpp.

◆ SetHDMIHDRGreenPrimaryY()

bool CNTV2Card::SetHDMIHDRGreenPrimaryY ( const uint16_t inGreenPrimaryY )

virtual

Sets the Display Mastering data for Green Primary Y as defined in SMPTE ST 2086. This is Byte 5 and 6 of SMDT Type 1.

Parameters

[in] inGreenPrimaryY Specifies the Green Primary Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 640 of file ntv2hdmi.cpp.

◆ SetHDMIHDRMaxContentLightLevel()

bool CNTV2Card::SetHDMIHDRMaxContentLightLevel ( const uint16_t inMaxContentLightLevel )

virtual

Sets the Display Mastering data for the Max Content Light Level(Max CLL) value. This is Byte 23 and 24 of SMDT Type 1.

Parameters

[in] inMaxContentLightLevel Specifies the Max Content Light Level value.

Returns: True if successful; otherwise false.

Definition at line 820 of file ntv2hdmi.cpp.

◆ SetHDMIHDRMaxFrameAverageLightLevel()

bool CNTV2Card::SetHDMIHDRMaxFrameAverageLightLevel ( const uint16_t inMaxFrameAverageLightLevel )

virtual

Sets the Display Mastering data for the Max Frame Average Light Level(Max FALL) value. This is Byte 25 and 26 of SMDT Type 1.

Parameters

[in] inMaxFrameAverageLightLevel Specifies the Max Frame Average Light Level value.

Returns: True if successful; otherwise false.

Definition at line 840 of file ntv2hdmi.cpp.

◆ SetHDMIHDRMaxMasteringLuminance()

bool CNTV2Card::SetHDMIHDRMaxMasteringLuminance ( const uint16_t inMaxMasteringLuminance )

virtual

Sets the Display Mastering data for the Max Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 19 and 20 of SMDT Type 1.

Parameters

[in] inMaxMasteringLuminance Specifies the Max Mastering Luminance value.

Returns: True if successful; otherwise false.

Definition at line 780 of file ntv2hdmi.cpp.

◆ SetHDMIHDRMinMasteringLuminance()

bool CNTV2Card::SetHDMIHDRMinMasteringLuminance ( const uint16_t inMinMasteringLuminance )

virtual

Sets the Display Mastering data for the Min Mastering Luminance value as defined in SMPTE ST 2086. This is Byte 21 and 22 of SMDT Type 1.

Parameters

[in] inMinMasteringLuminance Specifies the Min Mastering Luminance value.

Returns: True if successful; otherwise false.

Definition at line 800 of file ntv2hdmi.cpp.

◆ SetHDMIHDRRedPrimaryX()

bool CNTV2Card::SetHDMIHDRRedPrimaryX ( const uint16_t inRedPrimaryX )

virtual

Sets the Display Mastering data for Red Primary X as defined in SMPTE ST 2086. This is Byte 11 and 12 of SMDT Type 1.

Parameters

[in] inRedPrimaryX Specifies the Red Primary X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 700 of file ntv2hdmi.cpp.

◆ SetHDMIHDRRedPrimaryY()

bool CNTV2Card::SetHDMIHDRRedPrimaryY ( const uint16_t inRedPrimaryY )

virtual

Sets the Display Mastering data for Red Primary Y as defined in SMPTE ST 2086. This is Byte 13 and 14 of SMDT Type 1.

Parameters

[in] inRedPrimaryY Specifies the Red Primary Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 720 of file ntv2hdmi.cpp.

◆ SetHDMIHDRStaticMetadataDescriptorID()

bool CNTV2Card::SetHDMIHDRStaticMetadataDescriptorID ( const uint8_t inSMDId )

virtual

Definition at line 903 of file ntv2hdmi.cpp.

◆ SetHDMIHDRWhitePointX()

bool CNTV2Card::SetHDMIHDRWhitePointX ( const uint16_t inWhitePointX )

virtual

Sets the Display Mastering data for White Point X as defined in SMPTE ST 2086. This is Byte 15 and 16 of SMDT Type 1.

Parameters

[in] inWhitePointX Specifies the White Point X value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 740 of file ntv2hdmi.cpp.

◆ SetHDMIHDRWhitePointY()

bool CNTV2Card::SetHDMIHDRWhitePointY ( const uint16_t inWhitePointY )

virtual

Sets the Display Mastering data for White Point Y as defined in SMPTE ST 2086. This is Byte 17 and 18 of SMDT Type 1.

Parameters

[in] inWhitePointY Specifies the White Point Y value as defined in SMPTE ST 2086.

Returns: True if successful; otherwise false.

Definition at line 760 of file ntv2hdmi.cpp.

◆ SetHDMIInAudioChannel34Swap()

bool CNTV2Card::SetHDMIInAudioChannel34Swap	(	const bool	inIsSwapped,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the given HDMI input's audio channel 3/4 swap state.

Parameters

[in]	inIsSwapped	Specify true to swap channels 3 & 4; otherwise false.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetHDMIInAudioChannel34Swap

Definition at line 296 of file ntv2hdmi.cpp.

◆ SetHDMIInAudioSampleRateConverterEnable()

bool CNTV2Card::SetHDMIInAudioSampleRateConverterEnable	(	const bool	inNewValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 252 of file ntv2hdmi.cpp.

◆ SetHDMIInBitDepth()

bool CNTV2Card::SetHDMIInBitDepth	(	const NTV2HDMIBitDepth	inNewValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the given HDMI input's bit depth.

Parameters

[in]	inNewValue	Specifies the new NTV2HDMIBitDepth value to be used.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 203 of file ntv2hdmi.cpp.

◆ SetHDMIInColorSpace()

bool CNTV2Card::SetHDMIInColorSpace	(	const NTV2HDMIColorSpace	inNewValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the given HDMI input's color space.

Parameters

[in]	inNewValue	Specifies the new NTV2HDMIColorSpace value to be used.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 185 of file ntv2hdmi.cpp.

◆ SetHDMIInputRange()

bool CNTV2Card::SetHDMIInputRange	(	const NTV2HDMIRange	inNewValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the given HDMI input's input range.

Parameters

[in]	inNewValue	Specifies the new NTV2HDMIRange value to be used.
[in]	inChannel	Specifies the HDMI input of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

Definition at line 167 of file ntv2hdmi.cpp.

◆ SetHDMIOut3DMode()

bool CNTV2Card::SetHDMIOut3DMode ( const NTV2HDMIOut3DMode inValue )

virtual

Definition at line 318 of file ntv2hdmi.cpp.

◆ SetHDMIOut3DPresent()

bool CNTV2Card::SetHDMIOut3DPresent ( const bool inIs3DPresent )

virtual

Definition at line 306 of file ntv2hdmi.cpp.

◆ SetHDMIOutAudioChannel34Swap()

bool CNTV2Card::SetHDMIOutAudioChannel34Swap	(	const bool	inIsSwapped,
		const NTV2Channel	inWhichHDMIOut = `NTV2_CHANNEL1`
	)

virtual

Sets the HDMI output's audio channel 3/4 swap state.

Parameters

[in]	inIsSwapped	Specify true to swap channels 3 & 4; otherwise false.
[in]	inWhichHDMIOut	Optionally specifies the HDMI output of interest as an NTV2Channel, a zero-based index value. Defaults to the first HDMI output.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetHDMIOutAudioChannel34Swap

Definition at line 1042 of file ntv2hdmi.cpp.

◆ SetHDMIOutAudioChannels()

bool CNTV2Card::SetHDMIOutAudioChannels ( const NTV2HDMIAudioChannels inNewValue )

virtual

Definition at line 851 of file ntv2audio.cpp.

◆ SetHDMIOutAudioFormat()

bool CNTV2Card::SetHDMIOutAudioFormat ( const NTV2AudioFormat inNewValue )

virtual

Sets the HDMI output's audio format.

Parameters

[in] inNewValue Specifies the audio format

Returns: True if successful; otherwise false.

Definition at line 984 of file ntv2audio.cpp.

◆ SetHDMIOutAudioRate()

bool CNTV2Card::SetHDMIOutAudioRate ( const NTV2AudioRate inNewValue )

virtual

Sets the HDMI output's audio rate.

Parameters

[in] inNewValue Specifies the audio rate

Returns: True if successful; otherwise false.

Definition at line 972 of file ntv2audio.cpp.

◆ SetHDMIOutAudioSource2Channel()

bool CNTV2Card::SetHDMIOutAudioSource2Channel	(	const NTV2AudioChannelPair	inNewValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Sets the HDMI output's 2-channel audio source.

Parameters

[in]	inNewValue	Specifies the audio channels from the given Audio System to be used.
[in]	inAudioSystem	Specifies the Audio System that will supply audio samples to the HDMI output. Defaults to NTV2_AUDIOSYSTEM_1.

Returns: True if successful; otherwise false.

Definition at line 863 of file ntv2audio.cpp.

◆ SetHDMIOutAudioSource8Channel()

bool CNTV2Card::SetHDMIOutAudioSource8Channel	(	const NTV2Audio8ChannelSelect	inNewValue,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Changes the HDMI output's 8-channel audio source.

Parameters

[in]	inNewValue	Specifies the audio channels from the given Audio System to be used.
[in]	inAudioSystem	Specifies the Audio System that will supply audio samples to the HDMI output. Defaults to NTV2_AUDIOSYSTEM_1.

Returns: True if successful; otherwise false.

Definition at line 914 of file ntv2audio.cpp.

◆ SetHDMIOutBitDepth()

bool CNTV2Card::SetHDMIOutBitDepth ( const NTV2HDMIBitDepth inNewValue )

virtual

Definition at line 462 of file ntv2hdmi.cpp.

◆ SetHDMIOutColorSpace()

bool CNTV2Card::SetHDMIOutColorSpace ( const NTV2HDMIColorSpace inNewValue )

virtual

Definition at line 398 of file ntv2hdmi.cpp.

◆ SetHDMIOutDecimateMode()

bool CNTV2Card::SetHDMIOutDecimateMode ( const bool inEnable )

virtual

Enables or disables decimate mode on the device's HDMI rasterizer, which halves the output frame rate when enabled. This allows a 60 Hz video stream to be displayed on a 30 Hz HDMI monitor.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, enables decimation mode; otherwise disables decimation mode.

Definition at line 550 of file ntv2hdmi.cpp.

◆ SetHDMIOutForceConfig()

bool CNTV2Card::SetHDMIOutForceConfig ( const bool inNewValue )

virtual

Definition at line 525 of file ntv2hdmi.cpp.

◆ SetHDMIOutLevelBMode()

bool CNTV2Card::SetHDMIOutLevelBMode ( const bool inEnable )

virtual

Enables or disables level-B mode on the device's HDMI rasterizer.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, enables level-B mode; otherwise disables level-B mode.

Definition at line 578 of file ntv2hdmi.cpp.

◆ SetHDMIOutPrefer420()

bool CNTV2Card::SetHDMIOutPrefer420 ( const bool inNewValue )

virtual

Definition at line 537 of file ntv2hdmi.cpp.

◆ SetHDMIOutProtocol()

bool CNTV2Card::SetHDMIOutProtocol ( const NTV2HDMIProtocol inNewValue )

virtual

Definition at line 512 of file ntv2hdmi.cpp.

◆ SetHDMIOutRange()

bool CNTV2Card::SetHDMIOutRange ( const NTV2HDMIRange inNewValue )

virtual

Definition at line 383 of file ntv2hdmi.cpp.

◆ SetHDMIOutSampleStructure()

bool CNTV2Card::SetHDMIOutSampleStructure ( const NTV2HDMISampleStructure inNewValue )

virtual

Definition at line 354 of file ntv2hdmi.cpp.

◆ SetHDMIOutTsiIO()

bool CNTV2Card::SetHDMIOutTsiIO ( const bool inTsiEnable )

virtual

Enables or disables two sample interleave I/O mode on the device's HDMI rasterizer.

Returns: True if successful; otherwise false.

Parameters

[in] inTsiEnable If true, enables two sample interleave I/O; otherwise disables two sample interleave I/O.

Definition at line 564 of file ntv2hdmi.cpp.

◆ SetHDMIOutVideoFPS()

bool CNTV2Card::SetHDMIOutVideoFPS ( const NTV2FrameRate inNewValue )

virtual

Definition at line 370 of file ntv2hdmi.cpp.

◆ SetHDMIOutVideoStandard()

bool CNTV2Card::SetHDMIOutVideoStandard ( const NTV2Standard inNewValue )

virtual

Definition at line 331 of file ntv2hdmi.cpp.

◆ SetHDMIV2Mode()

bool CNTV2Card::SetHDMIV2Mode ( const NTV2HDMIV2Mode inMode )

virtual

Sets HDMI V2 mode for the device.

Returns: True if successful; otherwise false.

Parameters

[in] inMode Specifies the HDMI V2 operation mode for the device. Use NTV2_HDMI_V2_HDSD_BIDIRECTIONAL for HD or SD capture and playback. Use NTV2_HDMI_V2_4K_CAPTURE for 4K capture. Use NTV2_HDMI_V2_4K_PLAYBACK for 4K playback.

Note: 4K modes are exclusive.

Definition at line 592 of file ntv2hdmi.cpp.

◆ SetHDMIV2TxBypass()

bool CNTV2Card::SetHDMIV2TxBypass ( const bool inBypass )

virtual

Definition at line 348 of file ntv2hdmi.cpp.

◆ SetHDRData() [1/2]

bool CNTV2Card::SetHDRData ( const HDRFloatValues & inFloatValues )

virtual

Definition at line 961 of file ntv2hdmi.cpp.

◆ SetHDRData() [2/2]

bool CNTV2Card::SetHDRData ( const HDRRegValues & inRegisterValues )

virtual

Definition at line 969 of file ntv2hdmi.cpp.

◆ SetHeadphoneOutputGain()

bool CNTV2Card::SetHeadphoneOutputGain ( const ULWord inGainValue )

virtual

Sets the gain for the headphone out.

Parameters

[in] inGainValue Specifies the new headphone gain level. This is a signed 18-bit value, where unity gain is 0x10000.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SetHeadphoneOutputGain, Audio Mixer

Definition at line 710 of file ntv2audio.cpp.

◆ SetInputFrame()

bool CNTV2Card::SetInputFrame	(	const NTV2Channel	inChannel,
		const ULWord	inValue
	)

virtual

Sets the input frame index number for the given FrameStore. This identifies which frame in device SDRAM will be written after the next VBI.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number.
[in]	inValue	Specifies the desired frame index number in device memory to be written. See Frame Buffer Indexing for more information.

Returns: True if successful; otherwise false.

Note: For the effect to be noticeable, the FrameStore should be enabled (see CNTV2Card::EnableChannel) and in NTV2_MODE_CAPTURE mode.; Normally, if the device NTV2RegisterWriteMode is NTV2_REGWRITE_SYNCTOFRAME, the new value takes effect at the next input frame interrupt. For example, if line 300 of frame 5 is currently being written in device memory at the instant this function is called with frame 6, video won't be written into frame 6 in device memory until the input VBI fires after the last line of frame 5 has been written.; If the FrameStore's NTV2RegisterWriteMode is NTV2_REGWRITE_SYNCTOFIELD, the new value takes effect at the next input field interrupt. This makes it possible to record lines from NTV2_FIELD0 and NTV2_FIELD1 in separate frame buffers, if desired. See CNTV2Card::SetRegisterWriteMode and/or Field/Frame Interrupts for more information.

Warning: If the designated FrameStore/channel is enabled and in NTV2_MODE_CAPTURE mode, and the given frame is within the frame range being used by another FrameStore/channel, this will likely result in torn/bad video in either or both channels. See When FrameStores Access the Same Frame Buffer Memory; If the designated FrameStore/channel is enabled and in NTV2_MODE_CAPTURE mode, and the given frame is in Audio Buffer memory that's in use by a running Audio System, this will likely result in torn/bad video and/or bad audio. See Audio Buffer Corruption

See also: CNTV2Card::GetInputFrame, FrameStore Operation

Definition at line 2209 of file ntv2register.cpp.

◆ SetInputVerticalEventCount()

bool CNTV2Card::SetInputVerticalEventCount	(	const ULWord	inCount,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Resets my input interrupt event tally for the given channel.

Parameters

[in]	inCount	Specifies the new count value. Use zero to reset the tally.
[in]	inChannel	Specifies the [input] channel.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetInputVerticalEventCount, CNTV2Card::SetInterruptEventCount, Field/Frame Interrupts

Definition at line 128 of file ntv2subscriptions.cpp.

◆ SetInputVideoSelect()

bool CNTV2Card::SetInputVideoSelect ( NTV2InputVideoSelect inInputSelect )

virtual

Definition at line 3352 of file ntv2register.cpp.

◆ SetIsoConvertMode()

bool CNTV2Card::SetIsoConvertMode ( const NTV2IsoConvertMode inValue )

virtual

Definition at line 24 of file ntv2regconv.cpp.

◆ SetLEDState()

bool CNTV2Card::SetLEDState ( ULWord inValue )

virtual

The four on-board LEDs can be set by writing 0-15.

Parameters

[in] inValue Sets the state of the four on-board LEDs using the least significant four bits of the given ULWord value.

Returns: True if successful; otherwise, false.

Definition at line 2483 of file ntv2register.cpp.

◆ SetLHIHDMIOutColorSpace()

bool CNTV2Card::SetLHIHDMIOutColorSpace ( const NTV2LHIHDMIColorSpace inNewValue )

virtual

Definition at line 435 of file ntv2hdmi.cpp.

◆ SetLHIVideoDACMode() [1/2]

bool CNTV2Card::SetLHIVideoDACMode ( const NTV2VideoDACMode inValue )

virtual

Definition at line 286 of file ntv2regconv.cpp.

◆ SetLHIVideoDACMode() [2/2]

bool CNTV2Card::SetLHIVideoDACMode ( NTV2LHIVideoDACMode value )

virtual

Definition at line 282 of file ntv2regconv.cpp.

◆ SetLHIVideoDACStandard()

bool CNTV2Card::SetLHIVideoDACStandard ( const NTV2Standard inValue )

virtual

Definition at line 280 of file ntv2regconv.cpp.

◆ SetLTCEmbeddedOutEnable()

bool CNTV2Card::SetLTCEmbeddedOutEnable ( const bool inNewValue )

virtual

Deprecated:: Use GetLTCInputEnable instead. First deprecated in SDK 16.3.

Definition at line 3684 of file ntv2register.cpp.

◆ SetLTCInputEnable()

bool CNTV2Card::SetLTCInputEnable ( const bool inEnable )

virtual

Enables or disables the ability for the device to read analog LTC on the reference input connector.

Parameters

[in] inEnable If true, the device will read analog LTC from the reference input connector, and won't be able to genlock to external reference. If false, the device will expect a reference signal at the reference input connector, not analog LTC.

Returns: True if successful; otherwise false.

Note: Not all devices are able to read analog LTC from their reference input. Call NTV2DeviceCanDoLTCInOnRefPort to find out.

See also: GetLTCInputEnable, NTV2DeviceCanDoLTCInOnRefPort, Analog LTC Input

Definition at line 3651 of file ntv2register.cpp.

◆ SetLUTControlSelect()

bool CNTV2Card::SetLUTControlSelect ( const NTV2LUTControlSelect inLUTSelect )

virtual

Definition at line 329 of file ntv2csclut.cpp.

◆ SetLUTEnable()

bool CNTV2Card::SetLUTEnable	(	const bool	inEnable,
		const NTV2Channel	inLUT
	)

virtual

Enables or disables the given LUT.

Parameters

[in]	inEnable	Specify true to enable, or false to disable.
[in]	inLUT	Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index number).

Returns: True if successful; otherwise false.

Note: This function only affects devices having version 2 LUTs (see NTV2DeviceGetLUTVersion).

Definition at line 1128 of file ntv2csclut.cpp.

◆ SetLUTV2HostAccessBank()

bool CNTV2Card::SetLUTV2HostAccessBank ( const NTV2ColorCorrectionHostAccessBank inValue )

virtual

Definition at line 195 of file ntv2csclut.cpp.

◆ SetLUTV2OutputBank()

bool CNTV2Card::SetLUTV2OutputBank	(	const NTV2Channel	inLUTWidget,
		const ULWord	inBank
	)

virtual

Definition at line 102 of file ntv2csclut.cpp.

◆ SetMixerBGInputControl()

bool CNTV2Card::SetMixerBGInputControl	(	const UWord	inWhichMixer,
		const NTV2MixerKeyerInputControl	inInputControl
	)

virtual

Sets the background input control value for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inInputControl	Specifies the mixer/keyer's background input control value.

See also: CNTV2Card::GetMixerBGInputControl, Mixer/Keyer Operation, widget_mixkey

Definition at line 2897 of file ntv2register.cpp.

◆ SetMixerBGMatteEnabled()

bool CNTV2Card::SetMixerBGMatteEnabled	(	const UWord	inWhichMixer,
		const bool	inIsEnabled
	)

virtual

Answers if the given mixer/keyer's background matte is enabled or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inIsEnabled	Specify true to enable the mixer's background matte; otherwise false to disable it.

See also: CNTV2Card::GetMixerBGMatteEnabled, CNTV2Card::SetMixerFGMatteEnabled, Mixer/Keyer Operation, widget_mixkey

Definition at line 2997 of file ntv2register.cpp.

◆ SetMixerCoefficient()

bool CNTV2Card::SetMixerCoefficient	(	const UWord	inWhichMixer,
		const ULWord	inMixCoefficient
	)

virtual

Sets the current mix coefficient of the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inMixCoefficient	Specifies the new mix coefficient value, where `0x10000` is the maximum.

See also: CNTV2Card::GetMixerCoefficient, Mixer/Keyer Operation, widget_mixkey

Definition at line 2944 of file ntv2register.cpp.

◆ SetMixerFGInputControl()

bool CNTV2Card::SetMixerFGInputControl	(	const UWord	inWhichMixer,
		const NTV2MixerKeyerInputControl	inInputControl
	)

virtual

Sets the foreground input control value for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inInputControl	Specifies the mixer/keyer's foreground input control value.

See also: CNTV2Card::GetMixerFGInputControl, Mixer/Keyer Operation, widget_mixkey

Definition at line 2874 of file ntv2register.cpp.

◆ SetMixerFGMatteEnabled()

bool CNTV2Card::SetMixerFGMatteEnabled	(	const UWord	inWhichMixer,
		const bool	inIsEnabled
	)

virtual

Answers if the given mixer/keyer's foreground matte is enabled or not.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inIsEnabled	Specify true to enable the mixer's foreground matte; otherwise false to disable it.

See also: CNTV2Card::GetMixerFGMatteEnabled, CNTV2Card::SetMixerBGMatteEnabled, Mixer/Keyer Operation, widget_mixkey

Definition at line 2982 of file ntv2register.cpp.

◆ SetMixerMatteColor()

bool CNTV2Card::SetMixerMatteColor	(	const UWord	inWhichMixer,
		const YCbCr10BitPixel	inYCbCrValue
	)

virtual

Sets the matte color to use for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inYCbCrValue	Specifies the new matte color value to use.

See also: CNTV2Card::GetMixerMatteColor, CNTV2Card::GetMixerFGMatteEnabled, CNTV2Card::SetMixerFGMatteEnabled, CNTV2Card::GetMixerBGMatteEnabled, CNTV2Card::SetMixerBGMatteEnabled, Mixer/Keyer Operation, widget_mixkey

Definition at line 3021 of file ntv2register.cpp.

◆ SetMixerMode()

bool CNTV2Card::SetMixerMode	(	const UWord	inWhichMixer,
		const NTV2MixerKeyerMode	inMode
	)

virtual

Sets the mode for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inMode	Specifies the mode value.

See also: CNTV2Card::GetMixerMode, Mixer/Keyer Operation, widget_mixkey

Definition at line 2920 of file ntv2register.cpp.

◆ SetMixerRGBRange()

bool CNTV2Card::SetMixerRGBRange	(	const UWord	inWhichMixer,
		const NTV2MixerRGBRange	inRGBRange
	)

virtual

Sets the RGB range for the given mixer/keyer.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer of interest as a zero-based index number.
[in]	inRGBRange	Specifies the new RGB range value to use.

Definition at line 3054 of file ntv2register.cpp.

◆ SetMixerVancOutputFromForeground()

bool CNTV2Card::SetMixerVancOutputFromForeground	(	const UWord	inWhichMixer,
		const bool	inFromForegroundSource = `(! (0) )`
	)

virtual

Sets the VANC source for the given mixer/keyer to the foreground video (or not). See the SDI Ancillary Data discussion for more information.

Returns: True if successful; otherwise false.

Parameters

[in]	inWhichMixer	Specifies the mixer/keyer to be affected as a zero-based index number.
[in]	inFromForegroundSource	If true, sets the mixer/keyer's VANC source to its foreground video input; otherwise, sets it to its background video input.

See also: CNTV2Card::GetMixerVancOutputFromForeground, Mixer/Keyer Operation, widget_mixkey

Definition at line 2853 of file ntv2register.cpp.

◆ SetMode() [1/2]

bool CNTV2Card::SetMode	(	const NTV2Channel	inChannel,
		const NTV2Mode	inNewValue,
		const bool	inIsRetail = `(! (0) )`
	)

virtual

Determines if a given FrameStore on the AJA device will be used to capture or playout video.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number).
[in]	inNewValue	Specifies the desired mode (NTV2_MODE_DISPLAY or NTV2_MODE_CAPTURE).
[in]	inIsRetail	This parameter is obsolete and ignored.

Returns: True if successful; otherwise false.

In NTV2_MODE_CAPTURE mode, device frame memory is written; in NTV2_MODE_DISPLAY mode, it's read from.

Note: AutoCirculate automatically sets the NTV2Mode (but doesn't automatically un-set it after use).

See also: CNTV2Card::GetMode, FrameStore Operation

Definition at line 1607 of file ntv2register.cpp.

◆ SetMode() [2/2]

bool CNTV2Card::SetMode	(	const NTV2ChannelSet &	inChannels,
		const NTV2Mode	inMode
	)

virtual

Sets the capture or playout mode of a set of FrameStores on the AJA device.

Parameters

[in]	inChannels	Specifies the FrameStore(s) of interest.
[in]	inNewValue	Specifies the desired mode (NTV2_MODE_DISPLAY or NTV2_MODE_CAPTURE).

Returns: True if all FrameStore(s) were successfully configured; otherwise false.

In NTV2_MODE_CAPTURE mode, device frame memory is written; in NTV2_MODE_DISPLAY mode, it's read from.

Note: AutoCirculate automatically sets the NTV2Mode (but doesn't automatically un-set it after use).

See also: CNTV2Card::GetMode, FrameStore Operation

Definition at line 1616 of file ntv2register.cpp.

◆ SetMultiFormatMode()

bool CNTV2Card::SetMultiFormatMode ( const bool inEnable )

virtual

Enables or disables multi-format (per channel) device operation. If enabled, each device channel can handle a different video format (subject to certain limitations). If disabled, all device channels have the same video format.

Returns: True if successful; otherwise false.

Parameters

[in] inEnable If true, sets the device in multi-format mode. If false, sets the device in uni-format mode.

Deprecated:: Uniformat mode is deprecated starting in SDK 17.0. Passing false for inEnable will cause this function to return false (fail). Eventually this function will be removed from the class.

See also: NTV2DeviceCanDoMultiFormat, CNTV2Card::GetMultiFormatMode, Video Output Clocking & Synchronization

Definition at line 4379 of file ntv2register.cpp.

◆ SetMultiLinkAudioMode()

bool CNTV2Card::SetMultiLinkAudioMode	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inEnable
	)

virtual

Sets the multi-link audio mode for the given audio system.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the NTV2AudioSystem of interest.
[in]	inEnable	Specify true to enable multi-link audio mode; otherwise specify false.

See also: CNTV2Card::GetMultiLinkAudioMode, NTV2DeviceCanDoMultiLinkAudio, Multi-Link Audio (32, 48, 64 Audio Channels)

Definition at line 1643 of file ntv2audio.cpp.

◆ SetMultiRasterBypassEnable()

bool CNTV2Card::SetMultiRasterBypassEnable ( const bool inEnable )

virtual

Definition at line 4702 of file ntv2register.cpp.

◆ SetNumberAudioChannels() [1/2]

bool CNTV2Card::SetNumberAudioChannels	(	const ULWord	inNumChannels,
		const NTV2AudioSystem	inAudioSystem = `NTV2_AUDIOSYSTEM_1`
	)

virtual

Sets the number of audio channels to be concurrently captured or played for a given Audio System on the AJA device.

Returns: True if successful; otherwise false.

Parameters

[in]	inNumChannels	Specifies the number of audio channels the device will record or play to/from a given Audio System. For most applications, this should always be set to the maximum number of audio channels the device is capable of capturing or playing, which can be obtained by calling the NTV2DeviceGetMaxAudioChannels function.
[in]	inAudioSystem	Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1.

Definition at line 146 of file ntv2audio.cpp.

◆ SetNumberAudioChannels() [2/2]

bool CNTV2Card::SetNumberAudioChannels	(	const ULWord	inNumChannels,
		const NTV2AudioSystemSet &	inAudioSystems
	)

virtual

Sets the number of audio channels to be concurrently captured or played for the given Audio System(s).

Returns: True if successful; otherwise false.

Parameters

[in]	inNumChannels	Specifies the number of audio channels the device will record or play. For most applications, this should always be set to the maximum number of audio channels the device is capable of capturing or playing (see NTV2DeviceGetMaxAudioChannels ).
[in]	inAudioSystems	Specifies the Audio System(s) of interest.

Definition at line 170 of file ntv2audio.cpp.

◆ SetOutputFrame()

bool CNTV2Card::SetOutputFrame	(	const NTV2Channel	inChannel,
		const ULWord	inValue
	)

virtual

Sets the output frame index number for the given FrameStore. This identifies which frame in device SDRAM will be used for playout after the next VBI.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number.
[in]	inValue	Specifies the desired output frame index number in device memory. See Frame Buffer Indexing for more information.

Returns: True if successful; otherwise false.

Note: For the effect to be noticeable, the FrameStore should be enabled (see CNTV2Card::EnableChannel) and in NTV2_MODE_DISPLAY mode.; Normally, if the device NTV2RegisterWriteMode is NTV2_REGWRITE_SYNCTOFRAME, the new value takes effect at the next output frame interrupt. For example, if line 300 of frame 5 is currently going "out the jack" at the instant this function is called with frame 6, frame 6 won't go "out the jack" until the output VBI fires after the last line of frame 5 has gone out the spigot.; If the FrameStore's NTV2RegisterWriteMode is NTV2_REGWRITE_SYNCTOFIELD, the new value takes effect at the next output field interrupt, which makes it possible to playout lines for NTV2_FIELD0 and NTV2_FIELD1 from separate frame buffers, if desired. See CNTV2Card::SetRegisterWriteMode and/or Field/Frame Interrupts for more information.

Warning: If the designated FrameStore is enabled and in NTV2_MODE_DISPLAY mode, and the given frame is within the frame range being used by another FrameStore/channel, this will likely result in wrong/torn/bad output video. See When FrameStores Access the Same Frame Buffer Memory; If the designated FrameStore is enabled and in NTV2_MODE_DISPLAY mode, and the given frame is in Audio Buffer memory that's in use by a running Audio System, this will likely result in wrong/torn/bad output video. See Audio Buffer Corruption

See also: CNTV2Card::GetOutputFrame, FrameStore Operation

Definition at line 2191 of file ntv2register.cpp.

◆ SetOutputVerticalEventCount()

bool CNTV2Card::SetOutputVerticalEventCount	(	const ULWord	inCount,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Resets my output interrupt event tally for the given channel.

Parameters

[in]	inCount	Specifies the new count value. Use zero to reset the tally.
[in]	inChannel	Specifies the [output] channel.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetOutputVerticalEventCount, CNTV2Card::SetInterruptEventCount, Field/Frame Interrupts

Definition at line 123 of file ntv2subscriptions.cpp.

◆ SetPCIAccessFrame()

bool CNTV2Card::SetPCIAccessFrame	(	const NTV2Channel	inChannel,
		const ULWord	inValue,
		const bool	inWaitForVBI = `(! (0) )`
	)

virtual

Deprecated:: Declared obsolete starting in SDK 16.2. The "PCI Access Frame" register had no effect on the hardware, but was used to store the next/pending output frame.

Definition at line 2164 of file ntv2register.cpp.

◆ SetProgressivePicture()

bool CNTV2Card::SetProgressivePicture ( ULWord value )

virtual

Definition at line 1072 of file ntv2register.cpp.

◆ SetPulldownMode()

bool CNTV2Card::SetPulldownMode	(	NTV2Channel	inChannel,
		bool	inValue
	)

virtual

Definition at line 2831 of file ntv2register.cpp.

◆ SetQuadFrameEnable()

bool CNTV2Card::SetQuadFrameEnable	(	const bool	inValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Enables or disables quad-frame mode on the device.

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specify 'true' to put the device into quad frame mode. Specify 'false' to put the device into normal (non-quad) frame mode.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1. Ignored if the device is incapable of 4K.

Note: Most clients won't need to call this function, as calling CNTV2Card::SetVideoFormat to one of the 4K/UHD formats will automatically do so.

Definition at line 1092 of file ntv2register.cpp.

◆ SetQuadQuadFrameEnable()

bool CNTV2Card::SetQuadQuadFrameEnable	(	const bool	inValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Enables or disables "quad-quad" 8K frame mode on the device.

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specify 'true' to put the device into "quad quad" frame mode. Specify 'false' to put the device into normal (non-quad-quad) frame mode.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1. Ignored if the device is incapable of 8K/UHD2.

Note: Most clients won't need to call this function, as CNTV2Card::SetVideoFormat using one of the 8K/UHD2 formats will automatically do so.

Definition at line 1125 of file ntv2register.cpp.

◆ SetQuadQuadSquaresEnable()

bool CNTV2Card::SetQuadQuadSquaresEnable	(	const bool	inValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Enables or disables quad-quad-frame (8K) squares mode on the device.

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specify a non-zero value (true) to put the device into quad quad frame mode. Specify zero (false) to put the device into normal (non-quad-quad) frame mode.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1. Ignored if the device is incapable of multi-format mode, or is not currently in multi-format mode.

Definition at line 1180 of file ntv2register.cpp.

◆ SetReference()

bool CNTV2Card::SetReference	(	const NTV2ReferenceSource	inRefSource,
		const bool	inKeepFramePulseSelect = `(0)`
	)

virtual

Sets the device's clock reference source. See Video Output Clocking & Synchronization for more information.

Parameters

[in]	inRefSource	Specifies the NTV2ReferenceSource to use.
[in]	inKeepFramePulseSelect	For devices that support a frame pulse source that's independent of the reference source, specify true to prevent resetting the frame pulse source.

Returns: True if successful; otherwise false.

See also: GetReference, GetReferenceVideoFormat, Video Output Clocking & Synchronization

Definition at line 1484 of file ntv2register.cpp.

◆ SetRegisterWriteMode()

bool CNTV2Card::SetRegisterWriteMode	(	const NTV2RegisterWriteMode	inValue,
		const NTV2Channel	inFrameStore = `NTV2_CHANNEL1`
	)

virtual

Sets the FrameStore's NTV2RegisterWriteMode, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect.

Parameters

[in]	inValue	Specifies the NTV2RegisterWriteMode to set for the FrameStore.
[in]	inFrameStore	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number. If omitted, defaults to NTV2_CHANNEL1.

See also: CNTV2Card::GetRegisterWriteMode, CNTV2Card::SetInputFrame, CNTV2Card::SetOutputFrame, Field/Frame Interrupts

Definition at line 2448 of file ntv2register.cpp.

◆ SetRP188BypassSource()

bool CNTV2Card::SetRP188BypassSource	(	const NTV2Channel	inSDIOutput,
		const UWord	inSDIInput
	)

virtual

For the given SDI output that's in RP188 bypass mode (E-E), specifies the SDI input to be used as a timecode source.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest, expressed as an NTV2Channel.
[in]	inSDIInput	Specifies the SDI input to be used as a timecode source, expressed as a zero-based index number.

Returns: True if successful; otherwise false.

Definition at line 2581 of file ntv2register.cpp.

◆ SetRP188Data()

bool CNTV2Card::SetRP188Data	(	const NTV2Channel	inSDIOutput,
		const NTV2_RP188 &	inRP188Data
	)

virtual

Writes the raw RP188 data into the DBB/Low/Hi registers for the given SDI output. These values are latched and sent at the next VBI.

Parameters

[in]	inSDIOutput	Specifies the SDI output of interest as an NTV2Channel value.
[in]	inRP188Data	Specifies the raw RP188 data values to be written.

Note: This call will have no effect if the SDI output is in "bypass mode".

See also: CNTV2Card::GetRP188Data, CNTV2Card::IsRP188BypassEnabled, CNTV2Card::DisableRP188Bypass, Timecode (RP-188, SMPTE-12M)

Definition at line 2521 of file ntv2register.cpp.

◆ SetRP188Mode()

bool CNTV2Card::SetRP188Mode	(	const NTV2Channel	inChannel,
		const NTV2_RP188Mode	inMode
	)

virtual

Sets the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel.

Parameters

[in]	inChannel	Specifies the channel of interest.
[in]	inMode	Specifies the new RP-188 mode for the given channel. Must be one of NTV2_RP188_INPUT or NTV2_RP188_OUTPUT. All other values are illegal.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetRP188Mode, Timecode (RP-188, SMPTE-12M)

Definition at line 2491 of file ntv2register.cpp.

◆ SetRP188SourceFilter()

bool CNTV2Card::SetRP188SourceFilter	(	const NTV2Channel	inSDIInput,
		const UWord	inFilterValue
	)

virtual

Sets the RP188 DBB filter for the given SDI input.

Parameters

[in]	inSDIInput	Specifies the SDI input of interest, expressed as an NTV2Channel.
[in]	inFilterValue	Specifies the new filter value to use. Only the lower 8 bits are used. Use 0x00 for LTC; 0x01 for VITC1; 0x02 for VITC2; 0xFF for unfiltered.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetRP188SourceFilter, CNTV2Card::SetRP188BypassSource, Timecode (RP-188, SMPTE-12M)

Definition at line 2533 of file ntv2register.cpp.

◆ SetRS422BaudRate()

bool CNTV2Card::SetRS422BaudRate	(	const NTV2Channel	inSerialPort,
		const NTV2_RS422_BAUD_RATE	inBaudRate
	)

virtual

Sets the baud rate of the specified RS422 serial port.

Returns: True if successful; otherwise false.

Parameters

[in]	inSerialPort	Specifies the RS422 serial port to be affected, expressed as an NTV2Channel (a zero-based index number). Call NTV2DeviceGetNumSerialPorts to determine the number of available serial ports.
[in]	inBaudRate	Specifies the NTV2_RS422_BAUD_RATE to be used. (The default baud rate upon power-up or reset is NTV2_RS422_BAUD_RATE_38400.)

Note: This function only works with programmable RS422 devices.

See also: CNTV2Card::SetRS422Parity, CNTV2Card::GetRS422BaudRate, NTV2DeviceGetNumSerialPorts, NTV2DeviceCanDoProgrammableRS422

Definition at line 4445 of file ntv2register.cpp.

◆ SetRS422Parity()

bool CNTV2Card::SetRS422Parity	(	const NTV2Channel	inSerialPort,
		const NTV2_RS422_PARITY	inParity
	)

virtual

Sets the parity control on the specified RS422 serial port.

Returns: True if successful; otherwise false.

Parameters

[in]	inSerialPort	Specifies the RS422 serial port to be affected, expressed as an NTV2Channel (a zero-based index number). Call NTV2DeviceGetNumSerialPorts to determine the number of available serial ports.
[in]	inParity	Specifies if parity should be used, and if so, whether it should be odd or even.

Note: This function only works with programmable RS422 devices.

See also: CNTV2Card::GetRS422Parity, CNTV2Card::SetRS422BaudRate, NTV2DeviceGetNumSerialPorts, NTV2DeviceCanDoProgrammableRS422

Definition at line 4394 of file ntv2register.cpp.

◆ SetSDI1OutHTiming()

bool CNTV2Card::SetSDI1OutHTiming ( ULWord value )

virtual

Definition at line 3332 of file ntv2register.cpp.

◆ SetSDI2OutHTiming()

bool CNTV2Card::SetSDI2OutHTiming ( ULWord value )

virtual

Definition at line 3336 of file ntv2register.cpp.

◆ SetSDIInLevelBtoLevelAConversion() [1/2]

bool CNTV2Card::SetSDIInLevelBtoLevelAConversion	(	const NTV2ChannelSet &	inSDIInputs,
		const bool	inEnable
	)

virtual

Enables or disables 3G level B to 3G level A conversion at the SDI input(s).

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIInputs	Specifies the SDI input(s) to be affected, each specified by an NTV2Channel, a zero-based index (where 0 == SDIIn1, 1 == SDIIn2, etc.).
[in]	inEnable	Specify true to automatically convert incoming 3g level B signals to 3g level A. Specify false for normal operation.

Definition at line 4283 of file ntv2register.cpp.

◆ SetSDIInLevelBtoLevelAConversion() [2/2]

bool CNTV2Card::SetSDIInLevelBtoLevelAConversion	(	const UWord	inInputSpigot,
		const bool	inEnable
	)

virtual

Enables or disables 3G level B to 3G level A conversion at the SDI input widget (assuming the AJA device can do so).

Returns: True if successful; otherwise false.

Parameters

[in]	inInputSpigot	Specifies the SDI input spigot to be affected (where 0 == SDIIn1, 1 == SDIIn2, etc.).
[in]	inEnable	Specify true to automatically convert incoming 3g level B signals to 3g level A. Specify false for normal operation.

Definition at line 4260 of file ntv2register.cpp.

◆ SetSDIOut12GEnable()

bool CNTV2Card::SetSDIOut12GEnable	(	const NTV2Channel	inChannel,
		const bool	inEnable
	)

virtual

Definition at line 3910 of file ntv2register.cpp.

◆ SetSDIOut2Kx1080Enable()

bool CNTV2Card::SetSDIOut2Kx1080Enable	(	const NTV2Channel	inChannel,
		const bool	inIsEnabled
	)

virtual

Definition at line 3842 of file ntv2register.cpp.

◆ SetSDIOut3GbEnable()

bool CNTV2Card::SetSDIOut3GbEnable	(	const NTV2Channel	inChannel,
		const bool	inEnable
	)

virtual

Definition at line 3871 of file ntv2register.cpp.

◆ SetSDIOut3GEnable()

bool CNTV2Card::SetSDIOut3GEnable	(	const NTV2Channel	inChannel,
		const bool	inEnable
	)

virtual

Definition at line 3856 of file ntv2register.cpp.

◆ SetSDIOut6GEnable()

bool CNTV2Card::SetSDIOut6GEnable	(	const NTV2Channel	inChannel,
		const bool	inEnable
	)

virtual

Definition at line 3885 of file ntv2register.cpp.

◆ SetSDIOutLevelAtoLevelBConversion() [1/2]

bool CNTV2Card::SetSDIOutLevelAtoLevelBConversion	(	const NTV2ChannelSet &	inSDIOutputs,
		const bool	inEnable
	)

virtual

Enables or disables 3G level A to 3G level B conversion at the given SDI output(s).

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutputs	Specifies the SDI output(s) to be affected, each specified by an NTV2Channel, a zero-based index (where 0 == SDIOut1, 1 == SDIOut2, etc.).
[in]	inEnable	If true, outgoing 3G level A signal converted to 3G level B signal at SDI output widget. If false, specifies normal operation.

Definition at line 4325 of file ntv2register.cpp.

◆ SetSDIOutLevelAtoLevelBConversion() [2/2]

bool CNTV2Card::SetSDIOutLevelAtoLevelBConversion	(	const UWord	inOutputSpigot,
		const bool	inEnable
	)

virtual

Enables or disables 3G level A to 3G level B conversion at the SDI output widget (assuming the AJA device can do so).

Returns: True if successful; otherwise false.

Parameters

[in]	inOutputSpigot	Specifies the SDI output widget to be affected (where 0 == SDIOut1, 1 == SDIOut2, etc.).
[in]	inEnable	If true, outgoing 3g level a signal converted to 3g level b signal at SDI output widget. If false, specifies normal operation.

Definition at line 4315 of file ntv2register.cpp.

◆ SetSDIOutputAudioSystem() [1/2]

bool CNTV2Card::SetSDIOutputAudioSystem	(	const NTV2Channel	inSDIOutputConnector,
		const NTV2AudioSystem	inAudioSystem
	)

virtual

Sets the device's NTV2AudioSystem that will provide audio for the given SDI output's audio embedder. For 3G-capable SDI outputs, this affects Data Stream 1 (or Link A).

Parameters

[in]	inSDIOutputConnector	Specifies the SDI output connector of interest as an NTV2Channel (a zero-based index number).
[in]	inAudioSystem	Specifies the Audio System to be used (e.g., NTV2_AUDIOSYSTEM_1).

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; Use the NTV2DeviceGetNumVideoOutputs function to determine the number of SDI output jacks the device has.; The Corvid 88 has a firmware limitation where audio systems 5/6/7/8 cannot playback embedded audio on SDIs 1/2/3/4, nor can audio systems 1/2/3/4 playback embedded audio on SDIs 5/6/7/8.

See also: CNTV2Card::GetSDIOutputAudioSystem, CNTV2Card::SetSDIOutputDS2AudioSystem, CNTV2Card::GetSDIOutputDS2AudioSystem, Audio Playout

Definition at line 3949 of file ntv2register.cpp.

◆ SetSDIOutputAudioSystem() [2/2]

bool CNTV2Card::SetSDIOutputAudioSystem	(	const NTV2ChannelSet &	inSDIOutputs,
		const NTV2AudioSystem	inAudioSystem,
		const bool	inDS2 = `(0)`
	)

virtual

Sets the device's NTV2AudioSystem that will provide audio for the given SDI outputs' audio embedders. For 3G-capable SDI outputs, this affects Data Stream 1 (or Link A).

Parameters

[in]	inSDIOutputs	Specifies the SDI output connectors of interest as an NTV2ChannelSet (a set of zero-based index numbers).
[in]	inAudioSystem	Specifies the Audio System to be used (e.g., NTV2_AUDIOSYSTEM_1).
[in]	inDS2	Optionally specifies if Data Stream 2 should be configured. Defaults to false (DS1).

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; Use the NTV2DeviceGetNumVideoOutputs function to determine the number of SDI output jacks the device has.; The Corvid 88 has a firmware limitation where audio systems 5/6/7/8 cannot playback embedded audio on SDIs 1/2/3/4, nor can audio systems 1/2/3/4 playback embedded audio on SDIs 5/6/7/8.

See also: CNTV2Card::GetSDIOutputAudioSystem, CNTV2Card::GetSDIOutputDS2AudioSystem, Audio Playout

Definition at line 3976 of file ntv2register.cpp.

◆ SetSDIOutputDS2AudioSystem()

bool CNTV2Card::SetSDIOutputDS2AudioSystem	(	const NTV2Channel	inSDIOutputConnector,
		const NTV2AudioSystem	inAudioSystem
	)

virtual

Sets the Audio System that will supply audio for the given SDI output's audio embedder for Data Stream 2 (Link B) for dual-link playout.

Parameters

[in]	inSDIOutputConnector	Specifies the SDI output connector of interest as an NTV2Channel (a zero-based index number).
[in]	inAudioSystem	Specifies the Audio System that is to be used by the SDI output's embedder (e.g., NTV2_AUDIOSYSTEM_1).

Returns: True if successful; otherwise false.

Note: Use the NTV2DeviceGetNumAudioSystems function to determine how many independent Audio Systems are available on the device.; The Corvid 88 has a firmware limitation where audio systems 5/6/7/8 cannot playback embedded audio on SDIs 1/2/3/4, nor can audio systems 1/2/3/4 playback embedded audio on SDIs 5/6/7/8.

See also: CNTV2Card::GetSDIOutputAudioSystem, CNTV2Card::SetSDIOutputAudioSystem, CNTV2Card::GetSDIOutputDS2AudioSystem, Audio Playout

Definition at line 4006 of file ntv2register.cpp.

◆ SetSDIOutputStandard() [1/2]

bool CNTV2Card::SetSDIOutputStandard	(	const NTV2ChannelSet &	inSDIOutputs,
		const NTV2Standard	inValue
	)

virtual

Sets the video standard for the given SDI output(s).

Parameters

[in]	inSDIOutputs	Specifies the SDI output connector(s) of interest. Each is a zero-based index number, where zero is "SDIOut1".
[in]	inValue	Specifies the video standard.

Returns: True if successful; otherwise false.

Definition at line 3249 of file ntv2register.cpp.

◆ SetSDIOutputStandard() [2/2]

bool CNTV2Card::SetSDIOutputStandard	(	const UWord	inOutputSpigot,
		const NTV2Standard	inValue
	)

virtual

Sets the SDI output spigot's video standard.

Parameters

[in]	inOutputSpigot	Specifies the SDI output spigot of interest as a zero-based index number, where zero is "SDI Out 1".
[in]	inValue	Specifies the video standard.

Returns: True if successful; otherwise false.

Definition at line 3200 of file ntv2register.cpp.

◆ SetSDIOutRGBLevelAConversion() [1/2]

bool CNTV2Card::SetSDIOutRGBLevelAConversion	(	const NTV2ChannelSet &	inSDIOutputs,
		const bool	inEnable
	)

virtual

Enables or disables an RGB-over-3G-level-A conversion at the given SDI output(s).

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIOutputs	Specifies the SDI output(s) to be affected, each specified by an NTV2Channel, a zero-based index (where 0 == SDIOut1, 1 == SDIOut2, etc.).
[in]	inEnable	If true, perform the conversion at the output SDI spigot; otherwise have the SDI output spigot operate normally (no conversion).

Definition at line 4357 of file ntv2register.cpp.

◆ SetSDIOutRGBLevelAConversion() [2/2]

bool CNTV2Card::SetSDIOutRGBLevelAConversion	(	const UWord	inOutputSpigot,
		const bool	inEnable
	)

virtual

Enables or disables an RGB-over-3G-level-A conversion at the SDI output widget (assuming the AJA device can do so).

Returns: True if successful; otherwise false.

Parameters

[in]	inOutputSpigot	Specifies the SDI output to be affected (where 0 == SDIOut1, 1 == SDIOut2, etc.).
[in]	inEnable	If true, perform the conversion at the output SDI spigot; otherwise have the SDI output spigot operate normally (no conversion).

Definition at line 4347 of file ntv2register.cpp.

◆ SetSDIOutVPID()

bool CNTV2Card::SetSDIOutVPID	(	const ULWord	inValueA,
		const ULWord	inValueB,
		const UWord	inOutputSpigot = `NTV2_CHANNEL1`
	)

virtual

Definition at line 135 of file ntv2regvpid.cpp.

◆ SetSDIRelayManualControl()

bool CNTV2Card::SetSDIRelayManualControl	(	const NTV2RelayState	inValue,
		const UWord	inIndex0
	)

virtual

Sets the state of the given connector pair relays to NTV2_DEVICE_BYPASSED (or NTV2_THROUGH_DEVICE if under manual control).

Parameters

[in]	inValue	Specifies the desired relay state.
[in]	inIndex0	Specifies the relay/connector pair of interest. Use 0 for SDI 1&2, or 1 for SDI 3&4.

Returns: True if successful; otherwise false.

Note: Manual control won't change the state of the relays if the watchdog timer for the relays is enabled. Because this call modifies the control register, it sends a "kick" sequence, which has the side effect of restarting the timeout counter.

Definition at line 4099 of file ntv2register.cpp.

◆ SetSDITransmitEnable() [1/2]

bool CNTV2Card::SetSDITransmitEnable	(	const NTV2Channel	inChannel,
		const bool	inEnable
	)

virtual

Sets the specified bidirectional SDI connector to act as an input or an output.

Returns: True if successful; otherwise false.

Parameters

[in]	inChannel	Specifies the SDI connector as an NTV2Channel (a zero-based index number).
[in]	inEnable	If true, specifies that the channel connector is to be used as an output. If false, specifies it's to be used as an input.

Note: After switching a bidirectional SDI connector from output to input (i.e., inEnable = false), it may take the hardware on the device up to approximately 10 frames to synchronize with the input signal such that the device can accurately report the video format seen at the input.

See also: NTV2DeviceHasBiDirectionalSDI, Signal Inputs & Outputs

Definition at line 3796 of file ntv2register.cpp.

◆ SetSDITransmitEnable() [2/2]

bool CNTV2Card::SetSDITransmitEnable	(	const NTV2ChannelSet &	inSDIConnectors,
		const bool	inEnable
	)

virtual

Sets the specified SDI connector(s) to act as an input or an output.

Returns: True if successful; otherwise false.

Parameters

[in]	inSDIConnectors	Specifies the SDI connector(s) to be affected.
[in]	inEnable	If true, specifies that the channel connector is to be used as an output. If false, specifies it's to be used as an input.

Note: After switching a bidirectional SDI connector from output to input (i.e., inEnable = false), it may take the hardware on the device up to approximately 10 frames to synchronize with the input signal such that the device can accurately report the video format seen at the input.

See also: NTV2DeviceHasBiDirectionalSDI, Signal Inputs & Outputs

Definition at line 3808 of file ntv2register.cpp.

◆ SetSDIWatchdogEnable()

bool CNTV2Card::SetSDIWatchdogEnable	(	const bool	inEnable,
		const UWord	inIndex0
	)

virtual

Sets the connector pair relays to be under watchdog timer control or manual control.

Parameters

[in]	inEnable	Specify true to have the watchdog timer control the relays. Specify false to manually control the relays.
[in]	inIndex0	Specifies the relay/connector pair of interest. Use 0 for SDI 1&2, or 1 for SDI 3&4.

Returns: True if successful; otherwise false.

Note: Because this call modifies the control register, it sends a kick sequence, which restarts the timeout counter.; If the board's jumpers aren't set in the position to enable the watchdog timer, this call will have no effect. See the Hardware Jumpers section in the Corvid 24 documentation for more information.

Definition at line 4127 of file ntv2register.cpp.

◆ SetSDIWatchdogTimeout()

bool CNTV2Card::SetSDIWatchdogTimeout ( const ULWord inValue )

virtual

Specifies the amount of time that must elapse before the watchdog timer times out.

Parameters

[in] inValue Specifies the timeout interval in units of 8 nanoseconds.

Returns: True if successful; otherwise false.

Note: The timeout interval begins or is reset when a kick sequence is received. This call resets the timeout counter to zero, which will then start counting until this value is reached, triggering the watchdog timer (if it's enabled).

Definition at line 4147 of file ntv2register.cpp.

◆ SetSecondaryVideoFormat()

bool CNTV2Card::SetSecondaryVideoFormat ( NTV2VideoFormat inFormat )

virtual

Definition at line 3339 of file ntv2register.cpp.

◆ SetSmpte372()

bool CNTV2Card::SetSmpte372	(	ULWord	inValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Enables or disables the device's SMPTE-372 (dual-link) mode (used for older 3G-levelB-capable devices).

Note: This allows older devices to handle 1080p60/1080p5994/1080p50 signals by "ganging" two 30Hz FrameStores. See Dual-Link and 3G Overview for more information.; The enable bits work on channel pairs, thus a parameter of NTV2_CHANNEL1 or NTV2_CHANNEL2 refers to the same control bit.

Returns: True if successful; otherwise false.

Parameters

[in]	inValue	Specify a non-zero value (true) to put the device into SMPTE 372 dual-link mode.
[in]	inChannel	Specifies the channel of interest. Defaults to channel 1.

Todo:

Should use bool parameter instead of a ULWord.

Should be named SetSMPTE372Enable.

Definition at line 1043 of file ntv2register.cpp.

◆ SetStandard()

bool CNTV2Card::SetStandard	(	NTV2Standard	inValue,
		NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Definition at line 807 of file ntv2register.cpp.

◆ SetStereoCompressorFlipLeftHorz()

bool CNTV2Card::SetStereoCompressorFlipLeftHorz ( const ULWord inNewValue )

virtual

Definition at line 446 of file ntv2regconv.cpp.

◆ SetStereoCompressorFlipLeftVert()

bool CNTV2Card::SetStereoCompressorFlipLeftVert ( const ULWord inNewValue )

virtual

Definition at line 448 of file ntv2regconv.cpp.

◆ SetStereoCompressorFlipMode()

bool CNTV2Card::SetStereoCompressorFlipMode ( const ULWord inNewValue )

virtual

Definition at line 444 of file ntv2regconv.cpp.

◆ SetStereoCompressorFlipRightHorz()

bool CNTV2Card::SetStereoCompressorFlipRightHorz ( const ULWord inNewValue )

virtual

Definition at line 450 of file ntv2regconv.cpp.

◆ SetStereoCompressorFlipRightVert()

bool CNTV2Card::SetStereoCompressorFlipRightVert ( const ULWord inNewValue )

virtual

Definition at line 452 of file ntv2regconv.cpp.

◆ SetStereoCompressorLeftSource()

bool CNTV2Card::SetStereoCompressorLeftSource ( const NTV2OutputCrosspointID inNewValue )

virtual

Definition at line 456 of file ntv2regconv.cpp.

◆ SetStereoCompressorOutputMode()

bool CNTV2Card::SetStereoCompressorOutputMode ( const NTV2StereoCompressorOutputMode inNewValue )

virtual

Definition at line 442 of file ntv2regconv.cpp.

◆ SetStereoCompressorRightSource()

bool CNTV2Card::SetStereoCompressorRightSource ( const NTV2OutputCrosspointID inNewValue )

virtual

Definition at line 458 of file ntv2regconv.cpp.

◆ SetStereoCompressorStandard()

bool CNTV2Card::SetStereoCompressorStandard ( const NTV2Standard inNewValue )

virtual

Definition at line 454 of file ntv2regconv.cpp.

◆ SetSuspendHostAudio()

bool CNTV2Card::SetSuspendHostAudio ( const bool inSuspend )

virtual

Suspends or resumes host OS audio (e.g. CoreAudio on MacOS) for the AJA device.

Parameters

[in] inSuspend If true, suspends host OS audio for the AJA device; otherwise, resumes it.

Returns: True if successful; otherwise false.

Note: This function is currently only implemented on MacOS, and is used to suspend or resume CoreAudio when an application uses AutoCirculate to capture or play audio, to keep the two Audio Systems from conflicting with each other.

Definition at line 1384 of file ntv2audio.cpp.

◆ SetTsiFrameEnable()

bool CNTV2Card::SetTsiFrameEnable	(	const bool	inIsEnabled,
		const NTV2Channel	inChannel
	)

virtual

Enables or disables SMPTE 425 two-sample interleave (Tsi) frame mode on the device.

Returns: True if successful; otherwise false.

Parameters

[in]	inIsEnabled	Specify true to put the device's FrameStores into two-sample interleave (Tsi) mode. Specify false to put the device's FrameStores into non-Tsi mode.
[in]	inChannel	Specifies the FrameStore bank of interest. Using anything ordinally less than NTV2_CHANNEL5 will affect FrameStores 1/2/3/4, while anything ordinally greater than NTV2_CHANNEL4 will affect FrameStores 5/6/7/8.

Note: Since Tsi is the default 4K mode, there's no need to call this function if Set4kSquaresEnable(false) was called.

Definition at line 1311 of file ntv2register.cpp.

◆ SetUCAutoLine21()

bool CNTV2Card::SetUCAutoLine21 ( const ULWord inValue )

virtual

Definition at line 42 of file ntv2regconv.cpp.

◆ SetUCPassLine21()

bool CNTV2Card::SetUCPassLine21 ( const ULWord inValue )

virtual

Definition at line 40 of file ntv2regconv.cpp.

◆ SetUpConvertMode()

bool CNTV2Card::SetUpConvertMode ( const NTV2UpConvertMode inValue )

virtual

Definition at line 12 of file ntv2regconv.cpp.

◆ SetVANCMode() [1/3]

bool CNTV2Card::SetVANCMode	(	const NTV2ChannelSet &	inChannels,
		const NTV2VANCMode	inVancMode
	)

virtual

Sets the VANC mode for the given FrameStores.

Parameters

[in]	inChannels	Specifies the FrameStores of interest as any number of NTV2Channel values, each a zero-based index number.
[in]	inVancMode	Specifies the new NTV2VANCMode setting.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetVANCMode, VANC Frame Geometries

Definition at line 2630 of file ntv2register.cpp.

◆ SetVANCMode() [2/3]

bool CNTV2Card::SetVANCMode	(	const NTV2VANCMode	inVancMode,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Sets the VANC mode for the given FrameStore.

Parameters

[in]	inVancMode	Specifies the new NTV2VANCMode setting.
[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetVANCMode, VANC Frame Geometries

Definition at line 2640 of file ntv2register.cpp.

◆ SetVANCMode() [3/3]

virtual bool CNTV2Card::SetVANCMode	(	const NTV2VANCMode	inVancMode,
		const NTV2Standard	st,
		const NTV2FrameGeometry	fg,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

inlinevirtual

Definition at line 1203 of file ntv2card.h.

◆ SetVANCShiftMode() [1/2]

bool CNTV2Card::SetVANCShiftMode	(	NTV2Channel	inChannel,
		NTV2VANCDataShiftMode	inMode
	)

virtual

Enables or disables the "VANC Shift Mode" feature for the given channel.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel, a zero-based index number.
[in]	inMode	Specifies the new data shift mode. Use NTV2_VANCDATA_NORMAL to disable; use NTV2_VANCDATA_8BITSHIFT_ENABLE to enable.

Returns: True if successful; otherwise false.

Note

The bit shift feature only affects VANC lines (not visible raster lines) and only when the device FrameStore is configured as follows:

video format is set for an HD format (see NTV2_IS_HD_VIDEO_FORMAT macro) – not SD or 4K/UHD;
pixel format is set for NTV2_FBF_8BIT_YCBCR;
VANC mode is set to NTV2_VANCMODE_TALL or NTV2_VANCMODE_TALLER (see CNTV2Card::SetVANCMode).

See also: CNTV2Card::GetVANCShiftMode, CNTV2Card::GetVANCMode, CNTV2Card::SetVANCMode, VANC Frame Geometries

Definition at line 2800 of file ntv2register.cpp.

◆ SetVANCShiftMode() [2/2]

bool CNTV2Card::SetVANCShiftMode	(	NTV2ChannelSet &	inChannels,
		const NTV2VANCDataShiftMode	inMode
	)

virtual

Sets the "VANC Shift Mode" for the given channel(s).

Parameters

[in]	inChannels	Specifies the FrameStore(s) of interest as NTV2Channel values (zero-based index numbers).
[in]	inMode	Specifies the new data shift mode. Use NTV2_VANCDATA_NORMAL to disable; use NTV2_VANCDATA_8BITSHIFT_ENABLE to enable.

Returns: True if successful; otherwise false.

Note

The bit shift feature only affects VANC lines (not visible raster lines) and only when the device FrameStore is configured as follows:

video format is set for an HD format (see NTV2_IS_HD_VIDEO_FORMAT macro) – not SD or 4K/UHD;
pixel format is set for NTV2_FBF_8BIT_YCBCR;
VANC mode is set to NTV2_VANCMODE_TALL or NTV2_VANCMODE_TALLER (see CNTV2Card::SetVANCMode).

See also: CNTV2Card::GetVANCShiftMode, CNTV2Card::GetVANCMode, CNTV2Card::SetVANCMode, VANC Frame Geometries

Definition at line 2811 of file ntv2register.cpp.

◆ SetVideoDACMode()

bool CNTV2Card::SetVideoDACMode ( NTV2VideoDACMode inValue )

virtual

Definition at line 3195 of file ntv2register.cpp.

◆ SetVideoFormat() [1/2]

bool CNTV2Card::SetVideoFormat	(	const NTV2ChannelSet &	inFrameStores,
		const NTV2VideoFormat	inVideoFormat,
		const bool	inIsAJARetail = `(! (0) )`
	)

virtual

Sets the video format for one or more FrameStores.

Parameters

[in]	inFrameStores	Specifies the FrameStore(s) of interest as a channel-set (a set of zero-based index numbers).
[in]	inVideoFormat	Specifies the desired video format. It must be a valid NTV2VideoFormat constant.
[in]	inIsAJARetail	Specify 'true' to preserve the current horizontal and vertical timing settings. Defaults to true on MacOS, false on other platforms.

Returns: True if successful; otherwise false.

This function changes the device configuration to a specific video standard (e.g., 525, 1080, etc.), frame geometry (e.g., 1920x1080, 720x486, etc.) and frame rate (e.g., 59.94 fps, 29.97 fps, etc.), plus a few other settings (e.g., progressive/interlaced, etc.), all based on the given video format.

Definition at line 323 of file ntv2register.cpp.

◆ SetVideoFormat() [2/2]

bool CNTV2Card::SetVideoFormat	(	const NTV2VideoFormat	inVideoFormat,
		const bool	inIsAJARetail = `(! (0) )`,
		const bool	inKeepVancSettings = `(0)`,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Configures the AJA device to handle a specific video format.

Parameters

[in]	inVideoFormat	Specifies the desired video format for the given channel on the device. It must be a valid NTV2VideoFormat constant.
[in]	inIsAJARetail	Specify 'true' to preserve the current horizontal and vertical timing settings. Defaults to true on MacOS, false on other platforms.
[in]	inKeepVancSettings	If true, specifies that the device's current VANC settings are to be preserved; otherwise, they will not be preserved. Defaults to false.
[in]	inChannel	Specifies the NTV2Channel of interest. Defaults to NTV2_CHANNEL1. For UHD/4K video formats, specify NTV2_CHANNEL1 to configure quadrant channels 1-4, or NTV2_CHANNEL5 to configure quadrant channels 5-8.

Returns: True if successful; otherwise false.

This function changes the device configuration to a specific video standard (e.g., 525, 1080, etc.), frame geometry (e.g., 1920x1080, 720x486, etc.) and frame rate (e.g., 59.94 fps, 29.97 fps, etc.), plus a few other settings (e.g., progressive/interlaced, etc.), all based on the given video format.

Definition at line 204 of file ntv2register.cpp.

◆ SetVideoHOffset()

bool CNTV2Card::SetVideoHOffset	(	const int	inHOffset,
		const UWord	inOutputSpigot = `0`
	)

virtual

Adjusts the horizontal timing offset, in pixels, for the given SDI output connector.

Parameters

[in]	inHOffset	Specifies the horizontal output timing offset, a signed value, in pixels after or before the nominal value.
[in]	inOutputSpigot	(Added in SDK v16.1) Optionally specifies the SDI output connector of interest. Defaults to 0 (SDI Out 1).

Note: The output timing can only be adjusted when the device's reference source is set for external reference.; The "inOutputSpigot" parameter is respected only if the device is multi-format-capable (see NTV2DeviceCanDoMultiFormat) and the device is currently in multi-format mode (see CNTV2Card::GetMultiFormatMode and CNTV2Card::SetMultiFormatMode). Otherwise, this function sets the horizontal timing offset for SDI Output 1 (i.e., the "global" output timing).

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetVideoHOffset, CNTV2Card::SetVideoVOffset

Definition at line 616 of file ntv2register.cpp.

◆ SetVideoLimiting()

bool CNTV2Card::SetVideoLimiting ( const NTV2VideoLimiting inValue )

virtual

Sets the device's video range limiting mode.

Parameters

[in] outValue Specifies the NTV2VideoLimiting setting to be used.

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetVideoLimiting

Definition at line 2609 of file ntv2register.cpp.

◆ SetVideoVOffset()

bool CNTV2Card::SetVideoVOffset	(	const int	inVOffset,
		const UWord	inOutputSpigot = `0`
	)

virtual

Adjusts the vertical timing offset, in lines, for the given SDI output connector.

Parameters

[in]	inVOffset	Specifies the vertical output timing offset, a signed value, in lines after or before the nominal value.
[in]	inOutputSpigot	(Added in SDK v16.1) Optionally specifies the SDI output connector of interest. Defaults to 0 (SDI Out 1).

Note: The output timing can only be adjusted when the device's reference source is set for external reference.; The "inOutputSpigot" parameter is respected only if the device is multi-format-capable (see NTV2DeviceCanDoMultiFormat) and the device is currently in multi-format mode (see CNTV2Card::GetMultiFormatMode and CNTV2Card::SetMultiFormatMode). Otherwise, this function sets the vertical timing offset for SDI Output 1 (i.e., the "global" output timing).

Returns: True if successful; otherwise false.

See also: CNTV2Card::GetVideoVOffset, CNTV2Card::SetVideoHOffset

Definition at line 723 of file ntv2register.cpp.

◆ SetVPIDColorimetry()

bool CNTV2Card::SetVPIDColorimetry	(	const NTV2VPIDColorimetry	inValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 183 of file ntv2regvpid.cpp.

◆ SetVPIDLuminance()

bool CNTV2Card::SetVPIDLuminance	(	const NTV2VPIDLuminance	inValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 193 of file ntv2regvpid.cpp.

◆ SetVPIDRGBRange()

bool CNTV2Card::SetVPIDRGBRange	(	const NTV2VPIDRGBRange	inValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 203 of file ntv2regvpid.cpp.

◆ SetVPIDTransferCharacteristics()

bool CNTV2Card::SetVPIDTransferCharacteristics	(	const NTV2VPIDTransferCharacteristics	inValue,
		const NTV2Channel	inChannel
	)

virtual

Definition at line 173 of file ntv2regvpid.cpp.

◆ SetWarmBootFirmwareReload()

bool CNTV2Card::SetWarmBootFirmwareReload ( bool enable )

protectedvirtual

Definition at line 4546 of file ntv2register.cpp.

◆ StartAudioInput()

bool CNTV2Card::StartAudioInput	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inWaitForVBI = `(0)`
	)

virtual

Starts the capture side of the given NTV2AudioSystem, writing incoming audio samples into the Audio System's capture buffer.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inWaitForVBI	If 'false', the default, immediately starts writing captured audio samples into the capture buffer. If 'true', checks if the required firmware feature is present, and if so, waits until the next input VBI before starting to write captured samples into the capture buffer.

Note: It is not an error to call this function when the Audio System's capture side is already running.; Applications using AutoCirculate won't need to call this function, since AutoCirculate configures the Audio System automatically.

See also: CNTV2Card::StopAudioInput, CNTV2Card::IsAudioInputRunning, Audio Capture

Definition at line 1108 of file ntv2audio.cpp.

◆ StartAudioOutput()

bool CNTV2Card::StartAudioOutput	(	const NTV2AudioSystem	inAudioSystem,
		const bool	inWaitForVBI = `(0)`
	)

virtual

Starts the playout side of the given NTV2AudioSystem, reading outgoing audio samples from the Audio System's playout buffer.

Returns: True if successful; otherwise false.

Parameters

[in]	inAudioSystem	Specifies the Audio System of interest.
[in]	inWaitForVBI	If 'false', the default, immediately starts reading audio samples from the playout buffer and inserting into the HANC stream. If 'true', checks if the required firmware feature is present, and if so, waits until the next output VBI before starting to read samples from the playout buffer.

Note: It is not an error to call this function when the Audio System's playout side is already running.; Applications using AutoCirculate won't need to call this function, since AutoCirculate configures the Audio System automatically.

See also: CNTV2Card::StopAudioOutput, CNTV2Card::IsAudioOutputRunning, CNTV2Card::CanDoAudioWaitForVBI, Audio Playout

Definition at line 1019 of file ntv2audio.cpp.

◆ StopAudioInput()

bool CNTV2Card::StopAudioInput ( const NTV2AudioSystem inAudioSystem )

virtual

Stops the capture side of the given NTV2AudioSystem, and resets the capture position (i.e. "Write Head") back to the start of the Audio System's capture buffer (offset zero). This can be useful for resynchronizing audio and video.

Returns: True if successful; otherwise false.

Parameters

[in] inAudioSystem Specifies the Audio System of interest.

Note: It is not an error to call this function when the Audio System's capture side is already stopped.; Applications using AutoCirculate won't need to call this function, since AutoCirculate configures the Audio System automatically.

See also: CNTV2Card::StartAudioInput, CNTV2Card::IsAudioInputRunning, Audio Capture

Definition at line 1150 of file ntv2audio.cpp.

◆ StopAudioOutput()

bool CNTV2Card::StopAudioOutput ( const NTV2AudioSystem inAudioSystem )

virtual

Stops the playout side of the given NTV2AudioSystem, parking the "Read Head" at the start of the playout buffer.

Returns: True if successful; otherwise false.

Parameters

[in] inAudioSystem Specifies the Audio System of interest.

Note: It is not an error to call this function when the Audio System's playout side is already stopped.; Applications using AutoCirculate won't need to call this function, since AutoCirculate configures the Audio System automatically.

See also: CNTV2Card::StartAudioOutput, CNTV2Card::IsAudioOutputRunning, Audio Playout

Definition at line 1060 of file ntv2audio.cpp.

◆ StreamBufferQueue()

ULWord CNTV2Card::StreamBufferQueue	(	const NTV2Channel	inChannel,
		NTV2Buffer &	inBuffer,
		ULWord64	bufferCookie,
		NTV2StreamBuffer &	status
	)

virtual

Queue a buffer to the stream. The bufferCookie is a user defined identifier of the buffer used by the stream methods.

Returns: The queued buffer status.

Definition at line 67 of file ntv2stream.cpp.

◆ StreamBufferRelease()

ULWord CNTV2Card::StreamBufferRelease	(	const NTV2Channel	inChannel,
		NTV2StreamBuffer &	status
	)

virtual

Remove the oldest buffer released by the streaming engine from the buffer queue.

Returns: The removed buffer status.

Definition at line 77 of file ntv2stream.cpp.

◆ StreamBufferStatus()

ULWord CNTV2Card::StreamBufferStatus	(	const NTV2Channel	inChannel,
		ULWord64	bufferCookie,
		NTV2StreamBuffer &	status
	)

virtual

Get the status of the buffer identified by the bufferCookie.

Returns: The buffer status.

Definition at line 86 of file ntv2stream.cpp.

◆ StreamChannelFlush()

ULWord CNTV2Card::StreamChannelFlush	(	const NTV2Channel	inChannel,
		NTV2StreamChannel &	status
	)

virtual

Flush a stream. Remove all the buffers from the stream except a currently active idle buffer. The stream must be in the initialize or idle state.

Returns: The current stream status.

Definition at line 43 of file ntv2stream.cpp.

◆ StreamChannelInitialize()

ULWord CNTV2Card::StreamChannelInitialize ( const NTV2Channel inChannel )

virtual

Initialize a stream. Put the stream queue and hardware in a known good state ready for use. Releases all buffers remaining in the queue. At least one new buffer must be queued before starting the stream.

Definition at line 11 of file ntv2stream.cpp.

◆ StreamChannelRelease()

ULWord CNTV2Card::StreamChannelRelease ( const NTV2Channel inChannel )

virtual

Release a stream. Releases all buffers remaining in the queue.

Definition at line 19 of file ntv2stream.cpp.

◆ StreamChannelStart()

ULWord CNTV2Card::StreamChannelStart	(	const NTV2Channel	inChannel,
		NTV2StreamChannel &	status
	)

virtual

Start a stream. Put the stream is the active state to start processing queued buffers. For frame based video, the stream will start with the current buffer on the next frame sync.

Returns: The current stream status.

Definition at line 27 of file ntv2stream.cpp.

◆ StreamChannelStatus()

ULWord CNTV2Card::StreamChannelStatus	(	const NTV2Channel	inChannel,
		NTV2StreamChannel &	status
	)

virtual

Get the current stream status.

Returns: The current stream status.

Definition at line 51 of file ntv2stream.cpp.

◆ StreamChannelStop()

ULWord CNTV2Card::StreamChannelStop	(	const NTV2Channel	inChannel,
		NTV2StreamChannel &	status
	)

virtual

Stop a stream. Put the stream is the idle state. For frame based video, the stream will idle on the buffer on air after the next frame sync.

Returns: The current stream status.

Definition at line 35 of file ntv2stream.cpp.

◆ StreamChannelWait()

ULWord CNTV2Card::StreamChannelWait	(	const NTV2Channel	inChannel,
		NTV2StreamChannel &	status
	)

virtual

Wait for any stream event. Returns for any state or buffer change.

Returns: The current stream status.

Definition at line 59 of file ntv2stream.cpp.

◆ SubscribeEvent()

bool CNTV2Card::SubscribeEvent ( const INTERRUPT_ENUMS inEventCode )

virtual

Causes me to be notified when the given event/interrupt is triggered for the AJA device.

Parameters

[in] inEventCode Specifies the INTERRUPT_ENUMS of interest.

Returns: True if successful; otherwise false, which can indicate communication with the device has been lost, or on the Windows platform, there are no more event subscription handles available.

See also: CNTV2Card::UnsubscribeEvent, Field/Frame Interrupts

Definition at line 19 of file ntv2subscriptions.cpp.

◆ SubscribeInputVerticalEvent() [1/2]

bool CNTV2Card::SubscribeInputVerticalEvent ( const NTV2Channel inChannel = NTV2_CHANNEL1 )

virtual

Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel.

Parameters

[in] inChannel Specifies the input channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false, which can indicate communication with the device has been lost, or on the Windows platform, there are no more event subscription handles available.

Note: Windows Users: AJA recommends calling this function on the same thread that will call CNTV2Card::WaitForInputVerticalInterrupt or CNTV2Card::WaitForInputFieldID.

See also: CNTV2Card::UnsubscribeInputVerticalEvent, CNTV2Card::SubscribeEvent, Field/Frame Interrupts

Definition at line 39 of file ntv2subscriptions.cpp.

◆ SubscribeInputVerticalEvent() [2/2]

bool CNTV2Card::SubscribeInputVerticalEvent ( const NTV2ChannelSet & inChannels )

virtual

Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel(s).

Parameters

[in] inChannels Specifies the input channel(s) of interest.

Returns: True if successful; otherwise false, which can indicate communication with the device has been lost, or on the Windows platform, there are no more event subscription handles available.

Note: Windows Users: AJA recommends calling this function on the same thread that will call CNTV2Card::WaitForInputVerticalInterrupt or CNTV2Card::WaitForInputFieldID.

See also: CNTV2Card::UnsubscribeInputVerticalEvent, CNTV2Card::SubscribeEvent, Field/Frame Interrupts

Definition at line 44 of file ntv2subscriptions.cpp.

◆ SubscribeOutputVerticalEvent() [1/2]

bool CNTV2Card::SubscribeOutputVerticalEvent ( const NTV2Channel inChannel )

virtual

Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel.

Parameters

[in] inChannel Specifies the output channel of interest.

Returns: True if successful; otherwise false, which can indicate communication with the device has been lost, or on the Windows platform, there are no more event subscription handles available.

Note: Windows Users: AJA recommends calling this function on the same thread that will call CNTV2Card::WaitForOutputVerticalInterrupt or CNTV2Card::WaitForOutputFieldID.

See also: CNTV2Card::UnsubscribeOutputVerticalEvent, CNTV2Card::SubscribeEvent, Field/Frame Interrupts

Definition at line 25 of file ntv2subscriptions.cpp.

◆ SubscribeOutputVerticalEvent() [2/2]

bool CNTV2Card::SubscribeOutputVerticalEvent ( const NTV2ChannelSet & inChannels )

virtual

Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel(s).

Parameters

[in] inChannels Specifies the output channel(s) of interest.

Returns: True if successful; otherwise false, which can indicate communication with the device has been lost, or on the Windows platform, there are no more event subscription handles available.

Note: Windows Users: AJA recommends calling this function on the same thread that will call CNTV2Card::WaitForOutputVerticalInterrupt or CNTV2Card::WaitForOutputFieldID.

See also: CNTV2Card::UnsubscribeOutputVerticalEvents, CNTV2Card::SubscribeEvent, Field/Frame Interrupts

Definition at line 30 of file ntv2subscriptions.cpp.

◆ SupportsP2PTarget()

bool CNTV2Card::SupportsP2PTarget ( void )

virtual

Returns: True if this device can directly receive data from another PCIe device via DMA; otherwise false.

Definition at line 2427 of file ntv2register.cpp.

◆ SupportsP2PTransfer()

bool CNTV2Card::SupportsP2PTransfer ( void )

virtual

Returns: True if this device can directly transmit data to another PCIe device via DMA; otherwise false.

Definition at line 2405 of file ntv2register.cpp.

◆ UnsubscribeEvent()

bool CNTV2Card::UnsubscribeEvent ( const INTERRUPT_ENUMS inEventCode )

virtual

Unregisters me so I'm no longer notified when the given event/interrupt is triggered on the AJA device.

Parameters

[in] inEventCode Specifies the INTERRUPT_ENUMS of interest.

Returns: True if successful; otherwise false.

See also: CNTV2Card::SubscribeEvent, Field/Frame Interrupts

Definition at line 55 of file ntv2subscriptions.cpp.

◆ UnsubscribeInputVerticalEvent() [1/2]

bool CNTV2Card::UnsubscribeInputVerticalEvent ( const NTV2Channel inChannel = NTV2_CHANNEL1 )

virtual

Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel.

Parameters

[in] inChannel Specifies the input channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

This function undoes the effects of a prior call to SubscribeInputVerticalEvent.

See also: CNTV2Card::SubscribeInputVerticalEvent, CNTV2Card::UnsubscribeEvent, Field/Frame Interrupts

Definition at line 75 of file ntv2subscriptions.cpp.

◆ UnsubscribeInputVerticalEvent() [2/2]

bool CNTV2Card::UnsubscribeInputVerticalEvent ( const NTV2ChannelSet & inChannels )

virtual

Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel(s).

Parameters

[in] inChannels Specifies the input channel(s) of interest.

Returns: True if successful; otherwise false.

This function undoes the effects of a prior call to SubscribeInputVerticalEvents.

See also: CNTV2Card::SubscribeInputVerticalEvents, CNTV2Card::UnsubscribeEvent, Field/Frame Interrupts

Definition at line 80 of file ntv2subscriptions.cpp.

◆ UnsubscribeOutputVerticalEvent() [1/2]

bool CNTV2Card::UnsubscribeOutputVerticalEvent ( const NTV2Channel inChannel )

virtual

Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel.

Parameters

[in] inChannel Specifies the output channel of interest. Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false.

This function undoes the effect of a prior call to SubscribeOutputVerticalEvent.

See also: CNTV2Card::SubscribeOutputVerticalEvent, CNTV2Card::UnsubscribeEvent, Field/Frame Interrupts

Definition at line 61 of file ntv2subscriptions.cpp.

◆ UnsubscribeOutputVerticalEvent() [2/2]

bool CNTV2Card::UnsubscribeOutputVerticalEvent ( const NTV2ChannelSet & inChannels )

virtual

Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel(s).

Parameters

[in] inChannels Specifies the output channel(s) of interest.

Returns: True if successful; otherwise false.

This function undoes the effect of a prior call to SubscribeOutputVerticalEvents.

See also: CNTV2Card::SubscribeOutputVerticalEvents, CNTV2Card::UnsubscribeEvent, Field/Frame Interrupts

Definition at line 66 of file ntv2subscriptions.cpp.

◆ WaitForInputFieldID()

bool CNTV2Card::WaitForInputFieldID	(	const NTV2FieldID	inFieldID,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Efficiently sleeps the calling thread/process until the next input VBI for the given field and input channel.

Parameters

[in]	inFieldID	Specifies the field identifier of interest. Use NTV2_FIELD0 to wait for the frame interrupt of progressive or interlaced video. Use NTV2_FIELD1 to wait for the field interrupt of interlaced or Psf video.
[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.

Returns: True if successful; otherwise false. A false result usually indicates the wait timed out, which is often due to the FrameStore being configured for playout, or if its input is not receiving a valid signal.

Bug:

On the Windows platform, the SDK uses an event to wait on, which only gets cleared by a previous call to Wait. Unfortunately, this is historically different from Linux and MacOS, where the event is always cleared before the Wait. Each method has advantages and disadvantages. To work around this:

Call GetInputVerticalInterruptCount before and after calling this function to verify that an interrupt really occurred;
Call CNTV2WinDriverInterface::GetInterruptEvent to get the event handle, and manually clear the event before calling this function.

See also: CNTV2Card::WaitForInputVerticalInterrupt, Field/Frame Interrupts, Video Output Clocking & Synchronization

Definition at line 214 of file ntv2subscriptions.cpp.

◆ WaitForInputVerticalInterrupt()

bool CNTV2Card::WaitForInputVerticalInterrupt	(	const NTV2Channel	inChannel = `NTV2_CHANNEL1`,
		UWord	inRepeatCount = `1`
	)

virtual

Efficiently sleeps the calling thread/process until the next one or more field (interlaced video) or frame (progressive or interlaced video) VBIs occur for the specified input channel.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1.
[in]	inRepeatCount	Specifies the number of input VBIs to wait for until returning. Defaults to 1.

Returns: True if successful; otherwise false. A false result usually indicates the wait timed out, which is often due to the FrameStore being configured for playout, or if its input is not receiving a valid signal.

Bug:

On the Windows platform, the SDK uses an event to wait on, which only gets cleared by a previous call to Wait. Unfortunately, this is historically different from Linux and MacOS, where the event is always cleared before the Wait. Each method has advantages and disadvantages. To work around this:

Call GetInputVerticalInterruptCount before and after calling this function to verify that an interrupt really occurred;
Call CNTV2WinDriverInterface::GetInterruptEvent to get the event handle, and manually clear the event before calling this function.

See also: CNTV2Card::WaitForInputFieldID, Field/Frame Interrupts, Video Output Clocking & Synchronization

Definition at line 149 of file ntv2subscriptions.cpp.

◆ WaitForOutputFieldID()

bool CNTV2Card::WaitForOutputFieldID	(	const NTV2FieldID	inFieldID,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Efficiently sleeps the calling thread/process until the next output VBI for the given field and output channel.

Parameters

[in]	inFieldID	Specifies the field identifier of interest. Use NTV2_FIELD0 to wait for the frame interrupt of progressive or interlaced video. Use NTV2_FIELD1 to wait for the field interrupt of interlaced video.
[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1. Note that this parameter is irrelevant for all currently supported NTV2 devices, which use one common hardware clock that drives all SDI outputs.

Returns: True if successful; otherwise false. A false result usually indicates the wait timed out.

Note: The device's timing reference source affects how often – or even if – the VBI occurs. See Video Output Clocking & Synchronization for more information.

Bug:

On the Windows platform, the SDK uses an event to wait on, which only gets cleared by a prior call to CNTV2Card::WaitForOutputFieldID. This is historically different from Linux and MacOS, where the event is always cleared before the Wait. Each method has advantages and disadvantages. To work around this:

Call CNTV2Card::GetOutputVerticalInterruptCount before and after calling this function to verify that an interrupt really occurred;
Call CNTV2WinDriverInterface::GetInterruptEvent to get the event handle, and manually clear the event before calling this function.

See also: CNTV2Card::WaitForOutputVerticalInterrupt, Field/Frame Interrupts, Video Output Clocking & Synchronization

Definition at line 180 of file ntv2subscriptions.cpp.

◆ WaitForOutputVerticalInterrupt()

bool CNTV2Card::WaitForOutputVerticalInterrupt	(	const NTV2Channel	inChannel = `NTV2_CHANNEL1`,
		UWord	inRepeatCount = `1`
	)

virtual

Efficiently sleeps the calling thread/process until the next one or more field (interlaced video) or frame (progressive or interlaced video) VBIs occur for the specified output channel.

Parameters

[in]	inChannel	Specifies the FrameStore of interest as an NTV2Channel (a zero-based index number). Defaults to NTV2_CHANNEL1. Note that this parameter is irrelevant for all currently supported NTV2 devices, which use one common hardware clock that drives all SDI outputs.
[in]	inRepeatCount	Specifies the number of output VBIs to wait for until returning. Defaults to 1.

Returns: True if successful; otherwise false. A false result usually indicates the wait timed out.

Note: The device's timing reference source affects how often – or even if – the VBI occurs. See Video Output Clocking & Synchronization for more information.; For interlaced video, callers that need to know whether the field or frame interrupt occurred should call CNTV2Card::WaitForOutputFieldID instead.

Bug:

On the Windows platform, the SDK uses an event to wait on, which only gets cleared by a prior call to WaitForOutputVerticalInterrupt. This is historically different from Linux and MacOS, where the event is always cleared before the Wait. Each method has advantages and disadvantages. To work around this:

Call CNTV2Card::GetOutputVerticalInterruptCount before and after calling this function to verify that an interrupt really occurred;
Call CNTV2WinDriverInterface::GetInterruptEvent to obtain the Windows event HANDLE, and manually clear it before calling this function.

See also: CNTV2Card::WaitForOutputFieldID, Field/Frame Interrupts, Video Output Clocking & Synchronization

Definition at line 134 of file ntv2subscriptions.cpp.

◆ Write12BitLUTTables()

bool CNTV2Card::Write12BitLUTTables	(	const UWordSequence &	inRedLUT,
		const UWordSequence &	inGreenLUT,
		const UWordSequence &	inBlueLUT
	)

virtual

Definition at line 930 of file ntv2csclut.cpp.

◆ WriteAnalogLTCOutput() [1/2]

bool CNTV2Card::WriteAnalogLTCOutput	(	const UWord	inLTCOutput,
		const NTV2_RP188 &	inRP188Data
	)

virtual

Writes the given timecode to the specified analog LTC output register.

Parameters

[in]	inLTCOutput	Specifies the device's analog LTC output to use. Use 0 for LTC Out 1, 1 for LTC Out 2, etc. (Call NTV2DeviceGetNumLTCOutputs to determine the number of analog LTC outputs.)
[in]	inRP188Data	Specifies the timecode to write into the device registers. Only the "Low" and "High" fields are used – the "DBB" field is ignored.

Returns: True if successful; otherwise false.

See also: NTV2DeviceGetNumLTCOutputs, Analog LTC Output

Definition at line 3748 of file ntv2register.cpp.

◆ WriteAnalogLTCOutput() [2/2]

bool CNTV2Card::WriteAnalogLTCOutput	(	const UWord	inLTCOutput,
		const RP188_STRUCT &	inRP188Data
	)

virtual

Writes the given timecode to the specified analog LTC output register.

Parameters

[in]	inLTCOutput	Specifies the device's analog LTC output to use. Use 0 for LTC Out 1, 1 for LTC Out 2, etc. (Call NTV2DeviceGetNumLTCOutputs to determine the number of analog LTC outputs.)
[in]	inRP188Data	Specifies the timecode to write into the device registers. Only the "Low" and "High" fields are used – the "DBB" field is ignored.

Returns: True if successful; otherwise false.

See also: NTV2DeviceGetNumLTCOutputs, Analog LTC Output

Definition at line 3741 of file ntv2register.cpp.

◆ WriteAudioSource()

bool CNTV2Card::WriteAudioSource	(	const ULWord	inValue,
		const NTV2Channel	inChannel = `NTV2_CHANNEL1`
	)

virtual

Deprecated:: This function is obsolete.

Definition at line 481 of file ntv2audio.cpp.

◆ WriteHDBrightnessAdjustment()

bool CNTV2Card::WriteHDBrightnessAdjustment ( const ULWord inNewValue )

virtual

Definition at line 401 of file ntv2regconv.cpp.

◆ WriteHDCbOffsetAdjustment()

bool CNTV2Card::WriteHDCbOffsetAdjustment ( const ULWord inNewValue )

virtual

Definition at line 405 of file ntv2regconv.cpp.

◆ WriteHDContrastAdjustment()

bool CNTV2Card::WriteHDContrastAdjustment ( const ULWord inNewValue )

virtual

Definition at line 402 of file ntv2regconv.cpp.

◆ WriteHDCrOffsetAdjustment()

bool CNTV2Card::WriteHDCrOffsetAdjustment ( const ULWord inNewValue )

virtual

Definition at line 406 of file ntv2regconv.cpp.

◆ WriteHDProcAmpControlsInitialized()

bool CNTV2Card::WriteHDProcAmpControlsInitialized ( const ULWord inNewValue = 1 )

virtual

Definition at line 400 of file ntv2regconv.cpp.

◆ WriteHDSaturationAdjustmentCb()

bool CNTV2Card::WriteHDSaturationAdjustmentCb ( const ULWord inNewValue )

virtual

Definition at line 403 of file ntv2regconv.cpp.

◆ WriteHDSaturationAdjustmentCr()

bool CNTV2Card::WriteHDSaturationAdjustmentCr ( const ULWord inNewValue )

virtual

Definition at line 404 of file ntv2regconv.cpp.

◆ WriteLUTTables()

bool CNTV2Card::WriteLUTTables	(	const UWordSequence &	inRedLUT,
		const UWordSequence &	inGreenLUT,
		const UWordSequence &	inBlueLUT
	)

virtual

Writes the LUT tables.

Parameters

[in]	inRedLUT	The Red LUT, a std::vector of unsigned 10-bit integer values.
[in]	inGreenLUT	The Green LUT, a std::vector of unsigned 10-bit integer values.
[in]	inBlueLUT	The Blue LUT, a std::vector of unsigned 10-bit integer values.

Returns: True if successful; otherwise false.

Note: Version 2 LUTs (see NTV2DeviceGetLUTVersion) require setup of kRegLUTV2Control (register 376) for this function to work properly.

Definition at line 845 of file ntv2csclut.cpp.

◆ WriteOutputTimingControl()

bool CNTV2Card::WriteOutputTimingControl	(	const ULWord	inValue,
		const UWord	inOutputSpigot = `0`
	)

virtual

Adjusts the output timing for the given SDI output connector.

Parameters

[in]	inValue	Specifies the output timing control value to use. The lower 16 bits of this 32-bit value control the horizontal timing, while the upper 16 bits control the vertical. Each horizontal increment/decrement moves the output relative to the reference by one pixel. Each vertical increment/decrement moves the output relative to the reference by one line.
[in]	inOutputSpigot	Optionally specifies the SDI output connector of interest. Defaults to zero (SDI Out 1).

Note: The output timing can only be adjusted when the device's reference source is set for external reference.; The "inOutputSpigot" parameter is respected only if the device is multi-format-capable (see NTV2DeviceCanDoMultiFormat) and the device is currently in multi-format mode (see CNTV2Card::GetMultiFormatMode and CNTV2Card::SetMultiFormatMode). Otherwise, the timing is changed for all SDI outputs.

Returns: True if successful; otherwise false.

See also: CNTV2Card::ReadOutputTimingControl, CNTV2Card::SetVideoVOffset, CNTV2Card::SetVideoHOffset

Definition at line 3291 of file ntv2register.cpp.

◆ WriteProcAmpC1CBAdjustment()

bool CNTV2Card::WriteProcAmpC1CBAdjustment ( const ULWord inNewValue )

virtual

Definition at line 425 of file ntv2regconv.cpp.

◆ WriteProcAmpC1CRAdjustment()

bool CNTV2Card::WriteProcAmpC1CRAdjustment ( const ULWord inNewValue )

virtual

Definition at line 426 of file ntv2regconv.cpp.

◆ WriteProcAmpC1YAdjustment()

bool CNTV2Card::WriteProcAmpC1YAdjustment ( const ULWord inNewValue )

virtual

Definition at line 424 of file ntv2regconv.cpp.

◆ WriteProcAmpC2CBAdjustment()

bool CNTV2Card::WriteProcAmpC2CBAdjustment ( const ULWord inNewValue )

virtual

Definition at line 427 of file ntv2regconv.cpp.

◆ WriteProcAmpC2CRAdjustment()

bool CNTV2Card::WriteProcAmpC2CRAdjustment ( const ULWord inNewValue )

virtual

Definition at line 428 of file ntv2regconv.cpp.

◆ WriteProcAmpOffsetYAdjustment()

bool CNTV2Card::WriteProcAmpOffsetYAdjustment ( const ULWord inNewValue )

virtual

Definition at line 429 of file ntv2regconv.cpp.

◆ WriteRegisters()

bool CNTV2Card::WriteRegisters ( const NTV2RegisterWrites & inRegWrites )

virtual

Writes the given sequence of NTV2RegInfo's.

Parameters

[in] inRegWrites Specifies the sequence of NTV2RegInfo's to be written.

Returns: True if all registers were written successfully; otherwise false.

Note: This operation is not guaranteed to be performed atomically.

Definition at line 4583 of file ntv2register.cpp.

◆ WriteSDBrightnessAdjustment()

bool CNTV2Card::WriteSDBrightnessAdjustment ( const ULWord inNewValue )

virtual

Definition at line 394 of file ntv2regconv.cpp.

◆ WriteSDCbOffsetAdjustment()

bool CNTV2Card::WriteSDCbOffsetAdjustment ( const ULWord inNewValue )

virtual

Definition at line 398 of file ntv2regconv.cpp.

◆ WriteSDContrastAdjustment()

bool CNTV2Card::WriteSDContrastAdjustment ( const ULWord inNewValue )

virtual

Definition at line 395 of file ntv2regconv.cpp.

◆ WriteSDCrOffsetAdjustment()

bool CNTV2Card::WriteSDCrOffsetAdjustment ( const ULWord inNewValue )

virtual

Definition at line 399 of file ntv2regconv.cpp.

◆ WriteSDHueAdjustment()

bool CNTV2Card::WriteSDHueAdjustment ( const ULWord inNewValue )

virtual

Definition at line 397 of file ntv2regconv.cpp.

◆ WriteSDIInVPID()

bool CNTV2Card::WriteSDIInVPID	(	const NTV2Channel	inChannel,
		const ULWord	inValA,
		const ULWord	inValB
	)

protectedvirtual

Definition at line 115 of file ntv2regvpid.cpp.

◆ WriteSDProcAmpControlsInitialized()

bool CNTV2Card::WriteSDProcAmpControlsInitialized ( const ULWord inNewValue = 1 )

virtual

Definition at line 393 of file ntv2regconv.cpp.

◆ WriteSDSaturationAdjustment()

bool CNTV2Card::WriteSDSaturationAdjustment ( const ULWord inNewValue )

virtual

Definition at line 396 of file ntv2regconv.cpp.

◆ WriteVirtualData()

bool CNTV2Card::WriteVirtualData	(	const ULWord	inTag,
		const void *	inVirtualData,
		const ULWord	inVirtualDataSize
	)

virtual

Writes the block of virtual data.

Parameters

[in]	inTag	Tag for the virtual data.
[in]	inVirtualData	Virtual data to be written
[in]	inVirtualDataSize	Virtual data size to write

Returns: True if all requested data was successfully written; otherwise false.

Note: This operation is not guaranteed to be performed atomically.

Definition at line 4634 of file ntv2register.cpp.

Member Data Documentation

◆ NULL_POINTER

NTV2Buffer CNTV2Card::NULL_POINTER

staticprotected

Used for default empty NTV2Buffer parameters – do not modify.

Definition at line 6221 of file ntv2card.h.

The documentation for this class was generated from the following files:

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2card.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2anc.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2audio.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2autocirculate.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2aux.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2card.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2csclut.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2dma.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2dynamicdevice.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2hdmi.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2hevc.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2interrupts.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2regconv.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2register.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2regroute.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2regvpid.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2stream.cpp
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2subscriptions.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

CSCs, LUTs & Color Correction

HDMI

Ancillary Data

Auxillary Data

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColorCorrectionColor

Constructor & Destructor Documentation

◆ CNTV2Card() [1/2]

◆ CNTV2Card() [2/2]

◆ ~CNTV2Card()

Member Function Documentation

◆ AbortMailBoxLock()

◆ AcquireMailBoxLock()

◆ AddDynamicBitfile()

◆ AddDynamicDirectory()

◆ AncExtractGetBufferOverrun()

◆ AncExtractGetDefaultDIDs()

◆ AncExtractGetField1Size()

◆ AncExtractGetField2Size()

◆ AncExtractGetFilterDIDs()

◆ AncExtractGetMaxNumFilterDIDs()

◆ AncExtractGetWriteInfo()

◆ AncExtractInit()

◆ AncExtractIsEnabled()

◆ AncExtractIsProgressive()

◆ AncExtractSetComponents()

◆ AncExtractSetEnable()

◆ AncExtractSetField2WriteParams()

◆ AncExtractSetFilterDIDs()

◆ AncExtractSetWriteParams()

◆ AncInsertGetReadInfo()

◆ AncInsertInit()

◆ AncInsertIsEnabled()

◆ AncInsertSetComponents()

◆ AncInsertSetEnable()

◆ AncInsertSetField2ReadParams()

◆ AncInsertSetIPParams()

◆ AncInsertSetReadParams()

◆ AncSetFrameBufferSize()

◆ ApplySignalRoute() [1/2]

◆ ApplySignalRoute() [2/2]

◆ AutoCirculateFlush()

◆ AutoCirculateGetFrameStamp()

◆ AutoCirculateGetStatus()

◆ AutoCirculateInitForInput()

◆ AutoCirculateInitForOutput()

◆ AutoCirculatePause()

◆ AutoCirculatePreRoll()

◆ AutoCirculateResume()

◆ AutoCirculateSetActiveFrame()

◆ AutoCirculateStart()

◆ AutoCirculateStop() [1/2]

◆ AutoCirculateStop() [2/2]

◆ AutoCirculateTransfer()

◆ AuxExtractGetBufferOverrun()

◆ AuxExtractGetDefaultPacketFilters()

◆ AuxExtractGetField1Size()

◆ AuxExtractGetField2Size()

◆ AuxExtractGetFilterInclusionMode()

◆ AuxExtractGetMaxNumPacketFilters()

◆ AuxExtractGetPacketFilters()

◆ AuxExtractGetWriteInfo()

◆ AuxExtractInit()

◆ AuxExtractIsEnabled()

◆ AuxExtractIsProgressive()

◆ AuxExtractSetEnable()

◆ AuxExtractSetField2WriteParams()

◆ AuxExtractSetFilterInclusionMode()

◆ AuxExtractSetPacketFilters()

◆ AuxExtractSetWriteParams()

◆ AuxInsertGetReadInfo()

◆ AuxInsertInit()

◆ AuxInsertIsEnabled()