Skip to content

Commit

Permalink
Document looping support
Browse files Browse the repository at this point in the history
Since godotengine/godot#77857 is merged and will be released in 4.2, it would be great to update the documentation.
  • Loading branch information
kinami-imai committed Sep 29, 2023
1 parent 12b7fee commit acf453a
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions tutorials/animation/playing_videos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ See :ref:`doc_viewports` and the
`GUI in 3D demo <https://github.com/godotengine/godot-demo-projects/tree/master/viewport/gui_in_3d>`__
for more information on setting this up.

Looping a video
^^^^^^^^^^^^^^^

For looping a video, the **Loop** property can be enabled. This will seamlessly
restart the video when it reaches its end.

Note that setting the project setting **Video Delay Compensation** to a non-zero
value might cause your loop to not be seamless, because the synchronization of
audio and video takes place at the start of each loop causing occasional missed
frames. Set **Video Delay Compensation** in your project settings to **0** to
avoid frame drop issues.

Video decoding conditions and recommended resolutions
-----------------------------------------------------

Expand Down Expand Up @@ -143,9 +155,6 @@ There are several limitations with the current implementation of video playback
- Seeking a video to a certain point is not supported.
- Changing playback speed is not supported. VideoStreamPlayer also won't follow
:ref:`Engine.time_scale<class_Engine_property_time_scale>`.
- Looping is not supported, but you can connect a VideoStreamPlayer's
:ref:`finished <class_VideoStreamPlayer_signal_finished>` signal to a function
that plays the video again.
- Streaming a video from a URL is not supported.

.. _doc_playing_videos_recommended_theora_encoding_settings:
Expand Down

0 comments on commit acf453a

Please sign in to comment.