class Input::Frames::FrameSource

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

Members

Properties

Syntax: public FrameSourceProperties & Properties;

Gets a collection of additional FrameSource properties.

~FrameSource

Syntax: public inline virtual ~FrameSource ( );

Destructs an instance of the FrameSource class.

GetWriter

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

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

Returns

The FrameWriter used to write 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< FrameSource > FromFormat ( const std::shared_ptr< FrameFormat > & format );

Initializes a new instance of the FrameSource class.

Parameters

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

Returns

The newly created FrameSource wrapped inside a std::shared_ptr

FromFormat

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

Initializes a new instance of the FrameSource class.

Parameters

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

• callback TODO

Returns

The newly created FrameSource wrapped inside a std::shared_ptr

CallbackFunction_Type

Syntax: typedef CallbackFunction_Type;