Output Class

Pull-side terminal sink. More...

Declaration

class simaai::neat::Output { ... }

Included Headers

#include <Output.h>

Base class

class	Node

Public Constructors Index

	Output ()=default
	Construct with default options (max_buffers=4, drop=false, sync=false). More...
	Output (std::string name)
	Construct with a public Graph output endpoint name. More...
	Output (OutputOptions opt)
	Construct with explicit options. More...
	Output (std::string name, OutputOptions opt)
	Construct with a public Graph output endpoint name and explicit options. More...

Public Member Functions Index

const OutputOptions &	options () const
	Inspect the Node's options. More...
std::string	kind () const override
	Type label for this Node kind. More...
std::string	user_label () const override
	Optional public Graph endpoint name used by Run::pull(name, ...). More...
const std::string &	endpoint_name () const noexcept
	Explicit public endpoint name, empty when unnamed. More...
NodeCapsBehavior	caps_behavior () const override
	Whether the Node negotiates static or dynamic caps. 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...

Private Member Attributes Index

OutputOptions	opt_
std::string	endpoint_name_

Description

Pull-side terminal sink.

Samples land here for Run::pull() to consume.

Definition at line 71 of file Output.h.

Public Constructors

Output()

simaai::neat::Output::Output ()

default

Construct with default options (max_buffers=4, drop=false, sync=false).

Definition at line 74 of file Output.h.

Output()

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

inline explicit

Construct with a public Graph output endpoint name.

Definition at line 76 of file Output.h.

76 explicit Output(std::string name) : endpoint_name_(std::move(name)) {}

Output()

simaai::neat::Output::Output (OutputOptions opt)

inline explicit

Construct with explicit options.

Definition at line 78 of file Output.h.

78 explicit Output(OutputOptions opt) : opt_(std::move(opt)) {}

Output()

simaai::neat::Output::Output (std::string name, OutputOptions opt)

inline

Construct with a public Graph output endpoint name and explicit options.

Definition at line 80 of file Output.h.

80 Output(std::string name, OutputOptions opt)

81 : opt_(std::move(opt)), endpoint_name_(std::move(name)) {}

Public Member Functions

backend_fragment()

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

GStreamer fragment this Node emits.

Definition at line 105 of file Output.h.

caps_behavior()

NodeCapsBehavior simaai::neat::Output::caps_behavior ()

inline

Whether the Node negotiates static or dynamic caps.

Definition at line 101 of file Output.h.

101 NodeCapsBehavior caps_behavior() const override {

102 return NodeCapsBehavior::Dynamic;

103 }

element_names()

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

Deterministic element names this Node will create.

Definition at line 107 of file Output.h.

endpoint_name()

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

inline noexcept

Explicit public endpoint name, empty when unnamed.

Definition at line 97 of file Output.h.

97 const std::string& endpoint_name() const noexcept {

98 return endpoint_name_;

99 }

kind()

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

inline

Type label for this Node kind.

Definition at line 89 of file Output.h.

89 std::string kind() const override {

90 return "Output";

91 }

options()

const OutputOptions & simaai::neat::Output::options ()

inline

Inspect the Node's options.

Definition at line 84 of file Output.h.

84 const OutputOptions& options() const {

85 return opt_;

86 }

user_label()

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

inline

Optional public Graph endpoint name used by Run::pull(name, ...).

Definition at line 93 of file Output.h.

93 std::string user_label() const override {

94 return endpoint_name_;

95 }

Private Member Attributes

endpoint_name_

std::string simaai::neat::Output::endpoint_name_

Definition at line 111 of file Output.h.

111 std::string endpoint_name_;

opt_

OutputOptions simaai::neat::Output::opt_

Definition at line 110 of file Output.h.

110 OutputOptions opt_;

---

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

• Output.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.