Update Peer Position

Update Peer Position

Updates the two-dimensional position of the own peer in the room. You have to set the scale beforehand via Set Room Position Scale.

Warning

Invoking Update Peer Position too frequently can lead to operational issues where the optimization of audio streams may not function correctly. Limit the frequency of calling to a maximum of 10 times per second. This equates to one update every 100 milliseconds. We recommend using Unreal’s Set Timer by Event node to update the position in Odin rooms.

Tip

This function is optional and only used for performance reasons and to save bandwidth. This is not needed to make spatial audio work.

Inputs

NameTypeDescription
Execexec
RoomRoomThe room in which the peer’s position shall be set.
PositionstructThe value of the position, for now as 2D vector.
On ErrordelegateDelegate to handle errors while updating the position.
On SuccessdelegateCalled when the position has been successfully updated.

Outputs

NameTypeDescription
Execexec
On ResponseexecCalled when the server has returned its response. Use the success output to understand if anything went fine.
Successbooleantrue if the position has been successfully set.