ntv2signalrouter.h File Reference

Declares CNTV2SignalRouter class. More...

#include "ajaexport.h"
#include "ntv2publicinterface.h"
#include <stddef.h>
#include <sstream>
#include <set>
#include <map>

Include dependency graph for ntv2signalrouter.h:

This graph shows which files directly or indirectly include this file:

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
typedef std::map< std::string, NTV2InputXptID >	String2InputXpt
typedef String2InputXpt::const_iterator	String2InputXptConstIter
typedef std::map< NTV2InputXptID, std::string >	InputXpt2String
typedef InputXpt2String::const_iterator	InputXpt2StringConstIter
typedef std::multimap< NTV2InputXptID, NTV2WidgetID >	InputXpt2WidgetIDs
typedef std::pair< NTV2InputXptID, NTV2WidgetID >	InputXpt2WidgetIDPair
typedef InputXpt2WidgetIDs::const_iterator	InputXpt2WidgetIDsConstIter
typedef std::map< std::string, NTV2OutputXptID >	String2OutputXpt
typedef String2OutputXpt::const_iterator	String2OutputXptConstIter
typedef std::map< NTV2OutputXptID, std::string >	OutputXpt2String
typedef OutputXpt2String::const_iterator	OutputXpt2StringConstIter
typedef std::multimap< NTV2OutputXptID, NTV2WidgetID >	OutputXpt2WidgetIDs
typedef std::pair< NTV2OutputXptID, NTV2WidgetID >	OutputXpt2WidgetIDPair
typedef OutputXpt2WidgetIDs::const_iterator	OutputXpt2WidgetIDsConstIter
typedef std::pair< NTV2WidgetID, NTV2OutputXptID >	Widget2OutputXptPair
typedef std::multimap< NTV2WidgetID, NTV2OutputXptID >	Widget2OutputXpts
typedef Widget2OutputXpts::const_iterator	Widget2OutputXptsConstIter
typedef std::pair< NTV2WidgetID, NTV2InputXptID >	Widget2InputXptPair
typedef std::multimap< NTV2WidgetID, NTV2InputXptID >	Widget2InputXpts
typedef Widget2InputXpts::const_iterator	Widget2InputXptsConstIter
typedef std::pair< NTV2WidgetID, NTV2Channel >	Widget2ChannelPair
typedef std::multimap< NTV2WidgetID, NTV2Channel >	Widget2Channels
typedef Widget2Channels::const_iterator	Widget2ChannelsConstIter
typedef std::pair< NTV2WidgetID, NTV2WidgetType >	Widget2TypePair
typedef std::multimap< NTV2WidgetID, NTV2WidgetType >	Widget2Types
typedef Widget2Types::const_iterator	Widget2TypesConstIter
typedef std::set< NTV2WidgetType >	NTV2WidgetTypeSet
typedef NTV2WidgetTypeSet::const_iterator	NTV2WidgetTypeSetConstIter

Functions
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2OutputXptIDSet &inObj)
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2InputXptIDSet &inObj)
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2WidgetIDSet &inObj)
std::ostream &	operator<< (std::ostream &inOutStream, const NTV2XptConnections &inObj)
NTV2InputXptID	GetFrameBufferInputXptFromChannel (const NTV2Channel inFrameStore, const bool inIsBInput=false)
NTV2InputXptID	GetCSCInputXptFromChannel (const NTV2Channel inCSC, const bool inIsKeyInput=false)
NTV2InputXptID	GetLUTInputXptFromChannel (const NTV2Channel inLUT)
NTV2InputXptID	GetDLInInputXptFromChannel (const NTV2Channel inChannel, const bool inLinkB=false)
NTV2InputXptID	GetDLOutInputXptFromChannel (const NTV2Channel inDLOutWidget)
NTV2OutputXptID	GetCSCOutputXptFromChannel (const NTV2Channel inCSC, const bool inIsKey=false, const bool inIsRGB=false)
NTV2OutputXptID	GetLUTOutputXptFromChannel (const NTV2Channel inLUT)
NTV2OutputXptID	GetFrameBufferOutputXptFromChannel (const NTV2Channel inFrameStore, const bool inIsRGB=false, const bool inIs425=false)
NTV2OutputXptID	GetInputSourceOutputXpt (const NTV2InputSource inInputSource, const bool inIsSDI_DS2=false, const bool inIsHDMI_RGB=false, const UWord inHDMI_Quadrant=0)
NTV2OutputXptID	GetSDIInputOutputXptFromChannel (const NTV2Channel inSDIInput, const bool inIsDS2=false)
NTV2OutputXptID	GetDLOutOutputXptFromChannel (const NTV2Channel inDLOutput, const bool inIsLinkB=false)
NTV2OutputXptID	GetDLInOutputXptFromChannel (const NTV2Channel inDLInput)
NTV2InputXptID	GetOutputDestInputXpt (const NTV2OutputDestination inOutputDest, const bool inIsSDI_DS2=false, const UWord inHDMI_Quadrant=99)
NTV2InputXptID	GetSDIOutputInputXpt (const NTV2Channel inSDIOutput, const bool inIsDS2=false)
NTV2OutputXptID	GetMixerOutputXptFromChannel (const NTV2Channel inChannel, const bool inIsKey=false)
NTV2InputXptID	GetMixerFGInputXpt (const NTV2Channel inChannel, const bool inIsKey=false)
NTV2InputXptID	GetMixerBGInputXpt (const NTV2Channel inChannel, const bool inIsKey=false)
NTV2InputXptID	GetTSIMuxInputXptFromChannel (const NTV2Channel inTSIMuxer, const bool inLinkB=false)
NTV2OutputXptID	GetTSIMuxOutputXptFromChannel (const NTV2Channel inTSIMuxer, const bool inLinkB=false, const bool inIsRGB=false)
std::ostream &	operator<< (std::ostream &inOutStream, const CNTV2SignalRouter &inObj)

