[torchcodec] Add a simple example showing how to decode the first fra…

…me of a video (#51) Summary: Pull Request resolved: #51 Differential Revision: D59022932
pytorch · Jun 25, 2024 · e863c06 · e863c06
1 parent d024e7b
commit e863c06
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 34 deletions.
diff --git a/examples/basic_example.py b/examples/basic_example.py
@@ -0,0 +1,17 @@
+"""
+=============
+Basic Example to use TorchCodec to decode a video.
+=============
+"""
+
+# A simple example showing how to decode the first few frames of a video.
+# using the :class:`~torchcodec.decoders.SimpleVideoDecoder` class.
+# %%
+from torchcodec.decoders import SimpleVideoDecoder
+
+video_file_path = __file__ + "../test/decoders/resources/nasa_13013.mp4"
+simple_decoder = SimpleVideoDecoder(video_file_path)
+num_frames = len(simple_decoder)
+print("{video_file_path=} has {num_frames=} frames")
+first_frame = simple_decoder[0]
+print("{type(first_frame)=}")
diff --git a/examples/basic_example_remove_me.py b/examples/basic_example_remove_me.py