Skip to content

Commit 032e3de

Browse files
committed
docs: move drain_video_frames docstring to ConnectionManager
SubscriberPeerConnection is internal; ConnectionManager is the public entry point users actually interact with.
1 parent 8efddcd commit 032e3de

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

getstream/video/rtc/connection_manager.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ def __init__(
6161
drain_video_frames: bool = True,
6262
**kwargs: Any,
6363
):
64+
"""
65+
Args:
66+
drain_video_frames: When True, attaches a MediaBlackhole to each
67+
incoming video track so unconsumed frames are drained
68+
automatically. This prevents unbounded queue growth in
69+
RTCRtpReceiver when no subscriber is consuming the track.
70+
The drain is stopped once a real subscriber is added via
71+
add_track_subscriber.
72+
"""
6473
super().__init__()
6574

6675
# Public attributes

getstream/video/rtc/pc.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,15 +133,6 @@ def __init__(
133133
configuration: aiortc.RTCConfiguration,
134134
drain_video_frames: bool = True,
135135
) -> None:
136-
"""
137-
Args:
138-
drain_video_frames: When True, attaches a MediaBlackhole to each
139-
incoming video track so unconsumed frames are drained
140-
automatically. This prevents unbounded queue growth in
141-
RTCRtpReceiver when no subscriber is consuming the track.
142-
The drain is stopped once a real subscriber is added via
143-
add_track_subscriber.
144-
"""
145136
logger.info(
146137
f"creating subscriber peer connection with configuration: {configuration}"
147138
)

0 commit comments

Comments
 (0)