class Input::Frames::FrameSetSource

Represents a source of image frame data, used as input to or output from Vision AI operations.

Members

Properties

Syntax: public FrameSetSourceProperties & Properties;

Gets a collection of additional FrameSetSource properties.

~FrameSetSource

Syntax: public inline virtual ~FrameSetSource ( );

Destructs an instance of the FrameSetSource class.

GetWriter

Syntax: public inline std::shared_ptr< FrameSetWriter > GetWriter ( );

Gets the FrameWriter used to write frame data into this FrameSetSource object.

Returns

The FrameWriter used to write frame data, wrapped inside a std::shared_ptr

GetReader

Syntax: public inline std::shared_ptr< FrameSetReader > GetReader ( );

Gets the FrameReader used to read frame data from this FrameSetSource object.

Returns

The FrameReader used to read frame data, wrapped inside a std::shared_ptr

CloseWriter

Syntax: public inline void CloseWriter ( );

Closes the frame source for writing.

FromFormat

Syntax: public inline static std::shared_ptr< FrameSetSource > FromFormat ( const std::shared_ptr< FrameSetFormat > & format );

Initializes a new instance of the FrameSetSource class.

Parameters

• format A FrameSetFormat obtained via FrameSetFormat::Create() or similar

Returns

The newly created FrameSetSource wrapped inside a std::shared_ptr

FromFormat

Syntax: public inline static std::shared_ptr< FrameSetSource > FromFormat ( const std::shared_ptr< FrameSetFormat > & format , CallbackFunction_Type callback );

Initializes a new instance of the FrameSetSource class.

Parameters

• format A FrameSetFormat obtained via FrameSetFormat::Create() or similar

• callback TODO

Returns

The newly created FrameSetSource wrapped inside a std::shared_ptr

CallbackFunction_Type

Syntax: typedef CallbackFunction_Type;