Merge pull request #1023 from pipecat-ai/aleix/introduce-heartbeat-frames

introduce heartbeat frames

examples/foundational/31-heartbeats.py

@@ -0,0 +1,43 @@
+#
+# Copyright (c) 2024–2025, Daily
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+import asyncio
+import sys
+
+from loguru import logger
+
+from pipecat.frames.frames import Frame
+from pipecat.pipeline.pipeline import Pipeline
+from pipecat.pipeline.runner import PipelineRunner
+from pipecat.pipeline.task import PipelineParams, PipelineTask
+from pipecat.processors.frame_processor import FrameDirection, FrameProcessor
+
+logger.remove(0)
+logger.add(sys.stderr, level="DEBUG")
+
+
+class NullProcessor(FrameProcessor):
+    async def process_frame(self, frame: Frame, direction: FrameDirection):
+        await super().process_frame(frame, direction)
+
+
+async def main():
+    """This test shows heartbeat monitoring by displaying a warning when
+    heartbeats are not received.
+
+    """
+
+    pipeline = Pipeline([NullProcessor()])
+
+    task = PipelineTask(pipeline, PipelineParams(enable_heartbeats=True))
+
+    runner = PipelineRunner()
+
+    await runner.run(task)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())