Functions
Our Unreal Engine Plugin contains these Blueprint 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. In production this should be done in a protected environment, e.g. your authentication server (see example project `Token Server´) |
| 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. These keys are only for development and should not be used in production. |
| 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 |