Developer Documentation
Our new developer documentation is now available. Please check it out!

Room.Join

public static bool Join(string endPoint, string token, uint samplerate, bool stereo, out Room room)
public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, uint samplerate, bool stereo, out Room room)
public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, out Room room)
public static Room Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo)

Create and join a Room

Parameters

NameTypeDescription
endPointStringGateway server
tokenStringJoin token
samplerateUInt32sets default samplerate
stereoBooleansets default stereo flag
roomRoomInitialized room
connectionPoolHandleOdinConnectionPoolHandleConnection pool for the room
roomNameStringinitial room name
userDataByte[]initial userdata
positionXSingleinitial position
positionYSingleinitial position
positionZSingleinitial position

Returns

TypeDescription
Booleantrue on successfully request join or false
Roomtrue on successfully request join or false

Variants

Join(endPoint, token, samplerate, stereo, room)

public static bool Join(string endPoint, string token, uint samplerate, bool stereo, out Room room)

Create and join a Room

Parameters

NameTypeDescription
endPointStringGateway server
tokenStringJoin token
samplerateUInt32sets default samplerate
stereoBooleansets default stereo flag
roomRoomInitialized room

Returns

TypeDescription
Booleantrue on successfully request join or false

Join(connectionPoolHandle, endPoint, token, samplerate, stereo, room)

public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, uint samplerate, bool stereo, out Room room)

Create and join a Room

Parameters

NameTypeDescription
connectionPoolHandleOdinConnectionPoolHandleConnection pool for the room
endPointStringGateway server
tokenStringJoin token
samplerateUInt32sets default samplerate
stereoBooleansets default stereo flag
roomRoomInitialized room

Returns

TypeDescription
Booleantrue on successfully request join or false

Join(connectionPoolHandle, endPoint, token, roomName, userData, positionX, positionY, positionZ, samplerate, stereo, room)

public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, out Room room)

Create and join a Room

Parameters

NameTypeDescription
connectionPoolHandleOdinConnectionPoolHandleConnection pool for the room
endPointStringGateway server
tokenStringJoin token
roomNameStringinitial room name
userDataByte[]initial userdata
positionXSingleinitial position
positionYSingleinitial position
positionZSingleinitial position
samplerateUInt32sets default samplerate
stereoBooleansets default stereo flag
roomRoomInitialized room

Returns

TypeDescription
Booleantrue on successfully request join or false

Join(connectionPoolHandle, endPoint, token, roomName, userData, positionX, positionY, positionZ, samplerate, stereo)

public static Room Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo)

Create and join a Room

Parameters

NameTypeDescription
connectionPoolHandleOdinConnectionPoolHandleConnection pool for the room
endPointStringGateway server
tokenStringJoin token
roomNameStringinitial room name
userDataByte[]initial userdata
positionXSingleinitial position
positionYSingleinitial position
positionZSingleinitial position
samplerateUInt32sets default samplerate
stereoBooleansets default stereo flag

Returns

TypeDescription
Roomtrue on successfully request join or false