eSDK Pro Plugin Input Classes

This topic describes the Input class and the classes derived from it in the eSDK Pro Plugin API:

• Input class — Represents a generic input port that receives data from another task within the plugin pipeline.
• FrameInput class — Specialized input port for receiving image frames, supporting both synchronous and asynchronous frame access.
• DataInput class — Specialized input port for receiving generic data, supporting both synchronous and asynchronous data access.

‍

Plugin Input Class

Namespace: eSdkPro::Plugin

‍Header: eSdkPro/plugin/port.h

An input port used to receive data from a task.

‍

GetName()

std::string eSdkPro::Plugin::Input::GetName() const

Returns: The name of the input.

‍

GetType()

PortType eSdkPro::Plugin::Input::GetType() const

Returns: The type of the input.

‍

GetPlatform()

HWPlatform eSdkPro::Plugin::Input::GetPlatform() const

Returns: The hardware platform of the input.

‍

Plugin FrameInput Class

Namespace: eSdkPro::Plugin  ‍

Header: eSdkPro/plugin/port.h

An input port for frames.

‍

GetFrame()

Frame eSdkPro::Plugin::FrameInput::GetFrame()

Returns the input frame. The frame's data becomes invalid and must not be used after Process() returns.‍

Returns: The input frame.

‍

GetFrameAsync()

Frame eSdkPro::Plugin::FrameInput::GetFrameAsync()

Returns the input frame. The frame's data stays valid after Process() returns until a matching call to ReleaseAsyncFrame().‍

Returns: The input frame.

‍

ReleaseAsyncFrame()

void eSdkPro::Plugin::FrameInput::ReleaseAsyncFrame(const Frame& frame)

Releases the frame returned by GetFrameAsync(). Must be called to release the frame or the frame will be leaked.‍

Parameter: frame — The frame that has been previously returned by GetFrameAsync().

‍

‍

Plugin DataInput Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/port.h

An input port for generic data.

‍

GetData()

Data eSdkPro::Plugin::DataInput::GetData()

Returns the input data. The data becomes invalid and must not be used after Process() returns.

Returns: The input data.

‍

GetDataAsync()

Data eSdkPro::Plugin::DataInput::GetDataAsync()

Returns the input data. The data stays valid after Process() returns until a matching call to ReleaseAsyncData().

Returns: The input data.

‍

ReleaseAsyncData()

void eSdkPro::Plugin::DataInput::ReleaseAsyncData(const Data& data)

Releases the data returned by GetDataAsync(). You must call this method to release the data, or the data will be leaked.

Parameter: data — The data previously returned by GetDataAsync().

‍

See Also

• Plugin TaskWorker Class
• Port Classes
• Frame Class