Skip to main content

TurnController

Struct TurnController 

Source
pub struct TurnController<T: AudioTurnDetector> { /* private fields */ }
Expand description

Orchestration wrapper around any AudioTurnDetector.

Tracks prediction state across calls and provides convenience methods like reset_if_finished for correct VAD integration without manual state bookkeeping.

§Usage

let detector = PipecatSmartTurn::new()?;
let mut ctrl = TurnController::new(detector);

// Audio arrives continuously
ctrl.push_audio(&frame);

// VAD speech start — soft reset (keeps buffer if turn was unfinished)
ctrl.reset_if_finished();

// VAD speech end — predict
let result = ctrl.predict()?;

See reset_if_finished for details on when to use soft vs hard reset.

Implementations§

Source§

impl<T: AudioTurnDetector> TurnController<T>

Source

pub fn new(inner: T) -> Self

Create a new controller wrapping the given detector.

Source

pub fn push_audio(&mut self, frame: &AudioFrame<'_>)

Feed audio into the detector.

Source

pub fn predict(&mut self) -> Result<TurnPrediction, TurnError>

Run prediction on buffered audio.

Tracks the result state internally for reset_if_finished.

Source

pub fn reset(&mut self)

Hard reset — always clears the buffer.

Use when you know a new turn is starting (e.g. after the assistant finishes responding).

Source

pub fn reset_if_finished(&mut self) -> bool

Soft reset — clears the buffer only if the last prediction was Finished or no prediction has been made since the last reset.

Returns true if a reset occurred, false if skipped.

Call this on VAD speech-start when you don’t know whether the user is continuing the same turn or starting a new one. If the previous prediction was Unfinished, the buffer is preserved so the next predict runs on the full accumulated audio.

Source

pub fn last_state(&self) -> Option<TurnState>

Returns the state from the last predict call, or None if no prediction has been made since the last reset.

Source

pub fn inner_mut(&mut self) -> &mut T

Returns a mutable reference to the inner detector.

Source

pub fn into_inner(self) -> T

Unwrap the controller, returning the inner detector.

Auto Trait Implementations§

§

impl<T> Freeze for TurnController<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for TurnController<T>
where T: RefUnwindSafe,

§

impl<T> Send for TurnController<T>

§

impl<T> Sync for TurnController<T>

§

impl<T> Unpin for TurnController<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for TurnController<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for TurnController<T>
where T: 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<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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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