ui_event_decorator

Decorator for marking worker methods as UI event handlers.

pipecat.workers.ui.ui_event_decorator.ui_event(name: str)[source]

Mark a worker method as a handler for a named UI event.

On UIWorker subclasses, decorated methods are automatically dispatched when a BusUIEventMessage with a matching name arrives.

Example:

class MyUIWorker(UIWorker):
    @ui_event("nav_click")
    async def on_nav(self, message):
        view = message.payload.get("view")
        ...