Skip to main content

Input Class

Push-mode source Node. More...

Declaration

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

Included Headers

#include <Input.h>

Base classes

classNode
classOutputSpecProvider

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::stringkind () const override

Type label for this Node kind. More...

std::stringuser_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...

InputRoleinput_role () const override

Role this Node plays as a stream source. More...

NodeCapsBehaviorcaps_behavior () const override

Whether the Node negotiates static or dynamic caps. More...

std::stringbuffer_name_hint (int node_index) const override

Optional buffer-name hint used during wiring. More...

std::stringbackend_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...

OutputSpecoutput_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::stringcaps_string () const

Render the negotiated caps as a GStreamer caps string. More...

Private Member Attributes Index

InputOptionsopt_
std::stringendpoint_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 141 of file Input.h.

Public Constructors

Input()

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

Construct with caps / pool / memory options.

Definition at line 144 of file Input.h.

Input()

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

Construct with a public Graph input endpoint name.

Definition at line 146 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 148 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 177 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 174 of file Input.h.

caps_behavior()

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

Whether the Node negotiates static or dynamic caps.

Definition at line 170 of file Input.h.

170 NodeCapsBehavior caps_behavior() const override {
171 return NodeCapsBehavior::Static;
172 }

caps_string()

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

Render the negotiated caps as a GStreamer caps string.

Definition at line 188 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 179 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 162 of file Input.h.

162 const std::string& endpoint_name() const noexcept {
163 return endpoint_name_;
164 }

input_role()

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

Role this Node plays as a stream source.

Definition at line 166 of file Input.h.

166 InputRole input_role() const override {
167 return InputRole::Push;
168 }

kind()

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

Type label for this Node kind.

Definition at line 151 of file Input.h.

151 std::string kind() const override {
152 return "Input";
153 }

options()

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

Inspect the Node's options.

Definition at line 184 of file Input.h.

184 const InputOptions& options() const {
185 return opt_;
186 }

output_spec()

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

Negotiated downstream caps produced by this Node.

Definition at line 181 of file Input.h.

user_label()

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

User-facing label for this Node.

Definition at line 155 of file Input.h.

155 std::string user_label() const override {
156 if (!endpoint_name_.empty()) {
157 return endpoint_name_;
158 }
159 return "mysrc";
160 }

Private Member Attributes

endpoint_name_

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

Definition at line 192 of file Input.h.

192 std::string endpoint_name_;

opt_

InputOptions simaai::neat::Input::opt_

Definition at line 191 of file Input.h.

191 InputOptions opt_;

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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.