RTSPInput Class

RTSP source Node — pulls a stream from an RTSP URL. More...

Declaration

class simaai::neat::RTSPInput { ... }

Included Headers

#include <RTSPInput.h>

Base class

class	Node

Public Constructors Index

	RTSPInput (std::string url, int latency_ms=200, bool tcp=true, bool drop_on_latency=false, std::string buffer_mode="")
	Construct with an RTSP URL plus optional jitter-buffer / transport tuning. 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 &	url () const
	The RTSP URL this Node was constructed with. More...
int	latency_ms () const
	Jitter-buffer latency, in milliseconds. More...
bool	tcp () const
	True if the RTSP transport is forced to TCP (false = UDP). More...
bool	drop_on_latency () const
	True if late buffers should be dropped when the jitter-buffer overflows. More...
const std::string &	buffer_mode () const
	Buffer-mode label passed through to rtspsrc (empty = default). More...

Private Member Attributes Index

std::string	url_
int	latency_ms_ = 200
bool	tcp_ = true
bool	drop_on_latency_ = false
std::string	buffer_mode_

Description

RTSP source Node — pulls a stream from an RTSP URL.

Pair with H264Depacketize (and optionally H264CapsFixup) plus a decoder to obtain raw frames. The Session uses Session::run() since this Node is a source and no samples are pushed by the application.

Definition at line 28 of file RTSPInput.h.

Public Constructors

RTSPInput()

simaai::neat::RTSPInput::RTSPInput (std::string url, int latency_ms=200, bool tcp=true, bool drop_on_latency=false, std::string buffer_mode="")

Construct with an RTSP URL plus optional jitter-buffer / transport tuning.

Definition at line 31 of file RTSPInput.h.

Public Member Functions

backend_fragment()

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

GStreamer fragment this Node emits.

Definition at line 52 of file RTSPInput.h.

buffer_mode()

const std::string & simaai::neat::RTSPInput::buffer_mode ()

inline

Buffer-mode label passed through to rtspsrc (empty = default).

Definition at line 73 of file RTSPInput.h.

73 const std::string& buffer_mode() const {

74 return buffer_mode_;

75 }

caps_behavior()

NodeCapsBehavior simaai::neat::RTSPInput::caps_behavior ()

inline

Whether the Node negotiates static or dynamic caps.

Definition at line 47 of file RTSPInput.h.

47 NodeCapsBehavior caps_behavior() const override {

48 return NodeCapsBehavior::Dynamic;

49 }

drop_on_latency()

bool simaai::neat::RTSPInput::drop_on_latency ()

inline

True if late buffers should be dropped when the jitter-buffer overflows.

Definition at line 69 of file RTSPInput.h.

69 bool drop_on_latency() const {

70 return drop_on_latency_;

71 }

element_names()

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

Deterministic element names this Node will create.

Definition at line 54 of file RTSPInput.h.

input_role()

InputRole simaai::neat::RTSPInput::input_role ()

inline

Role this Node plays as a stream source.

Definition at line 43 of file RTSPInput.h.

43 InputRole input_role() const override {

44 return InputRole::Source;

45 }

kind()

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

inline

Type label for this Node kind.

Definition at line 35 of file RTSPInput.h.

35 std::string kind() const override {

36 return "RTSPInput";

37 }

latency_ms()

int simaai::neat::RTSPInput::latency_ms ()

inline

Jitter-buffer latency, in milliseconds.

Definition at line 61 of file RTSPInput.h.

61 int latency_ms() const {

62 return latency_ms_;

63 }

tcp()

bool simaai::neat::RTSPInput::tcp ()

inline

True if the RTSP transport is forced to TCP (false = UDP).

Definition at line 65 of file RTSPInput.h.

65 bool tcp() const {

66 return tcp_;

67 }

url()

const std::string & simaai::neat::RTSPInput::url ()

inline

The RTSP URL this Node was constructed with.

Definition at line 57 of file RTSPInput.h.

57 const std::string& url() const {

58 return url_;

59 }

user_label()

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

inline

User-facing label for this Node.

Definition at line 39 of file RTSPInput.h.

39 std::string user_label() const override {

40 return url_;

41 }

Private Member Attributes

buffer_mode_

std::string simaai::neat::RTSPInput::buffer_mode_

Definition at line 82 of file RTSPInput.h.

82 std::string buffer_mode_;

drop_on_latency_

bool simaai::neat::RTSPInput::drop_on_latency_ = false

Definition at line 81 of file RTSPInput.h.

81 bool drop_on_latency_ = false;

latency_ms_

int simaai::neat::RTSPInput::latency_ms_ = 200

Definition at line 79 of file RTSPInput.h.

79 int latency_ms_ = 200;

tcp_

bool simaai::neat::RTSPInput::tcp_ = true

Definition at line 80 of file RTSPInput.h.

80 bool tcp_ = true;

url_

std::string simaai::neat::RTSPInput::url_

Definition at line 78 of file RTSPInput.h.

78 std::string url_;

---

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

• RTSPInput.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.