FileInput Class

Wraps GStreamer's filesrc element — reads encoded media from a path on disk. More...

Declaration

class simaai::neat::FileInput { ... }

Included Headers

#include <FileInput.h>

Base class

class	Node

Public Constructors Index

	FileInput (std::string path)
	Construct with the filesystem path to read from. 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...
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	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...
const std::string &	path () const
	The path this FileInput was constructed with. More...

Private Member Attributes Index

std::string	path_

Description

Wraps GStreamer's filesrc element — reads encoded media from a path on disk.

Typical placement: first Node in a Session that processes a video / image file.

Usage:

 sess.add(sima::nodes::FileInput("input.mp4"));

Definition at line 31 of file FileInput.h.

Public Constructors

FileInput()

simaai::neat::FileInput::FileInput (std::string path)

explicit

Construct with the filesystem path to read from.

Definition at line 34 of file FileInput.h.

Public Member Functions

backend_fragment()

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

GStreamer fragment this Node emits.

Definition at line 54 of file FileInput.h.

caps_behavior()

NodeCapsBehavior simaai::neat::FileInput::caps_behavior ()

inline

Whether the Node negotiates static or dynamic caps.

Definition at line 49 of file FileInput.h.

49 NodeCapsBehavior caps_behavior() const override {

50 return NodeCapsBehavior::Dynamic;

51 }

element_names()

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

Deterministic element names this Node will create.

Definition at line 56 of file FileInput.h.

input_role()

InputRole simaai::neat::FileInput::input_role ()

inline

Role this Node plays as a stream source.

Definition at line 45 of file FileInput.h.

45 InputRole input_role() const override {

46 return InputRole::Source;

47 }

kind()

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

inline

Type label for this Node kind.

Definition at line 37 of file FileInput.h.

37 std::string kind() const override {

38 return "FileInput";

39 }

path()

const std::string & simaai::neat::FileInput::path ()

inline

The path this FileInput was constructed with.

Definition at line 59 of file FileInput.h.

59 const std::string& path() const {

60 return path_;

61 }

user_label()

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

inline

User-facing label for this Node.

Definition at line 41 of file FileInput.h.

41 std::string user_label() const override {

42 return path_;

43 }

Private Member Attributes

path_

std::string simaai::neat::FileInput::path_

Definition at line 64 of file FileInput.h.

64 std::string path_;

---

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

• FileInput.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.