Class OdinClient

Client Wrapper for ODIN ffi OdinNative.Core.OdinLibrary.NativeMethods

Assembly: cs.temp.dll.dll

Declaration

public class OdinClient : MarshalByRefObject, IDisposable

Implements:
Odin.IDisposable

Properties

Rooms

A collection of all OdinNative.Wrapper.Room.Room

Declaration

public RoomCollection Rooms { get; }

EndPoint

Connection EndPoint. Default from OdinEditorConfig.

Declaration

public Uri EndPoint { get; }

AccessKey

Client AccessKey for all new rooms. Default from OdinHandler config.

Declaration

public string AccessKey { get; }

UserData

Declaration

public IUserData UserData { get; }

Methods

Create(Uri)

Creates a new initialized instance for ODIN ffi C# Wrapper

Declaration

public static OdinClient Create(Uri server)

Returns

OdinNative.Wrapper.OdinClient: OdinClient wrapper

Parameters

Type	Name	Description
Odin.Uri	server	Odin Server/Gateway

Create(Uri, string)

Creates a new initialized instance for ODIN ffi C# Wrapper

Declaration

public static OdinClient Create(Uri server, string accessKey)

Returns

OdinNative.Wrapper.OdinClient: OdinClient wrapper

Parameters

Type	Name	Description
Odin.Uri	server	Odin Server
System.String	accessKey	Odin access key

Create(Uri, string, OdinConnectionPoolSettings)

Creates a new initialized instance for ODIN ffi C# Wrapper

Declaration

public static OdinClient Create(Uri server, string accessKey, NativeBindings.OdinConnectionPoolSettings settings)

Returns

OdinNative.Wrapper.OdinClient: OdinClient wrapper

Parameters

Type	Name	Description
Odin.Uri	server	Odin Server
System.String	accessKey	Odin access key
Odin.NativeBindings.OdinConnectionPoolSettings	settings	Custom settings

OnNativeDatagramReceived(ulong, ushort, IntPtr, uint, MarshalByRefObject)

Declaration

protected static void OnNativeDatagramReceived(ulong room_id, ushort media_id, IntPtr bytesPtr, uint bytes_length, MarshalByRefObject user_data)

Parameters

Type	Name
System.UInt64	room_id
System.UInt16	media_id
Odin.IntPtr	bytesPtr
System.UInt32	bytes_length
Odin.MarshalByRefObject	user_data

OnNativeRPCReceived(ulong, IntPtr, uint, MarshalByRefObject)

Declaration

protected static void OnNativeRPCReceived(ulong room_id, IntPtr bytesPtr, uint bytes_length, MarshalByRefObject user_data)

Parameters

Type	Name
System.UInt64	room_id
Odin.IntPtr	bytesPtr
System.UInt32	bytes_length
Odin.MarshalByRefObject	user_data

ReloadLibrary(bool)

Internal library reload

Declaration

protected void ReloadLibrary(bool init = true)

Parameters

Type	Name	Description
System.Boolean	init	Idicates to initialize the library again after release

CreateAccessKey()

Create a example access key that can be registered on 4Players (see https://developers.4players.io/odin/)

Declaration

public static string CreateAccessKey()

Returns

System.String: access key string or empty### CreateToken(string, string) Create a example token to join a room. For production use a token server!

Declaration

public static string CreateToken(string accesskey, string body)

Returns

System.String: token string or empty

Parameters

Type	Name	Description
System.String	accesskey	Key to generate a token from
System.String	body	token body

GenerateToken(string, out string)

Create a example token to join a room. For production use a token server!

Declaration

public bool GenerateToken(string body, out string token)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
System.String	body	token body
System.String	token	token string

CreateRoom(uint, bool)

Create a room for the set gateway.

Declaration

public Room CreateRoom(uint samplerate, bool stereo)

Returns

OdinNative.Wrapper.Room.Room: Room object with a connection

Parameters

Type	Name	Description
System.UInt32	samplerate	room default samplerate fallback
System.Boolean	stereo	room default stereo flag fallback

JoinRoom(string, uint, bool, bool)

Create and join a OdinNative.Wrapper.Room.Room

Declaration

public Room JoinRoom(string token, uint samplerate, bool stereo, bool handleRoom = true)

Returns

OdinNative.Wrapper.Room.Room: room or null

Parameters

Type	Name	Description
System.String	token	token
System.UInt32	samplerate
System.Boolean	stereo
System.Boolean	handleRoom	true will add the room to OdinNative.Wrapper.Room.RoomCollection of the client

JoinRoom(string, string, byte[], float, float, float, uint, bool, bool)

Create and join a OdinNative.Wrapper.Room.Room

Declaration

public Room JoinRoom(string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, bool handleRoom = true)

Returns

OdinNative.Wrapper.Room.Room: room or null

Parameters

Type	Name	Description
System.String	token	token
System.String	roomName	room alias
System.Byte[]	userData	initial userdata
System.Single	positionX	server culling position X
System.Single	positionY	server culling position Y
System.Single	positionZ
System.UInt32	samplerate
System.Boolean	stereo
System.Boolean	handleRoom	true will add the room to OdinNative.Wrapper.Room.RoomCollection of the client

Join(Room, string)

Join a object of base OdinNative.Wrapper.Room.Room

Declaration

public bool Join(Room room, string token)

Returns

System.Boolean

Parameters

Type	Name	Description
OdinNative.Wrapper.Room.Room	room	base type OdinNative.Wrapper.Room.Room
System.String	token

Join(Room, string, string, byte[], float, float)

Join a object of base OdinNative.Wrapper.Room.Room

Declaration

public bool Join(Room room, string token, string roomName, byte[] userData, float positionX, float positionY)

Returns

System.Boolean: room or null

Parameters

Type	Name	Description
OdinNative.Wrapper.Room.Room	room	base type OdinNative.Wrapper.Room.Room
System.String	token	token
System.String	roomName	room alias
System.Byte[]	userData	initial userdata
System.Single	positionX	server culling position X
System.Single	positionY	server culling position Y

CloseRoom(ulong)

Close a room by Id

Declaration

public bool CloseRoom(ulong roomId)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
System.UInt64	roomId	room id

CloseRoom(Room)

Close a room

Declaration

public bool CloseRoom(Room room)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
OdinNative.Wrapper.Room.Room	room	room to close

FreeRoom(ulong)

Close and remove a room by Id

Declaration

public bool FreeRoom(ulong roomId)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
System.UInt64	roomId	room id

FreeRoom(Room)

Close and remove a room

Declaration

public bool FreeRoom(Room room)

Returns

System.Boolean: true on success or false

Parameters

Type	Name
OdinNative.Wrapper.Room.Room	room

BroadcastSendMessage(string)

Send a message to all rooms with the default encoding UTF8

Declaration

public void BroadcastSendMessage(string message)

Parameters

Type	Name	Description
System.String	message	UTF8 string

CloseRooms()

Completely closes all OdinNative.Wrapper.Room.Room associated.

Declaration

public void CloseRooms()

FreeRooms()

Free all OdinNative.Wrapper.Room.Room associated.

Declaration

public void FreeRooms()

Dispose(bool)

On dispose will free all OdinNative.Wrapper.Room.Room and

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Indicates to dispose the library

~OdinClient()

Default deconstructor

Declaration

protected ~OdinClient()

Dispose()

On dispose will free all OdinNative.Wrapper.Room.Room and

Declaration

public void Dispose()

Implements

• Odin.IDisposable