VideoStreamTheora.xml 1.2 KB

123456789101112131415161718192021222324252627282930
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VideoStreamTheora" inherits="VideoStream" version="3.3">
  3. <brief_description>
  4. [VideoStream] resource for Ogg Theora videos.
  5. </brief_description>
  6. <description>
  7. [VideoStream] resource handling the [url=https://www.theora.org/]Ogg Theora[/url] video format with [code].ogv[/code] extension. The Theora codec is less efficient than [VideoStreamWebm]'s VP8 and VP9, but it requires less CPU resources to decode. The Theora codec is decoded on the CPU.
  8. [b]Note:[/b] While Ogg Theora videos can also have an [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. <method name="get_file">
  14. <return type="String" />
  15. <description>
  16. Returns the Ogg Theora video file handled by this [VideoStreamTheora].
  17. </description>
  18. </method>
  19. <method name="set_file">
  20. <return type="void" />
  21. <argument index="0" name="file" type="String" />
  22. <description>
  23. Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension.
  24. </description>
  25. </method>
  26. </methods>
  27. <constants>
  28. </constants>
  29. </class>