The SpatialPosition model represents a participant's audio position. The position is defined using Cartesian coordinates.

You can define the direction of each axis in the coordinate system using the setSpatialEnvironment method. By default, the environment consists of the following axes:

  • X-axis: Extends positive to the right
  • Y-axis: Extends positive upwards
  • Z-axis: Extends positive forwards

The setSpatialEnvironment method allows the application to choose the meaning of each axis and match the usage of the application.

Available in the package


x (double)

The x-coordinate of a new audio location.

y (double)

The y-coordinate of a new audio location.

z (double)

The z-coordinate of a new audio location.