Developer Documentation

OdinRoom.join

join(userData?: Uint8Array, position?: any): Promise<OdinPeer>

Joins the room and returns your own peer instance after the room was successfully joined.

Parameters

NameTypeDescription
userDataUint8ArrayOptional user data to set for the peer when connecting
positionanyOptional coordinates to set the three-dimensional position of the peer in the room when connecting

Returns

TypeDescription
Promise<OdinPeer>