Detailed Description

Declares CNTV2SignalRouter class.

Copyright

(C) 2014-2022 AJA Video Systems, Inc.

Definition in file ntv2signalrouter.h.

Typedef Documentation

InputXpt2String

typedef std::map<NTV2InputXptID, std::string> InputXpt2String

Definition at line 49 of file ntv2signalrouter.h.

InputXpt2StringConstIter

typedef InputXpt2String::const_iterator InputXpt2StringConstIter

Definition at line 50 of file ntv2signalrouter.h.

InputXpt2WidgetIDPair

typedef std::pair<NTV2InputXptID, NTV2WidgetID> InputXpt2WidgetIDPair

Definition at line 53 of file ntv2signalrouter.h.

InputXpt2WidgetIDs

typedef std::multimap<NTV2InputXptID, NTV2WidgetID> InputXpt2WidgetIDs

Definition at line 52 of file ntv2signalrouter.h.

InputXpt2WidgetIDsConstIter

typedef InputXpt2WidgetIDs::const_iterator InputXpt2WidgetIDsConstIter

Definition at line 54 of file ntv2signalrouter.h.

NTV2ActualConnections

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.

NTV2ActualConnectionsConstIter

typedef NTV2XptConnections::const_iterator NTV2ActualConnectionsConstIter

Definition at line 40 of file ntv2signalrouter.h.

NTV2Connection

typedef std::pair<NTV2InputXptID, NTV2OutputXptID> NTV2Connection

This links an NTV2InputXptID and an NTV2OutputXptID.

Definition at line 38 of file ntv2signalrouter.h.

NTV2CrosspointIDSet

typedef NTV2OutputCrosspointIDSet NTV2CrosspointIDSet

Deprecated:

Use NTV2OutputXptIDSet instead.

Definition at line 24 of file ntv2signalrouter.h.

NTV2InputCrosspointIDSet

typedef std::set<NTV2InputXptID> NTV2InputCrosspointIDSet

Definition at line 26 of file ntv2signalrouter.h.

NTV2InputCrosspointIDSetConstIter

typedef NTV2InputXptIDSet::const_iterator NTV2InputCrosspointIDSetConstIter

Definition at line 27 of file ntv2signalrouter.h.

NTV2InputCrosspointIDSetIter

typedef NTV2InputXptIDSet::iterator NTV2InputCrosspointIDSetIter

Definition at line 28 of file ntv2signalrouter.h.

NTV2InputXptIDSet

typedef std::set<NTV2InputXptID> NTV2InputXptIDSet

A collection of distinct NTV2InputXptID values.

Definition at line 26 of file ntv2signalrouter.h.

NTV2InputXptIDSetConstIter

typedef NTV2InputXptIDSet::const_iterator NTV2InputXptIDSetConstIter

A const iterator for iterating over an NTV2InputXptIDSet.

Definition at line 27 of file ntv2signalrouter.h.

NTV2InputXptIDSetIter

typedef NTV2InputXptIDSet::iterator NTV2InputXptIDSetIter

A non-const iterator for iterating over an NTV2InputXptIDSet.

Definition at line 28 of file ntv2signalrouter.h.

