Functions

Our Unreal Engine Plugin contains these Blueprint 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. In production this should be done in a protected environment, e.g. your authentication server (see example project `Token Server´)
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.
Construct Local MediaCreates a media object that will be used in the Add Media To Room node input. Connect an Audio Capture node to it.
Add Media To RoomAdds 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. These keys are only for development and should not be used in production.
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.
Set Room Position ScaleSets 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 PositionUpdates the two-dimensional position of the own peer in the room. You have to set the scale beforehand via Set Room Position Scale.
Send MessageSends arbitrary data to a list of target peers to an ODIN room. Every peer connected to the same room will be able to receive the message.