Skip to main content

VadProcessor

Struct VadProcessor 

Source
pub struct VadProcessor<V: VadAnalyzer> { /* private fields */ }
Expand description

A FrameProcessor that runs a VadAnalyzer over inbound audio and emits the VAD edge + lifecycle frames.

On each Frame::InputAudio it buffers PCM into analyzer-sized windows, runs the analyzer, and translates QUIET↔SPEAKING transitions into:

The original InputAudio frame is always forwarded downstream (STT/turn stages still need the raw audio). Tracks bot-speaking state from Frame::BotStartedSpeaking/Frame::BotStoppedSpeaking so interruption is only broadcast while the bot holds the floor (pipecat barge-in semantics).

Implementations§

Source§

impl<V: VadAnalyzer> VadProcessor<V>

Source

pub fn new(analyzer: V, window_samples: usize) -> Self

Wrap analyzer, consuming window_samples-sample windows. Barge-in interruption is enabled by default.

Source

pub fn without_barge_in_interruption(self) -> Self

Disable broadcasting Interruption on barge-in (the turn controller may own interruption via an InterruptionStrategy).

Trait Implementations§

Source§

impl<V: VadAnalyzer + 'static> FrameProcessor for VadProcessor<V>

Source§

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,

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,

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,

Called on End/Stop/Cancel after the terminal frame is forwarded. Flush + close. Default: no-op.
Source§

fn can_generate_metrics(&self) -> bool

Whether this processor produces metrics (pipecat can_generate_metrics, :395). Services override to true.

Auto Trait Implementations§

§

impl<V> Freeze for VadProcessor<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for VadProcessor<V>
where V: RefUnwindSafe,

§

impl<V> Send for VadProcessor<V>

§

impl<V> Sync for VadProcessor<V>
where V: Sync,

§

impl<V> Unpin for VadProcessor<V>
where V: Unpin,

§

impl<V> UnsafeUnpin for VadProcessor<V>
where V: UnsafeUnpin,

§

impl<V> UnwindSafe for VadProcessor<V>
where V: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more