NTV2OutputCrosspointIDSet

typedef std::set<NTV2OutputXptID> NTV2OutputCrosspointIDSet

Definition at line 18 of file ntv2signalrouter.h.

NTV2OutputCrosspointIDSetConstIter

typedef NTV2OutputXptIDSet::const_iterator NTV2OutputCrosspointIDSetConstIter

Definition at line 19 of file ntv2signalrouter.h.

NTV2OutputCrosspointIDSetIter

typedef NTV2OutputXptIDSet::iterator NTV2OutputCrosspointIDSetIter

Definition at line 20 of file ntv2signalrouter.h.

NTV2OutputXptIDSet

typedef std::set<NTV2OutputXptID> NTV2OutputXptIDSet

A collection of distinct NTV2OutputXptID values.

Definition at line 18 of file ntv2signalrouter.h.

NTV2OutputXptIDSetConstIter

typedef NTV2OutputXptIDSet::const_iterator NTV2OutputXptIDSetConstIter

A const iterator for iterating over an NTV2OutputXptIDSet.

Definition at line 19 of file ntv2signalrouter.h.

NTV2OutputXptIDSetIter

typedef NTV2OutputXptIDSet::iterator NTV2OutputXptIDSetIter

A non-const iterator for iterating over an NTV2OutputXptIDSet.

Definition at line 20 of file ntv2signalrouter.h.

NTV2PossibleConnections

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.

NTV2PossibleConnectionsConstIter

typedef NTV2PossibleConnections::const_iterator NTV2PossibleConnectionsConstIter

Definition at line 42 of file ntv2signalrouter.h.

NTV2SignalConnection

typedef std::pair<NTV2InputXptID, NTV2OutputXptID> NTV2SignalConnection

Definition at line 38 of file ntv2signalrouter.h.

NTV2WidgetIDSet

typedef std::set<NTV2WidgetID> NTV2WidgetIDSet

A collection of distinct NTV2WidgetID values.

Definition at line 32 of file ntv2signalrouter.h.

NTV2WidgetIDSetConstIter

typedef NTV2WidgetIDSet::const_iterator NTV2WidgetIDSetConstIter

An iterator for iterating over a read-only NTV2WidgetIDSet.

Definition at line 33 of file ntv2signalrouter.h.

NTV2WidgetTypeSet

typedef std::set<NTV2WidgetType> NTV2WidgetTypeSet

Definition at line 82 of file ntv2signalrouter.h.

NTV2WidgetTypeSetConstIter

typedef NTV2WidgetTypeSet::const_iterator NTV2WidgetTypeSetConstIter

Definition at line 83 of file ntv2signalrouter.h.

NTV2XptConnection

typedef std::pair<NTV2InputXptID, NTV2OutputXptID> NTV2XptConnection

Definition at line 38 of file ntv2signalrouter.h.

NTV2XptConnections

typedef std::map<NTV2InputXptID, NTV2OutputXptID> NTV2XptConnections

Definition at line 39 of file ntv2signalrouter.h.

NTV2XptConnectionsConstIter

typedef NTV2XptConnections::const_iterator NTV2XptConnectionsConstIter

Definition at line 40 of file ntv2signalrouter.h.

OutputXpt2String

typedef std::map<NTV2OutputXptID, std::string> OutputXpt2String

Definition at line 59 of file ntv2signalrouter.h.

OutputXpt2StringConstIter

typedef OutputXpt2String::const_iterator OutputXpt2StringConstIter

Definition at line 60 of file ntv2signalrouter.h.

OutputXpt2WidgetIDPair

typedef std::pair<NTV2OutputXptID, NTV2WidgetID> OutputXpt2WidgetIDPair

Definition at line 63 of file ntv2signalrouter.h.

OutputXpt2WidgetIDs

typedef std::multimap<NTV2OutputXptID, NTV2WidgetID> OutputXpt2WidgetIDs

Definition at line 62 of file ntv2signalrouter.h.

OutputXpt2WidgetIDsConstIter

typedef OutputXpt2WidgetIDs::const_iterator OutputXpt2WidgetIDsConstIter

Definition at line 64 of file ntv2signalrouter.h.

String2InputXpt

typedef std::map<std::string, NTV2InputXptID> String2InputXpt

Definition at line 46 of file ntv2signalrouter.h.

String2InputXptConstIter

typedef String2InputXpt::const_iterator String2InputXptConstIter

Definition at line 47 of file ntv2signalrouter.h.

String2OutputXpt

typedef std::map<std::string, NTV2OutputXptID> String2OutputXpt

