CameraServer

Inherits: Object

Server keeping track of different cameras accessible in Godot.

Description

The CameraServer keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone.

It is notably used to provide AR modules with a video feed from the camera.

Note: This class is currently only implemented on macOS and iOS. On other platforms, no CameraFeeds will be available.

Methods

void

add_feed ( CameraFeed feed )

CameraFeed[]

feeds ( )

CameraFeed

get_feed ( int index )

int

get_feed_count ( )

void

remove_feed ( CameraFeed feed )

Signals

  • camera_feed_added ( int id )

Emitted when a CameraFeed is added (e.g. a webcam is plugged in).


  • camera_feed_removed ( int id )

Emitted when a CameraFeed is removed (e.g. a webcam is unplugged).

Enumerations

enum FeedImage:

  • FEED_RGBA_IMAGE = 0 --- The RGBA camera image.

  • FEED_YCBCR_IMAGE = 0 --- The YCbCr camera image.

  • FEED_Y_IMAGE = 0 --- The Y component camera image.

  • FEED_CBCR_IMAGE = 1 --- The CbCr component camera image.

Method Descriptions

Adds the camera feed to the camera server.


Returns an array of CameraFeeds.


Returns the CameraFeed corresponding to the camera with the given index.


  • int get_feed_count ( )

Returns the number of CameraFeeds registered.


Removes the specified camera feed.