Ximea documentation

XIMEA is an IO plugin for Vahana VR. It allows Vahana VR to capture audio/video stream with Ximea cameras.

The plugin has been developed and tested with the following models:

• [MX023MG-SY-X2G] *8

Set-up

Drivers:

Input configuration

The ximea plugin can be used by Vahana VR through a .vah project file. Please see the *.vah file format specification for additional details.

Define an input for each input on the capture cards. The reader_config member specifies how to read it.

Example

"inputs" : [
{
"reader_config" : {
      "type" : "ximea",
      "name" : "MX023MG-SY-X2G27",
      "pixel_format" : "Grayscale",
      "interleaved" : false,
      "frame_rate" : {
        "num" : 30,
        "den" : 1
      },
      "device" : 0,
      "bandwidth" : 1000
    },
    "width" : 1936,
    "height" : 1216,
  ...
},
{
"reader_config" : {
      "type" : "ximea",
      "name" : "MX023MG-SY-X2G27",
      "pixel_format" : "Grayscale",
      "interleaved" : false,
      "frame_rate" : {
        "num" : 30,
        "den" : 1
      },
      "device" : 7,
      "bandwidth" : 1000,
      "fps_limit" : 30
    },
    "width" : 1936,
    "height" : 1216,
  ...
}]

Parameters

Note that the width and height fields must match exactly an existing display mode below.

Member	Type	Value
type	string	Ximea	Required. Defines an Ximea input.
device	int	-	Required. The input cam number (Starting from 0).
pixel_format	string	-	Unused. The input pixel format. Supported values are Grayscale.
bandwidth	int	-	Optional. The PCIx bus bandwidth upper limit allowed for the cam (highly recommanded for avoiding your OS to freeze).
fps_limit	int	-	Optional. The framerate upper limit for the cam (Work relativily bad).

XIMEA supported display modes

There is only one available display mode but downscaling is available at camera level : 1936x1216 FPS is not fixed