Creates a local room object that will be used to handle events and client side connection settings. Connect the Room output to the Room input of the Join Room node. You can also use the Room output to handle events like Room Joined or Media Added.
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´)
Creates an Odin Audio Capture object, that can be used to get access to the microphone on the users device. The Odin Audio Capture object adds features to the default Unreal Audio Capture, like enabling capture device switching on supported platforms or improved Push-To-Talk features. Please make sure, that the Audio Capture Plugin is enabled.
GetVolumeMultiplier: Retrieves the current volume multiplier of the capture device’s input. SetVolumeMultiplier: Sets the volume multiplier for the capture device’s input.
Handles 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.
Handles Room Joined events which are called once the local user has successfully joined a room. Connect a Bind to On Room Joined delegate node to handle this event for the specified room.
Called 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.
Called whenever a peer has added a media (i.e. activated the microphone). Connect to a Bind to On Media Added delegate node to handle this event for the specified room. Will not be called for the local player.
Listens to Peer Joined events in the given Room object. Peer Joined events will be called whenever a peer joins the room. Will not be called for the local player. Use the On Room Joined event to handle joins from the local player instead.
Listens to Peer User Data Changed events for the given Room object. Peer User Data Changed events will be called whenever a peer updates their user data. Is not called for the local player.
Listens for On Media Added events in the given Room object. On Media Added events will be called whenever a peer has added a media (i.e. activated the microphone). Is not called for the local player.
Listens to On Media Removed events in the given Room. On Media Removed will be called whenever a peer has removed a media (i.e. muted the microphone). Is not called for the local player.
Returns all available capture devices with the device id. IMPORTANT! Use the Async version in case you experience stuttering. The Async version runs asynchronously and uses a callback when the result is available.
IMPORTANT! Use the Async version in case you experience stuttering. Updates the capture device and restarts the capture stream of the Audio Capture component. The Async version runs asynchronously and does not block the main thread.
IMPORTANT! Use the Async version in case you experience stuttering. Updates the capture device and restarts the capture stream of the Audio Capture component. The Async version runs asynchronously and does not block the main thread.
Will be called if ODIN recognizes that the selected capture device does not supply data anymore, i.e., if a microphone was unplugged. ODIN will wait for AllowedTimeWithoutStreamUpdate seconds before trying a stream restart. You can set the AllowedTimeWithoutStreamUpdate parameter on the Odin Audio Capture Object.
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.
Sets the multiplicative scale for all coordinates used in position updates. Use this as the maximum radius in which a peer can be heard. The scale value is used to optimize audio streams by not streaming audio data to peer’s that are outside of hearing range.
Updates audio processing settings for capture media handles in a specific room. This function allows modification of various audio processing parameters for a room.
Closes the connection to the server and destroys the local room handle. This function is used to properly disconnect and clean up resources associated with a room.
This function can be used to reset the media handle assigned to the targeted ODIN Synth Component instance. Resetting a media handle will restore it to its default configuration. This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.
This function is used to modify the Attenuation Settings on the targeted ODIN Synth instance. It is worth noting that Attenuation Settings are only passed to new Active Sounds on start, so modified Attenuation data should be set before sound playback.