BaseOutput
- class pipecat.transports.base_output.BaseOutputTransport(params, **kwargs)[source]
Bases:
FrameProcessor- Parameters:
params (TransportParams)
- property sample_rate: int
- property audio_chunk_size: int
- async start(frame)[source]
- Parameters:
frame (StartFrame)
- async stop(frame)[source]
- Parameters:
frame (EndFrame)
- async cancel(frame)[source]
- Parameters:
frame (CancelFrame)
- async set_transport_ready(frame)[source]
To be called when the transport is ready to stream.
- Parameters:
frame (StartFrame)
- async send_message(frame)[source]
- Parameters:
frame (TransportMessageFrame | TransportMessageUrgentFrame)
- async register_video_destination(destination)[source]
- Parameters:
destination (str)
- async register_audio_destination(destination)[source]
- Parameters:
destination (str)
- async write_video_frame(frame)[source]
- Parameters:
frame (OutputImageRawFrame)
- async write_audio_frame(frame)[source]
- Parameters:
frame (OutputAudioRawFrame)
- async write_dtmf(frame)[source]
- Parameters:
frame (OutputDTMFFrame | OutputDTMFUrgentFrame)
- async send_audio(frame)[source]
- Parameters:
frame (OutputAudioRawFrame)
- async send_image(frame)[source]
- Parameters:
frame (OutputImageRawFrame | SpriteFrame)
- async process_frame(frame, direction)[source]
- Parameters:
frame (Frame)
direction (FrameDirection)
- class MediaSender(transport, *, destination, sample_rate, audio_chunk_size, params)[source]
Bases:
object- Parameters:
transport (BaseOutputTransport)
destination (str | None)
sample_rate (int)
audio_chunk_size (int)
params (TransportParams)
- property sample_rate: int
- property audio_chunk_size: int
- async start(frame)[source]
- Parameters:
frame (StartFrame)
- async stop(frame)[source]
- Parameters:
frame (EndFrame)
- async cancel(frame)[source]
- Parameters:
frame (CancelFrame)
- async handle_interruptions(_)[source]
- Parameters:
_ (StartInterruptionFrame)
- async handle_audio_frame(frame)[source]
- Parameters:
frame (OutputAudioRawFrame)
- async handle_image_frame(frame)[source]
- Parameters:
frame (OutputImageRawFrame | SpriteFrame)
- async handle_timed_frame(frame)[source]
- Parameters:
frame (Frame)
- async handle_sync_frame(frame)[source]
- Parameters:
frame (Frame)
- async handle_mixer_control_frame(frame)[source]
- Parameters:
frame (MixerControlFrame)