Blueprint Reference

Functions

NameDescription
Construct a RoomCreates a local room object that will be used to handle events and client side connection settings.
Make ODIN APM SettingsCreates an APM settings object that can be used to construct a room.
Generate Room TokenTakes an access key and a room id and creates a room token that is used to join a room.
Construct a Token GeneratorCreates a token generator that is used to generate room tokens on client side.
Join RoomJoins an ODIN room with the room token provided. Every peer connected to the same room will be able to talk to each other and exchange data.
Odin Create MediaCreates a media object that will be used in the Add Media node input. Connect an Audio Capture node to it.
Add MediaAdds a previously generated media object to the room. Once this is done, the users microphone input will be sent to other users so they can hear the audio.
Format ErrorTakes an ODIN error code and returns an error message a string which can be printed to the log.
Generate Access KeyCreates an access key that can be used to generate room tokens.
Add Odin Synth ComponentAdds the Odin Synth Component to the specified actor.
Odin Assign Synth to MediaAssign a media stream coming with the Media Added event to the Odin Synth Component which will generate audio output from the incoming stream.

Events

NameDescription
On Add Media SuccessThis event is triggered in the Add media function once the media has been added to the room successfully
On Connection State ChangedHandles Connection State Changed events which are called when the connection state changed (i.e. a disconnect to the server). Connect a Bind to On Connection State Changed delegate node to handle this event for the specified room.
On Room JoinedHandles Room Joined events which are called once the local player has successfully joined a room. Connect a Bind to On Room Joined delegate node to handle this event for the specified room.
On Room User Data ChangedCalled whenever the user data of the room changed. Connect a Bind to On Room User Data Changed delegate node to handle this event for the specified room.
On Peer JoinedCalled whenever a peer joins the room. Connect a Bind to On Peer Joined delegate node to handle this event for the specified room.
On Peer LeftCalled whenever a peer left the room. Connect a Bind to On Peer Left delegate node to handle this event for the specified room.
On Peer User Data ChangedCalled whenever a peer has changed its user data. Connect a Bind to On Peer User Data Changed delegate node to handle this event for the specified room.
On Media AddedCalled whenever a peer has added a media. Connect a Bind to On Media Added delegate node to handle this event for the specified room.
On Media RemovedCalled whenever a peer has removed a media. Connect a Bind to On Media Removed delegate node to handle this event for the specified room.

Delegates

NameDescription
Bind to On Connection State ChangedListens on Connection State Changed events on the given Room object and calls the connected event handler of type On Connection Changed.
Bind to On Room JoinedListens on Room Joined events on the given Room object and calls the connected event handler of type onRoomJoined.
Bind to On Room User Data ChangedListens on Room User Data Changed events on the given Room object which will be called whenever the rooms user data got updated.
Bind to On Peer JoinedListens on Peer Joined events on the given Room object which will be called whenever a peer joined the room. Is not called for the local player. Use the On Room Joined event to handle joins from the local player instead.
Bind to On Peer LeftListens on Peer Left events on the given Room object which will be called whenever a peer left the room. Is not called for the local player.
Bind to On Peer User Data ChangedListens on Peer User Data Changed events on the given Room object which will be called whenever a peer updates his user data. Is not called for the local player.
Bind to On Media AddedListens on Media Added events on the given Room object which will be called whenever a peer has added a media (i.e. activated the microphone). Is not called for the local player.
Bind to On Media RemovedListens on Media Removed events on the given Room object which will be called whenever a peer has removed a media (i.e. muted the microphone). Is not called for the local player.