VideoStreamWebm.xml 1.6 KB

12345678910111213141516171819202122232425262728293031
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VideoStreamWebm" inherits="VideoStream" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. [VideoStream] resource for WebM videos.
  5. </brief_description>
  6. <description>
  7. [VideoStream] resource handling the [url=https://www.webmproject.org/]WebM[/url] video format with [code].webm[/code] extension. Both the VP8 and VP9 codecs are supported. The VP8 and VP9 codecs are more efficient than [VideoStreamTheora], but they require more CPU resources to decode (especially VP9). Both the VP8 and VP9 codecs are decoded on the CPU.
  8. [b]Note:[/b] Alpha channel (also known as transparency) is not supported. The video will always appear to have a black background, even if it originally contains an alpha channel.
  9. [b]Note:[/b] Not supported on iOS, or when compiled for RISC-V, and there are known bugs and performance issues with WebM video playback in Godot. If you run into problems, try using the Ogg Theora format instead: [VideoStreamTheora]
  10. </description>
  11. <tutorials>
  12. </tutorials>
  13. <methods>
  14. <method name="get_file">
  15. <return type="String" />
  16. <description>
  17. Returns the WebM video file handled by this [VideoStreamWebm].
  18. </description>
  19. </method>
  20. <method name="set_file">
  21. <return type="void" />
  22. <argument index="0" name="file" type="String" />
  23. <description>
  24. Sets the WebM video file that this [VideoStreamWebm] resource handles. The [code]file[/code] name should have the [code].webm[/code] extension.
  25. </description>
  26. </method>
  27. </methods>
  28. <constants>
  29. </constants>
  30. </class>