Struct RtspSink 

pub struct RtspSink { /* private fields */ }

Publishes one compressed packet stream to an already-running RTSP server.

RtspSink::open performs the RTSP ANNOUNCE/SETUP/RECORD handshake through FFmpeg, so the server must already be listening at url and must permit publishing to that path. The server can be MediaMTX or any other implementation that accepts RTSP publishing; this element does not start, stop, or otherwise depend on a particular server process.

This is a remuxing sink, not an encoder. Incoming buffers must be compressed MediaBuffer::Packet values whose codec parameters and time base match the values passed to RtspSink::open. Place a crate::elements::Pacer upstream when publishing packets from a file, otherwise the file will be sent faster than real time.

The current sink publishes one stream. Build separate sinks and RTSP paths when publishing independent streams.

Implementations

impl RtspSink

pub fn open( name: impl Into<String>, url: impl Into<String>, transport: RtspTransport, params: Parameters, time_base: Rational, ) -> Result<Self>

Connects to url and starts publishing.

params and time_base must describe every packet subsequently passed to Sink::consume. TCP is the most reliable transport for general networks; UDP is useful when the network path and server permit the negotiated RTP/RTCP ports.

pub fn url(&self) -> &str

URL this sink publishes to.

Trait Implementations

impl Drop for RtspSink

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Element for RtspSink

fn name(&self) -> Arc<str>

Returns a cheap clone (refcount bump, not a deep copy) of this element’s name — crate::bus::BusEvent stores names as Arc<str> for exactly this reason: a hot path like crate::queue::Queue posting BusEvent::Dropped once per overflowed buffer shouldn’t pay for a fresh heap allocation every time it wants to report which element it is.

fn element_type(&self) -> ElementType

See ElementType.

fn pp_log(&self) -> &PpLog

This element’s identity for crate::bus::Bus::post — same id/name as Element::name, just already wrapped as the crate::pp_log::PpLog its pp_info!/pp_warn!/pp_error! macros need. A stored private field, not built fresh per call, for the same reason name() returns a cheap Arc<str> clone instead of a fresh String — see its own docs.

fn pp_log_mut(&mut self) -> &mut PpLog

Mutable access to the same field Element::pp_log reads — used by crate::pipeline::ChainBuilder to stamp the owning crate::pipeline::Pipeline’s id onto every element that passes through it, via element_pp_log. Not meant to be called from anywhere else.

fn graph_id(&self) -> Option<ElementId>

A pre-reserved graph identity for elements that expose dynamic attachment handles. Most elements receive an ID from ChainBuilder and keep the default None implementation.

impl Sink for RtspSink

fn consume(&mut self, buf: MediaBuffer) -> Result<()>

fn control(&mut self, msg: ControlMsg) -> Result<()>

Reacts to a ControlMsg (pause/resume/stop) and, for anything with a downstream of its own, forwards it on — same shape as consume, just a separate channel from MediaBuffer so it can reach every element (not just ones that already know how to interpret a data buffer) and, at a crate::queue::Queue, jump ahead of whatever data is backed up instead of waiting behind it. No default: every Sink has to consciously decide what this means for it, rather than silently dropping it.