Developer Documentation

Update Peer Position

Update Peer Position

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

Important

Invoking this method too frequently can lead to operational issues where the optimization of audio streams may not function correctly. Limit the frequency of calling Update Peer Position to a maximum of 10 times per second.

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.
PositionvectorThe value of the position.
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’ value to check if the position has been successfully set.
Successbooleantrue if the position has been successfully set.