System
Transport Frames
Frame types for managing transport-level messages and image requests in Pipecat
TransportMessageFrame
Frame for general transport-level messages.
Properties
message
Any
requiredThe message content to be transported
Methods
TransportMessageUrgentFrame
Frame for high-priority transport messages that need immediate handling.
Properties
message
Any
requiredThe urgent message content to be transported
Methods
UserImageRequestFrame
Frame for requesting images from specific users.
Properties
user_id
str
requiredIdentifier of the user to request image from
context
Any
Additional context for the image request
Methods
Usage Examples
Basic Transport Messages
Image Requests
Pipeline Integration
Frame Flow
Transport Patterns
Message Priority Handling
Image Request Flow
Notes
- Transport messages can carry any serializable content
- Urgent messages should be used sparingly
- Image requests should handle timeouts appropriately
- Consider implementing retry logic for failed requests
- Transport frames may interact with network conditions