Input Class

Push-mode source Node. More...

Declaration

class simaai::neat::Input { ... }

Included Headers

#include <Input.h>

Base classes

class	Node
class	OutputSpecProvider

Public Constructors Index

	Input (InputOptions opt)
	Construct with caps / pool / memory options. More...
	Input (std::string name)
	Construct with a public Graph input endpoint name. More...
	Input (std::string name, InputOptions opt)
	Construct with a public Graph input endpoint name and caps / pool / memory options. More...

Public Member Functions Index

std::string	kind () const override
	Type label for this Node kind. More...
std::string	user_label () const override
	User-facing label for this Node. More...
const std::string &	endpoint_name () const noexcept
	Explicit public endpoint name, empty when unnamed. More...
InputRole	input_role () const override
	Role this Node plays as a stream source. More...
NodeCapsBehavior	caps_behavior () const override
	Whether the Node negotiates static or dynamic caps. More...
std::string	buffer_name_hint (int node_index) const override
	Optional buffer-name hint used during wiring. More...
std::string	backend_fragment (int node_index) const override
	GStreamer fragment this Node emits. More...
std::vector< std::string >	element_names (int node_index) const override
	Deterministic element names this Node will create. More...
OutputSpec	output_spec (const OutputSpec &input) const override
	Negotiated downstream caps produced by this Node. More...
const InputOptions &	options () const
	Inspect the Node's options. More...
std::string	caps_string () const
	Render the negotiated caps as a GStreamer caps string. More...

Private Member Attributes Index

InputOptions	opt_
std::string	endpoint_name_

Description

Push-mode source Node.

The application feeds samples via Run::push().

Add this Node when the application owns frame production. Because it carries InputRole::Push, the Graph must be driven through Graph::build() plus Run::push() per sample (not Run::run(), which is for source-role pipelines).

Definition at line 150 of file Input.h.

Public Constructors

Input()

simaai::neat::Input::Input (InputOptions opt)

explicit

Construct with caps / pool / memory options.

Definition at line 153 of file Input.h.

Input()

simaai::neat::Input::Input (std::string name)

explicit

Construct with a public Graph input endpoint name.

Definition at line 155 of file Input.h.

Input()

simaai::neat::Input::Input (std::string name, InputOptions opt)

Construct with a public Graph input endpoint name and caps / pool / memory options.

Definition at line 157 of file Input.h.

Public Member Functions

backend_fragment()

std::string simaai::neat::Input::backend_fragment (int node_index)

GStreamer fragment this Node emits.

Definition at line 186 of file Input.h.

buffer_name_hint()

std::string simaai::neat::Input::buffer_name_hint (int node_index)

Optional buffer-name hint used during wiring.

Definition at line 183 of file Input.h.

caps_behavior()

NodeCapsBehavior simaai::neat::Input::caps_behavior ()

inline

Whether the Node negotiates static or dynamic caps.

Definition at line 179 of file Input.h.

caps_string()

std::string simaai::neat::Input::caps_string ()

Render the negotiated caps as a GStreamer caps string.

Definition at line 197 of file Input.h.

element_names()

std::vector< std::string > simaai::neat::Input::element_names (int node_index)

Deterministic element names this Node will create.

Definition at line 188 of file Input.h.

endpoint_name()

const std::string & simaai::neat::Input::endpoint_name ()

inline noexcept

Explicit public endpoint name, empty when unnamed.

Definition at line 171 of file Input.h.

input_role()

InputRole simaai::neat::Input::input_role ()

inline

Role this Node plays as a stream source.

Definition at line 175 of file Input.h.

kind()

std::string simaai::neat::Input::kind ()

inline

Type label for this Node kind.

Definition at line 160 of file Input.h.

options()

const InputOptions & simaai::neat::Input::options ()

inline

Inspect the Node's options.

Definition at line 193 of file Input.h.

output_spec()

OutputSpec simaai::neat::Input::output_spec (const OutputSpec & input)

Negotiated downstream caps produced by this Node.

Definition at line 190 of file Input.h.

user_label()

std::string simaai::neat::Input::user_label ()

inline

User-facing label for this Node.

Definition at line 164 of file Input.h.

Private Member Attributes

endpoint_name_

std::string simaai::neat::Input::endpoint_name_

Definition at line 201 of file Input.h.

opt_

InputOptions simaai::neat::Input::opt_

Definition at line 200 of file Input.h.

---

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

• Input.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.