Room

Nodes to create, connect and close ODIN rooms, send RPCs and messages, and react to room events.

Functions

Node	Type	Description
Clear Listen ChannelMask For Peer	Callable function	Removes a previously set per-peer listen channel mask override, falling back to the default set via SetListenChannelMask for that peer.
Close Room	Callable function	Leaves the room gracefully: the local peer leaves the room on the server, every peer that was announced through On Peer Joined is reported through On Peer Left, the room status changes to closed, and the native room is freed (at the latest after two seconds).
Connect Room	Callable function	Connects the room to an ODIN gateway and joins it with the given authentication token.
Construct Room	Callable function	Creates a new ODIN room object.
Free Room	Callable function	Releases the native room immediately, without waiting for the server to confirm that the local peer left.
Get Connection Stats	Pure function	Returns statistics of the room's connection: the UDP datagrams and bytes sent and received, and the round-trip time.
Get Decoders by Peer	Pure function	Returns all decoders that are registered for the given peer of this room (see Register Decoder to Peer).
Get Odin Room Name	Pure function	Returns the name of the room as reported by the native room handle.
Get own Peer ID	Pure function	Retrieves the Peer ID assigned to the local client by the ODIN server.
Get Reconnect Token	Pure function	Returns the latest reconnect token the server issued for this room (see On New Reconnect Token).
Get Room Name	Pure function	Returns the ID of the joined room, as reported by On Room Joined.
Is Closing	Pure function	Whether CloseRoom was called and the native room has not been freed yet.
Is Connected	Pure function	Returns true if the client is currently connected to the ODIN server and the room session is active.
Open Socket	Callable function	Opens a socket to a peer in this room, or to all peers with a Target Peer Id of 0.
Remove All Sockets	Callable function	Closes and removes all sockets of this room.
Remove Peer Sockets	Callable function	Close and remove all sockets whose remote peer is the given peer.
Send Audio	Callable function	Drain Encoder pipline for audio data and sends encoded voice packets to the server.
Send ChangeSelf Rpc	Callable function	Updates the local peer's User Data.
Send Message Rpc	Callable function	Sends an arbitrary data message to a specific list of peers.
Send Rpc	Callable function	Sends a custom RPC to the server.
Send SetChannelMasks Rpc	Callable function	Sends the channel masks the local peer listens to, per remote peer.
Set Crypto Password	Pure function	Sets the shared secret of the room's crypto extension from a password.
Set Listen ChannelMask	Callable function	Sets the channel mask used when listening to peers that do not have a per-peer override set via SetListenChannelMaskForPeer.
Set Listen ChannelMask For Peer	Callable function	Overrides the channel mask used when listening to a specific peer, taking precedence over the default set via SetListenChannelMask.

Events

Event	Raised by	Description
On Message Received	Odin Room	Event triggered when an arbitrary message is received from a peer.
On New Reconnect Token	Odin Room	Event triggered when the server issues a new reconnect token.
On Peer Changed	Odin Room	Event triggered when a remote peer updates their user data.
On Peer Joined	Odin Room	Event triggered when a remote peer joins the room.
On Peer Left	Odin Room	Event triggered when a remote peer leaves the room.
On Room Error	Odin Room	Raised when the server reports an error for this room.
On Room Joined	Odin Room	Event triggered when the local client has successfully joined the room.
On Room Status Changed	Odin Room	Raised when the connection status of the room changes: joining while (re)connecting, joined once the room is joined, and closed after the room was closed.
On Rpc	Odin Room	Raised for every RPC the server sends to this room, with the raw JSON.
On Socket	Odin Room	Raised when a message arrives on any socket of this room.

Properties

Variables that Blueprints can read (Get) and, where noted, write (Set) directly on an object of the class.

Property	Class	Type	Access	Description
Crypto	Odin Room	Odin Crypto	Get/Set	Optional instance of pluggable encryption module for room communications. A cipher can be attached to the room on creation to enable customizable, end-to-end encryption(E2EE). Needs ODIN_USE_CRYPTO with CryptoExtention and associated library.