Definition at line 56 of file ntv2signalrouter.h.

String2OutputXptConstIter

typedef String2OutputXpt::const_iterator String2OutputXptConstIter

Definition at line 57 of file ntv2signalrouter.h.

Widget2ChannelPair

typedef std::pair<NTV2WidgetID, NTV2Channel> Widget2ChannelPair

Definition at line 74 of file ntv2signalrouter.h.

Widget2Channels

typedef std::multimap<NTV2WidgetID, NTV2Channel> Widget2Channels

Definition at line 75 of file ntv2signalrouter.h.

Widget2ChannelsConstIter

typedef Widget2Channels::const_iterator Widget2ChannelsConstIter

Definition at line 76 of file ntv2signalrouter.h.

Widget2InputXptPair

typedef std::pair<NTV2WidgetID, NTV2InputXptID> Widget2InputXptPair

Definition at line 70 of file ntv2signalrouter.h.

Widget2InputXpts

typedef std::multimap<NTV2WidgetID, NTV2InputXptID> Widget2InputXpts

Definition at line 71 of file ntv2signalrouter.h.

Widget2InputXptsConstIter

typedef Widget2InputXpts::const_iterator Widget2InputXptsConstIter

Definition at line 72 of file ntv2signalrouter.h.

Widget2OutputXptPair

typedef std::pair<NTV2WidgetID, NTV2OutputXptID> Widget2OutputXptPair

Definition at line 66 of file ntv2signalrouter.h.

Widget2OutputXpts

typedef std::multimap<NTV2WidgetID, NTV2OutputXptID> Widget2OutputXpts

Definition at line 67 of file ntv2signalrouter.h.

Widget2OutputXptsConstIter

typedef Widget2OutputXpts::const_iterator Widget2OutputXptsConstIter

Definition at line 68 of file ntv2signalrouter.h.

Widget2TypePair

typedef std::pair<NTV2WidgetID, NTV2WidgetType> Widget2TypePair

Definition at line 78 of file ntv2signalrouter.h.

Widget2Types

typedef std::multimap<NTV2WidgetID, NTV2WidgetType> Widget2Types

Definition at line 79 of file ntv2signalrouter.h.

Widget2TypesConstIter

typedef Widget2Types::const_iterator Widget2TypesConstIter

Definition at line 80 of file ntv2signalrouter.h.

Function Documentation

GetCSCInputXptFromChannel()

NTV2InputXptID GetCSCInputXptFromChannel	(	const NTV2Channel	inCSC,
		const bool	inIsKeyInput = false
	)

Returns

The appropriate NTV2InputXptID for the given color space converter (CSC) widget, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetCSCOutputXptFromChannel()

NTV2OutputXptID GetCSCOutputXptFromChannel	(	const NTV2Channel	inCSC,
		const bool	inIsKey = false,
		const bool	inIsRGB = false
	)

Returns

The appropriate NTV2OutputCrosspointID for the given color space converter (CSC) widget, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetDLInInputXptFromChannel()

NTV2InputXptID GetDLInInputXptFromChannel	(	const NTV2Channel	inChannel,
		const bool	inLinkB = false
	)

Returns

The appropriate NTV2InputXptID for the given Dual-Link Input widget, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetDLInOutputXptFromChannel()

NTV2OutputXptID GetDLInOutputXptFromChannel

(

const NTV2Channel

inDLInput

)

Returns

The appropriate NTV2OutputCrosspointID for the given Dual Link Input, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetDLOutInputXptFromChannel()

NTV2InputXptID GetDLOutInputXptFromChannel

(

const NTV2Channel

inDLOutWidget

)

Returns

The appropriate NTV2InputXptID for the given Dual Link Output widget, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetDLOutOutputXptFromChannel()

NTV2OutputXptID GetDLOutOutputXptFromChannel	(	const NTV2Channel	inDLOutput,
		const bool	inIsLinkB = false
	)

Returns

The NTV2OutputCrosspointID for the given Dual Link Output, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetFrameBufferInputXptFromChannel()

NTV2InputXptID GetFrameBufferInputXptFromChannel	(	const NTV2Channel	inFrameStore,
		const bool	inIsBInput = false
	)

Returns

The appropriate NTV2InputXptID for the given FrameStore, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetFrameBufferOutputXptFromChannel()

NTV2OutputXptID GetFrameBufferOutputXptFromChannel	(	const NTV2Channel	inFrameStore,
		const bool	inIsRGB = false,
		const bool	inIs425 = false
	)

Returns

