frames

RTVI pipeline frame definitions.

class pipecat.processors.frameworks.rtvi.frames.RTVIServerMessageFrame(data: Any)[source]

Bases: SystemFrame

A frame for sending server messages to the client.

Parameters:: data – The message data to send to the client.

data: Any

class pipecat.processors.frameworks.rtvi.frames.RTVIClientMessageFrame(msg_id: str, type: str, data: Any | None = None)[source]

Bases: SystemFrame

A frame for sending messages from the client to the RTVI server.

This frame is meant for custom messaging from the client to the server and expects a server-response message.

msg_id: str

type: str

data: Any | None = None

class pipecat.processors.frameworks.rtvi.frames.RTVIServerResponseFrame(client_msg: RTVIClientMessageFrame, data: Any | None = None, error: str | None = None)[source]

Bases: SystemFrame

A frame for responding to a client RTVI message.

This frame should be sent in response to an RTVIClientMessageFrame and include the original RTVIClientMessageFrame to ensure the response is properly attributed to the original request. To respond with an error, set the error field to a string describing the error. This will result in the client receiving an error-response message instead of a server-response message.

client_msg: RTVIClientMessageFrame

data: Any | None = None

error: str | None = None