Our new developer documentation is now available. Please check it out!
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
| Name | Type | Description |
|---|---|---|
| Exec | exec | |
| Room | Room | The room in which the peer’s position shall be set. |
| Position | vector | The value of the position. |
| On Error | delegate | Delegate to handle errors while updating the position. |
| On Success | delegate | Called when the position has been successfully updated. |
Outputs
| Name | Type | Description |
|---|---|---|
| Exec | exec | |
| On Response | exec | Called when the server has returned its response. Use the ‘success’ value to check if the position has been successfully set. |
| Success | boolean | true if the position has been successfully set. |