Frames
The Frame base class, frame categories and common frame options, from @pipedog/core/frames/frames.
import { ControlFrame, DataFrame, Frame, SystemFrame } from "@pipedog/core/frames/frames";See Frames for how the categories are processed.
Frame
The base class of every frame. Its fields are set automatically.
Prop
Type
SystemFrame, DataFrame, ControlFrame
The three base categories add no fields: they only decide how frames are queued and whether
interruptions drop them. SystemFrames are processed with high priority and never dropped;
DataFrames and ControlFrames are processed in order and dropped on interruption unless
interruptible is false.
TextFrame
Prop
Type
Constructor options:
Prop
Type
Audio frames
InputAudioRawFrame (a system frame) and OutputAudioRawFrame (a data frame) share the
AudioRawFrame mixin. Their options:
Prop
Type
Lifecycle frames
StartFrame starts the pipeline. EndFrame (control, uninterruptible) ends it gracefully,
CancelFrame (system) stops it immediately; both take an optional reason:
Prop
Type
ErrorFrame
Prop
Type
MetricsFrame
Prop
Type
pipedog is an unofficial community TypeScript port of Pipecat. It is not affiliated with or endorsed by Daily or the Pipecat project.
Portions adapted from the Pipecat documentation, Copyright (c) 2024–2025 Daily, BSD-2-Clause (see apps/docs/LICENSE-pipecat-docs).