AJA NTV2 SDK
17.1.3.1410
NTV2 SDK 17.1.3.1410
|
Declares CNTV2SignalRouter class. More...
#include "ajaexport.h"
#include "ntv2publicinterface.h"
#include <stddef.h>
#include <sstream>
#include <set>
#include <map>
Go to the source code of this file.
Classes | |
class | CNTV2SignalRouter |
This class is a collection of widget input-to-output connections that can be applied all-at-once to an NTV2 device. Call AddConnection to connect a widget input (specified by NTV2InputXptID) to a widget's output (specified by NTV2OutputXptID). Call the CNTV2Card::ApplySignalRoute function to apply this route to the device. More... | |
struct | CNTV2SignalRouter::PrintCodeConfig |
Typedefs | |
typedef std::set< NTV2OutputXptID > | NTV2OutputCrosspointIDSet |
typedef std::set< NTV2OutputXptID > | NTV2OutputXptIDSet |
A collection of distinct NTV2OutputXptID values. More... | |
typedef NTV2OutputXptIDSet::const_iterator | NTV2OutputCrosspointIDSetConstIter |
typedef NTV2OutputXptIDSet::const_iterator | NTV2OutputXptIDSetConstIter |
A const iterator for iterating over an NTV2OutputXptIDSet. More... | |
typedef NTV2OutputXptIDSet::iterator | NTV2OutputCrosspointIDSetIter |
typedef NTV2OutputXptIDSet::iterator | NTV2OutputXptIDSetIter |
A non-const iterator for iterating over an NTV2OutputXptIDSet. More... | |
typedef NTV2OutputCrosspointIDSet | NTV2CrosspointIDSet |
typedef std::set< NTV2InputXptID > | NTV2InputCrosspointIDSet |
typedef std::set< NTV2InputXptID > | NTV2InputXptIDSet |
A collection of distinct NTV2InputXptID values. More... | |
typedef NTV2InputXptIDSet::const_iterator | NTV2InputCrosspointIDSetConstIter |
typedef NTV2InputXptIDSet::const_iterator | NTV2InputXptIDSetConstIter |
A const iterator for iterating over an NTV2InputXptIDSet. More... | |
typedef NTV2InputXptIDSet::iterator | NTV2InputCrosspointIDSetIter |
typedef NTV2InputXptIDSet::iterator | NTV2InputXptIDSetIter |
A non-const iterator for iterating over an NTV2InputXptIDSet. More... | |
typedef std::set< NTV2WidgetID > | NTV2WidgetIDSet |
A collection of distinct NTV2WidgetID values. More... | |
typedef NTV2WidgetIDSet::const_iterator | NTV2WidgetIDSetConstIter |
An iterator for iterating over a read-only NTV2WidgetIDSet. More... | |
typedef std::pair< NTV2InputXptID, NTV2OutputXptID > | NTV2SignalConnection |
typedef std::pair< NTV2InputXptID, NTV2OutputXptID > | NTV2XptConnection |
typedef std::pair< NTV2InputXptID, NTV2OutputXptID > | NTV2Connection |
This links an NTV2InputXptID and an NTV2OutputXptID. More... | |
typedef std::map< NTV2InputXptID, NTV2OutputXptID > | NTV2XptConnections |
typedef std::map< NTV2InputXptID, NTV2OutputXptID > | NTV2ActualConnections |
A map of zero or more one-to-one actual NTV2InputXptID to NTV2OutputXptID connections. More... | |
typedef NTV2XptConnections::const_iterator | NTV2XptConnectionsConstIter |
typedef NTV2XptConnections::const_iterator | NTV2ActualConnectionsConstIter |
typedef std::multimap< NTV2InputXptID, NTV2OutputXptID > | NTV2PossibleConnections |
A map of zero or more one-to-many possible NTV2InputXptID to NTV2OutputXptID connections. More... | |
typedef NTV2PossibleConnections::const_iterator | NTV2PossibleConnectionsConstIter |
Declares CNTV2SignalRouter class.
Definition in file ntv2signalrouter.h.
typedef std::map<NTV2InputXptID, NTV2OutputXptID> NTV2ActualConnections |
A map of zero or more one-to-one actual NTV2InputXptID to NTV2OutputXptID connections.
Definition at line 39 of file ntv2signalrouter.h.
typedef NTV2XptConnections::const_iterator NTV2ActualConnectionsConstIter |
Definition at line 40 of file ntv2signalrouter.h.
typedef std::pair<NTV2InputXptID, NTV2OutputXptID> NTV2Connection |
This links an NTV2InputXptID and an NTV2OutputXptID.
Definition at line 38 of file ntv2signalrouter.h.
Definition at line 24 of file ntv2signalrouter.h.
typedef std::set<NTV2InputXptID> NTV2InputCrosspointIDSet |
Definition at line 26 of file ntv2signalrouter.h.
typedef NTV2InputXptIDSet::const_iterator NTV2InputCrosspointIDSetConstIter |
Definition at line 27 of file ntv2signalrouter.h.
typedef NTV2InputXptIDSet::iterator NTV2InputCrosspointIDSetIter |
Definition at line 28 of file ntv2signalrouter.h.
typedef std::set<NTV2InputXptID> NTV2InputXptIDSet |
A collection of distinct NTV2InputXptID values.
Definition at line 26 of file ntv2signalrouter.h.
typedef NTV2InputXptIDSet::const_iterator NTV2InputXptIDSetConstIter |
A const iterator for iterating over an NTV2InputXptIDSet.
Definition at line 27 of file ntv2signalrouter.h.
typedef NTV2InputXptIDSet::iterator NTV2InputXptIDSetIter |
A non-const iterator for iterating over an NTV2InputXptIDSet.
Definition at line 28 of file ntv2signalrouter.h.
typedef std::set<NTV2OutputXptID> NTV2OutputCrosspointIDSet |
Definition at line 18 of file ntv2signalrouter.h.
typedef NTV2OutputXptIDSet::const_iterator NTV2OutputCrosspointIDSetConstIter |
Definition at line 19 of file ntv2signalrouter.h.
typedef NTV2OutputXptIDSet::iterator NTV2OutputCrosspointIDSetIter |
Definition at line 20 of file ntv2signalrouter.h.
typedef std::set<NTV2OutputXptID> NTV2OutputXptIDSet |
A collection of distinct NTV2OutputXptID values.
Definition at line 18 of file ntv2signalrouter.h.
typedef NTV2OutputXptIDSet::const_iterator NTV2OutputXptIDSetConstIter |
A const iterator for iterating over an NTV2OutputXptIDSet.
Definition at line 19 of file ntv2signalrouter.h.
typedef NTV2OutputXptIDSet::iterator NTV2OutputXptIDSetIter |
A non-const iterator for iterating over an NTV2OutputXptIDSet.
Definition at line 20 of file ntv2signalrouter.h.
typedef std::multimap<NTV2InputXptID, NTV2OutputXptID> NTV2PossibleConnections |
A map of zero or more one-to-many possible NTV2InputXptID to NTV2OutputXptID connections.
Definition at line 41 of file ntv2signalrouter.h.
typedef NTV2PossibleConnections::const_iterator NTV2PossibleConnectionsConstIter |
Definition at line 42 of file ntv2signalrouter.h.
typedef std::pair<NTV2InputXptID, NTV2OutputXptID> NTV2SignalConnection |
Definition at line 38 of file ntv2signalrouter.h.
typedef std::set<NTV2WidgetID> NTV2WidgetIDSet |
A collection of distinct NTV2WidgetID values.
Definition at line 32 of file ntv2signalrouter.h.
typedef NTV2WidgetIDSet::const_iterator NTV2WidgetIDSetConstIter |
An iterator for iterating over a read-only NTV2WidgetIDSet.
Definition at line 33 of file ntv2signalrouter.h.
typedef std::pair<NTV2InputXptID, NTV2OutputXptID> NTV2XptConnection |
Definition at line 38 of file ntv2signalrouter.h.
typedef std::map<NTV2InputXptID, NTV2OutputXptID> NTV2XptConnections |
Definition at line 39 of file ntv2signalrouter.h.
typedef NTV2XptConnections::const_iterator NTV2XptConnectionsConstIter |
Definition at line 40 of file ntv2signalrouter.h.
NTV2InputXptID GetCSCInputXptFromChannel | ( | const NTV2Channel | inCSC, |
const bool | inIsKeyInput = false |
||
) |
[in] | inCSC | Specifies the CSC of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsKeyInput | Specify true to obtain the key (alpha) input crosspoint. Defaults to false (the video input crosspoint). |
Definition at line 775 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetCSCOutputXptFromChannel | ( | const NTV2Channel | inCSC, |
const bool | inIsKey = false , |
||
const bool | inIsRGB = false |
||
) |
[in] | inCSC | Specifies the CSC of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsKey | Specify true to obtain the key (alpha) output crosspoint. Defaults to false (the video output crosspoint). |
[in] | inIsRGB | Specify true to obtain the RGB video output crosspoint. Defaults to false (the YUV video output crosspoint). Ignored if true passed to inIsKey. |
Definition at line 819 of file ntv2signalrouter.cpp.
NTV2InputXptID GetDLInInputXptFromChannel | ( | const NTV2Channel | inChannel, |
const bool | inLinkB = false |
||
) |
[in] | inChannel | Specifies the Dual-Link Input converter of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inLinkB | Specifies whether to return the A or the B link crosspoint ID. Defaults to the A link crosspoint. |
Definition at line 796 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetDLInOutputXptFromChannel | ( | const NTV2Channel | inDLInput | ) |
[in] | inDLInput | Specifies the Dual-Link Input widget of interest, expressed as an NTV2Channel (a zero-based index value). |
Definition at line 917 of file ntv2signalrouter.cpp.
NTV2InputXptID GetDLOutInputXptFromChannel | ( | const NTV2Channel | inDLOutWidget | ) |
[in] | inDLOutWidget | Specifies the Dual Link Output of interest, expressed as an NTV2Channel (a zero-based index value). |
Definition at line 808 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetDLOutOutputXptFromChannel | ( | const NTV2Channel | inDLOutput, |
const bool | inIsLinkB = false |
||
) |
[in] | inDLOutput | Specifies the Dual-Link Output widget of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsLinkB | Specify true to obtain the DS2 output crosspoint. Defaults to false (the DS1 output crosspoint). |
Definition at line 905 of file ntv2signalrouter.cpp.
NTV2InputXptID GetFrameBufferInputXptFromChannel | ( | const NTV2Channel | inFrameStore, |
const bool | inIsBInput = false |
||
) |
[in] | inFrameStore | Specifies the FrameStore of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsBInput | Specify true to obtain the "B" input crosspoint (for dual-link). Defaults to false (the "A" input crosspoint). |
Definition at line 762 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetFrameBufferOutputXptFromChannel | ( | const NTV2Channel | inFrameStore, |
const bool | inIsRGB = false , |
||
const bool | inIs425 = false |
||
) |
[in] | inFrameStore | Specifies the FrameStore of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsRGB | Specify true to obtain the RGB output crosspoint. Defaults to false (the YUV output crosspoint). |
[in] | inIs425 | Specify true to obtain the 425 output crosspoint. Defaults to false (the normal non-425 output crosspoint). |
Definition at line 845 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetInputSourceOutputXpt | ( | const NTV2InputSource | inInputSource, |
const bool | inIsSDI_DS2 = false , |
||
const bool | inIsHDMI_RGB = false , |
||
const UWord | inHDMI_Quadrant = 0 |
||
) |
[in] | inInputSource | Specifies the NTV2InputSource of interest. |
[in] | inIsSDI_DS2 | Specify true to obtain the DS2 output crosspoint (for SDI input sources). Defaults to false (the DS1 output crosspoint). Ignored for non-SDI input sources. |
[in] | inIsHDMI_RGB | Specify true to obtain the RGB output crosspoint (for HDMI input sources). Defaults to false (the YUV output crosspoint). Ignored for non-HDMI input sources. |
[in] | inHDMI_Quadrant | Specifies the 4K/UHD quadrant of interest (for HDMI input sources), where 0=upperLeft, 1=upperRight, 2=lowerLeft, 3=lowerRight. Defaults to 0 (upperLeft). Ignored for non-HDMI input sources. |
Definition at line 865 of file ntv2signalrouter.cpp.
NTV2InputXptID GetLUTInputXptFromChannel | ( | const NTV2Channel | inLUT | ) |
[in] | inLUT | Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index value). |
Definition at line 788 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetLUTOutputXptFromChannel | ( | const NTV2Channel | inLUT | ) |
[in] | inLUT | Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index value). |
Definition at line 838 of file ntv2signalrouter.cpp.
NTV2InputXptID GetMixerBGInputXpt | ( | const NTV2Channel | inChannel, |
const bool | inIsKey = false |
||
) |
[in] | inChannel | Specifies the NTV2Channel of interest. Mixer 1 is used for channels 1 & 2, mixer 2 for channels 3 & 4, etc. |
[in] | inIsKey | Specify true to obtain the key input crosspoint. Defaults to false (the video input). |
Definition at line 981 of file ntv2signalrouter.cpp.
NTV2InputXptID GetMixerFGInputXpt | ( | const NTV2Channel | inChannel, |
const bool | inIsKey = false |
||
) |
[in] | inChannel | Specifies the NTV2Channel of interest. Mixer 1 is used for channels 1 & 2, mixer 2 for channels 3 & 4, etc. |
[in] | inIsKey | Specify true to obtain the key input crosspoint. Defaults to false (the video input). |
Definition at line 968 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetMixerOutputXptFromChannel | ( | const NTV2Channel | inChannel, |
const bool | inIsKey = false |
||
) |
[in] | inChannel | Specifies the NTV2Channel of interest. Mixer 1 is used for channels 1 & 2, mixer 2 for channels 3 & 4, etc. |
[in] | inIsKey | Specify true to obtain the key output crosspoint. Defaults to false (the video output crosspoint). |
Definition at line 955 of file ntv2signalrouter.cpp.
NTV2InputXptID GetOutputDestInputXpt | ( | const NTV2OutputDestination | inOutputDest, |
const bool | inIsSDI_DS2 = false , |
||
const UWord | inHDMI_Quadrant = 99 |
||
) |
[in] | inOutputDest | Specifies the NTV2OutputDestination of interest. |
[in] | inIsSDI_DS2 | Specify true to obtain the DS2 input crosspoint (SDI output destinations only). Defaults to false (the DS1 input). Ignored for non-SDI output destinations. |
[in] | inHDMI_Quadrant | Specifies the 4K/UHD quadrant of interest (for HDMI output destinations), where 0=upperLeft, 1=upperRight, 2=lowerLeft, 3=lowerRight. Values above 3 are deemed to be non-4K/UHD (the default). Ignored for non-HDMI output destinations. |
Definition at line 928 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetSDIInputOutputXptFromChannel | ( | const NTV2Channel | inSDIInput, |
const bool | inIsDS2 = false |
||
) |
[in] | inSDIInput | Specifies the SDI Input widget of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsDS2 | Specify true to obtain the DS2 output crosspoint. Defaults to false (the DS1 output crosspoint). |
Definition at line 893 of file ntv2signalrouter.cpp.
NTV2InputXptID GetSDIOutputInputXpt | ( | const NTV2Channel | inSDIOutput, |
const bool | inIsDS2 = false |
||
) |
[in] | inSDIOutput | Specifies the SDI Output widget of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inIsDS2 | Specify true to obtain the DS2 input crosspoint. Defaults to false (the DS1 input). |
Definition at line 942 of file ntv2signalrouter.cpp.
NTV2InputXptID GetTSIMuxInputXptFromChannel | ( | const NTV2Channel | inTSIMuxer, |
const bool | inLinkB = false |
||
) |
[in] | inTSIMuxer | Specifies the 425Mux widget of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inLinkB | Specify true to obtain the "B" input crosspoint. Defaults to false, the "A" input. |
Definition at line 993 of file ntv2signalrouter.cpp.
NTV2OutputXptID GetTSIMuxOutputXptFromChannel | ( | const NTV2Channel | inTSIMuxer, |
const bool | inLinkB = false , |
||
const bool | inIsRGB = false |
||
) |
[in] | inTSIMuxer | Specifies the 425Mux widget of interest, expressed as an NTV2Channel (a zero-based index value). |
[in] | inLinkB | Specify true to obtain the "B" output crosspoint. Defaults to false, the "A" output. |
[in] | inIsRGB | Specify true to obtain the RGB output crosspoint. Defaults to false, the YUV output. |
Definition at line 1005 of file ntv2signalrouter.cpp.
std::ostream& operator<< | ( | std::ostream & | inOutStream, |
const CNTV2SignalRouter & | inObj | ||
) |
std::ostream& operator<< | ( | std::ostream & | inOutStream, |
const NTV2InputXptIDSet & | inObj | ||
) |
std::ostream& operator<< | ( | std::ostream & | inOutStream, |
const NTV2OutputXptIDSet & | inObj | ||
) |
std::ostream& operator<< | ( | std::ostream & | inOutStream, |
const NTV2WidgetIDSet & | inObj | ||
) |
std::ostream& operator<< | ( | std::ostream & | inOutStream, |
const NTV2XptConnections & | inObj | ||
) |