doc(openai): Added hint re the 24kHz sample rate

pipecat-ai · Jun 1, 2024 · 7085b1e · 7085b1e
1 parent 8683cae
commit 7085b1e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/pipecat/services/openai.py b/src/pipecat/services/openai.py
@@ -264,6 +264,16 @@ async def run_image_gen(self, prompt: str) -> AsyncGenerator[Frame, None]:
 
 
 class OpenAITTSService(TTSService):
+    """This service uses the OpenAI TTS API to generate audio from text.
+    The returned audio is PCM encoded at 24kHz. When using the DailyTransport, set the sample rate in the DailyParams:
+    ```
+    DailyParams(
+        audio_out_enabled=True,
+        audio_out_sample_rate=24_000,
+    )
+    ```
+    """
+
     def __init__(
             self,
             *,