 |
AJA NTV2 SDK
17.0.1.1246
NTV2 SDK 17.0.1.1246
|
|
AJA NTV2 SDK
17.0.1.1246
NTV2 SDK 17.0.1.1246
|
I interrogate and control an AJA video/audio capture/playout device. More...
#include <ntv2card.h>
Public Types | |
| enum | ColorCorrectionColor { RED, GREEN, BLUE, NUM_COLORS } |
Public Member Functions | |
| virtual bool | SetVideoFormat (const NTV2VideoFormat inVideoFormat, const bool inIsAJARetail=true, const bool inKeepVancSettings=false, 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=true) |
| Sets the video format for one or more FrameStores. More... | |
| virtual bool | SetFrameGeometry (NTV2FrameGeometry inGeometry, bool inIsRetail=true, NTV2Channel inChannel=NTV2_CHANNEL1) |
| Sets the frame geometry of the given channel. More... | |
| virtual bool | SetFrameBufferFormat (NTV2Channel inChannel, NTV2FrameBufferFormat inNewFormat, bool inIsAJARetail=true, 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=true, 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=false) |
| Sets the device's clock reference source. See Device Clocking and 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 Device Clocking and Synchronization for more information. More... | |
| virtual bool | SetFramePulseReference (const NTV2ReferenceSource inRefSource) |
| Sets the device's frame pulse reference source. See Device Clocking and 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=true) |
| 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 | GetSupportedVideoFormats (NTV2VideoFormatSet &outFormats) |
| Returns a std::set of NTV2VideoFormat values that I support. 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) |
| virtual bool | GetVideoLimiting (NTV2VideoLimiting &outValue) |
| 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=false, 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=true) |
| virtual bool | GetPCIAccessFrame (const NTV2Channel inChannel, ULWord &outValue) |
| virtual bool | SetEnableVANCData (const NTV2ChannelSet &inChannels, const bool inVANCenable, const bool inTallerVANC=false) |
| 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 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, NTV2_POINTER 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... | |
| 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=false) |
| 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=false) |
| Returns the video format of the signal that is present on the given input source. More... | |
| virtual NTV2VideoFormat | GetSDIInputVideoFormat (NTV2Channel inChannel, bool inIsProgressive=false) |
| 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 | 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 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 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) |
Device Features | |
| virtual class DeviceCapabilities & | features (void) |
| virtual bool | DeviceCanDoFormat (const NTV2FrameRate inFR, const NTV2FrameGeometry inFG, const NTV2Standard inStd) |
| virtual bool | DeviceCanDo3GOut (const UWord index0) |
| virtual bool | DeviceCanDoLTCEmbeddedN (const UWord index0) |
| virtual ULWord | DeviceGetFrameBufferSize (void) |
| virtual ULWord | DeviceGetNumberFrameBuffers (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 bool | DeviceCanDoAudioMixer (void) |
| virtual bool | DeviceCanDoHDMIQuadRasterConversion (void) |
| virtual bool | DeviceIsDNxIV (void) |
| virtual bool | DeviceHasMicInput (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 | DMAStreamStart (ULWord *inBuffer, const ULWord inByteCount, const NTV2Channel inChannel, const bool inToHost) |
| Streaming transfers. More... | |
| virtual bool | DMAStreamStop (const NTV2Channel inChannel, const bool inToHost) |
| 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=false, bool inRDMA=false) |
| 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=false, bool inRDMA=false) |
| 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=false, 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=true) |
| Sets the VANC source for the given mixer/keyer to the foreground video (or not). See the 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 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=false) |
| 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=false) |
| 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=false) |
| 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 | 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=false) |
| 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 | 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=false, const bool bInQuiet=false) |
| 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=false) |
| 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=false) |
| 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=false) |
| 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=false) |
| 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... | |
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=false) |
| 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=false) |
| Applies the given routing table to the AJA device. More... | |
| virtual bool | ApplySignalRoute (const NTV2XptConnections &inConnections, const bool inReplace=false) |
| 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) |
Bi-directional SDI | |
| 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, NTV2_POINTER inBuffer, ULWord64 bufferCookie, ULWord flags, NTV2StreamBuffer &status) |
| virtual bool | ReadRP188Registers (const NTV2Channel inChannel, RP188_STRUCT *pRP188Data) |
| virtual std::string | GetDescription (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=false) |
| static NTV2VideoFormat | GetNTV2VideoFormat (NTV2FrameRate frameRate, NTV2Standard standard, bool isThreeG, UByte inputGeometry=0, bool progressivePicture=false, bool isSquareDivision=true) |
| 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 shared 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) const |
| virtual bool | IS_INPUT_SPIGOT_INVALID (const UWord inInputSpigot) const |
| 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=false) |
| 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=false) |
| 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 ANC 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... | |
| static UWord | AncExtractGetMaxNumFilterDIDs (void) |
| static NTV2DIDSet | AncExtractGetDefaultDIDs (const bool inHDAudio=true) |
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 |
I interrogate and control an AJA video/audio capture/playout device.
Definition at line 262 of file ntv2card.h.
| Enumerator | |
|---|---|
| RED | |
| GREEN | |
| BLUE | |
| NUM_COLORS | |
Definition at line 6137 of file ntv2card.h.
| CNTV2Card::CNTV2Card | ( | ) |
My default constructor.
Definition at line 19 of file ntv2card.cpp.
|
explicit |
Constructor that opens the device.
| [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). |
|
virtual |
My destructor.
Definition at line 55 of file ntv2card.cpp.
|
virtual |
Definition at line 4402 of file ntv2register.cpp.
|
virtual |
Definition at line 4388 of file ntv2register.cpp.
|
virtual |
Adds the given bitfile to the list of available dynamic bitfiles.
| [in] | inBitfilePath | A string containing the path to the bitfile. |
Definition at line 215 of file ntv2dynamicdevice.cpp.
|
virtual |
Adds all bitfiles found in the given host file directory to the list of available dynamic bitfiles.
| [in] | inDirectory | A string containing the path to the directory. |
Definition at line 220 of file ntv2dynamicdevice.cpp.
|
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.)
| [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) |
Definition at line 1011 of file ntv2anc.cpp.
|
static |
| [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. |
Definition at line 1052 of file ntv2anc.cpp.
Answers with the number of bytes of field 1 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)
| [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 969 of file ntv2anc.cpp.
Answers with the number of bytes of field 2 ANC extracted. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports Anc extractor firmware.)
| [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 990 of file ntv2anc.cpp.
|
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.)
| [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). |
Definition at line 919 of file ntv2anc.cpp.
|
static |
Definition at line 1045 of file ntv2anc.cpp.
|
virtual |
Answers with the given SDI input's current Anc extractor info. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)
| [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. |
Definition at line 897 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 701 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 788 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 755 of file ntv2anc.cpp.
|
virtual |
Enables or disables the given SDI input's Anc extractor. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc extractor firmware.)
| [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. |
Definition at line 767 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 851 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 944 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 805 of file ntv2anc.cpp.
|
virtual |
Answers where, in device SDRAM, the given SDI connector's Anc inserter is currently reading Anc data for playout.
| [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.
|
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.)
| [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. |
Definition at line 303 of file ntv2anc.cpp.
|
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.)
| [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.
|
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.)
| [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. |
Definition at line 357 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 374 of file ntv2anc.cpp.
|
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.)
| [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. |
Definition at line 456 of file ntv2anc.cpp.
|
virtual |
Configures the Anc inserter IP specific params.
| [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.
|
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.)
| [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. |
Definition at line 414 of file ntv2anc.cpp.
Sets the capacity of the ANC buffers in device frame memory. (Call NTV2DeviceCanDoCustomAnc to determine if the device supports custom Anc inserter firmware.)
| [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. |
Definition at line 123 of file ntv2anc.cpp.
|
virtual |
Applies the given routing table to the AJA device.
| [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.
Definition at line 242 of file ntv2regroute.cpp.
|
virtual |
Applies the given widget routing connections to the AJA device.
| [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.
Definition at line 255 of file ntv2regroute.cpp.
|
virtual |
Flushes AutoCirculate for the given channel.
| [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.
Definition at line 610 of file ntv2autocirculate.cpp.
|
virtual |
Returns precise timing information for the given frame and channel that's currently AutoCirculating.
| [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.
Definition at line 667 of file ntv2autocirculate.cpp.
|
virtual |
Returns the current AutoCirculate status for the given channel.
| [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.
Definition at line 646 of file ntv2autocirculate.cpp.
|
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.
true if successful; otherwise false. | [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. |
inFrameCount, and explicitly specifying a frame range using inStartFrameNumber and inEndFrameNumber parameters. 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.
Definition at line 221 of file ntv2autocirculate.cpp.
|
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.
true if successful; otherwise false. | [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. |
inFrameCount, and explicitly specifying a frame range using inStartFrameNumber and inEndFrameNumber parameters. 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.
Definition at line 353 of file ntv2autocirculate.cpp.
|
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.
| [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.
Definition at line 570 of file ntv2autocirculate.cpp.
|
virtual |
Tells AutoCirculate how many frames to skip before playout starts for the given channel.
| [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.
Definition at line 628 of file ntv2autocirculate.cpp.
|
virtual |
Resumes AutoCirculate for the given channel, picking up at the next frame without loss of audio synchronization.
| [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.
Definition at line 591 of file ntv2autocirculate.cpp.
|
virtual |
Immediately changes the Active Frame for the given channel.
| [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.
Definition at line 677 of file ntv2autocirculate.cpp.
|
virtual |
Starts AutoCirculating the specified channel that was previously initialized by CNTV2Card::AutoCirculateInitForInput or CNTV2Card::AutoCirculateInitForOutput.
| [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:
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.Definition at line 503 of file ntv2autocirculate.cpp.
|
virtual |
Stops AutoCirculate for the given channel, and releases the on-device frame buffers that were allocated to it.
| [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.
Definition at line 519 of file ntv2autocirculate.cpp.
|
virtual |
Stops any number of AutoCirculate channels. See the other AutoCirculateStop function overload for full details on what happens to each channel.
| [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.
|
virtual |
Transfers all or part of a frame as specified in the given AUTOCIRCULATE_TRANSFER object to/from the host.
| [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.
Definition at line 695 of file ntv2autocirculate.cpp.
|
virtual |
Reads the given set of registers from the bank specified in position 0.
| [in] | inBankSelect | Specifies the bank select register. |
| [in] | inOutRegInfo | Specifies the register to be read (plus mask/shift/value). |
Definition at line 4535 of file ntv2register.cpp.
|
virtual |
Writes the given set of registers to the bank specified at position 0.
| [in] | inBankSelect | Specifies the bank select register. |
| [in] | inRegInfo | Specifies the register to be written, and its mask, shift and value. |
Definition at line 4510 of file ntv2register.cpp.
|
virtual |
Answers whether or not the given widget signal input (sink) can legally be connected to the given signal output (source).
| [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. |
Definition at line 192 of file ntv2regroute.cpp.
|
virtual |
| [in] | inDeviceID | Specifies the device ID of interest. |
Definition at line 139 of file ntv2dynamicdevice.cpp.
|
virtual |
Answers whether or not the FPGA can be reloaded without powering off.
| [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. |
Definition at line 312 of file ntv2card.cpp.
|
virtual |
Removes all existing signal path connections between any and all widgets on the AJA device.
This function writes zeroes into all crosspoint selection registers, effectively clearing any existing routing configuration on the device.
Definition at line 278 of file ntv2regroute.cpp.
|
virtual |
Connects the given widget signal input (sink) to the given widget signal output (source).
| [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. |
Definition at line 87 of file ntv2regroute.cpp.
|
virtual |
Answers with the frame number that contains the given address.
| [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. |
Definition at line 440 of file ntv2dma.cpp.
|
virtual |
Definition at line 391 of file ntv2card.cpp.
|
virtual |
Definition at line 471 of file ntv2card.cpp.
|
virtual |
Definition at line 456 of file ntv2card.cpp.
|
virtual |
Definition at line 461 of file ntv2card.cpp.
|
virtual |
Definition at line 384 of file ntv2card.cpp.
|
virtual |
Definition at line 446 of file ntv2card.cpp.
|
virtual |
Definition at line 476 of file ntv2card.cpp.
|
virtual |
Definition at line 466 of file ntv2card.cpp.
|
virtual |
Definition at line 396 of file ntv2card.cpp.
|
virtual |
Definition at line 441 of file ntv2card.cpp.
|
virtual |
Definition at line 451 of file ntv2card.cpp.
|
virtual |
Definition at line 431 of file ntv2card.cpp.
|
virtual |
Definition at line 411 of file ntv2card.cpp.
|
virtual |
Definition at line 436 of file ntv2card.cpp.
|
virtual |
Definition at line 416 of file ntv2card.cpp.
|
virtual |
Definition at line 421 of file ntv2card.cpp.
|
virtual |
Definition at line 401 of file ntv2card.cpp.
|
virtual |
Definition at line 426 of file ntv2card.cpp.
|
virtual |
Definition at line 406 of file ntv2card.cpp.
|
virtual |
Definition at line 492 of file ntv2card.cpp.
|
virtual |
Definition at line 487 of file ntv2card.cpp.
|
virtual |
Disables the given FrameStore.
| [in] | inChannel | Specifies the FrameStore as an NTV2Channel value. |
Definition at line 2093 of file ntv2register.cpp.
|
virtual |
Disables the given FrameStore(s).
| [in] | inChannels | Specifies the FrameStore(s) to be disabled. |
Definition at line 2103 of file ntv2register.cpp.
|
virtual |
Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given input channel on the device.
| [in] | channel | Specifies the input channel of interest. Defaults to NTV2_CHANNEL1. |
Definition at line 40 of file ntv2interrupts.cpp.
|
virtual |
Prevents the CNTV2Card instance from waiting for and responding to input vertical blanking interrupts originating from the given frameStore(s) on the device.
| [in] | inFrameStores | Specifies the frameStore(s) of interest. |
Definition at line 41 of file ntv2interrupts.cpp.
|
virtual |
Definition at line 33 of file ntv2interrupts.cpp.
|
virtual |
Prevents the CNTV2Card instance from waiting for and responding to vertical blanking interrupts originating from the given output channel on the device.
| [in] | channel | Specifies the output channel of interest. Defaults to NTV2_CHANNEL1. |
Definition at line 39 of file ntv2interrupts.cpp.
|
virtual |
Configures the SDI output's embedder to embed SMPTE 12M timecode specified in calls to CNTV2Card::SetRP188Data.
| [in] | inSDIOutput | Specifies the SDI output of interest, expressed as an NTV2Channel. |
Definition at line 2578 of file ntv2register.cpp.
|
virtual |
Disconnects the given widget signal input (sink) from whatever output (source) it may be connected.
| [in] | inInputXpt | Specifies the input (signal sink) to be disconnected. |
Definition at line 134 of file ntv2regroute.cpp.
|
virtual |
Enables or disables automatic buffer locking.
| [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. |
Definition at line 524 of file ntv2dma.cpp.
|
virtual |
Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers.
| [in] | inBuffer | Specifies the host buffer to lock. |
| [in] | inMap | Also lock the segment map. |
| [in] | inRDMA | Lock a GPUDirect buffer for p2p DMA. |
Definition at line 487 of file ntv2dma.cpp.
|
inlinevirtual |
Page-locks the given host buffer to reduce transfer time and CPU usage of DMA transfers.
| [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. |
Definition at line 717 of file ntv2card.h.
|
virtual |
Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock.
| [in] | inBuffer | Specifies the host buffer to unlock. |
Definition at line 502 of file ntv2dma.cpp.
|
inlinevirtual |
Unlocks the given host buffer that was previously locked using CNTV2Card::DMABufferLock.
| [in] | pInBuffer | Specifies the starting address of the previously locked host buffer. |
| [in] | inByteCount | Specifies the total length of the previously locked host buffer. |
Definition at line 738 of file ntv2card.h.
|
virtual |
Unlocks all previously-locked buffers used for DMA transfers.
Definition at line 515 of file ntv2dma.cpp.
|
virtual |
Clears the ancillary data region in the device frame buffer for the specified frames.
| [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) |
Definition at line 553 of file ntv2dma.cpp.
|
virtual |
DirectGMA p2p transfers (not GPUDirect: see DMABufferLock)
Definition at line 116 of file ntv2dma.cpp.
|
virtual |
Definition at line 122 of file ntv2dma.cpp.
|
virtual |
Transfers data from the AJA device to the host.
| [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. |
Definition at line 29 of file ntv2dma.cpp.
|
virtual |
Transfers the contents of the ancillary data buffer(s) from a given frame on the AJA device to the host.
| [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. |
Definition at line 230 of file ntv2dma.cpp.
|
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.
| [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. |
Definition at line 194 of file ntv2dma.cpp.
|
virtual |
Transfers a single frame from the AJA device to the host. This call is multi-format compatible.
| [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. |
Definition at line 46 of file ntv2dma.cpp.
|
virtual |
Transfers a single frame from the AJA device to the host.
| [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. |
Definition at line 41 of file ntv2dma.cpp.
|
virtual |
Performs a segmented data transfer from the AJA device to the host.
| [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. |
Definition at line 90 of file ntv2dma.cpp.
|
virtual |
Streaming transfers.
Definition at line 136 of file ntv2dma.cpp.
|
virtual |
Definition at line 149 of file ntv2dma.cpp.
|
virtual |
Transfers data from the host to the AJA device.
| [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. |
Definition at line 35 of file ntv2dma.cpp.
|
virtual |
Transfers the contents of the ancillary data buffer(s) from the host to a given frame on the AJA device.
| [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. |
Definition at line 286 of file ntv2dma.cpp.
|
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.
| [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. |
Definition at line 212 of file ntv2dma.cpp.
|
virtual |
Transfers a single frame from the host to the AJA device.
| [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. |
Definition at line 65 of file ntv2dma.cpp.
|
virtual |
Transfers a single frame from the host to the AJA device. This function is multi-format compatible.
| [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. |
Definition at line 70 of file ntv2dma.cpp.
|
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.
| [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 |
Definition at line 353 of file ntv2dma.cpp.
|
virtual |
Performs a segmented data transfer from the host to the AJA device.
| [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. |
Definition at line 103 of file ntv2dma.cpp.
|
virtual |
Definition at line 722 of file ntv2csclut.cpp.
|
virtual |
Definition at line 779 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1361 of file ntv2csclut.cpp.
|
virtual |
Sends the given color lookup tables (LUTs) to the given LUT and bank.
| [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). |
Definition at line 695 of file ntv2csclut.cpp.
|
virtual |
Writes the LUT tables to the given LUT and bank.
| [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). |
Definition at line 752 of file ntv2csclut.cpp.
|
virtual |
Sets 4K Down Convert PSF in mode.
| [in] | inEnable | If true, specifies PSF in If false, specifies P in |
Definition at line 4080 of file ntv2register.cpp.
|
virtual |
Sets 4K Down Convert RGB mode.
| [in] | inEnable | If true, specifies RGB mode If false, specifies YCC mode |
Definition at line 4054 of file ntv2register.cpp.
|
virtual |
Sets 4K Down Convert YCC 444 mode.
| [in] | inEnable | If true, specifies YCC 444 If false, specifies YCC 422 |
Definition at line 4067 of file ntv2register.cpp.
|
virtual |
Sets 4K Down Convert PSF out Mode.
| [in] | inEnable | If true, specifies PSF out If false, specifies P out |
Definition at line 4093 of file ntv2register.cpp.
|
virtual |
Enables breakout board analog audio XLR inputs.
| [in] | inEnable | If true, specifies that the XLR connectors are enabled. If false, breakout board audio reverts to digital AES inputs. |
Definition at line 1826 of file ntv2audio.cpp.
|
virtual |
Enables the given FrameStore.
| [in] | inChannel | Specifies the FrameStore as an NTV2Channel value. |
Definition at line 2113 of file ntv2register.cpp.
|
virtual |
Enables the given FrameStore(s).
| [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. |
Definition at line 2123 of file ntv2register.cpp.
|
virtual |
Enables the device's frame pulse reference select.
| [in] | inEnable | Specify true to enable the frame pulse reference; otherwise specify false. |
Definition at line 1570 of file ntv2register.cpp.
|
virtual |
Enables or disables HDMI HDR.
| [in] | inEnableHDMIHDR | If true, sets the device to output HDMI HDR Metadata; otherwise sets the device to not output HDMI HDR Metadata. |
Definition at line 923 of file ntv2hdmi.cpp.
|
virtual |
Enables or disables HDMI HDR Dolby Vision.
| [in] | inEnable | If true, sets the device to output HDMI HDR Dolby Vision; otherwise sets the device to not output HDMI HDR Dolby Vision. |
Definition at line 942 of file ntv2hdmi.cpp.
|
virtual |
Controls the 4k/2k -> UHD/HD HDMI center cropping feature.
| [in] | inEnable | Specify true to enable center cropping; otherwise false to disable it. |
Definition at line 1062 of file ntv2hdmi.cpp.
|
virtual |
Enables or disables override of HDMI parameters.
| [in] | inEnable | Specify true to enable HDMI user-override; otherwise false to disable it. |
Definition at line 1049 of file ntv2hdmi.cpp.
|
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.
| [in] | channel | Specifies the input channel of interest. Defaults to NTV2_CHANNEL1. |
Definition at line 23 of file ntv2interrupts.cpp.
|
virtual |
Allows the CNTV2Card instance to wait for and respond to input vertical blanking interrupts originating from the given FrameStore(s).
| [in] | inFrameStores | The input frameStore(s) of interest. |
Definition at line 24 of file ntv2interrupts.cpp.
|
virtual |
Definition at line 21 of file ntv2interrupts.cpp.
|
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.
| [in] | channel | Specifies the frameStore of interest. Defaults to NTV2_CHANNEL1. |
Definition at line 22 of file ntv2interrupts.cpp.
|
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.
| [in] | inSDIOutput | Specifies the SDI output of interest, expressed as an NTV2Channel. |
Definition at line 2587 of file ntv2register.cpp.
|
inlinevirtual |
Definition at line 377 of file ntv2card.h.
|
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.
| [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. |
Definition at line 113 of file ntv2autocirculate.cpp.
|
virtual |
Definition at line 2196 of file ntv2register.cpp.
|
static |
Definition at line 1349 of file ntv2csclut.cpp.
|
static |
Definition at line 469 of file ntv2csclut.cpp.
|
static |
Definition at line 661 of file ntv2csclut.cpp.
|
virtual |
Answers with the current LUT plane.
| [out] | outLUTPlane | Receives the current LUT plane. |
Definition at line 353 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1010 of file ntv2csclut.cpp.
|
virtual |
Answers whether the FrameStore bank's current SMPTE 425 "4K squares" (i.e., "2K quadrants") mode is enabled or not.
| [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 1291 of file ntv2register.cpp.
|
virtual |
Definition at line 3205 of file ntv2register.cpp.
|
virtual |
Definition at line 796 of file ntv2register.cpp.
|
virtual |
Definition at line 784 of file ntv2register.cpp.
|
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.
| [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. |
Definition at line 1541 of file ntv2audio.cpp.
|
virtual |
Definition at line 2244 of file ntv2register.cpp.
|
virtual |
Definition at line 1778 of file ntv2audio.cpp.
|
virtual |
Answers whether or not the specified bidirectional XLR audio connectors are collectively acting as inputs or outputs.
| [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). |
Definition at line 1737 of file ntv2audio.cpp.
|
virtual |
Returns the video format of the signal that is present on the device's composite video input.
Definition at line 3524 of file ntv2register.cpp.
|
virtual |
Definition at line 275 of file ntv2regconv.cpp.
|
virtual |
Returns the video format of the signal that is present on the device's analog video input.
Definition at line 3508 of file ntv2register.cpp.
|
virtual |
Answers with the (SDI) input channel that's providing the clock reference being used by the given device's analog LTC input.
| [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. |
Definition at line 3727 of file ntv2register.cpp.
|
virtual |
Answers with the (SDI) output channel that's providing the clock reference being used by the given device's analog LTC output.
| [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. |
Definition at line 3767 of file ntv2register.cpp.
|
virtual |
Definition at line 3214 of file ntv2register.cpp.
|
virtual |
Answers with the offset and size of an ancillary data region within a device frame buffer.
| [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. |
Definition at line 574 of file ntv2dma.cpp.
|
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.
| [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. |
Definition at line 659 of file ntv2dma.cpp.
|
virtual |
Answers whether or not the device's NTV2AudioSystem is currently operating in 20-bit mode. Normally the NTV2AudioSystem operates in 24-bit mode.
| [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. |
Definition at line 1196 of file ntv2audio.cpp.
|
virtual |
Definition at line 293 of file ntv2audio.cpp.
|
virtual |
Retrieves the size of the input or output audio buffer being used for a given Audio System on the AJA device.
| [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. |
Definition at line 271 of file ntv2audio.cpp.
|
virtual |
Answers whether or not the Audio System is configured to write captured audio samples into device audio buffer memory.
| [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. |
Definition at line 1286 of file ntv2audio.cpp.
|
virtual |
Answers with the audio input delay for the given Audio System on the device.
| [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. |
Definition at line 1316 of file ntv2audio.cpp.
|
virtual |
Answers if NTV2AudioLoopBack mode is currently on or off for the given NTV2AudioSystem.
| [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. |
Definition at line 324 of file ntv2audio.cpp.
|
virtual |
Answers with the byte offset in device SDRAM into the specified Audio System's audio buffer.
| [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 159 of file ntv2dma.cpp.
|
virtual |
Answers with the Audio System that's currently driving the given input of the Audio Mixer.
| [in] | inMixerInput | Specifies the Audio Mixer's input of interest. |
| [out] | outAudioSystem | Receives the NTV2AudioSystem that's currently driving the Audio Mixer's input. |
Definition at line 664 of file ntv2audio.cpp.
|
virtual |
Answers with the Audio Channel Pair that's currently driving the given input of the Audio Mixer.
| [in] | inMixerInput | Specifies the Audio Mixer's input of interest. |
| [out] | outChannelPair | Receives the NTV2AudioChannelPair that's currently driving the audio mixer's input. |
Definition at line 689 of file ntv2audio.cpp.
|
virtual |
Answers with a std::bitset that indicates which input audio channels of the given Audio Mixer input are currently muted.
| [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. |
Definition at line 849 of file ntv2audio.cpp.
|
virtual |
Answers with the current gain setting for the Audio Mixer's given input.
| [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. |
Definition at line 719 of file ntv2audio.cpp.
|
virtual |
Answers with the Audio Mixer's current audio input levels.
| [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). |
Definition at line 874 of file ntv2audio.cpp.
|
virtual |
Answers with the Audio Mixer's current sample count used for measuring audio levels.
| [out] | outSampleCount | Receives the current sample count. |
Definition at line 938 of file ntv2audio.cpp.
|
virtual |
Answers with a std::bitset that indicates which output audio channels of the Audio Mixer are currently muted.
| [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). |
Definition at line 830 of file ntv2audio.cpp.
|
virtual |
Answers with the current gain setting for the Audio Mixer's output.
| [out] | outGainValue | Receives the current main input gain level. This is a signed 18-bit value, where unity gain is 0x10000. |
Definition at line 746 of file ntv2audio.cpp.
|
virtual |
Answers with the Audio Mixer's current audio output levels.
| [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). |
Definition at line 762 of file ntv2audio.cpp.
|
virtual |
Answers with the current state of the AES Sync Mode bit for the given Audio System's output.
| [in] | inAudioSystem | Specifies the audio system of interest. |
| [out] | outAESSyncModeBitSet | Receives 'true' if the bit is set; otherwise 'false' (normal operation). |
Definition at line 1797 of file ntv2audio.cpp.
|
virtual |
Answers with the audio output delay for the given Audio System on the device.
| [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. |
Definition at line 1332 of file ntv2audio.cpp.
|
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.
| [in] | inSDIOutputConnector | Specifies the SDI output of interest. |
| [out] | outIsEnabled | Receives 'true' if the audio output embedder is enabled; otherwise 'false' if disabled. |
Definition at line 1671 of file ntv2audio.cpp.
|
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.
| [in] | inAudioSystem | Specifies the audio system of interest. |
| [out] | outEraseModeEnabled | Receives 'true' if enabled; otherwise 'false' if disabled (normal operation). |
Definition at line 1701 of file ntv2audio.cpp.
|
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.
| [out] | outAudioSystem | Receives the current audio system being used. |
| [out] | outChannelPair | Receives the current audio channel pair being used. |
Definition at line 1117 of file ntv2audio.cpp.
|
virtual |
Answers if the device's Audio System is currently paused or not.
| [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. |
Definition at line 1211 of file ntv2audio.cpp.
|
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.
| [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". |
Definition at line 1347 of file ntv2audio.cpp.
|
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.
| [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. |
Definition at line 1388 of file ntv2audio.cpp.
|
virtual |
Answers which NTV2AudioChannelPairs being transmitted by the given NTV2AudioSystem are currently being flagged as non-PCM.
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. |
| [out] | outNonPCMChannelPairs | Receives the NTV2AudioChannelPairs that are currently being flagged as non-PCM. |
Definition at line 1400 of file ntv2audio.cpp.
|
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.
| [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 1300 of file ntv2audio.cpp.
|
virtual |
Returns the current NTV2AudioRate for the given Audio System.
| [out] | outRate | Receives the current NTV2AudioRate. |
| [in] | inAudioSystem | Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1. |
Definition at line 229 of file ntv2audio.cpp.
|
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.)
| [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 452 of file ntv2audio.cpp.
|
virtual |
Answers with the device's current NTV2AudioSource (and also possibly its NTV2EmbeddedAudioInput) for the given NTV2AudioSystem.
| [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. |
Definition at line 523 of file ntv2audio.cpp.
|
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.
| [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 436 of file ntv2audio.cpp.
|
virtual |
Definition at line 96 of file ntv2autocirculate.cpp.
|
virtual |
Definition at line 3093 of file ntv2register.cpp.
|
virtual |
Definition at line 3123 of file ntv2register.cpp.
|
virtual |
Definition at line 57 of file ntv2dynamicdevice.cpp.
|
virtual |
Generates and returns an info string with date, time and name for the given inBifFileInfo.
| [in] | inBitFileInfo | BitFile Info structure to get information from, no validity checks are made on the structure before use. |
Definition at line 291 of file ntv2card.cpp.
|
virtual |
Definition at line 327 of file ntv2card.cpp.
|
virtual |
Definition at line 227 of file ntv2csclut.cpp.
|
virtual |
Definition at line 77 of file ntv2csclut.cpp.
|
virtual |
Answers with the current LUT bank in use for the given LUT.
| [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). |
Definition at line 120 of file ntv2csclut.cpp.
|
virtual |
Definition at line 320 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1228 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1294 of file ntv2csclut.cpp.
|
virtual |
Answers whether or not the given CSC is set to produce alpha channel data from its key input.
| [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). |
Definition at line 1205 of file ntv2csclut.cpp.
|
virtual |
Answers with the current matrix type being used for the given CSC.
| [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). |
Definition at line 460 of file ntv2csclut.cpp.
|
virtual |
Definition at line 444 of file ntv2csclut.cpp.
|
virtual |
Answers with the current operating mode of the given color space converter.
| [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). |
Definition at line 410 of file ntv2csclut.cpp.
|
virtual |
Answers with the current RGB range being used by a given CSC.
| [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). |
Definition at line 1174 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1193 of file ntv2csclut.cpp.
|
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.
| [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). |
Definition at line 1338 of file ntv2csclut.cpp.
|
virtual |
Answers with a connected NTV2InputCrosspointID for the given NTV2OutputCrosspointID.
| [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. |
Definition at line 51 of file ntv2regroute.cpp.
|
virtual |
Answers with all of the NTV2InputCrosspointIDs that are connected to the given NTV2OutputCrosspointID.
| [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. |
Definition at line 67 of file ntv2regroute.cpp.
|
virtual |
Answers with the currently connected NTV2OutputCrosspointID for the given NTV2InputCrosspointID.
| [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. |
Definition at line 29 of file ntv2regroute.cpp.
|
virtual |
Answers with the device's current widget routing connections.
| [out] | outConnections | Receives the current routing connections. |
Definition at line 345 of file ntv2regroute.cpp.
|
virtual |
Definition at line 218 of file ntv2regconv.cpp.
|
virtual |
Definition at line 21 of file ntv2regconv.cpp.
|
virtual |
Definition at line 19 of file ntv2regconv.cpp.
|
virtual |
Definition at line 17 of file ntv2regconv.cpp.
|
virtual |
Definition at line 15 of file ntv2regconv.cpp.
|
virtual |
Definition at line 39 of file ntv2regconv.cpp.
|
virtual |
| [in] | inChannel | Specifies the channel (SDI input) of interest. |
Definition at line 4140 of file ntv2register.cpp.
|
virtual |
| [in] | inChannel | Specifies the channel (SDI input) of interest. |
Definition at line 4151 of file ntv2register.cpp.
|
virtual |
Definition at line 15 of file ntv2interrupts.cpp.
|
virtual |
Definition at line 195 of file ntv2register.cpp.
|
virtual |
Definition at line 37 of file ntv2regconv.cpp.
|
virtual |
Answers which AES/EBU audio channel pairs are present on the device.
| [out] | outDetectedChannelPairs | Receives the set of unique audio channel pairs that are present in any of the device's AES/EBU inputs. |
Definition at line 1475 of file ntv2audio.cpp.
|
virtual |
Answers which audio channel pairs are present in the given Audio System's input stream.
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. |
| [out] | outDetectedChannelPairs | Receives the NTV2AudioChannelPairs that are present in the Audio System's input stream. |
Definition at line 1457 of file ntv2audio.cpp.
|
virtual |
Answers with the address and size of the given frame.
| [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. |
Definition at line 433 of file ntv2dma.cpp.
|
virtual |
Definition at line 375 of file ntv2dma.cpp.
|
virtual |
Answers with this device's version number.
Definition at line 63 of file ntv2card.cpp.
|
virtual |
Answers with this device's version number as a human-readable string.
Definition at line 70 of file ntv2card.cpp.
|
virtual |
Reads the current die temperature of the device.
| [out] | outTemp | Receives the temperature value that was read from the device. |
| [in] | inTempScale | Specifies the temperature unit scale to use. Defaults to Celsius. |
Definition at line 4409 of file ntv2register.cpp.
|
virtual |
Reads the current "Vcc" voltage of the device.
| [out] | outVoltage | Receives the "Vcc" voltage that was read from the device. |
Definition at line 4431 of file ntv2register.cpp.
|
virtual |
Answers with the set of channels that are currently disabled.
| [out] | outChannels | Receives the set of enabled channels. |
Definition at line 2166 of file ntv2register.cpp.
|
virtual |
Answers with this device's display name.
Definition at line 84 of file ntv2card.cpp.
|
virtual |
Definition at line 3194 of file ntv2register.cpp.
|
virtual |
Definition at line 23 of file ntv2regconv.cpp.
|
virtual |
Answers with the individual version components of this device's driver.
| [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. |
Definition at line 145 of file ntv2card.cpp.
|
virtual |
Answers with this device's driver's version as a human-readable string.
Definition at line 123 of file ntv2card.cpp.
|
virtual |
Definition at line 3178 of file ntv2register.cpp.
|
virtual |
Definition at line 3165 of file ntv2register.cpp.
|
virtual |
Definition at line 77 of file ntv2dynamicdevice.cpp.
|
virtual |
Definition at line 68 of file ntv2dynamicdevice.cpp.
|
virtual |
For the given NTV2AudioSystem, answers with the current NTV2EmbeddedAudioClock setting.
| [out] | outValue | Receives the current NTV2EmbeddedAudioClock setting. |
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. Defaults to NTV2_AUDIOSYSTEM_1. |
Definition at line 428 of file ntv2audio.cpp.
|
virtual |
Answers with the device's current embedded (SDI) audio source for the given NTV2AudioSystem.
| [out] | outEmbeddedSource | Receives the NTV2EmbeddedAudioInput (SDI audio source). |
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. |
Definition at line 380 of file ntv2audio.cpp.
|
virtual |
Definition at line 4085 of file ntv2register.cpp.
|
virtual |
Definition at line 4059 of file ntv2register.cpp.
|
virtual |
Definition at line 4072 of file ntv2register.cpp.
|
virtual |
Definition at line 4098 of file ntv2register.cpp.
|
virtual |
Definition at line 27 of file ntv2regconv.cpp.
|
virtual |
Answers with the set of channels that are currently enabled.
| [out] | outChannels | Receives the set of enabled channels. |
Definition at line 2152 of file ntv2register.cpp.
|
virtual |
Answers whether or not the device's current frame pulse reference source is enabled. See Device Clocking and Synchronization for more information.
| [out] | outEnabled | Receives true if the frame pulse reference is enabled; otherwise false. |
Definition at line 1580 of file ntv2register.cpp.
|
virtual |
Answers if the HDMI 4k/2k -> UHD/HD center cropping is enabled or not.
| [out] | outIsEnabled | Receives true if center cropping is enabled; otherwise false. |
Definition at line 1067 of file ntv2hdmi.cpp.
|
virtual |
Answers if override of HDMI parameters is enabled or not.
| [out] | outIsEnabled | Receives true if enabled; otherwise false. |
Definition at line 1054 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 1973 of file ntv2register.cpp.
|
virtual |
Definition at line 341 of file ntv2audio.cpp.
|
virtual |
Retrieves the device's current "retail service" task mode.
| [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. |
Definition at line 184 of file ntv2register.cpp.
|
virtual |
Definition at line 3204 of file ntv2register.cpp.
|
virtual |
Definition at line 92 of file ntv2card.cpp.
|
virtual |
Returns the current frame buffer format for the given FrameStore on the AJA device.
| [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. |
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 1891 of file ntv2register.cpp.
|
virtual |
Answers with the current frame buffer orientation for the given NTV2Channel.
| [in] | inChannel | Specifies the channel (aka FrameStore) of interest. |
| [out] | outValue | Receives the NTV2VideoFrameBufferOrientation value. |
Definition at line 1995 of file ntv2register.cpp.
|
virtual |
Definition at line 1943 of file ntv2register.cpp.
|
virtual |
Definition at line 1919 of file ntv2register.cpp.
|
virtual |
Answers with the frame size currently being used on the device.
| [in] | inChannel | Currently ignored. Use NTV2_CHANNEL1. |
| [out] | outValue | Receives the device's current frame size. |
Definition at line 2050 of file ntv2register.cpp.
|
inline |
Definition at line 388 of file ntv2driverinterface.h.
|
virtual |
Definition at line 972 of file ntv2register.cpp.
|
virtual |
Answers with the device's current frame pulse reference source.
| [out] | outRefSource | Receives the NTV2ReferenceSource value. |
Definition at line 1599 of file ntv2register.cpp.
|
virtual |
Returns the AJA device's currently configured frame rate via its "value" parameter.
| [out] | outValue | Receives the device's current NTV2FrameRate value. |
| [in] | inChannel | Specifies the NTV2Channel of interest. |
Definition at line 1024 of file ntv2register.cpp.
|
virtual |
Definition at line 68 of file ntv2autocirculate.cpp.
|
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.
| [out] | outBluePrimaryX | Receives the Blue Primary X value as defined in SMPTE ST 2086. |
Definition at line 674 of file ntv2hdmi.cpp.
|
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.
| [out] | outBluePrimaryY | Receives the Blue Primary Y value as defined in SMPTE ST 2086. |
Definition at line 694 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 874 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 952 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 897 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 933 of file ntv2hdmi.cpp.
|
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.
| [out] | outGreenPrimaryX | Receives the Green Primary X value as defined in SMPTE ST 2086. |
Definition at line 634 of file ntv2hdmi.cpp.
|
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.
| [out] | outGreenPrimaryY | Receives the Green Primary Y value as defined in SMPTE ST 2086. |
Definition at line 654 of file ntv2hdmi.cpp.
|
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.
| [out] | outMaxContentLightLevel | Receives the Max Content Light Level value. |
Definition at line 834 of file ntv2hdmi.cpp.
|
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.
| [out] | outMaxFrameAverageLightLevel | Receives the Max Frame Average Light Level value. |
Definition at line 854 of file ntv2hdmi.cpp.
|
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.
| [out] | outMaxMasteringLuminance | Receives the Max Mastering Luminance value. |
Definition at line 794 of file ntv2hdmi.cpp.
|
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.
| [out] | outMinMasteringLuminance | Receives the Min Mastering Luminance value. |
Definition at line 814 of file ntv2hdmi.cpp.
|
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.
| [out] | outRedPrimaryX | Receives the Red Primary X value as defined in SMPTE ST 2086. |
Definition at line 714 of file ntv2hdmi.cpp.
|
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.
| [out] | outRedPrimaryY | Receives the Red Primary Y value as defined in SMPTE ST 2086. |
Definition at line 734 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 917 of file ntv2hdmi.cpp.
|
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.
| [out] | outWhitePointX | Receives the White Point X value as defined in SMPTE ST 2086. |
Definition at line 754 of file ntv2hdmi.cpp.
|
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.
| [out] | outWhitePointY | Receives the White Point Y value as defined in SMPTE ST 2086. |
Definition at line 774 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's current audio channel 3/4 swap setting.
| [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. |
Definition at line 286 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 260 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's current bit depth setting.
| [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. |
Definition at line 216 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's current colorimetry.
| [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. |
Definition at line 148 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's current color space setting.
| [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. |
Definition at line 194 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's Dolby Vision flag is set.
| [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. |
Definition at line 157 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's video dynamic range and mastering information.
| [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. |
Definition at line 136 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's video dynamic range and mastering information.
| [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. |
Definition at line 76 of file ntv2hdmi.cpp.
|
virtual |
Answers if the given HDMI input is genlocked or not.
| [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. |
Definition at line 239 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's protocol.
| [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. |
Definition at line 229 of file ntv2hdmi.cpp.
|
virtual |
Answers with the current number of audio channels being received on the given HDMI input.
| [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. |
Definition at line 272 of file ntv2hdmi.cpp.
|
virtual |
Answers with the current colorspace for the given HDMI input.
| [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. |
Definition at line 52 of file ntv2hdmi.cpp.
|
virtual |
Answers with the given HDMI input's current input range setting.
| [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. |
Definition at line 176 of file ntv2hdmi.cpp.
|
virtual |
Answers with the contents of the HDMI Input status register for the given HDMI input.
Definition at line 44 of file ntv2hdmi.cpp.
|
protectedvirtual |
Answers with the HDMI Input status register number for the given HDMI input.
Definition at line 28 of file ntv2hdmi.cpp.
|
virtual |
| [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 3467 of file ntv2register.cpp.
|
virtual |
Answers with the given HDMI input's video black/white range.
| [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. |
Definition at line 64 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 324 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 312 of file ntv2hdmi.cpp.
|
virtual |
Answers with the HDMI output's current audio channel 3/4 swap setting.
| [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. |
Definition at line 1034 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 967 of file ntv2audio.cpp.
|
virtual |
Answers with the HDMI output's current audio format.
| [out] | outValue | Receives the HDMI output's current audio format. |
Definition at line 1100 of file ntv2audio.cpp.
|
virtual |
Answers with the HDMI output's current audio rate.
| [out] | outValue | Receives the HDMI output's current audio rate. |
Definition at line 1088 of file ntv2audio.cpp.
|
virtual |
Answers with the HDMI output's current 2-channel audio source.
| [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. |
Definition at line 995 of file ntv2audio.cpp.
|
virtual |
Answers with the HDMI output's current 8-channel audio source.
| [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. |
Definition at line 1050 of file ntv2audio.cpp.
|
virtual |
Definition at line 492 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 414 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 557 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 450 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 456 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 531 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 585 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 543 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 519 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 390 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 363 of file ntv2hdmi.cpp.
|
virtual |
Answers with the current HDMI output status.
| [out] | outStatus | Receives the current status of the HDMI output. |
Definition at line 606 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 571 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 377 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 339 of file ntv2hdmi.cpp.
|
virtual |
Answers with the current HDMI V2 mode of the device.
| [out] | outMode | Receives the current HDMI V2 operation mode for the device. |
Definition at line 599 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 988 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 995 of file ntv2hdmi.cpp.
|
virtual |
Answers with the current gain setting for the headphone out.
| [out] | outGainValue | Receives the current headphone gain level. This is a signed 18-bit value, where unity gain is 0x10000. |
Definition at line 812 of file ntv2audio.cpp.
|
virtual |
For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently not PCM-encoded.
| [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. |
Definition at line 1640 of file ntv2audio.cpp.
|
virtual |
For the given SDI input (specified as a channel number), returns the set of audio channel pairs that are currently PCM-encoded.
| [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. |
Definition at line 1612 of file ntv2audio.cpp.
|
virtual |
Returns the current field ID of the specified input channel.
| [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. |
Definition at line 198 of file ntv2subscriptions.cpp.
|
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.
| [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. |
Definition at line 2234 of file ntv2register.cpp.
|
virtual |
Answers with the number of input interrupt events that I successfully waited for on the given channel.
| [out] | outCount | Receives the number of input interrupt events that were successfully waited for. |
| [in] | inChannel | Specifies the NTV2Channel of interest. |
Definition at line 114 of file ntv2subscriptions.cpp.
|
virtual |
Answers with the number of input vertical interrupts handled by the driver for the given input channel.
| [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. |
Definition at line 98 of file ntv2subscriptions.cpp.
|
virtual |
Returns the video format of the signal that is present on the given input source.
| [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). |
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 3381 of file ntv2register.cpp.
|
virtual |
Definition at line 3373 of file ntv2register.cpp.
|
virtual |
Returns the size and time/date stamp of the device's currently-installed firmware.
| [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". |
Definition at line 267 of file ntv2card.cpp.
|
virtual |
Definition at line 35 of file ntv2regconv.cpp.
|
virtual |
Answers with the current state of the four on-board LEDs.
| [out] | outValue | Receives the current state of the four on-board LEDs. Only the least significant four bits of the ULWord have any meaning. |
Definition at line 2500 of file ntv2register.cpp.
|
virtual |
Definition at line 440 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 283 of file ntv2regconv.cpp.
|
virtual |
Definition at line 323 of file ntv2regconv.cpp.
|
virtual |
Definition at line 281 of file ntv2regconv.cpp.
|
virtual |
Definition at line 3698 of file ntv2register.cpp.
|
virtual |
Answers true if the device is currently configured to read analog LTC from the reference input connector (instead of reference).
| [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. |
Definition at line 3668 of file ntv2register.cpp.
|
virtual |
Answers whether or not a valid analog LTC signal is being applied to the device's analog LTC input connector.
| [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). |
Definition at line 3677 of file ntv2register.cpp.
|
virtual |
Definition at line 334 of file ntv2csclut.cpp.
|
virtual |
Reads the LUT tables (as double-precision floating point values).
| [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. |
Definition at line 984 of file ntv2csclut.cpp.
|
virtual |
Definition at line 258 of file ntv2csclut.cpp.
|
virtual |
Definition at line 137 of file ntv2csclut.cpp.
|
virtual |
Returns the current background input control value for the given mixer/keyer.
| [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. |
Definition at line 2922 of file ntv2register.cpp.
|
virtual |
Answers if the given mixer/keyer's background matte is enabled or not.
| [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. |
Definition at line 3005 of file ntv2register.cpp.
|
virtual |
Returns the current mix coefficient the given mixer/keyer.
| [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. |
Definition at line 2969 of file ntv2register.cpp.
|
virtual |
Returns the current foreground input control value for the given mixer/keyer.
| [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. |
Definition at line 2899 of file ntv2register.cpp.
|
virtual |
Answers if the given mixer/keyer's foreground matte is enabled or not.
| [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. |
Definition at line 2990 of file ntv2register.cpp.
|
virtual |
Answers with the given mixer/keyer's current matte color value being used.
| [in] | inWhichMixer | Specifies the mixer/keyer of interest as a zero-based index number. |
| [out] | outYCbCrValue | Receives the mixer's current matte color value. |
Definition at line 3022 of file ntv2register.cpp.
|
virtual |
Returns the current operating mode of the given mixer/keyer.
| [in] | inWhichMixer | Specifies the mixer/keyer of interest as a zero-based index number. |
| [out] | outMode | Receives the mode value. |
Definition at line 2945 of file ntv2register.cpp.
|
virtual |
Answers with the given mixer/keyer's current RGB Range.
| [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 3077 of file ntv2register.cpp.
|
virtual |
Returns the current sync state of the given mixer/keyer.
| [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. |
Definition at line 2978 of file ntv2register.cpp.
|
virtual |
Answers whether or not the VANC source for the given mixer/keyer is currently the foreground video. See the Ancillary Data discussion for more information.
| [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. |
Definition at line 2878 of file ntv2register.cpp.
|
virtual |
Answers with the current NTV2Mode of the given FrameStore on the AJA device.
| [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). |
In NTV2_MODE_CAPTURE mode, device frame memory is written; in NTV2_MODE_DISPLAY mode, it's read from.
Definition at line 1631 of file ntv2register.cpp.
|
virtual |
Answers with this device's model name.
Definition at line 78 of file ntv2card.cpp.
|
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.
| [out] | outIsEnabled | Receives true if the device is currently in multi-format mode, or false if it's in uni-format mode. |
Definition at line 4289 of file ntv2register.cpp.
|
virtual |
Answers with the current multi-link audio mode for the given audio system.
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. |
| [out] | outEnable | Receives true if multi-link audio mode is currently enabled; otherwise false if disabled. |
Definition at line 1761 of file ntv2audio.cpp.
|
virtual |
Definition at line 4664 of file ntv2register.cpp.
|
virtual |
Definition at line 599 of file ntv2register.cpp.
|
static |
Definition at line 379 of file ntv2register.cpp.
|
static |
Definition at line 373 of file ntv2register.cpp.
|
virtual |
Definition at line 774 of file ntv2register.cpp.
|
virtual |
Returns the current number of audio channels being captured or played by a given Audio System on the AJA device.
| [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 183 of file ntv2audio.cpp.
|
virtual |
Returns the current field ID of the specified output channel.
| [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. |
Definition at line 164 of file ntv2subscriptions.cpp.
|
virtual |
Answers with the current output frame number for the given FrameStore (expressed as an NTV2Channel).
| [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. |
Definition at line 2216 of file ntv2register.cpp.
|
virtual |
Answers with the number of output interrupt events that I successfully waited for on the given channel.
| [out] | outCount | Receives the number of output interrupt events that were successfully waited for. |
| [in] | inChannel | Specifies the NTV2Channel of interest. |
Definition at line 107 of file ntv2subscriptions.cpp.
|
virtual |
Answers with the number of output vertical interrupts handled by the driver for the given output channel.
| [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. |
Definition at line 91 of file ntv2subscriptions.cpp.
|
virtual |
Definition at line 2190 of file ntv2register.cpp.
|
virtual |
Answers with my PCI device ID.
| [out] | outPCIDeviceID | Receives my PCI device ID. |
Definition at line 2419 of file ntv2register.cpp.
|
virtual |
Definition at line 107 of file ntv2card.cpp.
|
virtual |
Definition at line 114 of file ntv2card.cpp.
|
virtual |
Answers with the implemented crosspoint connections (if known).
| [out] | outConnections | Receives the device's NTV2PossibleConnections. |
Definition at line 1811 of file ntv2register.cpp.
|
virtual |
Definition at line 2273 of file ntv2register.cpp.
|
virtual |
Definition at line 1083 of file ntv2register.cpp.
|
virtual |
Definition at line 2855 of file ntv2register.cpp.
|
virtual |
Returns the device's current quad-frame mode, whether it's enabled or not.
| [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 1211 of file ntv2register.cpp.
|
virtual |
Returns the device's current "quad-quad" frame mode, whether it's enabled or not.
| [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 1226 of file ntv2register.cpp.
|
virtual |
Returns the device's current "quad-quad-squares" frame mode, whether it's enabled or not.
| [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 1199 of file ntv2register.cpp.
|
virtual |
Answers with the current value of the 48kHz audio clock counter.
| [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. |
Definition at line 1819 of file ntv2audio.cpp.
|
virtual |
Answers with the device's current clock reference source.
| [out] | outRefSource | Receives the current NTV2ReferenceSource value. |
Definition at line 1527 of file ntv2register.cpp.
|
virtual |
Returns the video format of the signal that is present on the device's reference input.
Definition at line 3557 of file ntv2register.cpp.
Definition at line 3135 of file ntv2register.cpp.
|
virtual |
Answers with the FrameStore's current NTV2RegisterWriteMode setting, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect.
| [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. |
Definition at line 2486 of file ntv2register.cpp.
|
virtual |
Answers with the current signal routing between any and all widgets on the AJA device.
| [out] | outRouting | Receives the current signal routing. |
Definition at line 305 of file ntv2regroute.cpp.
|
virtual |
Answers with the current signal routing for the given channel.
| [in] | inChannel | Specifies the NTV2Channel of interest. |
| [out] | outRouting | Receives the current signal routing for the given channel. |
Definition at line 362 of file ntv2regroute.cpp.
|
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.
| [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. |
Definition at line 2606 of file ntv2register.cpp.
|
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...
| [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. |
Definition at line 2526 of file ntv2register.cpp.
|
virtual |
Returns the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel.
| [in] | inChannel | Specifies the channel of interest. |
| [out] | outMode | Receives the RP-188 mode for the given channel. |
Definition at line 2515 of file ntv2register.cpp.
|
virtual |
Returns the current RP188 filter setting for the given SDI input.
| [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. |
Definition at line 2557 of file ntv2register.cpp.
|
virtual |
Answers with the current baud rate of the specified RS422 serial port.
| [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. |
Definition at line 4367 of file ntv2register.cpp.
|
virtual |
Answers with the current parity control for the specified RS422 serial port.
| [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. |
Definition at line 4324 of file ntv2register.cpp.
|
virtual |
Reports the (local Pacific) build date and time of the currently-running firmware.
| [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. |
Definition at line 2383 of file ntv2register.cpp.
|
virtual |
Reports the (local Pacific) build date of the currently-running firmware.
| [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). |
Definition at line 2330 of file ntv2register.cpp.
|
virtual |
Reports the revision number of the currently-running firmware package. KonaIP style boards have a package.
| [out] | outRevision | Receives the revision number. |
Definition at line 2306 of file ntv2register.cpp.
|
virtual |
Reports the revision number of the currently-running firmware.
| [out] | outRevision | Receives the revision number. |
Definition at line 2316 of file ntv2register.cpp.
|
virtual |
Reports the (local Pacific) build time of the currently-running firmware.
| [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). |
Definition at line 2359 of file ntv2register.cpp.
|
virtual |
Reports the UserID number of the currently-running firmware.
| [out] | outUserID | Receives the UserID. |
Definition at line 2402 of file ntv2register.cpp.
|
virtual |
Definition at line 3349 of file ntv2register.cpp.
|
virtual |
Definition at line 3353 of file ntv2register.cpp.
|
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).
| [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 4194 of file ntv2register.cpp.
|
virtual |
Definition at line 3647 of file ntv2register.cpp.
|
virtual |
Definition at line 3623 of file ntv2register.cpp.
|
virtual |
Definition at line 3611 of file ntv2register.cpp.
|
virtual |
Definition at line 3635 of file ntv2register.cpp.
|
virtual |
Definition at line 3585 of file ntv2register.cpp.
|
virtual |
Definition at line 3601 of file ntv2register.cpp.
|
virtual |
Definition at line 3569 of file ntv2register.cpp.
|
virtual |
Returns the video format of the signal that is present on the given SDI input source.
| [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). |
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 3402 of file ntv2register.cpp.
|
virtual |
| [in] | inChannel | Specifies the channel (SDI input) of interest. |
Definition at line 4118 of file ntv2register.cpp.
|
virtual |
Definition at line 3929 of file ntv2register.cpp.
|
virtual |
Definition at line 3858 of file ntv2register.cpp.
|
virtual |
Definition at line 3887 of file ntv2register.cpp.
|
virtual |
Definition at line 3872 of file ntv2register.cpp.
|
virtual |
Definition at line 3904 of file ntv2register.cpp.
|
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).
| [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 4236 of file ntv2register.cpp.
|
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.)
| [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). |
Definition at line 553 of file ntv2audio.cpp.
|
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.
| [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). |
Definition at line 610 of file ntv2audio.cpp.
|
virtual |
Answers with the current video standard of the given SDI output spigot.
| [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. |
Definition at line 3274 of file ntv2register.cpp.
|
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).
| [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 4268 of file ntv2register.cpp.
|
virtual |
Definition at line 163 of file ntv2regvpid.cpp.
|
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.
| [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. |
Definition at line 3985 of file ntv2register.cpp.
|
virtual |
Answers if the bypass relays between connectors 1/2 or 3/4 are currently in bypass or routing the signals through the device.
| [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 3969 of file ntv2register.cpp.
|
virtual |
Answers whether or not the specified SDI connector is currently acting as a transmitter (i.e. an output).
| [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. |
Definition at line 3826 of file ntv2register.cpp.
|
virtual |
| [in] | inChannel | Specifies the channel (SDI input) of interest. |
Definition at line 4107 of file ntv2register.cpp.
|
virtual |
| [in] | inChannel | Specifies the channel (SDI input) of interest. |
Definition at line 4129 of file ntv2register.cpp.
|
virtual |
Answers true if the given connector pair relays are under watchdog timer control, or false if they're under manual control.
| [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. |
Definition at line 4013 of file ntv2register.cpp.
|
virtual |
Answers if the watchdog timer would put the SDI relays into NTV2_DEVICE_BYPASSED or NTV2_THROUGH_DEVICE.
| [out] | outValue | Receives the current state of the watchdog timer. |
Definition at line 3957 of file ntv2register.cpp.
|
virtual |
Answers with the amount of time that must elapse before the watchdog timer times out.
| [out] | outValue | Receives the time value in units of 8 nanoseconds. |
Definition at line 4041 of file ntv2register.cpp.
|
virtual |
Definition at line 3360 of file ntv2register.cpp.
|
virtual |
Answers with my serial number.
Definition at line 205 of file ntv2card.cpp.
|
protectedvirtual |
Definition at line 170 of file ntv2card.cpp.
|
protectedvirtual |
Definition at line 163 of file ntv2card.cpp.
|
virtual |
Answers with a string that contains my human-readable serial number.
Definition at line 219 of file ntv2card.cpp.
|
virtual |
Returns the device's current SMPTE-372 (dual-link) mode, whether it's enabled or not.
| [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. |
Should use bool& parameter instead of a ULWord&.
Should be named GetSMPTE372Enable.
Definition at line 1058 of file ntv2register.cpp.
|
virtual |
Definition at line 830 of file ntv2register.cpp.
|
virtual |
Definition at line 447 of file ntv2regconv.cpp.
|
virtual |
Definition at line 449 of file ntv2regconv.cpp.
|
virtual |
Definition at line 445 of file ntv2regconv.cpp.
|
virtual |
Definition at line 451 of file ntv2regconv.cpp.
|
virtual |
Definition at line 453 of file ntv2regconv.cpp.
|
virtual |
Definition at line 457 of file ntv2regconv.cpp.
|
virtual |
Definition at line 443 of file ntv2regconv.cpp.
|
virtual |
Definition at line 459 of file ntv2regconv.cpp.
|
virtual |
Definition at line 455 of file ntv2regconv.cpp.
|
virtual |
Returns a std::set of NTV2VideoFormat values that I support.
| [out] | outFormats | Receives the set of NTV2VideoFormat values, or empty upon failure. |
Definition at line 364 of file ntv2register.cpp.
|
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.
| [out] | outIsSuspended | Receives 'true' if the host OS audio service is currently suspended for the AJA device; otherwise, receives 'false'. |
Definition at line 1500 of file ntv2audio.cpp.
|
virtual |
Answers with the transmitting/output SDI connectors.
| [out] | outXmitSDIs | Receives the set of transmitting SDI connectors. |
Definition at line 3838 of file ntv2register.cpp.
|
virtual |
Returns the current SMPTE 425 two-sample-interleave frame mode on the device, whether it's enabled or not.
| [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 1406 of file ntv2register.cpp.
|
virtual |
Answers if the SMPTE 425 two-sample-interleave mux/demux input sync has failed or not.
| [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 1441 of file ntv2register.cpp.
|
virtual |
Definition at line 43 of file ntv2regconv.cpp.
|
virtual |
Definition at line 41 of file ntv2regconv.cpp.
|
virtual |
Definition at line 13 of file ntv2regconv.cpp.
|
virtual |
Retrieves the current VANC mode for the given FrameStore.
| [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. |
Definition at line 2744 of file ntv2register.cpp.
|
virtual |
Retrieves the current "VANC Shift Mode" feature for the given channel.
| [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. |
Definition at line 2837 of file ntv2register.cpp.
|
virtual |
Definition at line 3212 of file ntv2register.cpp.
|
virtual |
Definition at line 332 of file ntv2register.cpp.
|
virtual |
Answers with the current horizontal timing offset, in pixels, for the given SDI output connector.
| [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). |
Definition at line 704 of file ntv2register.cpp.
|
virtual |
Definition at line 2633 of file ntv2register.cpp.
|
virtual |
Answers with the current vertical timing offset, in lines, for the given SDI output connector.
| [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). |
Definition at line 752 of file ntv2register.cpp.
|
virtual |
Definition at line 188 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 198 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 208 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 178 of file ntv2regvpid.cpp.
|
virtual |
| [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.
|
virtual |
| [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.
|
virtual |
Definition at line 3150 of file ntv2register.cpp.
|
virtual |
Definition at line 339 of file ntv2csclut.cpp.
|
virtual |
Definition at line 4651 of file ntv2register.cpp.
|
virtual |
Get debug data from the hevc device.
| [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. |
Definition at line 173 of file ntv2hevc.cpp.
|
virtual |
Returns the driver version and time/date stamp of the hevc device's currently-installed firmware.
| [out] | pInfo | HevcDeviceInfo structure to receive the information. |
Definition at line 11 of file ntv2hevc.cpp.
|
virtual |
Get the status of the hevc device.
| [in] | pStatus | HevcDeviceDebug structure to receive the information. |
Definition at line 152 of file ntv2hevc.cpp.
|
virtual |
Read an hevc register.
| [in] | address | Hevc register byte address |
| [out] | pValue | Hevc register data |
| [in] | mask | Read bit mask |
| [in] | shift | Read bit shift |
Definition at line 54 of file ntv2hevc.cpp.
|
virtual |
Send a command to the hevc device. See the hevc codec documentation for details on commands.
| [in] | pCommand | HevcDeviceCommand structure with the command parameters. |
Definition at line 82 of file ntv2hevc.cpp.
|
virtual |
Transfer video to/from the hevc device.
| [in] | pTransfer | HevcDeviceTransfer structure with the transfer parameters. |
Definition at line 103 of file ntv2hevc.cpp.
|
virtual |
Write an hevc register.
| [in] | address | Hevc register byte address |
| [in] | value | Hevc register data |
| [in] | mask | Read bit mask |
| [in] | shift | Read bit shift |
Definition at line 32 of file ntv2hevc.cpp.
|
virtual |
For the given SDI input (specified as a channel number), answers if the specified audio channel pair is currently PCM-encoded or not.
| [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. |
Definition at line 1599 of file ntv2audio.cpp.
|
protectedvirtual |
Definition at line 177 of file ntv2card.cpp.
|
inlineprotectedvirtual |
Definition at line 6443 of file ntv2card.h.
|
protectedvirtual |
Definition at line 197 of file ntv2card.cpp.
|
protectedvirtual |
Definition at line 185 of file ntv2card.cpp.
|
virtual |
Answers whether or not the given NTV2AudioChannelPair in the given NTV2AudioSystem on the device is present in the input signal.
| [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. |
Definition at line 1445 of file ntv2audio.cpp.
|
virtual |
Answers whether or not the capture side of the given NTV2AudioSystem is currently running.
| [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'. |
Definition at line 1267 of file ntv2audio.cpp.
|
virtual |
Answers whether or not the playout side of the given NTV2AudioSystem is currently running.
| [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'. |
Definition at line 1176 of file ntv2audio.cpp.
|
virtual |
Definition at line 4688 of file ntv2register.cpp.
|
virtual |
Definition at line 1684 of file ntv2register.cpp.
|
virtual |
Answers whether or not the given FrameStore is enabled.
| [in] | inChannel | Specifies the FrameStore, as identified by an NTV2Channel value. |
| [out] | outEnabled | Receives "true" if the FrameStore is enabled, or "false" if disabled. |
Definition at line 2138 of file ntv2register.cpp.
|
virtual |
Answers whether or not the given widget signal input (sink) is connected to another output (source).
| [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). |
Definition at line 181 of file ntv2regroute.cpp.
|
virtual |
Answers whether or not the given widget signal input (sink) is connected to another output (source).
| [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. |
Definition at line 168 of file ntv2regroute.cpp.
|
virtual |
Definition at line 27 of file ntv2dynamicdevice.cpp.
|
virtual |
Definition at line 43 of file ntv2dynamicdevice.cpp.
|
virtual |
Answers whether or not the "fail-safe" (aka "safe-boot") bitfile is currently loaded and running in the FPGA.
| [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. |
Definition at line 303 of file ntv2card.cpp.
|
virtual |
Definition at line 4683 of file ntv2register.cpp.
|
virtual |
Definition at line 857 of file ntv2register.cpp.
|
virtual |
Answers if the SDI output's RP-188 bypass mode is enabled or not.
| [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). |
Definition at line 2565 of file ntv2register.cpp.
|
virtual |
Definition at line 878 of file ntv2register.cpp.
|
virtual |
Definition at line 2260 of file ntv2register.cpp.
|
virtual |
Restarts the countdown timer to prevent the watchdog timer from timing out.
Definition at line 3947 of file ntv2register.cpp.
|
virtual |
Definition at line 827 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1442 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1419 of file ntv2csclut.cpp.
|
virtual |
Quickly, dynamically loads the given device ID firmware.
| [in] | inDeviceID | Specifies the device ID of interest. |
Definition at line 145 of file ntv2dynamicdevice.cpp.
|
virtual |
Definition at line 1388 of file ntv2csclut.cpp.
|
virtual |
Writes the LUT tables.
| [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. |
Definition at line 809 of file ntv2csclut.cpp.
|
virtual |
Answers if the given mixer/keyer's has RGB mode support.
| [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 3062 of file ntv2register.cpp.
|
virtual |
Definition at line 2287 of file ntv2register.cpp.
|
virtual |
Definition at line 1076 of file ntv2csclut.cpp.
|
virtual |
Reads the current contents of the device's analog LTC input registers.
| [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. |
Definition at line 3714 of file ntv2register.cpp.
|
virtual |
Reads the current contents of the device's analog LTC input registers.
| [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. |
Definition at line 3704 of file ntv2register.cpp.
|
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.
| [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. |
Definition at line 468 of file ntv2audio.cpp.
|
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.
| [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. |
Definition at line 475 of file ntv2audio.cpp.
|
virtual |
Definition at line 483 of file ntv2audio.cpp.
|
virtual |
Definition at line 2251 of file ntv2register.cpp.
|
virtual |
Definition at line 415 of file ntv2regconv.cpp.
|
virtual |
Definition at line 419 of file ntv2regconv.cpp.
|
virtual |
Definition at line 416 of file ntv2regconv.cpp.
|
virtual |
Definition at line 420 of file ntv2regconv.cpp.
|
virtual |
Definition at line 414 of file ntv2regconv.cpp.
|
virtual |
Definition at line 417 of file ntv2regconv.cpp.
|
virtual |
Definition at line 418 of file ntv2regconv.cpp.
|
virtual |
Answers with the line offset into the frame currently being read (NTV2_MODE_DISPLAY) or written (NTV2_MODE_CAPTURE) for FrameStore 1.
| [out] | outValue | Receives the line number currently being read or written. |
Definition at line 2246 of file ntv2register.cpp.
|
virtual |
Reads the LUT tables (as raw, unsigned 10-bit integers).
| [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). |
Definition at line 1039 of file ntv2csclut.cpp.
|
virtual |
Returns the current output timing control value for the given SDI output connector.
| [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). |
Definition at line 3340 of file ntv2register.cpp.
|
virtual |
Definition at line 432 of file ntv2regconv.cpp.
|
virtual |
Definition at line 433 of file ntv2regconv.cpp.
|
virtual |
Definition at line 431 of file ntv2regconv.cpp.
|
virtual |
Definition at line 434 of file ntv2regconv.cpp.
|
virtual |
Definition at line 435 of file ntv2regconv.cpp.
|
virtual |
Definition at line 436 of file ntv2regconv.cpp.
|
virtual |
Definition at line 408 of file ntv2regconv.cpp.
|
virtual |
Definition at line 412 of file ntv2regconv.cpp.
|
virtual |
Definition at line 409 of file ntv2regconv.cpp.
|
virtual |
Definition at line 413 of file ntv2regconv.cpp.
|
virtual |
Definition at line 411 of file ntv2regconv.cpp.
|
virtual |
Definition at line 68 of file ntv2regvpid.cpp.
|
virtual |
For devices that support it (see the NTV2DeviceCanDoSDIErrorChecks function in "ntv2devicefeatures.h"), this function fetches the SDI statistics for all SDI input spigots.
| [out] | outStats | Receives the SDI statistics for all SDI input spigots. |
Definition at line 4601 of file ntv2register.cpp.
|
virtual |
Definition at line 407 of file ntv2regconv.cpp.
|
virtual |
Definition at line 410 of file ntv2regconv.cpp.
|
virtual |
Reads the block of virtual data for a specific tag.
| [in] | inTag | Tag for the virtual data. |
| [out] | outVirtualData | Virtual data buffer to be written |
| [in] | inVirtualDataSize | Virtual data size to read |
Definition at line 4582 of file ntv2register.cpp.
|
virtual |
Definition at line 4395 of file ntv2register.cpp.
|
virtual |
Removes the given widget routing connections from the AJA device.
| [in] | inConnections | Specifies the routing connections to be removed from the device. |
Definition at line 268 of file ntv2regroute.cpp.
|
protectedvirtual |
Definition at line 1116 of file ntv2autocirculate.cpp.
|
protectedvirtual |
Definition at line 987 of file ntv2autocirculate.cpp.
|
protectedvirtual |
|
protectedvirtual |
|
static |
Returns a string containing the decoded, human-readable device serial number.
| [in] | inSerialNumber | Specifies the 64-bit device serial number. |
Definition at line 213 of file ntv2card.cpp.
|
virtual |
Sets the LUT plane.
| [in] | inLUTPlane | Specifies the LUT plane of interest. |
Definition at line 345 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1425 of file ntv2csclut.cpp.
Definition at line 1402 of file ntv2csclut.cpp.
|
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.
| [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. |
Definition at line 1240 of file ntv2register.cpp.
|
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.
| [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. |
Definition at line 1568 of file ntv2audio.cpp.
|
virtual |
Definition at line 2243 of file ntv2register.cpp.
|
virtual |
Definition at line 1770 of file ntv2audio.cpp.
|
virtual |
Sets the specified bidirectional XLR audio connectors to collectively act as inputs or outputs.
| [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. |
Definition at line 1725 of file ntv2audio.cpp.
|
virtual |
Definition at line 274 of file ntv2regconv.cpp.
|
virtual |
Sets the (SDI) input channel that is to provide the clock reference to be used by the given analog LTC input.
| [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. |
Definition at line 3740 of file ntv2register.cpp.
|
virtual |
Sets the (SDI) output channel that is to provide the clock reference to be used by the given analog LTC output.
| [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. |
Definition at line 3785 of file ntv2register.cpp.
|
virtual |
Definition at line 3213 of file ntv2register.cpp.
|
virtual |
Enables or disables 20-bit mode for the NTV2AudioSystem.
| [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. |
Definition at line 1188 of file ntv2audio.cpp.
|
virtual |
Definition at line 283 of file ntv2audio.cpp.
|
virtual |
Changes the size of the audio buffer used for the given Audio System(s).
| [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. |
Definition at line 261 of file ntv2audio.cpp.
|
virtual |
Changes the size of the audio buffer that is used for a given Audio System in the AJA device.
| [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. |
Definition at line 252 of file ntv2audio.cpp.
|
virtual |
Enables or disables the writing of incoming audio into the given Audio System's capture buffer.
| [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. |
Definition at line 1279 of file ntv2audio.cpp.
|
virtual |
Sets the audio input delay for the given Audio System on the device.
| [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. |
Definition at line 1308 of file ntv2audio.cpp.
|
virtual |
Enables or disables NTV2AudioLoopBack mode for the given NTV2AudioSystem.
| [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. |
Definition at line 303 of file ntv2audio.cpp.
|
virtual |
Enables or disables NTV2AudioLoopBack mode for the given Audio Systems.
| [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. |
Definition at line 314 of file ntv2audio.cpp.
|
virtual |
Sets the Audio System that will drive the given input of the Audio Mixer.
| [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. |
Definition at line 676 of file ntv2audio.cpp.
|
virtual |
Specifies the Audio Channel Pair that will drive the given input of the Audio Mixer.
| [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. |
Definition at line 704 of file ntv2audio.cpp.
|
virtual |
Mutes (or enables) the given output audio channel of the Audio Mixer.
| [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. |
Definition at line 863 of file ntv2audio.cpp.
|
virtual |
Sets the gain for the given input of the Audio Mixer.
| [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. |
Definition at line 733 of file ntv2audio.cpp.
|
virtual |
Sets the Audio Mixer's sample count it uses for measuring audio levels.
| [in] | inSampleCount | Specifies the new sample count. Must be a power of two (e.g. 1, 2, 4, 8 ...) up to 0x8000 maximum. |
Definition at line 947 of file ntv2audio.cpp.
|
virtual |
Mutes or enables the individual output audio channels of the Audio Mixer.
| [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. |
Definition at line 842 of file ntv2audio.cpp.
|
virtual |
Sets the gain for the output of the Audio Mixer.
| [in] | inGainValue | Specifies the new input gain level. This is a signed 18-bit value, where unity gain is 0x10000. |
Definition at line 754 of file ntv2audio.cpp.
|
virtual |
Sets or clears the AES Sync Mode bit for the given Audio System's output.
| [in] | inAudioSystem | Specifies the audio system of interest. |
| [in] | inAESSyncModeBitSet | Specify 'true' to set the AES Sync Mode bit; otherwise 'false' for normal operation. |
Definition at line 1810 of file ntv2audio.cpp.
|
virtual |
Sets the audio output delay for the given Audio System on the device.
| [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. |
Definition at line 1324 of file ntv2audio.cpp.
|
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.
| [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. |
Definition at line 1688 of file ntv2audio.cpp.
|
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.
| [in] | inAudioSystem | Specifies the audio system of interest. |
| [in] | inEraseModeEnabled | Specify 'true' to enable output erase mode; otherwise 'false' for normal operation. |
Definition at line 1716 of file ntv2audio.cpp.
|
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.
| [in] | inAudioSystem | Specifies the audio system to use. |
| [in] | inChannelPair | Specifies the audio channel pair to use. |
Definition at line 1106 of file ntv2audio.cpp.
|
virtual |
Pauses or resumes output of audio samples and advancement of the audio buffer pointer ("play head") of the given Audio System.
| [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"). |
Definition at line 1204 of file ntv2audio.cpp.
|
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.
| [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). |
Definition at line 1340 of file ntv2audio.cpp.
|
virtual |
Determines whether the given audio channel pair being transmitted by the given Audio System is to be flagged as non-PCM or not.
| [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). |
Definition at line 1354 of file ntv2audio.cpp.
|
virtual |
Sets the non-PCM indicator in the AES header of the given channel pairs for the given Audio System on the device.
| [in] | inAudioSystem | Specifies the Audio System of interest. |
| [in] | inNonPCMChannelPairs | Specifies the audio channel pairs whose non-PCM indicators will be set "On". |
Definition at line 1366 of file ntv2audio.cpp.
|
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.
| [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 1293 of file ntv2audio.cpp.
|
virtual |
Sets the NTV2AudioRate for the given Audio System.
| [in] | inRate | Specifies the new NTV2AudioRate. |
| [in] | inAudioSystem | Optionally specifies the Audio System of interest. Defaults to NTV2_AUDIOSYSTEM_1. |
Definition at line 208 of file ntv2audio.cpp.
|
virtual |
Sets the audio source for the given NTV2AudioSystem on the device.
| [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. |
Definition at line 488 of file ntv2audio.cpp.
|
virtual |
Definition at line 155 of file ntv2csclut.cpp.
|
virtual |
Definition at line 68 of file ntv2csclut.cpp.
|
virtual |
Sets the LUT bank to be used for the given LUT.
| [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. |
Definition at line 85 of file ntv2csclut.cpp.
|
virtual |
Definition at line 311 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1211 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1252 of file ntv2csclut.cpp.
|
virtual |
Specifies whether or not the given CSC will produce alpha channel data from its key input.
| [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). |
Definition at line 1199 of file ntv2csclut.cpp.
|
virtual |
Sets the matrix type to be used for the given CSC, typically NTV2_Rec601Matrix or NTV2_Rec709Matrix.
| [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). |
Definition at line 452 of file ntv2csclut.cpp.
|
virtual |
Selects the color space converter operation method.
| [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. |
Definition at line 364 of file ntv2csclut.cpp.
|
virtual |
Sets the RGB range for the given CSC.
| [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). |
Definition at line 1165 of file ntv2csclut.cpp.
|
virtual |
Definition at line 1186 of file ntv2csclut.cpp.
|
virtual |
OK...shouldda been a table....started off as only 8 modes....
Definition at line 46 of file ntv2regconv.cpp.
|
virtual |
Definition at line 20 of file ntv2regconv.cpp.
|
virtual |
Definition at line 18 of file ntv2regconv.cpp.
|
virtual |
Definition at line 16 of file ntv2regconv.cpp.
|
virtual |
Definition at line 14 of file ntv2regconv.cpp.
|
virtual |
Definition at line 38 of file ntv2regconv.cpp.
|
virtual |
Definition at line 190 of file ntv2register.cpp.
|
virtual |
Definition at line 36 of file ntv2regconv.cpp.
|
virtual |
Definition at line 3187 of file ntv2register.cpp.
|
virtual |
Definition at line 22 of file ntv2regconv.cpp.
|
virtual |
Definition at line 3172 of file ntv2register.cpp.
|
virtual |
Definition at line 3160 of file ntv2register.cpp.
|
virtual |
Sets the NTV2EmbeddedAudioClock setting for the given NTV2AudioSystem.
| [in] | inValue | Specifies the NTV2EmbeddedAudioClock setting to use. |
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. Defaults to NTV2_AUDIOSYSTEM_1. |
Definition at line 420 of file ntv2audio.cpp.
|
virtual |
Sets the embedded (SDI) audio source for the given NTV2AudioSystem on the device.
| [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. |
Definition at line 349 of file ntv2audio.cpp.
|
virtual |
Definition at line 25 of file ntv2regconv.cpp.
|
virtual |
Definition at line 2736 of file ntv2register.cpp.
|
virtual |
Definition at line 2641 of file ntv2register.cpp.
|
inlinevirtual |
Definition at line 1447 of file ntv2card.h.
|
virtual |
Definition at line 1963 of file ntv2register.cpp.
|
virtual |
Definition at line 333 of file ntv2audio.cpp.
|
virtual |
Sets the device's task mode.
| [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. |
Definition at line 179 of file ntv2register.cpp.
|
virtual |
Definition at line 3203 of file ntv2register.cpp.
|
virtual |
Sets the frame buffer format for the given FrameStore(s) on the AJA device.
| [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 1874 of file ntv2register.cpp.
|
virtual |
Sets the frame buffer format for the given FrameStore on the AJA device.
| [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 1828 of file ntv2register.cpp.
|
virtual |
Sets the frame buffer orientation for the given NTV2Channel.
| [in] | inChannel | Specifies the channel (aka FrameStore) of interest. |
| [in] | inValue | Specifies the new frame buffer orientation. |
Definition at line 1983 of file ntv2register.cpp.
|
virtual |
Definition at line 1929 of file ntv2register.cpp.
|
virtual |
Definition at line 1909 of file ntv2register.cpp.
|
virtual |
Sets the device's intrinsic frame buffer size.
| [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. |
Definition at line 2008 of file ntv2register.cpp.
|
virtual |
Sets the device's intrinsic frame buffer size.
| [in] | inSize | Specifies the intrinsic frame size the hardware should use. |
Definition at line 1752 of file ntv2register.cpp.
|
virtual |
Sets the frame geometry of the given channel.
| [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. |
Definition at line 899 of file ntv2register.cpp.
|
virtual |
Sets the device's frame pulse reference source. See Device Clocking and Synchronization for more information.
| [in] | inRefSource | Specifies the NTV2ReferenceSource to use for the device's frame pulse reference. |
Definition at line 1592 of file ntv2register.cpp.
|
virtual |
Sets the AJA device's frame rate.
| [in] | inNewValue | Specifies the new NTV2FrameRate value the AJA device is to be configured with. |
| [in] | inChannel | Specifies the NTV2Channel of interest. |
Definition at line 1007 of file ntv2register.cpp.
|
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.
| [in] | inBluePrimaryX | Specifies the Blue Primary X value as defined in SMPTE ST 2086. |
Definition at line 660 of file ntv2hdmi.cpp.
|
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.
| [in] | inBluePrimaryY | Specifies the Blue Primary Y value as defined in SMPTE ST 2086. |
Definition at line 680 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 1014 of file ntv2hdmi.cpp.
|
virtual |
Enables or disables BT.2020 Y'cC'bcC'rc versus BT.2020 Y'C'bC'r or R'G'B'.
| [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'. |
Definition at line 860 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 1024 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 883 of file ntv2hdmi.cpp.
|
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.
| [in] | inGreenPrimaryX | Specifies the Green Primary X value as defined in SMPTE ST 2086. |
Definition at line 620 of file ntv2hdmi.cpp.
|
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.
| [in] | inGreenPrimaryY | Specifies the Green Primary Y value as defined in SMPTE ST 2086. |
Definition at line 640 of file ntv2hdmi.cpp.
|
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.
| [in] | inMaxContentLightLevel | Specifies the Max Content Light Level value. |
Definition at line 820 of file ntv2hdmi.cpp.
|
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.
| [in] | inMaxFrameAverageLightLevel | Specifies the Max Frame Average Light Level value. |
Definition at line 840 of file ntv2hdmi.cpp.
|
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.
| [in] | inMaxMasteringLuminance | Specifies the Max Mastering Luminance value. |
Definition at line 780 of file ntv2hdmi.cpp.
|
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.
| [in] | inMinMasteringLuminance | Specifies the Min Mastering Luminance value. |
Definition at line 800 of file ntv2hdmi.cpp.
|
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.
| [in] | inRedPrimaryX | Specifies the Red Primary X value as defined in SMPTE ST 2086. |
Definition at line 700 of file ntv2hdmi.cpp.
|
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.
| [in] | inRedPrimaryY | Specifies the Red Primary Y value as defined in SMPTE ST 2086. |
Definition at line 720 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 903 of file ntv2hdmi.cpp.
|
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.
| [in] | inWhitePointX | Specifies the White Point X value as defined in SMPTE ST 2086. |
Definition at line 740 of file ntv2hdmi.cpp.
|
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.
| [in] | inWhitePointY | Specifies the White Point Y value as defined in SMPTE ST 2086. |
Definition at line 760 of file ntv2hdmi.cpp.
|
virtual |
Sets the given HDMI input's audio channel 3/4 swap state.
| [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. |
Definition at line 296 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 252 of file ntv2hdmi.cpp.
|
virtual |
Sets the given HDMI input's bit depth.
| [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. |
Definition at line 203 of file ntv2hdmi.cpp.
|
virtual |
Sets the given HDMI input's color space.
| [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. |
Definition at line 185 of file ntv2hdmi.cpp.
|
virtual |
Sets the given HDMI input's input range.
| [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. |
Definition at line 167 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 318 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 306 of file ntv2hdmi.cpp.
|
virtual |
Sets the HDMI output's audio channel 3/4 swap state.
| [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. |
Definition at line 1042 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 961 of file ntv2audio.cpp.
|
virtual |
Sets the HDMI output's audio format.
| [in] | inNewValue | Specifies the audio format |
Definition at line 1094 of file ntv2audio.cpp.
|
virtual |
Sets the HDMI output's audio rate.
| [in] | inNewValue | Specifies the audio rate |
Definition at line 1082 of file ntv2audio.cpp.
|
virtual |
Sets the HDMI output's 2-channel audio source.
| [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. |
Definition at line 973 of file ntv2audio.cpp.
|
virtual |
Changes the HDMI output's 8-channel audio source.
| [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. |
Definition at line 1024 of file ntv2audio.cpp.
|
virtual |
Definition at line 462 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 398 of file ntv2hdmi.cpp.
|
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.
| [in] | inEnable | If true, enables decimation mode; otherwise disables decimation mode. |
Definition at line 550 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 525 of file ntv2hdmi.cpp.
|
virtual |
Enables or disables level-B mode on the device's HDMI rasterizer.
| [in] | inEnable | If true, enables level-B mode; otherwise disables level-B mode. |
Definition at line 578 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 537 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 512 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 383 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 354 of file ntv2hdmi.cpp.
|
virtual |
Enables or disables two sample interleave I/O mode on the device's HDMI rasterizer.
| [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.
|
virtual |
Definition at line 370 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 331 of file ntv2hdmi.cpp.
|
virtual |
Sets HDMI V2 mode for the device.
| [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. |
Definition at line 592 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 348 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 961 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 969 of file ntv2hdmi.cpp.
|
virtual |
Sets the gain for the headphone out.
| [in] | inGainValue | Specifies the new headphone gain level. This is a signed 18-bit value, where unity gain is 0x10000. |
Definition at line 820 of file ntv2audio.cpp.
|
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.
| [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. |
Definition at line 2225 of file ntv2register.cpp.
|
virtual |
Resets my input interrupt event tally for the given channel.
| [in] | inCount | Specifies the new count value. Use zero to reset the tally. |
| [in] | inChannel | Specifies the [input] channel. |
Definition at line 128 of file ntv2subscriptions.cpp.
|
virtual |
Definition at line 3368 of file ntv2register.cpp.
|
virtual |
Definition at line 24 of file ntv2regconv.cpp.
|
virtual |
The four on-board LEDs can be set by writing 0-15.
| [in] | inValue | Sets the state of the four on-board LEDs using the least significant four bits of the given ULWord value. |
Definition at line 2499 of file ntv2register.cpp.
|
virtual |
Definition at line 435 of file ntv2hdmi.cpp.
|
virtual |
Definition at line 286 of file ntv2regconv.cpp.
|
virtual |
Definition at line 282 of file ntv2regconv.cpp.
|
virtual |
Definition at line 280 of file ntv2regconv.cpp.
|
virtual |
Definition at line 3693 of file ntv2register.cpp.
|
virtual |
Enables or disables the ability for the device to read analog LTC on the reference input connector.
| [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. |
Definition at line 3660 of file ntv2register.cpp.
|
virtual |
Definition at line 329 of file ntv2csclut.cpp.
|
virtual |
Enables or disables the given LUT.
| [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). |
Definition at line 1128 of file ntv2csclut.cpp.
|
virtual |
Definition at line 195 of file ntv2csclut.cpp.
|
virtual |
Definition at line 102 of file ntv2csclut.cpp.
|
virtual |
Sets the background input control value for the given mixer/keyer.
| [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. |
Definition at line 2913 of file ntv2register.cpp.
|
virtual |
Answers if the given mixer/keyer's background matte is enabled or not.
| [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. |
Definition at line 3013 of file ntv2register.cpp.
|
virtual |
Sets the current mix coefficient of the given mixer/keyer.
| [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. |
Definition at line 2960 of file ntv2register.cpp.
|
virtual |
Sets the foreground input control value for the given mixer/keyer.
| [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. |
Definition at line 2890 of file ntv2register.cpp.
|
virtual |
Answers if the given mixer/keyer's foreground matte is enabled or not.
| [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. |
Definition at line 2998 of file ntv2register.cpp.
|
virtual |
Sets the matte color to use for the given mixer/keyer.
| [in] | inWhichMixer | Specifies the mixer/keyer of interest as a zero-based index number. |
| [in] | inYCbCrValue | Specifies the new matte color value to use. |
Definition at line 3037 of file ntv2register.cpp.
|
virtual |
Sets the mode for the given mixer/keyer.
| [in] | inWhichMixer | Specifies the mixer/keyer of interest as a zero-based index number. |
| [in] | inMode | Specifies the mode value. |
Definition at line 2936 of file ntv2register.cpp.
|
virtual |
Sets the RGB range for the given mixer/keyer.
| [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 3070 of file ntv2register.cpp.
|
virtual |
Sets the VANC source for the given mixer/keyer to the foreground video (or not). See the Ancillary Data discussion for more information.
| [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. |
Definition at line 2869 of file ntv2register.cpp.
|
virtual |
Determines if a given FrameStore on the AJA device will be used to capture or playout video.
| [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. |
In NTV2_MODE_CAPTURE mode, device frame memory is written; in NTV2_MODE_DISPLAY mode, it's read from.
Definition at line 1613 of file ntv2register.cpp.
|
virtual |
Sets the capture or playout mode of a set of FrameStores on the AJA device.
| [in] | inChannels | Specifies the FrameStore(s) of interest. |
| [in] | inNewValue | Specifies the desired mode (NTV2_MODE_DISPLAY or NTV2_MODE_CAPTURE). |
In NTV2_MODE_CAPTURE mode, device frame memory is written; in NTV2_MODE_DISPLAY mode, it's read from.
Definition at line 1622 of file ntv2register.cpp.
|
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.
| [in] | inEnable | If true, sets the device in multi-format mode. If false, sets the device in uni-format mode. |
Definition at line 4281 of file ntv2register.cpp.
|
virtual |
Sets the multi-link audio mode for the given audio system.
| [in] | inAudioSystem | Specifies the NTV2AudioSystem of interest. |
| [in] | inEnable | Specify true to enable multi-link audio mode; otherwise specify false. |
Definition at line 1753 of file ntv2audio.cpp.
|
virtual |
Definition at line 4659 of file ntv2register.cpp.
|
virtual |
Sets the number of audio channels to be concurrently captured or played for a given Audio System on the AJA device.
| [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 149 of file ntv2audio.cpp.
|
virtual |
Sets the number of audio channels to be concurrently captured or played for the given Audio System(s).
| [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 173 of file ntv2audio.cpp.
|
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.
| [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. |
Definition at line 2207 of file ntv2register.cpp.
|
virtual |
Resets my output interrupt event tally for the given channel.
| [in] | inCount | Specifies the new count value. Use zero to reset the tally. |
| [in] | inChannel | Specifies the [output] channel. |
Definition at line 123 of file ntv2subscriptions.cpp.
|
virtual |
Definition at line 2180 of file ntv2register.cpp.
|
virtual |
Definition at line 1074 of file ntv2register.cpp.
|
virtual |
Definition at line 2847 of file ntv2register.cpp.
|
virtual |
Enables or disables quad-frame mode on the device.
| [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. |
Definition at line 1094 of file ntv2register.cpp.
|
virtual |
Enables or disables "quad-quad" 8K frame mode on the device.
| [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. |
Definition at line 1127 of file ntv2register.cpp.
|
virtual |
Enables or disables quad-quad-frame (8K) squares mode on the device.
| [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 1182 of file ntv2register.cpp.
|
virtual |
Sets the device's clock reference source. See Device Clocking and Synchronization for more information.
| [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. |
Definition at line 1486 of file ntv2register.cpp.
|
virtual |
Sets the FrameStore's NTV2RegisterWriteMode, which determines when CNTV2Card::SetInputFrame or CNTV2Card::SetOutputFrame calls (and others) actually take effect.
| [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. |
Definition at line 2464 of file ntv2register.cpp.
|
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.
| [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. |
Definition at line 2597 of file ntv2register.cpp.
|
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.
| [in] | inSDIOutput | Specifies the SDI output of interest as an NTV2Channel value. |
| [in] | inRP188Data | Specifies the raw RP188 data values to be written. |
Definition at line 2537 of file ntv2register.cpp.
|
virtual |
Sets the current RP188 mode – NTV2_RP188_INPUT or NTV2_RP188_OUTPUT – for the given channel.
| [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. |
Definition at line 2507 of file ntv2register.cpp.
|
virtual |
Sets the RP188 DBB filter for the given SDI input.
| [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. |
Definition at line 2549 of file ntv2register.cpp.
|
virtual |
Sets the baud rate of the specified RS422 serial port.
| [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.) |
Definition at line 4345 of file ntv2register.cpp.
|
virtual |
Sets the parity control on the specified RS422 serial port.
| [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. |
Definition at line 4294 of file ntv2register.cpp.
|
virtual |
Definition at line 3348 of file ntv2register.cpp.
|
virtual |
Definition at line 3352 of file ntv2register.cpp.
|
virtual |
Enables or disables 3G level B to 3G level A conversion at the SDI input(s).
| [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 4185 of file ntv2register.cpp.
|
virtual |
Enables or disables 3G level B to 3G level A conversion at the SDI input widget (assuming the AJA device can do so).
| [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 4162 of file ntv2register.cpp.
|
virtual |
Definition at line 3919 of file ntv2register.cpp.
|
virtual |
Definition at line 3851 of file ntv2register.cpp.
|
virtual |
Definition at line 3880 of file ntv2register.cpp.
|
virtual |
Definition at line 3865 of file ntv2register.cpp.
|
virtual |
Definition at line 3894 of file ntv2register.cpp.
|
virtual |
Enables or disables 3G level A to 3G level B conversion at the given SDI output(s).
| [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 4227 of file ntv2register.cpp.
|
virtual |
Enables or disables 3G level A to 3G level B conversion at the SDI output widget (assuming the AJA device can do so).
| [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 4217 of file ntv2register.cpp.
|
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).
| [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). |
Definition at line 573 of file ntv2audio.cpp.
|
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).
| [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). |
Definition at line 600 of file ntv2audio.cpp.
|
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.
| [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). |
Definition at line 630 of file ntv2audio.cpp.
|
virtual |
Sets the video standard for the given SDI output(s).
| [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. |
Definition at line 3265 of file ntv2register.cpp.
|
virtual |
Sets the SDI output spigot's video standard.
| [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. |
Definition at line 3216 of file ntv2register.cpp.
|
virtual |
Enables or disables an RGB-over-3G-level-A conversion at the given SDI output(s).
| [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 4259 of file ntv2register.cpp.
|
virtual |
Enables or disables an RGB-over-3G-level-A conversion at the SDI output widget (assuming the AJA device can do so).
| [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 4249 of file ntv2register.cpp.
|
virtual |
Definition at line 135 of file ntv2regvpid.cpp.
|
virtual |
Sets the state of the given connector pair relays to NTV2_DEVICE_BYPASSED (or NTV2_THROUGH_DEVICE if under manual control).
| [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. |
Definition at line 4001 of file ntv2register.cpp.
|
virtual |
Sets the specified bidirectional SDI connector to act as an input or an output.
| [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. |
Definition at line 3805 of file ntv2register.cpp.
|
virtual |
Sets the specified SDI connector(s) to act as an input or an output.
| [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. |
Definition at line 3817 of file ntv2register.cpp.
|
virtual |
Sets the connector pair relays to be under watchdog timer control or manual control.
| [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. |
Definition at line 4029 of file ntv2register.cpp.
|
virtual |
Specifies the amount of time that must elapse before the watchdog timer times out.
| [in] | inValue | Specifies the timeout interval in units of 8 nanoseconds. |
Definition at line 4049 of file ntv2register.cpp.
|
virtual |
Definition at line 3355 of file ntv2register.cpp.
|
virtual |
Enables or disables the device's SMPTE-372 (dual-link) mode (used for older 3G-levelB-capable devices).
| [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. |
Should use bool parameter instead of a ULWord.
Should be named SetSMPTE372Enable.
Definition at line 1045 of file ntv2register.cpp.
|
virtual |
Definition at line 809 of file ntv2register.cpp.
|
virtual |
Definition at line 446 of file ntv2regconv.cpp.
|
virtual |
Definition at line 448 of file ntv2regconv.cpp.
|
virtual |
Definition at line 444 of file ntv2regconv.cpp.
|
virtual |
Definition at line 450 of file ntv2regconv.cpp.
|
virtual |
Definition at line 452 of file ntv2regconv.cpp.
|
virtual |
Definition at line 456 of file ntv2regconv.cpp.
|
virtual |
Definition at line 442 of file ntv2regconv.cpp.
|
virtual |
Definition at line 458 of file ntv2regconv.cpp.
|
virtual |
Definition at line 454 of file ntv2regconv.cpp.
|
virtual |
Suspends or resumes host OS audio (e.g. CoreAudio on MacOS) for the AJA device.
| [in] | inSuspend | If true, suspends host OS audio for the AJA device; otherwise, resumes it. |
Definition at line 1494 of file ntv2audio.cpp.
|
virtual |
Enables or disables SMPTE 425 two-sample interleave (Tsi) frame mode on the device.
| [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. |
Definition at line 1313 of file ntv2register.cpp.
|
virtual |
Definition at line 42 of file ntv2regconv.cpp.
|
virtual |
Definition at line 40 of file ntv2regconv.cpp.
|
virtual |
Definition at line 12 of file ntv2regconv.cpp.
|
virtual |
Sets the VANC mode for the given FrameStores.
| [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. |
Definition at line 2646 of file ntv2register.cpp.
|
virtual |
Sets the VANC mode for the given FrameStore.
| [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. |
Definition at line 2656 of file ntv2register.cpp.
|
inlinevirtual |
Definition at line 1449 of file ntv2card.h.
|
virtual |
Enables or disables the "VANC Shift Mode" feature for the given channel.
| [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. |
Definition at line 2816 of file ntv2register.cpp.
|
virtual |
Sets the "VANC Shift Mode" for the given channel(s).
| [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. |
Definition at line 2827 of file ntv2register.cpp.
|
virtual |
Definition at line 3211 of file ntv2register.cpp.
|
virtual |
Sets the video format for one or more FrameStores.
| [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. |
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 320 of file ntv2register.cpp.
|
virtual |
Configures the AJA device to handle a specific video format.
| [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. |
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.
|
virtual |
Adjusts the horizontal timing offset, in pixels, for the given SDI output connector.
| [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). |
Definition at line 618 of file ntv2register.cpp.
|
virtual |
Definition at line 2625 of file ntv2register.cpp.
|
virtual |
Adjusts the vertical timing offset, in lines, for the given SDI output connector.
| [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). |
Definition at line 725 of file ntv2register.cpp.
|
virtual |
Definition at line 183 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 193 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 203 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 173 of file ntv2regvpid.cpp.
|
protectedvirtual |
Definition at line 4446 of file ntv2register.cpp.
|
virtual |
Starts the capture side of the given NTV2AudioSystem, writing incoming audio samples into the Audio System's capture buffer.
| [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. |
Definition at line 1218 of file ntv2audio.cpp.
|
virtual |
Starts the playout side of the given NTV2AudioSystem, reading outgoing audio samples from the Audio System's playout buffer.
| [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. |
Definition at line 1129 of file ntv2audio.cpp.
|
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.
| [in] | inAudioSystem | Specifies the Audio System of interest. |
Definition at line 1260 of file ntv2audio.cpp.
|
virtual |
Stops the playout side of the given NTV2AudioSystem, parking the "Read Head" at the start of the playout buffer.
| [in] | inAudioSystem | Specifies the Audio System of interest. |
Definition at line 1170 of file ntv2audio.cpp.
|
virtual |
Queue a buffer to the stream. The bufferCookie is a user defined identifier of the buffer used by the stream methods.
Definition at line 67 of file ntv2stream.cpp.
|
virtual |
Remove the oldest buffer released by the streaming engine from the buffer queue.
Definition at line 77 of file ntv2stream.cpp.
|
virtual |
Get the status of the buffer identified by the bufferCookie.
Definition at line 85 of file ntv2stream.cpp.
|
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.
Definition at line 43 of file ntv2stream.cpp.
|
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.
|
virtual |
Release a stream. Releases all buffers remaining in the queue.
Definition at line 19 of file ntv2stream.cpp.
|
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.
Definition at line 27 of file ntv2stream.cpp.
|
virtual |
Get the current stream status.
Definition at line 51 of file ntv2stream.cpp.
|
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.
Definition at line 35 of file ntv2stream.cpp.
|
virtual |
Wait for any stream event. Returns for any state or buffer change.
Definition at line 59 of file ntv2stream.cpp.
|
virtual |
Causes me to be notified when the given event/interrupt is triggered for the AJA device.
| [in] | inEventCode | Specifies the INTERRUPT_ENUMS of interest. |
Definition at line 19 of file ntv2subscriptions.cpp.
|
virtual |
Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel.
| [in] | inChannel | Specifies the input channel of interest. Defaults to NTV2_CHANNEL1. |
Definition at line 39 of file ntv2subscriptions.cpp.
|
virtual |
Causes me to be notified when an input vertical blanking interrupt occurs on the given input channel(s).
| [in] | inChannels | Specifies the input channel(s) of interest. |
Definition at line 44 of file ntv2subscriptions.cpp.
|
virtual |
Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel.
| [in] | inChannel | Specifies the output channel of interest. |
Definition at line 25 of file ntv2subscriptions.cpp.
|
virtual |
Causes me to be notified when an output vertical blanking interrupt is generated for the given output channel(s).
| [in] | inChannels | Specifies the output channel(s) of interest. |
Definition at line 30 of file ntv2subscriptions.cpp.
|
virtual |
Definition at line 2443 of file ntv2register.cpp.
|
virtual |
Definition at line 2421 of file ntv2register.cpp.
|
virtual |
Unregisters me so I'm no longer notified when the given event/interrupt is triggered on the AJA device.
| [in] | inEventCode | Specifies the INTERRUPT_ENUMS of interest. |
Definition at line 55 of file ntv2subscriptions.cpp.
|
virtual |
Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel.
| [in] | inChannel | Specifies the input channel of interest. Defaults to NTV2_CHANNEL1. |
This function undoes the effects of a prior call to SubscribeInputVerticalEvent.
Definition at line 75 of file ntv2subscriptions.cpp.
|
virtual |
Unregisters me so I'm no longer notified when an input VBI is signaled on the given input channel(s).
| [in] | inChannels | Specifies the input channel(s) of interest. |
This function undoes the effects of a prior call to SubscribeInputVerticalEvents.
Definition at line 80 of file ntv2subscriptions.cpp.
|
virtual |
Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel.
| [in] | inChannel | Specifies the output channel of interest. Defaults to NTV2_CHANNEL1. |
This function undoes the effect of a prior call to SubscribeOutputVerticalEvent.
Definition at line 61 of file ntv2subscriptions.cpp.
|
virtual |
Unregisters me so I'm no longer notified when an output VBI is signaled on the given output channel(s).
| [in] | inChannels | Specifies the output channel(s) of interest. |
This function undoes the effect of a prior call to SubscribeOutputVerticalEvents.
Definition at line 66 of file ntv2subscriptions.cpp.
|
virtual |
Efficiently sleeps the calling thread/process until the next input VBI for the given field and input channel.
| [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. |
Definition at line 214 of file ntv2subscriptions.cpp.
|
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.
| [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. |
Definition at line 149 of file ntv2subscriptions.cpp.
|
virtual |
Efficiently sleeps the calling thread/process until the next output VBI for the given field and output channel.
| [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. |
Definition at line 180 of file ntv2subscriptions.cpp.
|
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.
| [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. |
HANDLE, and manually clear it before calling this function. Definition at line 134 of file ntv2subscriptions.cpp.
|
virtual |
Definition at line 930 of file ntv2csclut.cpp.
|
virtual |
Writes the given timecode to the specified analog LTC output register.
| [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. |
Definition at line 3757 of file ntv2register.cpp.
|
virtual |
Writes the given timecode to the specified analog LTC output register.
| [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. |
Definition at line 3750 of file ntv2register.cpp.
|
virtual |
Definition at line 484 of file ntv2audio.cpp.
|
virtual |
Definition at line 401 of file ntv2regconv.cpp.
|
virtual |
Definition at line 405 of file ntv2regconv.cpp.
|
virtual |
Definition at line 402 of file ntv2regconv.cpp.
|
virtual |
Definition at line 406 of file ntv2regconv.cpp.
|
virtual |
Definition at line 400 of file ntv2regconv.cpp.
|
virtual |
Definition at line 403 of file ntv2regconv.cpp.
|
virtual |
Definition at line 404 of file ntv2regconv.cpp.
|
virtual |
Writes the LUT tables.
| [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. |
Definition at line 845 of file ntv2csclut.cpp.
|
virtual |
Adjusts the output timing for the given SDI output connector.
| [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). |
Definition at line 3307 of file ntv2register.cpp.
|
virtual |
Definition at line 425 of file ntv2regconv.cpp.
|
virtual |
Definition at line 426 of file ntv2regconv.cpp.
|
virtual |
Definition at line 424 of file ntv2regconv.cpp.
|
virtual |
Definition at line 427 of file ntv2regconv.cpp.
|
virtual |
Definition at line 428 of file ntv2regconv.cpp.
|
virtual |
Definition at line 429 of file ntv2regconv.cpp.
|
virtual |
Writes the given sequence of NTV2RegInfo's.
| [in] | inRegWrites | Specifies the sequence of NTV2RegInfo's to be written. |
Definition at line 4483 of file ntv2register.cpp.
|
virtual |
Definition at line 394 of file ntv2regconv.cpp.
|
virtual |
Definition at line 398 of file ntv2regconv.cpp.
|
virtual |
Definition at line 395 of file ntv2regconv.cpp.
|
virtual |
Definition at line 399 of file ntv2regconv.cpp.
|
virtual |
Definition at line 397 of file ntv2regconv.cpp.
|
protectedvirtual |
Definition at line 115 of file ntv2regvpid.cpp.
|
virtual |
Definition at line 393 of file ntv2regconv.cpp.
|
virtual |
Definition at line 396 of file ntv2regconv.cpp.
|
virtual |
Writes the block of virtual data.
| [in] | inTag | Tag for the virtual data. |
| [in] | inVirtualData | Virtual data to be written |
| [in] | inVirtualDataSize | Virtual data size to write |
Definition at line 4563 of file ntv2register.cpp.
|
staticprotected |
Used for default empty NTV2Buffer parameters – do not modify.
Definition at line 6146 of file ntv2card.h.
1.8.17