eSDK Pro Plugin Output Classes

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

• Output class — Represents a generic output port that sends data from a task to downstream pipeline stages.
• FrameOutput class — Specialized output port for sending image frames, supporting reusable and queued frame operations.
• DataOutput class — Specialized output port for sending generic data, supporting reusable and queued data operations.

‍

Plugin Output Class

Namespace: eSdkPro::Plugin

‍Header: eSdkPro/plugin/port.h

An output port used to send data from a task.

‍

GetName()

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

Returns: The name of the output.

‍

GetType()

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

Returns: The type of the output.

‍

GetPlatform()

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

Returns: The hardware platform of the output.

‍

Plugin FrameOutput Class

Namespace: eSdkPro::Plugin  ‍

Header: eSdkPro/plugin/port.h

An output port for frames.

‍

PushFrame()

void eSdkPro::Plugin::FrameOutput::PushFrame(const Frame& frame)

Pushes an output frame.‍

Parameter: frame — The frame to be pushed to the output.

‍

RegisterOutputFrame()

void eSdkPro::Plugin::FrameOutput::RegisterOutputFrame(const Frame& frame)

Registers an output frame so that it may be reused.‍

Parameter: frame — The frame to be registered.

‍

DeregisterOutputFrame()

void eSdkPro::Plugin::FrameOutput::DeregisterOutputFrame(const Frame& frame)

Deregisters a reusable output frame.‍

Parameter: frame — The frame to be deregistered.

‍

QueueOutputFrame()

void eSdkPro::Plugin::FrameOutput::QueueOutputFrame(const Frame& frame)

Queues a registered output frame.‍

Parameter: frame — The frame to be queued.

‍

GetOutputFrame()

Frame eSdkPro::Plugin::FrameOutput::GetOutputFrame()

Blocks until a frame is available and returns it.‍

Returns: The next queued output frame.

‍

‍

Plugin DataOutput Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/port.h

An output port for generic data.

‍

PushData()

void eSdkPro::Plugin::DataOutput::PushData(const Data& data)

Pushes output data.

Parameter: data — The data to be pushed to the output.

‍

RegisterOutputData()

void eSdkPro::Plugin::DataOutput::RegisterOutputData(const Data& data)

Registers output data so that it may be reused.

Parameter: data — The data to be registered.

‍

DeregisterOutputData()

void eSdkPro::Plugin::DataOutput::DeregisterOutputData(const Data& data)

Deregisters reusable output data.

Parameter: data — The data to be deregistered.

‍

QueueOutputData()

void eSdkPro::Plugin::DataOutput::QueueOutputData(const Data& data)

Queues registered output data.

Parameter: data — The data to be queued.

‍

GetOutputData()

Data eSdkPro::Plugin::DataOutput::GetOutputData()

Blocks until data is available and returns it.

Returns: The next queued output data.

‍

See Also

• Plugin TaskWorker Class
• Port Classes
• Frame Class