Blueprint Reference
Functions
Name | Description |
---|---|
Construct a Room | Creates a local room object that will be used to handle events and client side connection settings. |
Make ODIN APM Settings | Creates an APM settings object that can be used to construct a room. |
Generate Room Token | Takes an access key and a room id and creates a room token that is used to join a room. |
Construct a Token Generator | Creates a token generator that is used to generate room tokens on client side. |
Join Room | Joins 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. |
Construct Local Media | Creates a media object that will be used in the Audio Capture node to it. |
Add Media To Room | Adds 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 Error | Takes an ODIN error code and returns an error message a string which can be printed to the log. |
Generate Access Key | Creates an access key that can be used to generate room tokens. |
Add Odin Synth Component | Adds the Odin Synth Component to the specified actor. |
Odin Assign Synth to Media | Assign a media stream coming with the Media Added event to the Odin Synth Component which will generate audio output from the incoming stream. |
Set Room Position Scale | Sets the multiplicative scale for all coordinates used in position updates. Note: The position scale should be set to the same value for all peers in the ODIN room. The scale value also has to be set individually for each room that will utilize ODIN’s optimization feature. |
Update Peer Position | Updates the two-dimensional position of the own peer in the room. You have to set the scale beforehand via |
Events
Name | Description |
---|---|
On Add Media To Room Success | This event is triggered in the |
On Connection State Changed | Handles Connection State Changed events which are called when the connection state changed (i.e. a disconnect to the server). Connect a |
On Room Joined | Handles Room Joined events which are called once the local player has successfully |
On Room User Data Changed | Called whenever the user data of the room changed. Connect a |
On Peer Joined | Called whenever a peer joins the room. Connect a |
On Peer Left | Called whenever a peer left the room. Connect a |
On Peer User Data Changed | Called whenever a peer has changed its user data. Connect a |
On Media Added | Called whenever a peer has added a media. Connect a |
On Media Removed | Called whenever a peer has removed a media. Connect a |
Delegates
Name | Description |
---|---|
Bind to On Connection State Changed | Listens on Connection State Changed events on the given Room object and calls the connected event handler of type |
Bind to On Room Joined | Listens on Room Joined events on the given Room object and calls the connected event handler of type |
Bind to On Room User Data Changed | Listens 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 Joined | Listens 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 |
Bind to On Peer Left | Listens 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 Changed | Listens 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 Added | Listens 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 Removed | Listens 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. |