DeviceCapabilities Class Reference

Convenience class/API for inquiring about device capabilities of physical and virtual devices. Instead of calling the old global ::NTV2DeviceCanDoXXX(mDeviceID) functions, call mCard.features().CanDoXXX(). Instead of calling ::NTV2DeviceGetNumYYY(mDeviceID), call mCard.features().GetNumYYY(). More...

#include <ntv2devicecapabilities.h>

Public Member Functions
	DeviceCapabilities (CNTV2DriverInterface &inDev)
bool	CanDoChannel (const NTV2Channel inChannel)
bool	CanDoConversionMode (const NTV2ConversionMode inMode)
bool	CanDoDSKMode (const NTV2DSKMode inMode)
bool	CanDoFrameBufferFormat (const NTV2PixelFormat inPF)
bool	CanDoPixelFormat (const NTV2PixelFormat inPF)
bool	CanDoInputSource (const NTV2InputSource inSrc)
bool	CanDoOutputDestination (const NTV2OutputDestination inDest)
bool	CanDoVideoFormat (const NTV2VideoFormat inVF)
bool	CanDoWidget (const NTV2WidgetID inWgtID)
bool	CanDoWidget (const NTV2WidgetType inWgtType, const UWord index0)
NTV2PixelFormats	PixelFormats (void)
NTV2VideoFormatSet	VideoFormats (void)
NTV2TCIndexes	InputTCIndexes (void)
NTV2TCIndexes	OutputTCIndexes (void)
bool	CanDoInputTCIndex (const NTV2TCIndex inTCNdx)
bool	CanDoOutputTCIndex (const NTV2TCIndex inTCNdx)

Detailed Description

Convenience class/API for inquiring about device capabilities of physical and virtual devices. Instead of calling the old global ::NTV2DeviceCanDoXXX(mDeviceID) functions, call mCard.features().CanDoXXX(). Instead of calling ::NTV2DeviceGetNumYYY(mDeviceID), call mCard.features().GetNumYYY().

See also

vidop-features

Definition at line 20 of file ntv2devicecapabilities.h.

Constructor & Destructor Documentation

DeviceCapabilities()

DeviceCapabilities::DeviceCapabilities ( CNTV2DriverInterface &  inDev )

inlineexplicit

Definition at line 23 of file ntv2devicecapabilities.h.

Member Function Documentation

CanDoChannel()

bool DeviceCapabilities::CanDoChannel ( const NTV2Channel  inChannel )

inline

Parameters

[in]

inChannel

Specifies the channel or FrameStore of interest.

Returns

True if the device has the given FrameStore; otherwise false.

Definition at line 196 of file ntv2devicecapabilities.h.

CanDoConversionMode()

bool DeviceCapabilities::CanDoConversionMode ( const NTV2ConversionMode  inMode )

inline

Parameters

[in]

inMode

Specifies the NTV2ConversionMode of interest.

Returns

True if the device can perform the requested conversion; otherwise false.

Definition at line 205 of file ntv2devicecapabilities.h.

CanDoDSKMode()

bool DeviceCapabilities::CanDoDSKMode ( const NTV2DSKMode  inMode )

inline

Parameters

[in]

inMode

Specifies the NTV2DSKMode of interest.

Returns

True if the device's Mixer/Keyer widget(s) can accommodate the requested downstream keyer mode; otherwise false.

Definition at line 214 of file ntv2devicecapabilities.h.

CanDoFrameBufferFormat()

bool DeviceCapabilities::CanDoFrameBufferFormat ( const NTV2PixelFormat  inPF )

inline

Parameters

[in]

inPF

Specifies the NTV2PixelFormat of interest.

Returns

True if the device's FrameStore widget(s) can read or write the requested pixel format; otherwise false.

Definition at line 223 of file ntv2devicecapabilities.h.

CanDoInputSource()

bool DeviceCapabilities::CanDoInputSource ( const NTV2InputSource  inSrc )

inline

Parameters

[in]

inSrc

Specifies the NTV2InputSource of interest.

Returns

True if the device has the requested input source; otherwise false.

Definition at line 233 of file ntv2devicecapabilities.h.

CanDoInputTCIndex()

bool DeviceCapabilities::CanDoInputTCIndex ( const NTV2TCIndex  inTCNdx )

inline

Parameters

[in]

inTCNdx

Specifies the NTV2TimecodeIndex of interest.

Returns

True if the device can read the given timecode; otherwise false.

Definition at line 320 of file ntv2devicecapabilities.h.

CanDoOutputDestination()

bool DeviceCapabilities::CanDoOutputDestination ( const NTV2OutputDestination  inDest )

inline

Parameters

[in]

inDest

Specifies the NTV2OutputDestination of interest.

Returns

True if the device has the requested output destination connector; otherwise false.

Definition at line 242 of file ntv2devicecapabilities.h.

CanDoOutputTCIndex()

bool DeviceCapabilities::CanDoOutputTCIndex ( const NTV2TCIndex  inTCNdx )

inline

Parameters

[in]

inTCNdx

Specifies the NTV2TimecodeIndex of interest.

Returns

True if the device can write the given timecode; otherwise false.

Definition at line 329 of file ntv2devicecapabilities.h.

CanDoPixelFormat()

bool DeviceCapabilities::CanDoPixelFormat ( const NTV2PixelFormat  inPF )

inline

Definition at line 227 of file ntv2devicecapabilities.h.

CanDoVideoFormat()

bool DeviceCapabilities::CanDoVideoFormat ( const NTV2VideoFormat  inVF )

inline

Parameters

[in]

inVF

Specifies the NTV2VideoFormat of interest.

Returns

True if the device's FrameStore(s) can handle the given video format; otherwise false.

Definition at line 251 of file ntv2devicecapabilities.h.

CanDoWidget() [1/2]

bool DeviceCapabilities::CanDoWidget ( const NTV2WidgetID  inWgtID )

inline

Parameters

[in]

inWgtID

Specifies the NTV2WidgetID of interest.

Returns

True if the device firmware implements the given widget; otherwise false.

Definition at line 260 of file ntv2devicecapabilities.h.

CanDoWidget() [2/2]

bool DeviceCapabilities::CanDoWidget	(	const NTV2WidgetType	inWgtType,
		const UWord	index0
	)

Parameters

[in]	inWgtType	Specifies the NTV2WidgetType.
[in]	index0	Specifies the widget of interest as a zero-based index.

Returns

True if the device firmware implements the given widget; otherwise false.

Definition at line 498 of file ntv2card.cpp.

InputTCIndexes()

NTV2TCIndexes DeviceCapabilities::InputTCIndexes ( void  )

inline

Returns

The set of unique NTV2TimecodeIndex values that can be ingested and captured by the device.

Definition at line 297 of file ntv2devicecapabilities.h.

OutputTCIndexes()

NTV2TCIndexes DeviceCapabilities::OutputTCIndexes ( void  )

inline

Returns

The set of unique NTV2TimecodeIndex values that can be output by the device.

Definition at line 308 of file ntv2devicecapabilities.h.

PixelFormats()

NTV2PixelFormats DeviceCapabilities::PixelFormats ( void  )

inline

Returns

The set of unique NTV2PixelFormat values supported by the device's FrameStore(s).

Definition at line 275 of file ntv2devicecapabilities.h.

VideoFormats()

NTV2VideoFormatSet DeviceCapabilities::VideoFormats ( void  )

inline

Returns

The set of unique NTV2VideoFormat values supported by the device's FrameStore(s).

Definition at line 286 of file ntv2devicecapabilities.h.

---

The documentation for this class was generated from the following files:

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2devicecapabilities.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2card.cpp