The appropriate NTV2OutputCrosspointID for the given FrameStore, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetInputSourceOutputXpt()

NTV2OutputXptID GetInputSourceOutputXpt	(	const NTV2InputSource	inInputSource,
		const bool	inIsSDI_DS2 = false,
		const bool	inIsHDMI_RGB = false,
		const UWord	inHDMI_Quadrant = 0
	)

Returns

The appropriate NTV2OutputCrosspointID for the given NTV2InputSource, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetLUTInputXptFromChannel()

NTV2InputXptID GetLUTInputXptFromChannel

(

const NTV2Channel

inLUT

)

Returns

The appropriate NTV2InputXptID for the given LUT widget, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[in]

inLUT

Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index value).

Definition at line 788 of file ntv2signalrouter.cpp.

GetLUTOutputXptFromChannel()

NTV2OutputXptID GetLUTOutputXptFromChannel

(

const NTV2Channel

inLUT

)

Returns

The appropriate NTV2OutputCrosspointID for the given LUT widget.

Parameters

[in]

inLUT

Specifies the LUT of interest, expressed as an NTV2Channel (a zero-based index value).

Definition at line 838 of file ntv2signalrouter.cpp.

GetMixerBGInputXpt()

NTV2InputXptID GetMixerBGInputXpt	(	const NTV2Channel	inChannel,
		const bool	inIsKey = false
	)

Returns

The appropriate mixer's background NTV2InputXptID for the given NTV2Channel, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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).

See also

GetMixerFGInputXpt, GetMixerOutputXptFromChannel, Mixer/Keyer Routing

Definition at line 981 of file ntv2signalrouter.cpp.

GetMixerFGInputXpt()

NTV2InputXptID GetMixerFGInputXpt	(	const NTV2Channel	inChannel,
		const bool	inIsKey = false
	)

Returns

The appropriate mixer's foreground NTV2InputXptID for the given NTV2Channel, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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).

See also

GetMixerBGInputXpt, GetMixerOutputXptFromChannel, Mixer/Keyer Routing

Definition at line 968 of file ntv2signalrouter.cpp.

GetMixerOutputXptFromChannel()

NTV2OutputXptID GetMixerOutputXptFromChannel	(	const NTV2Channel	inChannel,
		const bool	inIsKey = false
	)

Returns

The appropriate mixer's NTV2OutputCrosspointID for the given NTV2Channel, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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).

See also

GetMixerFGInputXpt, GetMixerBGInputXpt, Mixer/Keyer Routing

Definition at line 955 of file ntv2signalrouter.cpp.

GetOutputDestInputXpt()

NTV2InputXptID GetOutputDestInputXpt	(	const NTV2OutputDestination	inOutputDest,
		const bool	inIsSDI_DS2 = false,
		const UWord	inHDMI_Quadrant = 99
	)

Returns

The appropriate NTV2InputXptID for the given NTV2OutputDestination, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetSDIInputOutputXptFromChannel()

NTV2OutputXptID GetSDIInputOutputXptFromChannel	(	const NTV2Channel	inSDIInput,
		const bool	inIsDS2 = false
	)

Returns

The appropriate SDI input's NTV2OutputCrosspointID for the given SDI Input, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetSDIOutputInputXpt()

NTV2InputXptID GetSDIOutputInputXpt	(	const NTV2Channel	inSDIOutput,
		const bool	inIsDS2 = false
	)

Returns

The appropriate NTV2InputXptID for the given SDI Output, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetTSIMuxInputXptFromChannel()

NTV2InputXptID GetTSIMuxInputXptFromChannel	(	const NTV2Channel	inTSIMuxer,
		const bool	inLinkB = false
	)

Returns

The appropriate NTV2InputXptID for the given TSI Muxer widget, or NTV2_INPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

GetTSIMuxOutputXptFromChannel()

NTV2OutputXptID GetTSIMuxOutputXptFromChannel	(	const NTV2Channel	inTSIMuxer,
		const bool	inLinkB = false,
		const bool	inIsRGB = false
	)

Returns

The appropriate NTV2OutputXptID for the given TSI Muxer, or NTV2_OUTPUT_CROSSPOINT_INVALID upon failure.

Parameters

[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.

operator<<() [1/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const CNTV2SignalRouter &	inObj
	)

operator<<() [2/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2InputXptIDSet &	inObj
	)

operator<<() [3/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2OutputXptIDSet &	inObj
	)

operator<<() [4/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2WidgetIDSet &	inObj
	)

operator<<() [5/5]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const NTV2XptConnections &	inObj
	)