CameraServer.xml 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CameraServer" inherits="Object" version="3.3">
  3. <brief_description>
  4. Server keeping track of different cameras accessible in Godot.
  5. </brief_description>
  6. <description>
  7. The [CameraServer] keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone.
  8. It is notably used to provide AR modules with a video feed from the camera.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. <method name="add_feed">
  14. <return type="void" />
  15. <argument index="0" name="feed" type="CameraFeed" />
  16. <description>
  17. Adds a camera feed to the camera server.
  18. </description>
  19. </method>
  20. <method name="feeds">
  21. <return type="Array" />
  22. <description>
  23. Returns an array of [CameraFeed]s.
  24. </description>
  25. </method>
  26. <method name="get_feed">
  27. <return type="CameraFeed" />
  28. <argument index="0" name="index" type="int" />
  29. <description>
  30. Returns the [CameraFeed] with this id.
  31. </description>
  32. </method>
  33. <method name="get_feed_count">
  34. <return type="int" />
  35. <description>
  36. Returns the number of [CameraFeed]s registered.
  37. </description>
  38. </method>
  39. <method name="remove_feed">
  40. <return type="void" />
  41. <argument index="0" name="feed" type="CameraFeed" />
  42. <description>
  43. Removes a [CameraFeed].
  44. </description>
  45. </method>
  46. </methods>
  47. <signals>
  48. <signal name="camera_feed_added">
  49. <argument index="0" name="id" type="int" />
  50. <description>
  51. Emitted when a [CameraFeed] is added (e.g. webcam is plugged in).
  52. </description>
  53. </signal>
  54. <signal name="camera_feed_removed">
  55. <argument index="0" name="id" type="int" />
  56. <description>
  57. Emitted when a [CameraFeed] is removed (e.g. webcam is unplugged).
  58. </description>
  59. </signal>
  60. </signals>
  61. <constants>
  62. <constant name="FEED_RGBA_IMAGE" value="0" enum="FeedImage">
  63. The RGBA camera image.
  64. </constant>
  65. <constant name="FEED_YCBCR_IMAGE" value="0" enum="FeedImage">
  66. The YCbCr camera image.
  67. </constant>
  68. <constant name="FEED_Y_IMAGE" value="0" enum="FeedImage">
  69. The Y component camera image.
  70. </constant>
  71. <constant name="FEED_CBCR_IMAGE" value="1" enum="FeedImage">
  72. The CbCr component camera image.
  73. </constant>
  74. </constants>
  75. </class>