pub struct MixerProcessor<M: AudioMixer> { /* private fields */ }Expand description
A FrameProcessor that mixes a secondary AudioMixer source into the
bot’s output audio.
On Frame::OutputAudio/Frame::TtsAudio it blends the mixer source and
forwards the mixed audio; on Frame::MixerEnable it toggles mixing live
(pipecat’s MixerEnableFrame). Sits after TTS / before the transport-out
sink. All other frames pass through.
Implementations§
Source§impl<M: AudioMixer> MixerProcessor<M>
impl<M: AudioMixer> MixerProcessor<M>
Sourcepub fn disabled(mixer: M) -> Self
pub fn disabled(mixer: M) -> Self
Wrap mixer, initially disabled (pass-through until a
Frame::MixerEnable(true) arrives).
Trait Implementations§
Source§impl<M: AudioMixer + 'static> FrameProcessor for MixerProcessor<M>
impl<M: AudioMixer + 'static> FrameProcessor for MixerProcessor<M>
Source§fn name(&self) -> &str
fn name(&self) -> &str
Stable, human-readable name (observer events, error attribution, tracing).
Source§fn start<'life0, 'life1, 'life2, 'async_trait>(
&'life0 mut self,
_setup: &'life1 ProcessorSetup,
params: &'life2 StartParams,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn start<'life0, 'life1, 'life2, 'async_trait>(
&'life0 mut self,
_setup: &'life1 ProcessorSetup,
params: &'life2 StartParams,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called once when the
Frame::Start frame reaches this processor, before
any data frame. Open sockets / spawn provider readers here. Default: no-op.Source§fn process_frame<'life0, 'life1, 'async_trait>(
&'life0 mut self,
env: Envelope,
link: &'life1 Link,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn process_frame<'life0, 'life1, 'async_trait>(
&'life0 mut self,
env: Envelope,
link: &'life1 Link,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Handle one frame. Push results via
link. Must not block: long work
(a provider round-trip) is driven by an internally-spawned task that feeds
results back as frames. The default impl forwards the frame unchanged in
its direction — so a pure observer/no-op processor is process_frame =
default.Source§fn stop<'life0, 'async_trait>(
&'life0 mut self,
_reason: StopReason,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn stop<'life0, 'async_trait>(
&'life0 mut self,
_reason: StopReason,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Called on
End/Stop/Cancel after the terminal frame is forwarded.
Flush + close. Default: no-op.Source§fn can_generate_metrics(&self) -> bool
fn can_generate_metrics(&self) -> bool
Whether this processor produces metrics (pipecat
can_generate_metrics,
:395). Services override to true.Auto Trait Implementations§
impl<M> Freeze for MixerProcessor<M>where
M: Freeze,
impl<M> RefUnwindSafe for MixerProcessor<M>where
M: RefUnwindSafe,
impl<M> Send for MixerProcessor<M>
impl<M> Sync for MixerProcessor<M>where
M: Sync,
impl<M> Unpin for MixerProcessor<M>where
M: Unpin,
impl<M> UnsafeUnpin for MixerProcessor<M>where
M: UnsafeUnpin,
impl<M> UnwindSafe for MixerProcessor<M>where
M: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more