Skip to main content

FrameKind

flowcat_core::processor::frame

Enum FrameKind

pub enum FrameKind {
Show 49 variants    Start,
    Cancel,
    Error,
    Interruption,
    InputAudio,
    UserAudio,
    InputText,
    InputDtmf,
    UserStartedSpeaking,
    UserStoppedSpeaking,
    UserSpeaking,
    BotStartedSpeaking,
    BotStoppedSpeaking,
    BotSpeaking,
    VadUserStartedSpeaking,
    VadUserStoppedSpeaking,
    SttMute,
    Metrics,
    TransportMessage,
    ClientConnected,
    BotConnected,
    FunctionCallsStarted,
    FunctionCallInProgress,
    FunctionCallCancel,
    OutputAudio,
    TtsAudio,
    Text,
    LlmText,
    Transcription,
    InterimTranscription,
    TtsSpeak,
    TtsText,
    FunctionCallResult,
    LlmRun,
    LlmContext,
    OutputDtmf,
    End,
    Stop,
    LlmResponseStart,
    LlmResponseEnd,
    TtsStarted,
    TtsStopped,
    UpdateSettings,
    SpeechControlParams,
    Heartbeat,
    OutputTransportReady,
    FilterEnable,
    MixerEnable,
    Custom,
}

Expand description

A payload-free discriminant for Frame, used by event hooks (on_frame_reached_*), idle-frame detection, and observers that filter by type. Mirrors using isinstance on a pipecat frame class.

Variants§

Start

Cancel

Error

Interruption

InputAudio

UserAudio

InputText

InputDtmf

UserStartedSpeaking

UserStoppedSpeaking

UserSpeaking

BotStartedSpeaking

BotStoppedSpeaking

BotSpeaking

VadUserStartedSpeaking

VadUserStoppedSpeaking

SttMute

Metrics

TransportMessage

ClientConnected

BotConnected

FunctionCallsStarted

FunctionCallInProgress

FunctionCallCancel

OutputAudio

TtsAudio

Text

LlmText

Transcription

InterimTranscription

TtsSpeak

TtsText

FunctionCallResult

LlmRun

LlmContext

OutputDtmf

End

Stop

LlmResponseStart

LlmResponseEnd

TtsStarted

TtsStopped

UpdateSettings

SpeechControlParams

Heartbeat

OutputTransportReady

FilterEnable

MixerEnable

Custom

Trait Implementations§

impl Clone for FrameKind

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Copy for FrameKind

impl Debug for FrameKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Eq for FrameKind

impl Hash for FrameKind

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for FrameKind

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for FrameKind

Auto Trait Implementations§

impl Freeze for FrameKind

impl RefUnwindSafe for FrameKind

impl Send for FrameKind

impl Sync for FrameKind

impl Unpin for FrameKind

impl UnsafeUnpin for FrameKind

impl UnwindSafe for FrameKind

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

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

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

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

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