pub struct Tee { /* private fields */ }Expand description
Fans a single input out to multiple sinks. TeeBuilder owns the
initial fan-out; later branches are added and removed through a
TeeHandle, which can be cloned and used from any thread, independent
of whatever thread is driving Tee::consume
(the pipeline’s source/queue-worker thread). That’s the whole reason
Tee doesn’t implement crate::element::Source like other
multi-pad elements (e.g. crate::elements::FileDemuxer): its pads
live in individually locked branch slots instead of being a plain
&mut [SrcPad]. consume only holds the branch-list lock long enough
to take a cheap Arc snapshot, so a slow downstream does not block
unrelated attach/detach operations. Detach prevents any push that has
not started yet; one already executing downstream call may finish.
Cheap to fan out: MediaBuffer wraps its payload in an Arc, so
cloning a buffer for each output is a refcount bump, not a copy of the
encoded/decoded data.
Trait Implementations§
Source§impl Element for Tee
impl Element for Tee
Source§fn name(&self) -> Arc<str> ⓘ
fn name(&self) -> Arc<str> ⓘ
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.Source§fn element_type(&self) -> ElementType
fn element_type(&self) -> ElementType
ElementType.Source§fn graph_id(&self) -> Option<ElementId>
fn graph_id(&self) -> Option<ElementId>
ChainBuilder and keep the default None implementation.Source§fn pp_log(&self) -> &PpLog
fn pp_log(&self) -> &PpLog
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.Source§fn pp_log_mut(&mut self) -> &mut PpLog
fn pp_log_mut(&mut self) -> &mut PpLog
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.Source§impl Sink for Tee
impl Sink for Tee
fn consume(&mut self, buf: MediaBuffer) -> Result<()>
Source§fn control(&mut self, msg: ControlMsg) -> Result<()>
fn control(&mut self, msg: ControlMsg) -> Result<()>
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.