better docstring

home-assistant-libs · Sep 10, 2024 · 6cf5614 · 6cf5614
1 parent 6e0e8dd
commit 6cf5614
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/pydroid_ipcam/__init__.py b/pydroid_ipcam/__init__.py
@@ -64,7 +64,7 @@ def audio_opus_url(self) -> str:
         return f"{self.base_url}/audio.opus"
 
     def get_rtsp_url(self, video_codec: Literal["jpeg", "h264"] = "h264", audio_codec: Literal["ulaw", "alaw", "pcm", "opus", "aac"] = "opus") -> str:
-        """Return the RTSP URL for a given pair of video & audio codecs."""
+        """Return the RTSP URL for a given pair of video & audio codecs, using the developer-recommended h264 & opus if no arguments are supplied."""
         rtsp_protocol = "rtsps" if self._ssl else "rtsp"
         return f"{rtsp_protocol}://{self._host}:{self._port}/{video_codec}_{audio_codec}.sdp"