Skip to content

Commit e364461

Browse files
committed
update descriptions & comments to frame metadta
1 parent 36f9de3 commit e364461

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

examples/local_video/publisher.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
def parse_args() -> argparse.Namespace:
2323
parser = argparse.ArgumentParser(
24-
description="Publish a local camera track with optional packet-trailer metadata.",
24+
description="Publish a local camera track with optional frame metadata.",
2525
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
2626
)
2727
parser.add_argument("--camera-index", type=int, default=0, help="OpenCV camera index to use")

examples/local_video/subscriber.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class SubscribedVideoTrack:
3333

3434
def parse_args() -> argparse.Namespace:
3535
parser = argparse.ArgumentParser(
36-
description="Subscribe to a LiveKit video track and optionally display packet metadata.",
36+
description="Subscribe to a LiveKit video track and optionally display frame metadata.",
3737
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
3838
)
3939
parser.add_argument("--room-name", default="video-room", help="LiveKit room name")

livekit-rtc/livekit/rtc/video_source.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def capture_frame(
6060
rotation: proto_video.VideoRotation.ValueType = proto_video.VideoRotation.VIDEO_ROTATION_0,
6161
metadata: proto_video.FrameMetadata | None = None,
6262
) -> None:
63-
"""Capture a frame, optionally attaching packet trailer metadata."""
63+
"""Capture a frame, optionally attaching frame metadata."""
6464
req = proto_ffi.FfiRequest()
6565
req.capture_video_frame.source_handle = self._ffi_handle.handle
6666
req.capture_video_frame.buffer.CopyFrom(frame._proto_info())

0 commit comments

Comments
 (0)